Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improved exceptions - added new base exception #649

Merged

Conversation

cwoodfield
Copy link
Contributor

Hi! I just had first go at writing a network automation script using napalm; I wanted to wrap my execution block in a try/except block, catching napalm-specific exceptions so that it would not exit the script, but to exit on other exceptions. In order to do this, I would have had to catch almost every listed exception class defined in base/exceptions.py individually.

I wrote a simple patch here to create a new generic NapalmException class, which inherits from Exception, and then modified each other exception class to subclass NapalmException instead. This way, I can list NapalmException as the only exception I need to catch, and then interrogate further for specific exception types if needed.

I've run the docs/test.sh script and all is good; let me know if there's further testing I should be doing before submitting a pull request. Thanks!

@coveralls
Copy link

coveralls commented Feb 11, 2018

Coverage Status

Coverage increased (+0.007%) to 78.946% when pulling 18146df on cwoodfield:cwoodfield/better_exceptions into 2d08e66 on napalm-automation:develop.

@dbarrosop
Copy link
Member

This is completely reasonable and I am actually quite surprised we haven’t done this sooner... Let’s wait to see what others think before merging though.

Copy link
Member

@mirceaulinic mirceaulinic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It certainly makes sense, thanks!

@dbarrosop dbarrosop merged commit 4fa9681 into napalm-automation:develop Feb 17, 2018
ktbyers added a commit that referenced this pull request Apr 12, 2018
* Remove multiple entries for netmiko (#617)

* Fixes NX-OS string change in show diff rollback-patch output (#619)

* Require to upgrade setuptools

* Modify NX-OS to properly save config to startup-config on commit_config (#624)

* Fixing NX-OS rollback issue (#626)

* Junos fix next-hop self in get_bgp_config() (#620)

* junos fix nhs in get_bgp_config()

* junos add test case for nhs in get_bgp_config()

* junos fix missing policy in existing test case for nhs

* junos fix E712 comparison

* fix typo

* junos remove nhs key in group level in get_bgp_config()

* junos rework nhs in get_bgp_config() by fetching all policies in one go

* junos fix test case for nhs get_bgp_config()

* junos clean code and add comments in nhs get_bgp_config()

* junos nhs remove inactive term in mocked data

* IOS-XR: return the is_alive flag for the SSH channel (#623)

* Fixes for CAM and ARP parsing issues in nxos_ssh.py (#634)

* Fixes #441, Fixes #633 show arp and mac address table processing.

* Minor improvement to get_arp processing on NXOS SSH (#639)

* Minor improvement to get_arp processing on NXOS SSH

* don't hide relevant import errors (#635)

* don't hide relevant import errors

* original name

* py2 compliance

* now back to py3 compatibility....

* Update index.rst (#650)

* improved exceptions - added new base exception (#649)

* improved exceptions - added new base exception

* fixed pep8 issue

* another pep8 issue fixed

* fixes #640 junos ConnectionException (#648)

* FIXES #653 additional error message on failed replace (#654)

* NX-OS ping implementation using more shared common code (#642)

* fix get_mac_table on IOS when there are routed ports

* [646] updating junos.py to support PTX platform (#665)

* Minor doc changes for NX-OS and IOS (#669)

* Unify netmiko argument processing across napalm drivers (#673)

* Start sharing common Netmiko code

* Adding unit tests for new netmiko argument parsing

* Adding NXOS to use netmiko argument processing

* IOS-XR and netmiko args processing

* Make nxos_facts behavior more consistent between NX-API and SSH (#674)

* fix issue #477: the output is now consistent between NXOS and NXOS_SSH driver

* #477 fix crash for some N9K 93180YC-EX, 93180LC-EX, etc

* Updates to NX-OS SSH get_facts

* Adding better test case for NX-API

* Update get_interfaces_ip to deal with unnumbered interfaces (#632)

* Update get_interfaces_ip to deal with unnumbered interfaces

* Extend tests for show_ip_interface

* Fix issue about N9K with vxlan (#676)

* Adding VXLAN support: EVPN and control plane flags on mac address + new interface name

* Fix #672: get_interfaces() crash with nve interfaces or no IP address

* fix missing mgmt0 interface in the get_fact on N9K device

* fix wrong description SVI on N9K device

* fix some pep error and an EOL issue for a test case

* Fix setup.py issue when using pip 10. (#692)

* Add virtualbox provider to the docs (#679)

* Apply correct format to code block

* Add virtualbox provider flag to vagrant

* Lldp neighbors detail bugfix (#675)

* Cosmetic cleanup in line with PEP8, whitespace and indentation fixes

* Address inconsistency in junos xml rpc calls for lldp interface information.

* Add two more cases where the RPC call for lldp neighbors interface detail is different to that documented

* Add StackStorm integrations to README (#683)

* Track BGP state to report is_up (#684)

* NAPALM release 2.3.1 (#696)

* Rolling version to 2.3.1

* Fixing linter issues introduced by new version of pylama
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants