Release 5.1.0

.github/workflows/commit.yaml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.8, 3.9, 3.10.9, 3.11, 3.12.0]
+        python-version: ["3.9", "3.10.9", "3.11", "3.12", "3.13"]
 
     steps:
       - name: Checkout repository

.gitignore

@@ -59,6 +59,7 @@ docs/_static/
 .venv
 .vscode
 .devcontainer
+.python-version
 
 env
 *.swp

README.md

@@ -31,15 +31,15 @@ Install
 pip install napalm
 ```
 
+*Note*: Beginning with release 5.1.0 and later, NAPALM offers support for
+Python 3.9+ only.
+
 *Note*: Beginning with release 5.0.0 and later, NAPALM offers support for
 Python 3.8+ only.
 
 *Note*: Beginning with release 4.0.0 and later, NAPALM offers support for
 Python 3.7+ only.
 
-*Note*: Beginning with release 3.0.0 and later, NAPALM offers support for
-Python 3.6+ only.
-
 
 Upgrading
 =========

docs/requirements.txt

@@ -1,8 +1,8 @@
-urllib3==2.2.1 # https://github.com/readthedocs/readthedocs.org/issues/10290
-sphinx==7.2.6
+urllib3==2.3.0 # https://github.com/readthedocs/readthedocs.org/issues/10290
+sphinx==7.4.7
 sphinx-rtd-theme==2.0.0
 invoke==2.2.0
-jinja2==3.1.3
-MarkupSafe==2.1.5
-pytest==7.3.1
-ansible==9.4.0
+jinja2==3.1.6
+MarkupSafe==3.0.2
+pytest==8.3.5
+ansible==11.3.0

napalm/__init__.py

@@ -1,4 +1,4 @@
-import pkg_resources
+from importlib.metadata import version, PackageNotFoundError
 import sys
 import logging
 
@@ -17,14 +17,14 @@
 
 # Verify Python Version that is running
 try:
-    if not (sys.version_info.major == 3 and sys.version_info.minor >= 7):
-        raise RuntimeError("NAPALM requires Python 3.7 or greater")
+    if not (sys.version_info.major == 3 and sys.version_info.minor >= 9):
+        raise RuntimeError("NAPALM requires Python 3.9 or greater")
 except AttributeError:
-    raise RuntimeError("NAPALM requires Python 3.7 or greater")
+    raise RuntimeError("NAPALM requires Python 3.9 or greater")
 
 try:
-    __version__ = pkg_resources.get_distribution("napalm").version
-except pkg_resources.DistributionNotFound:
+    __version__ = version("napalm")
+except PackageNotFoundError:
     __version__ = "Not installed"
 
 __all__ = ("get_network_driver", "SUPPORTED_DRIVERS")

napalm/base/base.py

@@ -639,7 +639,7 @@ def get_lldp_neighbors_detail(
 
     def get_bgp_config(
         self, group: str = "", neighbor: str = ""
-    ) -> models.BPGConfigGroupDict:
+    ) -> models.BGPConfigGroupDict:
         """
         Returns a dictionary containing the BGP configuration.
         Can return either the whole config, either the config only for a group or neighbor.
@@ -921,12 +921,23 @@ def get_ntp_servers(self) -> Dict[str, models.NTPServerDict]:
         """
         Returns the NTP servers configuration as dictionary.
         The keys of the dictionary represent the IP Addresses of the servers.
-        Inner dictionaries do not have yet any available keys.
+        Inner dictionaries MAY contain information regarding per-server configuration.
 
         Example::
 
             {
-                '192.168.0.1': {},
+                '192.168.0.1':
+                {
+                    'address': '192.168.0.1',
+                    'port': 123,
+                    'version': 4,
+                    'association_type': 'SERVER',
+                    'iburst': False,
+                    'prefer': False,
+                    'network_instance': 'default',
+                    'source_address': '192.0.2.1',
+                    'key_id': -1,
+                },
                 '17.72.148.53': {},
                 '37.187.56.220': {},
                 '162.158.20.18': {}

napalm/base/clitools/cl_napalm.py

@@ -7,7 +7,8 @@
 import logging
 import argparse
 import getpass
-import pkg_resources
+import pkgutil
+from importlib.metadata import version
 from functools import wraps
 
 
@@ -156,9 +157,9 @@ def check_installed_packages():
     logger.debug("Gathering napalm packages")
     napalm_packages = sorted(
         [
-            "{}=={}".format(i.key, i.version)
-            for i in pkg_resources.working_set
-            if i.key.startswith("napalm")
+            "{}=={}".format(i.name, version(i.name))
+            for i in list(pkgutil.iter_modules())
+            if i.name.startswith("napalm")
         ]
     )
     for n in napalm_packages:

napalm/base/models.py

@@ -153,8 +153,8 @@
     "AFDict", {"sent_prefixes": int, "accepted_prefixes": int, "received_prefixes": int}
 )
 
-BPGConfigGroupDict = TypedDict(
-    "BPGConfigGroupDict",
+BGPConfigGroupDict = TypedDict(
+    "BGPConfigGroupDict",
     {
         "type": str,
         "description": str,
@@ -188,8 +188,8 @@
     },
 )
 
-BGPStateAdressFamilyDict = TypedDict(
-    "BGPStateAdressFamilyDict",
+BGPStateAddressFamilyDict = TypedDict(
+    "BGPStateAddressFamilyDict",
     {"received_prefixes": int, "accepted_prefixes": int, "sent_prefixes": int},
 )
 
@@ -203,7 +203,7 @@
         "is_enabled": bool,
         "description": str,
         "uptime": int,
-        "address_family": Dict[str, BGPStateAdressFamilyDict],
+        "address_family": Dict[str, BGPStateAddressFamilyDict],
     },
 )
 
@@ -223,16 +223,22 @@
 
 NTPPeerDict = TypedDict(
     "NTPPeerDict",
-    {
-        # will populate it in the future wit potential keys
-    },
+    {},
     total=False,
 )
 
 NTPServerDict = TypedDict(
     "NTPServerDict",
     {
-        # will populate it in the future wit potential keys
+        "address": str,
+        "port": int,
+        "version": int,
+        "association_type": str,
+        "iburst": bool,
+        "prefer": bool,
+        "network_instance": str,
+        "source_address": str,
+        "key_id": int,
     },
     total=False,
 )

napalm/base/test/base.py

@@ -323,7 +323,7 @@ def test_get_bgp_config(self):
         result = len(get_bgp_config) > 0
 
         for bgp_group in get_bgp_config.values():
-            result = result and self._test_model(models.BPGConfigGroupDict, bgp_group)
+            result = result and self._test_model(models.BGPConfigGroupDict, bgp_group)
             for bgp_neighbor in bgp_group.get("neighbors", {}).values():
                 result = result and self._test_model(
                     models.BGPConfigNeighborDict, bgp_neighbor

napalm/base/test/getters.py

@@ -90,7 +90,7 @@ def mock_wrapper(cls, test_case):
             attr.current_test = ""  # Empty them to avoid side effects
             attr.current_test_case = ""  # Empty them to avoid side effects
 
-        return result
+        return None
 
     @functools.wraps(func)
     def real_wrapper(cls, test_case):
@@ -249,7 +249,7 @@ def test_get_bgp_config(self, test_case):
         assert get_bgp_config == {} or len(get_bgp_config) > 0
 
         for bgp_group in get_bgp_config.values():
-            assert helpers.test_model(models.BPGConfigGroupDict, bgp_group)
+            assert helpers.test_model(models.BGPConfigGroupDict, bgp_group)
             for bgp_neighbor in bgp_group.get("neighbors", {}).values():
                 assert helpers.test_model(models.BGPConfigNeighborDict, bgp_neighbor)
 
@@ -311,7 +311,9 @@ def test_get_ntp_peers(self, test_case):
 
         for peer, peer_details in get_ntp_peers.items():
             assert isinstance(peer, str)
-            assert helpers.test_model(models.NTPPeerDict, peer_details)
+            assert helpers.test_model(
+                models.NTPPeerDict, peer_details, allow_subset=True
+            )
 
         return get_ntp_peers
 
@@ -323,7 +325,9 @@ def test_get_ntp_servers(self, test_case):
 
         for server, server_details in get_ntp_servers.items():
             assert isinstance(server, str)
-            assert helpers.test_model(models.NTPServerDict, server_details)
+            assert helpers.test_model(
+                models.NTPServerDict, server_details, allow_subset=True
+            )
 
         return get_ntp_servers
 

napalm/base/test/helpers.py

@@ -1,26 +1,31 @@
 """Several methods to help with the tests."""
 
 
-def test_model(model, data):
+def test_model(model, data, allow_subset=False):
     """Return if the dictionary `data` complies with the `model`."""
     # Access the underlying schema for a TypedDict directly
-    model = model.__annotations__
-    same_keys = set(model.keys()) == set(data.keys())
+    annotations = model.__annotations__
+    if allow_subset:
+        same_keys = set(data.keys()) <= set(annotations.keys())
+        source = data
+    else:
+        same_keys = set(annotations.keys()) == set(data.keys())
+        source = annotations
 
     if not same_keys:
         print(
             "model_keys: {}\ndata_keys: {}".format(
-                sorted(model.keys()), sorted(data.keys())
+                sorted(annotations.keys()), sorted(data.keys())
             )
         )
 
     correct_class = True
-    for key, instance_class in model.items():
-        correct_class = isinstance(data[key], instance_class) and correct_class
+    for key in source.keys():
+        correct_class = isinstance(data[key], annotations[key]) and correct_class
         if not correct_class:
             print(
                 "key: {}\nmodel_class: {}\ndata_class: {}".format(
-                    key, instance_class, data[key].__class__
+                    key, annotations[key], data[key].__class__
                 )
             )