annet 0.15.0__py3-none-any.whl → 0.15.2__py3-none-any.whl

annet/adapters/netbox/v37/storage.py

@@ -1,5 +1,5 @@
 from logging import getLogger
-from typing import Optional, List, Union, Dict
+from typing import Any, Optional, List, Union, Dict
 from ipaddress import ip_interface
 from collections import defaultdict
 
@@ -145,6 +145,7 @@ class NetboxStorageV37(Storage):
     def _load_devices(self, query: NetboxQuery) -> List[api_models.Device]:
         if not query.globs:
             return []
+        query = _hostname_dot_hack(query)
         return [
             device
             for device in self.netbox.dcim_all_devices(
@@ -223,3 +224,23 @@ def _match_query(query: NetboxQuery, device_data: api_models.Device) -> bool:
         if subquery.strip() in device_data.name:
             return True
     return False
+
+
+def _hostname_dot_hack(netbox_query: NetboxQuery) -> NetboxQuery:
+    # there is no proper way to lookup host by its hostname
+    # ie find "host" with fqdn "host.example.com"
+    # besides using name__ic (ie startswith)
+    # since there is no direct analogue for this field in netbox
+    # so we need to add a dot to hostnames (top-level fqdn part)
+    # so we would not receive devices with a common name prefix
+    def add_dot(raw_query: Any) -> Any:
+        if isinstance(raw_query, str) and "." not in raw_query:
+            raw_query = raw_query + "."
+        return raw_query
+
+    raw_query = netbox_query.query
+    if isinstance(raw_query, list):
+        for i, name in enumerate(raw_query):
+            raw_query[i] = add_dot(name)
+
+    return NetboxQuery(raw_query)

annet/annlib/netdev/devdb/data/devdb.json

@@ -6,18 +6,19 @@
     "Cisco.ASR": " ASR",
     "Cisco.ASR.ASR9000": " 9\\d{3}",
     "Cisco.XRV": "XRv",
-    "Cisco.Catalyst": "Catalyst",
-    "Cisco.Catalyst.C2900": " 29\\d\\d",
-    "Cisco.Catalyst.C2900.C2950": " 2950",
-    "Cisco.Catalyst.C2900.C2960": " 2960",
-    "Cisco.Catalyst.C2900.C2960.C2960Plus": " 2960-Plus",
-    "Cisco.Catalyst.C2900.C2960.C2960S": " 2960S",
-    "Cisco.Catalyst.C2900.C2960.C2960X": " 2960X",
-    "Cisco.Catalyst.C3500": " 35\\d\\d",
-    "Cisco.Catalyst.C3600": " 36\\d\\d",
-    "Cisco.Catalyst.C3700": " 37\\d\\d",
-    "Cisco.Catalyst.C4900": " 49\\d\\d",
-    "Cisco.Catalyst.C6500": " 65\\d\\d",
+    "Cisco.Catalyst": " (Catalyst |WS-C)",
+    "Cisco.Catalyst.C2900": "29\\d\\d",
+    "Cisco.Catalyst.C2900.C2950": "2950",
+    "Cisco.Catalyst.C2900.C2960": "2960",
+    "Cisco.Catalyst.C2900.C2960.C2960Plus": "2960-Plus",
+    "Cisco.Catalyst.C2900.C2960.C2960S": "2960S",
+    "Cisco.Catalyst.C2900.C2960.C2960X": "2960X",
+    "Cisco.Catalyst.C2900.C2960.C2960G": "2960G",
+    "Cisco.Catalyst.C3500": "35\\d\\d",
+    "Cisco.Catalyst.C3600": "36\\d\\d",
+    "Cisco.Catalyst.C3700": "37\\d\\d",
+    "Cisco.Catalyst.C4900": "49\\d\\d",
+    "Cisco.Catalyst.C6500": "65\\d\\d",
     "Cisco.Nexus": " [Nn]exus",
     "Cisco.Nexus.N3x": " 3\\d\\d\\d",
     "Cisco.Nexus.N3x.N3100": " 31\\d\\d",
@@ -52,13 +53,13 @@
     "Huawei.CE.CE8800.CE8850": " CE8850",
     "Huawei.CE.CE8800.CE8851": " CE8851",
     "Huawei.CE.CE9800": " CE98\\d\\d",
-    "Huawei.Quidway": " S\\d+",
-    "Huawei.Quidway.S2x": " S2\\d{3}",
-    "Huawei.Quidway.S2x.S2300": " S23\\d\\d",
-    "Huawei.Quidway.S2x.S2700": " S27\\d\\d",
-    "Huawei.Quidway.S5300": " S53\\d\\d",
-    "Huawei.Quidway.S5700": " S57\\d\\d",
-    "Huawei.Quidway.S6700": " S67\\d\\d",
+    "Huawei.Quidway": " (LS-)?S",
+    "Huawei.Quidway.S2x": "2\\d{3}",
+    "Huawei.Quidway.S2x.S2300": "23\\d\\d",
+    "Huawei.Quidway.S2x.S2700": "27\\d\\d",
+    "Huawei.Quidway.S5300": "53\\d\\d",
+    "Huawei.Quidway.S5700": "57\\d\\d",
+    "Huawei.Quidway.S6700": "67\\d\\d",
     "Huawei.NE": " NE\\d+",
     "Huawei.NE.NE40E": " NE40E",
     "Huawei.NE.NE8000": " NE8000",
@@ -111,6 +112,9 @@
     "PC.Whitebox.Edgecore": "[Ee]dge-?[Cc]ore",
     "PC.Whitebox.Edgecore.AS": "AS",
     "PC.Whitebox.Edgecore.AS9736": "AS9736",
+    "PC.Whitebox.NVIDIA": "NVIDIA",
+    "PC.Whitebox.NVIDIA.SN": " SN",
+    "PC.Whitebox.NVIDIA.SN.SN5600": " SN5600",
     "PC.Moxa": "[Mm]oxa",
     "PC.Moxa.NPort": " [Nn][Pp]ort",
     "PC.Moxa.NPort.6610": "6610",

annet/api/__init__.py

@@ -346,7 +346,7 @@ def diff(
         device = res.device
         acl_rules = res.get_acl_rules(args.acl_safe)
         new_files = res.get_new_files(args.acl_safe)
-        new_json_fragment_files = res.get_new_file_fragments()
+        new_json_fragment_files = res.get_new_file_fragments(args.acl_safe)
 
         pc_diff_files = []
         if res.old_files or new_files:

annet/argparse.py

@@ -107,6 +107,8 @@ class Arg:
         default = self.kwargs.get("default", None)
         if isinstance(default, ConvertibleDefault) and "type" in self.kwargs:
             default = self.kwargs["default"] = default.convert(self.kwargs["type"])
+        elif isinstance(default, Callable):
+            default = self.kwargs["default"] = default()
         elif default is False and "action" not in self.kwargs:
             self.kwargs["action"] = "store_true"
         self.default = default

annet/cli.py

@@ -273,7 +273,7 @@ def file_patch(args: cli_args.FilePatchOptions):
 def context():
     """ A group of commands for manipulating context.
 
-    By default, the context file is located in '~/.annushka/context.yml',
+    By default, the context file is located in '~/.annet/context.yml',
     but it can be set with the ANN_CONTEXT_CONFIG_PATH environment variable.
     """
     context_touch()

annet/cli_args.py

@@ -8,6 +8,7 @@ import os
 
 from valkit.common import valid_string_list
 
+import annet.lib
 from annet.argparse import Arg, ArgGroup, DefaultFromEnv
 from annet.hardware import hardware_connector
 from annet.storage import Query, get_storage
@@ -69,6 +70,11 @@ opt_expand_path = Arg(
     help="Use full paths of Entire-generators and no just names when writing them to the file system"
 )
 
+opt_dest_force_create_dir = Arg(
+    "--dest-force-create-dir", default=False,
+    help="Output generated data to dir, even for blackboxes"
+)
+
 opt_old = Arg(
     "old",
     help="A path to a file (or a directory with a batch of files) that contains the old config"
@@ -228,7 +234,7 @@ opt_log_json = Arg(
 )
 
 opt_log_dest = Arg(
-    "--log-dest", default="deploy/",
+    "--log-dest", default=annet.lib.get_default_log_dest,
     help="Log to a specified file, directory, or '-' (stdout)"
 )
 
@@ -425,6 +431,7 @@ class FileOutOptions(ArgGroup):
     expand_path = opt_expand_path
     no_label = opt_no_label
     no_color = opt_no_color
+    dest_force_create_dir = opt_dest_force_create_dir
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)

annet/lib.py

@@ -37,8 +37,20 @@ from annet.annlib.lib import (  # pylint: disable=unused-import
 from contextlog import get_logger
 
 
-_TEMPLATE_CONTEXT_PATH: Optional[str] = None
-_DEFAULT_CONTEXT_PATH: Optional[str] = None
+_HOMEDIR_PATH: Optional[str] = None           # defaults to ~/.annet
+_TEMPLATE_CONTEXT_PATH: Optional[str] = None  # defaults to annet/configs/context.yml
+_DEFAULT_CONTEXT_PATH: Optional[str] = None   # defaults to ~/.annet/context.yml
+
+
+def get_homedir_path() -> str:
+    if _HOMEDIR_PATH is None:
+        set_homedir_path("~/.annet/")
+    return _HOMEDIR_PATH
+
+
+def set_homedir_path(path: str) -> None:
+    global _HOMEDIR_PATH  # pylint: disable=global-statement
+    _HOMEDIR_PATH = path
 
 
 def get_template_context_path() -> str:
@@ -63,6 +75,11 @@ def set_default_context_path(path: str) -> None:
     _DEFAULT_CONTEXT_PATH = path
 
 
+def get_default_log_dest() -> str:
+    homedir = get_homedir_path()
+    return os.path.join(homedir, "deploy/")
+
+
 @lru_cache(maxsize=1)
 def _get_template_context():
     with open(get_template_context_path()) as f:

annet/output.py

@@ -24,6 +24,9 @@ from annet.connectors import Connector
 from annet.storage import Device, storage_connector
 
 
+BLACKBOX_FILENAME = "config.cfg"
+
+
 class _DriverConnector(Connector["OutputDriver"]):
     name = "OutputDriver"
     ep_name = "output"
@@ -77,7 +80,8 @@ class OutputDriverBasic(OutputDriver):
             yield from items_iter
 
         dest = arg_out.dest
-        dir_mode = dir_or_file_output(dest, query_result_count, suggest_dir=(os.sep in first_result[0]))
+        suggest_dir = arg_out.dest_force_create_dir or os.sep in first_result[0]
+        dir_mode = dir_or_file_output(dest, query_result_count, suggest_dir=suggest_dir)
         _reassembled_items = list(_reassemble_items())
 
         for output_no, (label, output, is_fail) in enumerate(_reassembled_items):
@@ -99,6 +103,9 @@ class OutputDriverBasic(OutputDriver):
                         print_label(label, back_color=label_color)
                     writer.write(sys.stdout)
             elif dir_mode:
+                if arg_out.dest_force_create_dir and os.sep not in label:
+                    label = os.path.join(label, BLACKBOX_FILENAME)
+
                 if label.startswith(LABEL_NEW_PREFIX):
                     label = label[len(LABEL_NEW_PREFIX):]
                 if label.startswith(os.sep):
@@ -114,7 +121,7 @@ class OutputDriverBasic(OutputDriver):
                     label = os.sep.join(parts[1:])
                     if not arg_out.expand_path:
                         label = os.path.basename(label)
-                    if query_result_count > 1:
+                    if query_result_count > 1 or arg_out.dest_force_create_dir:
                         label = os.path.join(hostname, label)
                 file_dest = os.path.join(dest, "errors") if is_fail else dest
                 out_file = os.path.normpath(os.path.join(file_dest, label))

{annet-0.15.0.dist-info → annet-0.15.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: annet
-Version: 0.15.0
+Version: 0.15.2
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT

{annet-0.15.0.dist-info → annet-0.15.2.dist-info}/RECORD

@@ -1,8 +1,8 @@
 annet/__init__.py,sha256=oyElxAW97sHgQccGafhaWVBveBn1gSjjdP_xHROaRLg,2139
 annet/annet.py,sha256=TMdEuM7GJQ4TjRVmuK3bCTZN-21lxjQ9sXqEdILUuBk,725
-annet/argparse.py,sha256=ZHKQriVCysSnox5stZnYxKLaPKzDjXbShxFyNW6LiiQ,12754
-annet/cli.py,sha256=yUStwwUKGgGuNw94EvabUEMhBs0YsIsc4omUivst8H0,12366
-annet/cli_args.py,sha256=_Du9Jhe86F4fsx7u9njjvg25jTdoBsdbTEzbuDFgrFU,13248
+annet/argparse.py,sha256=v1MfhjR0B8qahza0WinmXClpR8UiDFhmwDDWtNroJPA,12855
+annet/cli.py,sha256=AcSiqNa5Wk3yJks5LYcXqbYMZuySmQqMQK5hW_-irFw,12363
+annet/cli_args.py,sha256=KQlihxSl-Phhq1-9oJDdNSbIllEX55LlPfH6viEKOuw,13483
 annet/connectors.py,sha256=Xgr7fNopRhFAYnkiDxhohBtjlFOLY8v0xLExHmVMr00,2511
 annet/deploy.py,sha256=B8E0P_VvCrS2URjFvgmUiIkHp95g7pAWfmT34igaDeo,18893
 annet/diff.py,sha256=zLcaCnb4lZRUb7frpH1CstQ3kacRcCblZs1uLG8J5lk,3391
@@ -11,8 +11,8 @@ annet/filtering.py,sha256=F4ZKUCU3Yb1RlL2zKdyHtVUaWPzjWF4vWyMcdygKNYk,852
 annet/gen.py,sha256=8IPejduvYXmezUDolLKg4Imt1TxEp0KJ7kSgMtFcaCY,33628
 annet/hardware.py,sha256=HYPDfji_GdRn5S0_0fl4rvM7byOY9aHxG6VMAtsLaxE,1090
 annet/implicit.py,sha256=_3eY9NKqpLUm25vlJIP2cHN4gdTgzO6rG6mwCKJYMnQ,5439
-annet/lib.py,sha256=tQQlxZg1A2Q-tp18PoqBuORQmvP5dAAmAPvP6bBA6a0,3764
-annet/output.py,sha256=hJNGzL4Z3KgvqaCBkkmuuiXPhb64F1QV8YHkwnfhaaI,6852
+annet/lib.py,sha256=W6Z9UurcyF1zU3gAd8hIec9yBzeeHzxZEkvf1cIg8KI,4280
+annet/output.py,sha256=zAP3XixfSLNL988IF9ttyIbGaN4M6XhO5IhKkD1R-J8,7127
 annet/parallel.py,sha256=hLkzEht0KhzmzUWDdO4QFYQHzhxs3wPlTA8DxbB2ziw,17160
 annet/patching.py,sha256=nILbY5oJajN0b1j3f0HEJm05H3HVThnWvB7vDVh7UQw,559
 annet/reference.py,sha256=B8mH8VUMcecPnzULiTVb_kTQ7jQrCL7zp4pfIZQa5fk,4035
@@ -34,7 +34,7 @@ annet/adapters/netbox/common/storage_opts.py,sha256=idOm1na_2Axdi4MdLN4tAsPvsp5z
 annet/adapters/netbox/v24/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/adapters/netbox/v24/storage.py,sha256=THI592VLx3ehixsPZQ1Ko3mYIAZQbnDY-toIziqBbL8,6005
 annet/adapters/netbox/v37/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-annet/adapters/netbox/v37/storage.py,sha256=z0WCVApf7vHL6bxLiF_f6FVo6AVm_hZuiMib4dDJt0w,7595
+annet/adapters/netbox/v37/storage.py,sha256=TonXJuR6ng6xiczHsxsm0Zlo5Wokl3N_Uqg4r7HHj6c,8421
 annet/annlib/__init__.py,sha256=fT1l4xV5fqqg8HPw9HqmZVN2qwS8i6X1aIm2zGDjxKY,252
 annet/annlib/command.py,sha256=uuBddMQphtn8P5MO5kzIa8_QrtMns-k05VeKv1bcAuA,1043
 annet/annlib/diff.py,sha256=UPt3kYFQdQdVVy3ePYzNHPAxMVmHxCrCnZnMCV6ou2Q,4587
@@ -49,7 +49,7 @@ annet/annlib/types.py,sha256=VHU0CBADfYmO0xzB_c5f-mcuU3dUumuJczQnqGlib9M,852
 annet/annlib/netdev/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/annlib/netdev/db.py,sha256=fI_u5aya4l61mbYSjj4JwlVfi3s7obt2jqERSuXGRUI,1634
 annet/annlib/netdev/devdb/__init__.py,sha256=aKYjjLbJebdKBjnGDpVLQdSqrV2JL24spGm58tmMWVU,892
-annet/annlib/netdev/devdb/data/devdb.json,sha256=0c7r0_NF0QQVPd0p84yyFLKIn5iusuU0S45NDorLWEM,5570
+annet/annlib/netdev/devdb/data/devdb.json,sha256=pW4gwys2SbduBC65hepV_HOv9uxn8pxz0ckvGFJiPoU,5727
 annet/annlib/netdev/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/annlib/netdev/views/dump.py,sha256=rIlyvnA3uM8bB_7oq1nS2KDxTp6dQh2hz-FbNhYIpOU,4630
 annet/annlib/netdev/views/hardware.py,sha256=6453atMaeoLWJSXzZxQ0zeTrdtRwCv0dlu6ivvpcdYE,3423
@@ -61,7 +61,7 @@ annet/annlib/rbparser/platform.py,sha256=_W84Gt3XwURT2MLngZSmwZbWgqsnbrwzjNgHIHa
 annet/annlib/rbparser/syntax.py,sha256=iZ7Y-4QQBw4L3UtjEh54qisiRDhobl7HZxFNdP8mi54,3577
 annet/annlib/rulebook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/annlib/rulebook/common.py,sha256=9kCZwZpsH5UliF2OzaN9nLs2eLlz_d__4L7_oZ3SrCw,16054
-annet/api/__init__.py,sha256=-G9wlYePC3ZgNo1p8r17vmx0WLb3UNvCw3ZJ9UhYJ-I,33169
+annet/api/__init__.py,sha256=vh3FVvhghxEEskLM9TuGBSnYDXN5L8iUFBB-iV46WAA,33182
 annet/configs/context.yml,sha256=jzAQX9WbjFw_nsju8FLCCGfRc4ZXD0Mhb5pvO9emegI,413
 annet/configs/logging.yaml,sha256=Hu42lRK248dssp9TgkbHCaZNl0E6f4IChGb0XaQnTVo,970
 annet/generators/__init__.py,sha256=ACMH9UQ4I3uq2b8nDzOn2dgYxreDq4_3ojOGwht0-No,15543
@@ -127,10 +127,10 @@ annet/rulebook/texts/routeros.rul,sha256=ipfxjj0mjFef6IsUlupqx4BY_Je_OUb8u_U1019
 annet_generators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet_generators/example/__init__.py,sha256=zVd8_DrXuOASrNzg2Ab94rPyvJff83L-_HppDFxnUjM,228
 annet_generators/example/lldp.py,sha256=68CLrK7vxTQQy9XIBxtywuEdBNlIlfXGYj8_wYWs5UI,1146
-annet-0.15.0.dist-info/AUTHORS,sha256=rh3w5P6gEgqmuC-bw-HB68vBCr-yIBFhVL0PG4hguLs,878
-annet-0.15.0.dist-info/LICENSE,sha256=yPxl7dno02Pw7gAcFPIFONzx_gapwDoPXsIsh6Y7lC0,1079
-annet-0.15.0.dist-info/METADATA,sha256=YnR3Nr5WQwY-i1k4A8V_fKC_QIVrG36hp_oEhzebxTA,694
-annet-0.15.0.dist-info/WHEEL,sha256=ixB2d4u7mugx_bCBycvM9OzZ5yD7NmPXFRtKlORZS2Y,91
-annet-0.15.0.dist-info/entry_points.txt,sha256=yHimujIzR2bwNIbb--MTs_GpXiAve89Egpu2LlgTEkg,119
-annet-0.15.0.dist-info/top_level.txt,sha256=QsoTZBsUtwp_FEcmRwuN8QITBmLOZFqjssRfKilGbP8,23
-annet-0.15.0.dist-info/RECORD,,
+annet-0.15.2.dist-info/AUTHORS,sha256=rh3w5P6gEgqmuC-bw-HB68vBCr-yIBFhVL0PG4hguLs,878
+annet-0.15.2.dist-info/LICENSE,sha256=yPxl7dno02Pw7gAcFPIFONzx_gapwDoPXsIsh6Y7lC0,1079
+annet-0.15.2.dist-info/METADATA,sha256=zYV7OYVW5PBLs0_QUocznhtW6jKa1QpYr9bY0C9m3lE,694
+annet-0.15.2.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+annet-0.15.2.dist-info/entry_points.txt,sha256=yHimujIzR2bwNIbb--MTs_GpXiAve89Egpu2LlgTEkg,119
+annet-0.15.2.dist-info/top_level.txt,sha256=QsoTZBsUtwp_FEcmRwuN8QITBmLOZFqjssRfKilGbP8,23
+annet-0.15.2.dist-info/RECORD,,

{annet-0.15.0.dist-info → annet-0.15.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.0)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py3-none-any