annet 0.14.8__tar.gz → 0.14.10__tar.gz

{annet-0.14.8/annet.egg-info → annet-0.14.10}/PKG-INFO

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

{annet-0.14.8 → annet-0.14.10}/annet/adapters/netbox/common/manufacturer.py

@@ -25,8 +25,6 @@ def get_hw(manufacturer: str, model: str, platform_name: str):
         model = model.replace("MSN", "SN", 1)
     vendor = manufacturer + " " + model
     hw = HardwareView(_VENDORS.get(vendor.lower(), vendor), platform_name)
-    if not hw:
-        raise ValueError(f"unsupported manufacturer {manufacturer}")
     return hw
 
 
@@ -47,13 +45,4 @@ def get_breed(manufacturer: str, model: str):
         return "adva8"
     elif manufacturer == "Arista":
         return "eos4"
-    raise ValueError(f"unsupported manufacturer {manufacturer}")
-
-
-def is_supported(manufacturer: str) -> bool:
-    if manufacturer not in (
-            "Huawei", "Mellanox", "Juniper", "Cisco", "Adva", "Arista",
-    ):
-        logger.warning("Unsupported manufacturer `%s`", manufacturer)
-        return False
-    return True
+    return ""

{annet-0.14.8 → annet-0.14.10}/annet/adapters/netbox/common/models.py

@@ -2,15 +2,20 @@ from dataclasses import dataclass, field
 from datetime import datetime
 from typing import List, Optional, Any, Dict
 
+from annet.annlib.netdev.views.dump import DumpableView
 from annet.annlib.netdev.views.hardware import HardwareView
 from annet.storage import Storage
 
 
 @dataclass
-class Entity:
+class Entity(DumpableView):
     id: int
     name: str
 
+    @property
+    def _dump__list_key(self):
+        return self.name
+
 
 @dataclass
 class Label:
@@ -32,15 +37,19 @@ class DeviceType:
 
 
 @dataclass
-class DeviceIp:
+class DeviceIp(DumpableView):
     id: int
     display: str
     address: str
     family: int
 
+    @property
+    def _dump__list_key(self):
+        return self.address
+
 
 @dataclass
-class Prefix:
+class Prefix(DumpableView):
     id: int
     prefix: str
     site: Entity | None
@@ -55,9 +64,13 @@ class Prefix:
     last_updated: datetime
     description: str | None = ""
 
+    @property
+    def _dump__list_key(self):
+        return self.prefix
+
 
 @dataclass
-class IpAddress:
+class IpAddress(DumpableView):
     id: int
     assigned_object_id: int
     display: str
@@ -70,6 +83,10 @@ class IpAddress:
     prefix: Optional[Prefix] = None
     vrf: Optional[Entity] = None
 
+    @property
+    def _dump__list_key(self):
+        return self.address
+
 
 @dataclass
 class InterfaceConnectedEndpoint(Entity):

{annet-0.14.8 → annet-0.14.10}/annet/adapters/netbox/common/query.py

@@ -21,3 +21,6 @@ class NetboxQuery(Query):
     def globs(self):
         # We process every query host as a glob
         return self.query
+
+    def is_empty(self) -> bool:
+        return len(self.query) == 0

{annet-0.14.8 → annet-0.14.10}/annet/adapters/netbox/v24/storage.py

@@ -6,10 +6,11 @@ from annetbox.v24.client_sync import NetboxV24
 
 from annet.adapters.netbox.common import models
 from annet.adapters.netbox.common.manufacturer import (
-    is_supported, get_hw, get_breed,
+   get_hw, get_breed,
 )
 from annet.adapters.netbox.common.query import NetboxQuery
 from annet.adapters.netbox.common.storage_opts import NetboxStorageOpts
+from annet.annlib.netdev.views.hardware import HardwareView
 from annet.storage import Storage
 
 logger = getLogger(__name__)
