pyats.easypy package¶

pyats.easypy.Task(*args, **kwargs)¶

pyats.easypy.main()¶

command line entry point

command-line entry point. Uses the default runtime and checks for whether a jobfile is parsed from command line, if not, exist with parser error.

strictly used for setuptools.load_entry_point/console_script.

pyats.easypy.run(*args, max_runtime=None, **kwargs)¶

run api

Shortcut function to start a Task(), wait for it to finish, and return the result to the caller. This api avoids the overhead of having to deal with the task objects, and provides a black-box method of creating tasks sequentially.

Parameters

(int) (max_runtime) – finish, before terminating it forcifully and raising errors. If not provided, waits forever.
(tuple) (args) –
(dict) (kwargs) –

Returns

Return type

the task’s result code

Subpackages¶

Submodules¶

class pyats.easypy.base.Component(runtime)¶

Bases: object

classmethod configure_parser(parser, legacy_cli=True)¶

configures the main runtime parser with this component’s own parser group.

Note

to be implemented by the component owner/developer.
should be adding argument groups and args to the provided parser

property runtime¶

class pyats.easypy.commands.RunEasypy(prog)¶

Bases: pyats.cli.base.Command

Run Easypy Job file

description = '\nRuns a pyATS job file with the provided arguments, generating & report result.\n'¶

help = 'runs the provided pyATS job file'¶

main(argv)¶: internal entrypoint for commands

name = 'job'¶

usage = '{prog} [file] [options]\n\nExample\n-------\n {prog} /path/to/jobfile.py\n {prog} /path/to/jobfile.py --testbed-file /path/to/testbed.yaml\n'¶

class pyats.easypy.email.AbstractEmailReport¶

Bases: object

AbstractEmailReport class

Base class for all report emails to inherit from and follow.

create_email(from_addrs, to_addrs, mailhtml, default_domain=None)¶

Parameters: (bool) (mailhtml) –

returns EmailMessage class instance with subject and body filled. This class can be overwritten to allow for MIME rich contents

abstract format_content()¶: abstract method, returns the content of email report in str

abstract format_subject()¶: abstract method, returns the subject of email report in str

save(filename)¶: saves the report content to file. can be overwritten to do more.

class pyats.easypy.email.ExceptionEmailReport(runtime, subject='pyATS Report - job: {runtime.job.name} by: {runtime.env.user}, !!! an exception occurred !!!', contents=None, attachment=None)¶

Bases: pyats.easypy.email.AbstractEmailReport

ExceptionEmailReport class

Used by MailBot to convert exceptions and tracebacks into an informative email message. This class is only used when the test-infrastructure crashes.

format_content()¶: abstract method, returns the content of email report in str

format_subject()¶: abstract method, returns the subject of email report in str

get_attachment()¶

class pyats.easypy.email.MailBot(*args, **kwargs)¶

Bases: pyats.easypy.base.Component

Mail Bot Class

Allows auto-generation of report emails when Easypy is finished running, pulling the reports from runtime.mail_report. This class is a context manager: when codes are executed within it, any exceptions caught by __exit__ will be added to the email report and sent out.

mailbot constructor

Parameters

(list/str) (from_addrs) – in the generated email’s “From:” field.
to_addrs(list/str) (list or string-list of addresses to be used) – in the generated email’s “To:” field.
(str) (subject) –
(bool) (mailhtml) –
(bool) –

classmethod configure_parser(parser, legacy_cli=True)¶

property mailto¶

mailto property getter

Returns the to_addrs Mailbot object.

class pyats.easypy.email.TextEmailReport(runtime, subject='pyATS Report - job: {runtime.job.name} by: {runtime.env.user}, total: {runtime.job.results[total]} (P:{runtime.job.results[passed]}, PX:{runtime.job.results[passx]}, F:{runtime.job.results[failed]} ...)', contents=None, attachment=None)¶

Bases: pyats.easypy.email.AbstractEmailReport

TextEmailReport class

Used as the standard email report generator. The reporting content is based off basic string-formating using templates and “runtime” as the input.

contains a “contents” OrderableDict, allowing users to add, remove and re-order report content. Each key in this dict formats into a section’s banner title, and each value is sent through the formatter to generate section body.

format_content()¶: abstract method, returns the content of email report in str

format_subject()¶: abstract method, returns the subject of email report in str

get_attachment()¶

class pyats.easypy.job.Job(*args, **kwargs)¶

Bases: pyats.easypy.base.Component

Job class

Representing a currently running jobfile within easypy. Each easypy run is only associated with a single Job class instance, and is accessible as runtime.job.

Job objects performs the actual job environment setup, run, finalization and cleanup. Refer to corresponding method for details.

Job constructor

Instantiates a job object and sets all sorts of internal states.

Parameters

(str) (jobfile) –
(EasypyRuntime) (runtime) –

classmethod configure_parser(parser, legacy_cli=True)¶

details()¶

static generate_uid(jobfile)¶

property report¶

run()¶

Job run

Runs the provided jobfile. Steps:

runs all pre-job plugins
run main() function entry of provided jobfile
cleanup any dangling tasks
add any child task messages to report email
run post-job plugins

update_job()¶

class pyats.easypy.main.EasypyRuntime(parser=None, legacy_cli=True)¶

Bases: object

Built-in __init__

Initializes Easypy object with default values required for the parser.

CLI_DESCRIPTION = 'Easypy command line arguments.\nNon-recognized args will pass-through to the user job file.\n\nExample\n-------\n %(prog)s /path/to/jobfile.py\n %(prog)s /path/to/jobfile.py -testbed_file /path/to/testbed.yaml\n\n--------------------------------------------------------------------------------\n'¶

class ReturnCodes(value)¶

Bases: enum.IntEnum

Standard return codes for Easypy Runtime

ARGPARSE_ERROR = 2¶

NOT_100_PERCENT = 1¶

OK = 0¶

PLUGIN_ERROR = 3¶

UNKNOWN_ERROR = 4¶

property archive¶