How to use the command 'pyats shell' (with examples)
The ‘pyats shell’ command is used to open a pre-loaded pyATS interactive Python shell. This command saves time in prototyping and allows users to quickly start working with the pyATS framework. The shell provides a convenient environment for running pyATS commands and scripts, as well as accessing the pyATS libraries.
Use case 1: Open pyATS shell with a defined Testbed file
Code:
pyats shell --testbed-file path/to/testbed.yaml
Motivation:
The motivation for using this example is to quickly start working with a specific testbed configuration. By specifying the testbed file, users can easily access and interact with devices specified in the file within the pyATS shell.
Explanation:
--testbed-file: This argument is used to specify the path to the testbed file. The testbed file contains the details of the network devices to be used in the testing process, such as device connection information and credentials.
Example output:
pyATS> testbed.devices
{'device1': <device1>,
'device2': <device2>,
'device3': <device3>,
...}
In the example output, the ’testbed.devices’ object contains the devices specified in the testbed file. Users can now access and interact with these devices using pyATS commands and scripts.
Use case 2: Open pyATS shell with a defined Pickle file
Code:
pyats shell --pickle-file path/to/pickle.file
Motivation:
The motivation for using this example is to quickly start working with a previously saved pyATS session. By specifying the pickle file, users can resume their work from where they left off without the need to reload all the required objects and configurations manually.
Explanation:
--pickle-file: This argument is used to specify the path to the pickle file. The pickle file contains the serialized objects from a previous pyATS session, including the testbed, parsed output, and other relevant data.
Example output:
pyATS> result.keys()
['result1', 'result2', 'result3', ...]
In the example output, the ‘result.keys()’ command returns the keys of the previously saved results. Users can now access and manipulate these results within the pyATS shell.
Use case 3: Open pyATS shell with IPython disabled
Code:
pyats shell --no-ipython
Motivation:
The motivation for using this example is to disable the IPython functionality within the pyATS shell. In some cases, users may prefer to work with a simplified Python shell without the additional features provided by IPython.
Explanation:
--no-ipython: This argument is used to disable the IPython functionality in the pyATS shell. By default, the pyATS shell uses IPython, which provides a more powerful and interactive Python shell experience.
Example output:
Python 3.8.10 (default, May 3 2021, 08:08:16)
[GCC 8.4.0] on linux
PyATS Shell (no IPython)
pyATS>
In the example output, the pyATS shell starts without the IPython banner, indicating that IPython functionality is disabled.
Conclusion:
The ‘pyats shell’ command provides a convenient way to start working with the pyATS framework. By using different arguments, users can open the shell with a defined testbed or pickle file, as well as enable or disable IPython functionality. These examples showcase the flexibility and versatility of the ‘pyats shell’ command, allowing users to quickly prototype and interact with their pyATS test automation projects.
