updated based on feedback.

Author: itdependsnetworks

docs/user/lib_use_cases_lib_mapper.md

@@ -20,7 +20,7 @@ sot_driver = device.platform.napalm_driver
 
 
 # Connect to device via Napalm
-driver = napalm.get_network_driver("ios")
+driver = napalm.get_network_driver(sot_driver)
 
 device = driver(
     hostname="device.name",
@@ -38,6 +38,20 @@ net_con = NTC(host=device.name, username="demo", password="secret", device_type=
 
 Another use case could be using an example like the above in an Ansible filter. That would allow you to write a filter utilizing whichever automation library you needed without having to store the driver for each one in your Source of Truth.
 
+There is also a dynamically built mapping that gives you all of the libraries given a normalized name, here is a condensed snippet to understand the data structure of `KEY_TO_LIB_MAPPER`:
+
+```python
+{
+    "cisco_ios": {
+        "ansible": "cisco.ios.ios",
+        "napalm": "ios",
+    },
+    "cisco_nxos": {
+        "ansible": "cisco.nxos.nxos",
+        "napalm": "nxos",
+    }
+}
+```
 
 ## Aerleon Mapper
 

netutils/lib_mapper.py

@@ -684,36 +684,19 @@
 }
 
 
-def get_lib_mappings(
-    lib_mapping_reverse: t.Optional[t.Dict[str, t.Dict[str, str]]] = None
-) -> t.Dict[str, t.Dict[str, str]]:
-    """Generates a dictionary of all available network driver mappings.
-
-    Args:
-        lib_mapping_reverse: A reverse mapping of library names to their normalized names. Defaults to NAME_TO_LIB_MAPPER_REVERSE if not provided.
-
-    Returns:
-        A dictionary where the keys are normalized driver names and the values are dictionaries mapping tool names to their respective driver names.
-
-    Examples:
-        >>> from netutils.lib_mapper import get_lib_mappings
-        >>> mappings = get_lib_mappings()
-        >>> mappings["a10"]
-        {'ansible': 'a10.acos_axapi.a10', 'netmiko': 'a10', 'ntc_templates': 'a10'}
-        >>> mappings["cisco_ios"]["ansible"]
-        'cisco.ios.ios'
-        >>> mappings["cisco_ios"]["netmiko"]
-        'cisco_ios'
-        >>>
-    """
-    if not lib_mapping_reverse:
-        lib_mapping_reverse = NAME_TO_LIB_MAPPER_REVERSE
-    network_driver_mappings: t.Dict[str, t.Dict[str, str]] = {}
-
-    # initialize mapping from netutils library
-    for tool_name, mappings in lib_mapping_reverse.items():
-        for normalized_name, mapped_name in mappings.items():
-            network_driver_mappings.setdefault(normalized_name, {})
-            network_driver_mappings[normalized_name][tool_name] = mapped_name
-
-    return network_driver_mappings
+# Creates a structure like this:
+# {
+#     "cisco_ios": {
+#         "ansible": "cisco.ios.ios",
+#         "napalm": "ios",
+#     },
+#     "cisco_nxos": {
+#         "ansible": "cisco.nxos.nxos",
+#         "napalm": "nxos",
+#     },
+KEY_TO_LIB_MAPPER: t.Dict[str, t.Dict[str, str]] = {}
+
+for tool_name, mappings in NAME_TO_LIB_MAPPER_REVERSE.items():
+    for normalized_name, mapped_name in mappings.items():
+        KEY_TO_LIB_MAPPER.setdefault(normalized_name, {})
+        KEY_TO_LIB_MAPPER[normalized_name][tool_name] = mapped_name

tests/unit/test_lib_mapper.py

@@ -1,8 +1,6 @@
 """Test for the lib_mapper definitions."""
 
 import unittest
-import importlib.util
-import sys
 
 import pytest
 
@@ -100,11 +98,11 @@ def test_lib_mapper_ntctemplates_reverse_only():
     assert lib_mapper.NTCTEMPLATES_LIB_MAPPER["cisco_xe"] == "cisco_xe"
 
 
-def test_get_lib_mappings():
+def test_key_to_lib_mapper():
     """Test that the data structure returns as expected in get_lib_mappings."""
-    assert lib_mapper.get_lib_mappings()["arista_eos"]["ansible"] == "arista.eos.eos"
-    assert lib_mapper.get_lib_mappings()["arista_eos"]["pyntc"] == "arista_eos_eapi"
-    assert lib_mapper.get_lib_mappings()["cisco_ios"]["dna_center"] == "IOS"
+    assert lib_mapper.KEY_TO_LIB_MAPPER["arista_eos"]["ansible"] == "arista.eos.eos"
+    assert lib_mapper.KEY_TO_LIB_MAPPER["arista_eos"]["pyntc"] == "arista_eos_eapi"
+    assert lib_mapper.KEY_TO_LIB_MAPPER["cisco_ios"]["dna_center"] == "IOS"
 
 
 @pytest.mark.parametrize("lib", LIBRARIES)
@@ -139,15 +137,13 @@ def setUp(self):
         """Gather all mapper dictionaries from the module."""
         self.mappers = {}
         self.reverse_mappers = {}
-        spec = importlib.util.spec_from_file_location("lib_mapper", lib_mapper.__file__)
-        lib_mapper_module = importlib.util.module_from_spec(spec)
-        sys.modules["lib_mapper"] = lib_mapper_module
-        spec.loader.exec_module(lib_mapper_module)
 
         # Collect all variables ending with _LIB_MAPPER and _LIB_MAPPER_REVERSE
-        for name, value in vars(lib_mapper_module).items():
+        for name in dir(lib_mapper):
+            value = getattr(lib_mapper, name)
+
             if not isinstance(value, dict) or any(
-                name.startswith(prefix) for prefix in ["NAME_TO", "_", "MAIN", "DNA_CENTER"]
+                name.startswith(prefix) for prefix in ["NAME_TO", "KEY_TO", "_", "MAIN", "DNA_CENTER"]
             ):
                 continue
             if name.endswith("_LIB_MAPPER") and isinstance(value, dict):