@@ -162,7 +163,6 @@ class NetboxStorageV24(Storage):
             device
             for device in self.netbox.dcim_all_devices().results
             if _match_query(query, device)
-            if is_supported(device.device_type.manufacturer.name)
         ]
 
     def _load_interfaces(self, device_ids: List[int]) -> List[

{annet-0.14.8 → annet-0.14.10}/annet/adapters/netbox/v37/storage.py

@@ -10,7 +10,7 @@ from annetbox.v37.client_sync import NetboxV37
 
 from annet.adapters.netbox.common import models
 from annet.adapters.netbox.common.manufacturer import (
-    is_supported, get_hw, get_breed,
+    get_hw, get_breed,
 )
 from annet.adapters.netbox.common.query import NetboxQuery
 from annet.adapters.netbox.common.storage_opts import NetboxStorageOpts
@@ -43,20 +43,25 @@ def extend_device(
         storage: Storage,
 ) -> models.NetboxDevice:
     platform_name: str = ""
+    breed: str = ""
+    hw = HardwareView("", "")
     if device.platform:
         platform_name = device.platform.name
-    res = extend_device_base(
-        device=device,
-        interfaces=interfaces,
-        breed=get_breed(
+    if device.device_type and device.device_type.manufacturer:
+        breed = get_breed(
             device.device_type.manufacturer.name,
             device.device_type.model,
-        ),
-        hw=get_hw(
+        )
+        hw = get_hw(
             device.device_type.manufacturer.name,
             device.device_type.model,
             platform_name,
-        ),
+        )
+    res = extend_device_base(
+        device=device,
+        interfaces=interfaces,
+        breed=breed,
+        hw=hw,
         storage=storage,
     )
     res.neighbours = neighbours
@@ -146,7 +151,6 @@ class NetboxStorageV37(Storage):
                 name__ic=query.globs,
             ).results
             if _match_query(query, device)
-            if is_supported(device.device_type.manufacturer.name)
         ]
 
     def _extend_interfaces(self, interfaces: List[models.Interface]) -> List[models.Interface]:

{annet-0.14.8 → annet-0.14.10}/annet/annlib/netdev/views/dump.py

@@ -73,6 +73,14 @@ class DumpableView:
 
         if isinstance(value, DumpableView):
             ret += value.dump(prefix, seen=seen)  # pylint: disable=no-member
+        elif isinstance(value, dict):
+            for k, v in value.items():
+                ret.extend(self.__dump_value(f"{prefix}[{repr(k)}]", v, seen))
+        elif isinstance(value, (list, tuple)):
+            for i, v in enumerate(value):
+                name = getattr(v, "_dump__list_key", None)
+                name = repr(name) if name is not None else str(i)
+                ret.extend(self.__dump_value(f"{prefix}[{name}]", v, seen))
         else:
             fmt = repr(value)
             vtype = type(value)

{annet-0.14.8 → annet-0.14.10}/annet/annlib/rbparser/syntax.py

@@ -31,7 +31,7 @@ def compile_row_regexp(row, flags=0):
         row = row[:-3]
     elif "~/" in row:
         # ~/{regex}/ -> {regex}, () не нужны поскольку уже (?:) - non-captured
-        row = re.sub(r"~/([^/]+)/", r"\1", row)
+        row = re.sub(r"~/(((?!~/).)+)/", r"\1", row)
     else:
         row += r"(?:\s|$)"
     row = re.sub(r"\s+", r"\\s+", row)

{annet-0.14.8 → annet-0.14.10}/annet/argparse.py

@@ -370,7 +370,7 @@ class ArgParser(argparse.ArgumentParser):
         yield from _get_meta(func).opts
 
 
-def subcommand(*arg_list: Union[Arg, Type[ArgGroup]], parent: Callable = None):
+def subcommand(*arg_list: Union[Arg, Type[ArgGroup]], parent: Callable = None, is_group: bool = False):
     """
     декоратор, задающий cli-аргументы подпрограммы
 
@@ -382,7 +382,7 @@ def subcommand(*arg_list: Union[Arg, Type[ArgGroup]], parent: Callable = None):
     Связь аргументов происходит только по порядковому номеру, каждый аргумент subcommand становится аргументом функции.
     Функция вызывается только с позиционными аргументами, всегда с одним и тем же количеством аргументов.
 
-    Для создания более одного уровня команд используeтся агрумент parent
+    Для создания более одного уровня команд используется аргумент parent
 
     Пример: 'ann some thing' - вызовет some_thing()
 
@@ -397,6 +397,10 @@ def subcommand(*arg_list: Union[Arg, Type[ArgGroup]], parent: Callable = None):
     """
     def _amend_func(func):
         meta = _get_meta(func)
+        if is_group:
+            @functools.wraps(func)
+            def func():
+                meta.parser.print_help()
         cmd_name = func.__name__
         if parent:
             parentprefix = parent.__name__ + "_"

{annet-0.14.8 → annet-0.14.10}/annet/cli.py

@@ -1,25 +1,29 @@
 import argparse
+import itertools
+import json
 import operator
 import os
 import platform
 import subprocess
 import shutil
+import sys
 from contextlib import ExitStack, contextmanager
 from typing import Tuple, Iterable
 
+import tabulate
 import yaml
 from contextlog import get_logger
 from valkit.python import valid_logging_level
 
 from annet.deploy import driver_connector, fetcher_connector
-from annet import api, cli_args, filtering
+from annet import api, cli_args, filtering, generators
 from annet.api import collapse_texts, Deployer
 from annet.argparse import ArgParser, subcommand
 from annet.diff import gen_sort_diff
 from annet.gen import Loader, old_raw
 from annet.lib import get_context_path, repair_context_file
 from annet.output import output_driver_connector, OutputDriver
-from annet.storage import get_storage
+from annet.storage import get_storage, Device
 
 
 def fill_base_args(parser: ArgParser, pkg_name: str, logging_config: str):
@@ -60,19 +64,25 @@ def _gen_current_items(
 
 
 @contextmanager
-def get_loader(gen_args: cli_args.GenOptions, args: cli_args.QueryOptions):
+def get_loader(gen_args: cli_args.GenOptions, args: cli_args.QueryOptionsBase):
     exit_stack = ExitStack()
     storages = []
     with exit_stack:
         connector, connector_opts = get_storage()
         storage_opts = connector.opts().parse_params(connector_opts, args)
         storages.append(exit_stack.enter_context(connector.storage()(storage_opts)))
-        yield Loader(*storages, args=gen_args)
+        yield Loader(*storages, args=gen_args, no_empty_warning=args.query.is_empty())
 
 
-@subcommand(cli_args.QueryOptions, cli_args.opt_config, cli_args.FileOutOptions)
+@subcommand(is_group=True)
+def show():
+    """ A group of commands for showing parameters/configurations/data from deivces and data sources """
+    pass
+
+
+@subcommand(cli_args.QueryOptions, cli_args.opt_config, cli_args.FileOutOptions, parent=show)
 def show_current(args: cli_args.QueryOptions, config, arg_out: cli_args.FileOutOptions) -> None:
-    """ Показать текущий конфиг устройств """
+    """ Show current devices' configuration """
     gen_args = cli_args.GenOptions(args, no_acl=True)
     output_driver = output_driver_connector.get()
     with get_loader(gen_args, args) as loader:
@@ -89,9 +99,90 @@ def show_current(args: cli_args.QueryOptions, config, arg_out: cli_args.FileOutO
         output_driver.write_output(arg_out, items, len(loader.devices))
 
 
+@subcommand(cli_args.QueryOptions, cli_args.FileOutOptions, parent=show)
+def show_device_dump(args: cli_args.QueryOptions, arg_out: cli_args.FileOutOptions):
+    """ Show a dump of network devices' structure """
+    def _show_device_dump_items(devices):
+        for device in devices:
+            get_logger(host=device.hostname)  # add hostname into context
+            if hasattr(device, "dump"):
+                yield (
+                    device.hostname,
+                    "\n".join(device.dump("device")),
+                    False,
+                )
+            else:
+                get_logger().warning("method `dump` not implemented for %s", type(device))
+    arg_gens = cli_args.GenOptions(arg_out, args)
+    with get_loader(arg_gens, args) as loader:
+        if not loader.devices:
+            get_logger().error("No devices found for %s", args.query)
+        output_driver_connector.get().write_output(
+            arg_out,
+            _show_device_dump_items(loader.devices),
+            len(loader.device_ids),
+        )
+
+
+@subcommand(cli_args.ShowGeneratorsOptions, parent=show)
+def show_generators(args: cli_args.ShowGeneratorsOptions):
+    """ List applicable generators (for a device if query is set) """
+    arg_gens = cli_args.GenOptions(args)
+    with get_loader(arg_gens, args) as loader:
+        device: Device | None = None
+        devices = loader.devices
+        if len(devices) == 1:
+            device = devices[0]
+        elif len(devices) > 1:
+            get_logger().error("cannot show generators for more than one device at once")
+            sys.exit(1)
+        elif len(devices) == 0 and not args.query.is_empty():
+            # the error message will be logged in get_loader()
+            sys.exit(1)
+
+        if not device:
+            found_generators = loader.iter_all_gens()
+        else:
+            found_generators = []
+            gens = loader.resolve_gens(loader.devices)
+            for g in gens.partial[device]:
+                acl_func = g.acl_safe if args.acl_safe else g.acl
+                if g.supports_device(device) and acl_func(device):
+                    found_generators.append(g)
+            for g in gens.entire[device]:
+                if g.supports_device(device) and g.path(device):
+                    found_generators.append(g)
+            for g in gens.json_fragment[device]:
+                if g.supports_device(device) and g.path(device) and g.acl(device):
+                    found_generators.append(g)
+
+    output_data = []
+    for g in found_generators:
+        output_data.append({
+            "name": g.__class__.__name__,
+            "type": g.TYPE,
+            "tags": g.TAGS,
+            "module": g.__class__.__module__,
+            "description": generators.get_description(g.__class__),
+        })
+
+    if args.format == "json":
+        print(json.dumps(output_data))
+
+    elif args.format == "text":
+        keyfunc = operator.itemgetter("type")
+        for gen_type, gens in itertools.groupby(sorted(output_data, key=keyfunc, reverse=True), keyfunc):
+            print(tabulate.tabulate(
+                [(g["name"], ", ".join(g["tags"]), g["module"],  g["description"]) for g in gens],
+                [f"{gen_type}-Class", "Tags", "Module", "Description"],
+                tablefmt="orgtbl",
+            ))
+            print()
+
+
 @subcommand(cli_args.ShowGenOptions)
 def gen(args: cli_args.ShowGenOptions):
-    """ Сгенерировать конфиг для устройств """
+    """ Generate configuration for devices """
     with get_loader(args, args) as loader:
         (success, fail) = api.gen(args, loader)
 
@@ -110,7 +201,7 @@ def gen(args: cli_args.ShowGenOptions):
 
 @subcommand(cli_args.ShowDiffOptions)
 def diff(args: cli_args.ShowDiffOptions):
-    """ Сгенерировать конфиг для устройств и показать дифф по рулбуку с текущим """
+    """ Generate configuration for devices and show a diff with current configuration using the rulebook """
     with get_loader(args, args) as loader:
         filterer = filtering.filterer_connector.get()
         device_ids = loader.device_ids
@@ -123,7 +214,7 @@ def diff(args: cli_args.ShowDiffOptions):
 
 @subcommand(cli_args.ShowPatchOptions)
 def patch(args: cli_args.ShowPatchOptions):
-    """ Сгенерировать конфиг для устройств и сформировать патч """
+    """ Generate configuration patch for devices """
     with get_loader(args, args) as loader:
         (success, fail) = api.patch(args, loader)
 
@@ -138,7 +229,7 @@ def patch(args: cli_args.ShowPatchOptions):
 
 @subcommand(cli_args.DeployOptions)
 def deploy(args: cli_args.DeployOptions):
-    """ Сгенерировать конфиг для устройств и задеплоить его """
+    """ Generate and deploy configuration for devices """
 
     deployer = Deployer(args)
     filterer = filtering.filterer_connector.get()
@@ -155,7 +246,7 @@ def deploy(args: cli_args.DeployOptions):
 
 @subcommand(cli_args.FileDiffOptions)
 def file_diff(args: cli_args.FileDiffOptions):
-    """ Показать дифф по рулбуку между файлами или каталогами """
+    """ Generate a diff between files or directories using the rulebook """
     (success, fail) = api.file_diff(args)
     out = []
     output_driver = output_driver_connector.get()
@@ -168,7 +259,7 @@ def file_diff(args: cli_args.FileDiffOptions):
 
 @subcommand(cli_args.FilePatchOptions)
 def file_patch(args: cli_args.FilePatchOptions):
-    """ Сформировать патч для файлов или каталогов """
+    """ Generate configuration patch for files or directories """
     (success, fail) = api.file_patch(args)
     out = []
     output_driver = output_driver_connector.get()
@@ -178,26 +269,27 @@ def file_patch(args: cli_args.FilePatchOptions):
     output_driver.write_output(args, out, len(out))
 
 
-@subcommand()
+@subcommand(is_group=True)
 def context():
-    """ Операции для управления файлом контекста.
+    """ A group of commands for manipulating context.
 
-    По-умолчанию находится в '~/.annushka/context.yml', либо по пути в переменной окружения ANN_CONTEXT_CONFIG_PATH.
+    By default, the context file is located in '~/.annushka/context.yml',
+    but it can be set with the ANN_CONTEXT_CONFIG_PATH environment variable.
     """
     context_touch()
 
 
 @subcommand(parent=context)
 def context_touch():
-    """ Вывести путь к файлу контекста и, при отсутствии, создать его и наполнить данными (команда по-умолчанию) """
+    """ Show the context file path, and if the file is not present, create it with the default configuration """
     print(get_context_path(touch=True))
 
 
 @subcommand(cli_args.SelectContext, parent=context)
 def context_set_context(args: cli_args.SelectContext):
-    """ Задать текущий активный контекст по имени в конфигурации
+    """ Set the current active context.
 
-    Выбранный контекст будет использоваться по-умолчанию при незаданной переменной окружения ANN_SELECTED_CONTEXT
+    The selected context is used by default unless the environment variable ANN_SELECTED_CONTEXT is set
     """
     with open(path := get_context_path(touch=True)) as f:
         data = yaml.safe_load(f)
@@ -211,12 +303,10 @@ def context_set_context(args: cli_args.SelectContext):
 
 @subcommand(parent=context)
 def context_edit():
-    """ Открыть файл конфигурации контекста в редакторе из переменной окружения EDITOR
+    """ Open the context file using an editor from the EDITOR environment variable.
 
-    Если переменная окружения EDITOR не задана,
-    для Windows пытаемся открыть файл средствами ОС, для остальных случаев пытаемся открыть в vi
+    If the EDITOR variable is not set, default variables are: "notepad.exe" for Windows and "vi" otherwise
     """
-    editor = ""
     if e := os.getenv("EDITOR"):
         editor = e
     elif platform.system() == "Windows":
@@ -232,5 +322,5 @@ def context_edit():
 
 @subcommand(parent=context)
 def context_repair():
-    """ Попытаться исправить расхождения в формате файла контекста после изменении версии """
+    """ Try to fix the context file's structure if it was generated for the older versions of annet """
     repair_context_file()