Merge pull request #1476 from Kircheneer/type-hinting

Type hinting

.github/workflows/commit.yaml

@@ -1,4 +1,4 @@
---- 
+---
 name: build
 on: [push, pull_request]
 jobs:
@@ -33,10 +33,14 @@ jobs:
         run: |
           pylama .
 
+      - name: Run type checker
+        run: |
+          mypy -p napalm --config-file mypy.ini
+
       - name: Run Tests
         run: |
           py.test --cov=napalm --cov-report term-missing -vs --pylama
-        
+
   build_docs:
     needs: std_tests
     runs-on: ubuntu-latest

mypy.ini

@@ -5,6 +5,24 @@ allow_redefinition = True
 [mypy-napalm.base.*]
 disallow_untyped_defs = True
 
+[mypy-napalm.nxos.*]
+disallow_untyped_defs = True
+
+[mypy-napalm.eos.*]
+ignore_errors = True
+
+[mypy-napalm.ios.*]
+ignore_errors = True
+
+[mypy-napalm.iosxr_netconf.*]
+ignore_errors = True
+
+[mypy-napalm.nxapi_plumbing.*]
+disallow_untyped_defs = True
+
+[mypy-napalm.base.clitools.*]
+ignore_errors = True
+
 [mypy-napalm.base.test.*]
 ignore_errors = True
 

napalm/base/__init__.py

@@ -19,6 +19,8 @@
 import importlib
 
 # NAPALM base
+from typing import Type
+
 from napalm.base.base import NetworkDriver
 from napalm.base.exceptions import ModuleImportError
 from napalm.base.mock import MockDriver
@@ -29,7 +31,7 @@
 ]
 
 
-def get_network_driver(name, prepend=True):
+def get_network_driver(name: str, prepend: bool = True) -> Type[NetworkDriver]:
     """
     Searches for a class derived form the base NAPALM class NetworkDriver in a specific library.
     The library name must repect the following pattern: napalm_[DEVICE_OS].