nbforager 0.7.0__tar.gz → 0.8.1__tar.gz

{nbforager-0.7.0 → nbforager-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nbforager
-Version: 0.7.0
+Version: 0.8.1
 Summary: Python package designed to assist in working with the Netbox REST API. The filter parameters are identical to those in the Web UI filter form. It replaces brief data with full information, and Netbox objects are represented as a recursive multidimensional dictionary.
 License: Apache-2.0
 Keywords: netbox
@@ -23,7 +23,7 @@ Requires-Dist: requests (>=2,<3)
 Requires-Dist: tabulate (>=0.9,<0.10)
 Requires-Dist: vhelpers (>=0.3)
 Project-URL: Bug Tracker, https://github.com/vladimirs-git/nbforager/issues
-Project-URL: Download URL, https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.7.0.tar.gz
+Project-URL: Download URL, https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.8.1.tar.gz
 Project-URL: homepage, https://github.com/vladimirs-git/nbforager
 Project-URL: repository, https://github.com/vladimirs-git/nbforager
 Description-Content-Type: text/x-rst

{nbforager-0.7.0 → nbforager-0.8.1}/nbforager/api/connector.py

@@ -5,6 +5,7 @@
 from __future__ import annotations
 
 import json
+from typing import Generator
 
 from requests import Response
 from vhelpers import vdict
@@ -169,3 +170,6 @@ class Connector(BaseC):
         html: str = response.content.decode("utf-8")
         data: DAny = dict(json.loads(html))
         return data
+
+
+GConnector = Generator[Connector, None, None]

nbforager-0.8.1/nbforager/constants.py

@@ -0,0 +1,283 @@
+"""Constants for apps and models."""
+
+from nbforager.types_ import DLStr
+
+APPS = (
+    "circuits",
+    "core",
+    "dcim",
+    "extras",
+    "ipam",
+    "plugins",
+    "tenancy",
+    "users",
+    "virtualization",
+    "wireless",
+)
+"""Application names for NetBox v3.5."""
+
+DEPENDENT_MODELS: DLStr = {
+    "circuits/circuit-terminations": [
+        "circuits/circuits",
+        "circuits/provider-networks",
+        "dcim/cable-terminations",
+        "dcim/sites",
+        "extras/tags",
+    ],
+    "circuits/circuit-types": ["extras/tags"],
+    "circuits/circuits": [
+        "circuits/circuit-types",
+        "circuits/provider-accounts",
+        "circuits/providers",
+        "extras/tags",
+        "tenancy/tenants",
+    ],
+    "circuits/provider-accounts": ["circuits/providers", "extras/tags"],
+    "circuits/provider-networks": ["circuits/providers", "extras/tags"],
+    "circuits/providers": ["extras/tags", "ipam/asns"],
+    "core/data-files": ["core/data-sources"],
+    "core/data-sources": ["extras/tags"],
+    "core/jobs": ["extras/content-types"],
+    "dcim/cable-terminations": [
+        "dcim/cables",
+        "dcim/devices",
+        "dcim/locations",
+        "dcim/racks",
+        "dcim/sites",
+    ],
+    "dcim/cables": ["extras/tags", "tenancy/tenants"],
+    "dcim/console-port-templates": ["dcim/device-types", "dcim/module-types"],
+    "dcim/console-ports": [
+        "dcim/cable-terminations",
+        "dcim/devices",
+        "dcim/modules",
+        "extras/tags",
+    ],
+    "dcim/console-server-port-templates": ["dcim/device-types", "dcim/module-types"],
+    "dcim/console-server-ports": [
+        "dcim/cable-terminations",
+        "dcim/devices",
+        "dcim/modules",
+        "extras/tags",
+    ],
+    "dcim/device-bay-templates": ["dcim/device-types"],
+    "dcim/device-bays": ["dcim/devices", "extras/tags"],
+    "dcim/device-roles": ["extras/config-templates", "extras/tags"],
+    "dcim/device-types": ["dcim/manufacturers", "extras/tags"],
+    "dcim/devices": [
+        "dcim/device-roles",
+        "dcim/device-types",
+        "dcim/locations",
+        "dcim/platforms",
+        "dcim/racks",
+        "dcim/sites",
+        "dcim/virtual-chassis",
+        "extras/config-templates",
+        "extras/tags",
+        "tenancy/tenants",
+        "virtualization/clusters",
+    ],
+    "dcim/front-port-templates": [
+        "dcim/device-types",
+        "dcim/module-types",
+        "dcim/rear-port-templates",
+    ],
+    "dcim/front-ports": [
+        "dcim/cable-terminations",
+        "dcim/devices",
+        "dcim/modules",
+        "dcim/rear-ports",
+        "extras/tags",
+    ],
+    "dcim/interface-templates": ["dcim/device-types", "dcim/module-types"],
+    "dcim/interfaces": [
+        "dcim/cable-terminations",
+        "dcim/devices",
+        "dcim/modules",
+        "dcim/virtual-device-contexts",
+        "extras/tags",
+        "ipam/ip-addresses",
+        "ipam/l2vpn-terminations",
+        "ipam/vlans",
+        "ipam/vrfs",
+        "virtualization/interfaces",
+        "wireless/wireless-lans",
+    ],
+    "dcim/inventory-item-roles": ["extras/tags"],
+    "dcim/inventory-item-templates": [
+        "dcim/device-types",
+        "dcim/inventory-item-roles",
+        "dcim/manufacturers",
+    ],
+    "dcim/inventory-items": [
+        "dcim/devices",
+        "dcim/inventory-item-roles",
+        "dcim/manufacturers",
+        "extras/tags",
+    ],
+    "dcim/locations": ["dcim/sites", "extras/tags", "ipam/vlan-groups", "tenancy/tenants"],
+    "dcim/manufacturers": ["extras/tags"],
+    "dcim/module-bay-templates": ["dcim/device-types"],
+    "dcim/module-bays": ["dcim/devices", "extras/tags"],
+    "dcim/module-types": ["dcim/manufacturers", "extras/tags"],
+    "dcim/modules": ["dcim/devices", "dcim/module-bays", "dcim/module-types", "extras/tags"],
+    "dcim/platforms": ["dcim/manufacturers", "extras/config-templates", "extras/tags"],
+    "dcim/power-feeds": [
+        "dcim/cable-terminations",
+        "dcim/power-panels",
+        "dcim/racks",
+        "extras/tags",
+    ],
+    "dcim/power-outlet-templates": [
+        "dcim/device-types",
+        "dcim/module-types",
+        "dcim/power-port-templates",
+    ],
+    "dcim/power-outlets": [
+        "dcim/cable-terminations",
+        "dcim/devices",
+        "dcim/modules",
+        "dcim/power-ports",
+        "extras/tags",
+    ],
+    "dcim/power-panels": ["dcim/locations", "dcim/sites", "extras/tags"],
+    "dcim/power-port-templates": ["dcim/device-types", "dcim/module-types"],
+    "dcim/power-ports": ["dcim/cable-terminations", "dcim/devices", "dcim/modules", "extras/tags"],
+    "dcim/rack-reservations": ["dcim/racks", "extras/tags", "tenancy/tenants", "users/users"],
+    "dcim/rack-roles": ["extras/tags"],
+    "dcim/racks": [
+        "dcim/locations",
+        "dcim/rack-roles",
+        "dcim/sites",
+        "extras/tags",
+        "ipam/vlan-groups",
+        "tenancy/tenants",
+    ],
+    "dcim/rear-port-templates": ["dcim/device-types", "dcim/module-types"],
+    "dcim/rear-ports": ["dcim/cable-terminations", "dcim/devices", "dcim/modules", "extras/tags"],
+    "dcim/regions": ["extras/tags", "ipam/vlan-groups"],
+    "dcim/site-groups": ["extras/tags", "ipam/vlan-groups"],
+    "dcim/sites": [
+        "dcim/regions",
+        "dcim/site-groups",
+        "extras/tags",
+        "ipam/asns",
+        "ipam/vlan-groups",
+        "tenancy/tenants",
+    ],
+    "dcim/virtual-chassis": ["dcim/devices", "extras/tags"],
+    "dcim/virtual-device-contexts": ["dcim/devices", "extras/tags", "tenancy/tenants"],
+    "extras/config-contexts": [
+        "dcim/device-roles",
+        "dcim/device-types",
+        "dcim/locations",
+        "dcim/platforms",
+        "dcim/regions",
+        "dcim/site-groups",
+        "dcim/sites",
+        "extras/tags",
+        "tenancy/tenant-groups",
+        "tenancy/tenants",
+        "virtualization/cluster-groups",
+        "virtualization/cluster-types",
+        "virtualization/clusters",
+    ],
+    "extras/config-templates": ["extras/tags"],
+    "extras/content-types": [],
+    "extras/custom-fields": ["extras/content-types"],
+    "extras/custom-links": ["extras/content-types"],
+    "extras/export-templates": ["extras/content-types"],
+    "extras/image-attachments": ["extras/content-types"],
+    "extras/journal-entries": ["extras/content-types", "extras/tags", "users/users"],
+    "extras/object-changes": ["users/users"],
+    "extras/saved-filters": ["extras/content-types", "users/users"],
+    "extras/tags": [],
+    "extras/webhooks": ["extras/content-types"],
+    "ipam/aggregates": ["extras/tags", "ipam/rirs", "tenancy/tenants"],
+    "ipam/asn-ranges": ["extras/tags", "ipam/rirs", "tenancy/tenants"],
+    "ipam/asns": ["extras/tags", "ipam/rirs", "tenancy/tenants"],
+    "ipam/fhrp-group-assignments": ["extras/content-types", "ipam/fhrp-groups"],
+    "ipam/fhrp-groups": ["extras/tags", "ipam/ip-addresses"],
+    "ipam/ip-addresses": ["extras/tags", "ipam/vrfs", "tenancy/tenants"],
+    "ipam/ip-ranges": ["extras/tags", "ipam/roles", "ipam/vrfs", "tenancy/tenants"],
+    "ipam/l2vpn-terminations": ["extras/tags", "ipam/l2vpns"],
+    "ipam/l2vpns": ["extras/tags", "ipam/route-targets", "tenancy/tenants"],
+    "ipam/prefixes": [
+        "dcim/sites",
+        "extras/tags",
+        "ipam/roles",
+        "ipam/vlans",
+        "ipam/vrfs",
+        "tenancy/tenants",
+    ],
+    "ipam/rirs": ["extras/tags"],
+    "ipam/roles": ["extras/tags"],
+    "ipam/route-targets": ["extras/tags", "tenancy/tenants"],
+    "ipam/service-templates": ["extras/tags"],
+    "ipam/services": [
+        "dcim/devices",
+        "extras/tags",
+        "ipam/ip-addresses",
+        "virtualization/virtual-machines",
+    ],
+    "ipam/vlan-groups": ["extras/content-types", "extras/tags"],
+    "ipam/vlans": [
+        "dcim/sites",
+        "extras/tags",
+        "ipam/l2vpn-terminations",
+        "ipam/roles",
+        "ipam/vlan-groups",
+        "tenancy/tenants",
+    ],
+    "ipam/vrfs": ["extras/tags", "ipam/route-targets", "tenancy/tenants"],
+    "tenancy/contact-assignments": [
+        "extras/content-types",
+        "tenancy/contact-roles",
+        "tenancy/contacts",
+    ],
+    "tenancy/contact-groups": ["extras/tags"],
+    "tenancy/contact-roles": ["extras/tags"],
+    "tenancy/contacts": ["extras/tags", "tenancy/contact-groups"],
+    "tenancy/tenant-groups": ["extras/tags"],
+    "tenancy/tenants": ["extras/tags", "tenancy/tenant-groups"],
+    "users/groups": [],
+    "users/permissions": ["extras/content-types", "users/groups", "users/users"],
+    "users/tokens": ["users/users"],
+    "users/users": [],
+    "virtualization/cluster-groups": ["extras/tags", "ipam/vlan-groups"],
+    "virtualization/cluster-types": ["extras/tags"],
+    "virtualization/clusters": [
+        "dcim/sites",
+        "extras/tags",
+        "ipam/vlan-groups",
+        "tenancy/tenants",
+        "virtualization/cluster-groups",
+        "virtualization/cluster-types",
+    ],
+    "virtualization/interfaces": [
+        "extras/tags",
+        "ipam/ip-addresses",
+        "ipam/l2vpn-terminations",
+        "ipam/vlans",
+        "ipam/vrfs",
+        "virtualization/virtual-machines",
+    ],
+    "virtualization/virtual-machines": [
+        "dcim/device-roles",
+        "dcim/devices",
+        "dcim/platforms",
+        "dcim/sites",
+        "extras/tags",
+        "tenancy/tenants",
+        "virtualization/clusters",
+    ],
+    "wireless/wireless-lan-groups": ["extras/tags"],
+    "wireless/wireless-lans": [
+        "extras/tags",
+        "ipam/vlans",
+        "tenancy/tenants",
+        "wireless/wireless-lan-groups",
+    ],
+    "wireless/wireless-links": ["extras/tags", "tenancy/tenants"],
+}
+"""Models dependency for Netbox v3.5."""

{nbforager-0.7.0 → nbforager-0.8.1}/nbforager/helpers.py

@@ -2,16 +2,53 @@
 
 import itertools
 import urllib
+from copy import deepcopy
 from typing import Any
 from urllib.parse import ParseResult, urlencode, urlparse, parse_qs
 
 from vhelpers import vlist, vparam, vint
 
 from nbforager.exceptions import NbApiError
-from nbforager.types_ import LStr, LDAny, DDDLInt, LValue, LParam, LDList, DList, DLStr
+from nbforager.constants import DEPENDENT_MODELS
+from nbforager.types_ import LStr, LDAny, DDDLInt, LValue, LParam, LDList, DList, DLStr, ODLStr
 from nbforager.types_ import LTInt2, DAny, SeqStr, SStr, TValues, TLists, T2Str, T3Str, T3StrInt
 
 
+def dependency_ordered_paths(dependency: ODLStr = None) -> LStr:
+    """Order paths based on dependencies. Models with the lowes count of dependencies will be first.
+
+    :param dependency: Dictionary representing dependencies,
+        where key is the parent model and value is a list of child models.
+    :return: Ordered paths based on dependencies.
+    :raises ValueError: If circular dependency, too many iterations.
+    """
+    paths: LStr = []
+
+    idx = 0
+    dependency_: DLStr = dependency if dependency else DEPENDENT_MODELS
+    dependency_ = deepcopy(dependency_)
+
+    while dependency_:
+        for parent, children in dependency_.items():
+            if parent in paths:
+                continue
+            diff = set(children).difference(set(paths))
+            if parent == "dcim/devices":
+                diff.discard("dcim/virtual-chassis")
+            if not diff:
+                paths.append(parent)
+
+        dependency_ = {k: v for k, v in dependency_.items() if k not in paths}
+        if not dependency_:
+            break
+
+        idx += 1
+        if idx >= 100:
+            raise ValueError("Circular dependency, too many iterations")
+
+    return paths
+
+
 # =========================== app model id ===========================
 
 

{nbforager-0.7.0 → nbforager-0.8.1}/nbforager/nb_api.py

@@ -10,6 +10,7 @@ from requests import Response
 
 from nbforager import helpers as h
 from nbforager.api.circuits import CircuitsAC
+from nbforager.api.connector import Connector, GConnector
 from nbforager.api.core import CoreAC
 from nbforager.api.dcim import DcimAC
 from nbforager.api.extras import ExtrasAC
@@ -20,22 +21,10 @@ from nbforager.api.tenancy import TenancyAC
 from nbforager.api.users import UsersAC
 from nbforager.api.virtualization import VirtualizationAC
 from nbforager.api.wireless import WirelessAC
+from nbforager.constants import APPS
 from nbforager.parser.nb_parser import NbParser
 from nbforager.types_ import ODLStr, ODDAny, DAny, LDAny, LStr, LT2Str
 
-APPS = (
-    "circuits",
-    "core",
-    "dcim",
-    "extras",
-    "ipam",
-    "plugins",
-    "tenancy",
-    "users",
-    "virtualization",
-    "wireless",
-)
-
 
 class NbApi:
     """NbApi, Python wrapper of Netbox REST API.
@@ -282,6 +271,18 @@ class NbApi:
                 app_paths.append(path)
         return app_paths
 
+    def connectors(self) -> GConnector:
+        """Return generator of Connector instances ordered based on dependencies.
+            Connectors to models with the lowes count of dependencies will be first.
+
+        :return: Generator of Connector instances.
+        """
+        paths: LStr = h.dependency_ordered_paths()
+        for path in paths:
+            app, model = h.path_to_attrs(path)
+            connector: Connector = getattr(getattr(self, app), model)
+            yield connector
+
     def copy(self, **kwargs) -> NbApi:
         """Create a duplicate of the object.
 

{nbforager-0.7.0 → nbforager-0.8.1}/nbforager/parser/nb_parser.py

@@ -117,7 +117,7 @@ class NbParser:
 
         :param keys: Chaining dictionary keys to retrieve the desired value.
 
-        :return: Boolean value or an empty string if the value is absent.
+        :return: Boolean value or False if the value is absent.
         :rtype: bool
         """
         return self._get_keys(type_=bool, keys=keys, data=self.data)

{nbforager-0.7.0 → nbforager-0.8.1}/nbforager/types_.py

@@ -2,7 +2,7 @@
 
 from datetime import datetime
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Set, Tuple, Union, Sequence, TypeVar
+from typing import Any, Dict, List, Optional, Sequence, Set, TypeVar, Tuple, Union
 
 # 1 level
 DAny = Dict[str, Any]
@@ -10,6 +10,7 @@ DInt = Dict[str, int]
 DObj = Dict[str, object]
 DStr = Dict[str, str]
 Int = int
+IntStr = Union[int, str]
 LBool = List[bool]
 LInt = List[int]
 LPath = List[Path]
@@ -22,11 +23,10 @@ SInt = Set[int]
 SStr = Set[str]
 SeqStr = Sequence[str]
 Str = str
-IntStr = Union[int, str]
 T = TypeVar("T")
 T2Str = Tuple[str, str]
-T3StrInt = Tuple[str, str, int]
 T3Str = Tuple[str, str, str]
+T3StrInt = Tuple[str, str, int]
 TLists = (list, set, tuple)
 TStr = Tuple[str, ...]
 TValues = (str, int, float)
@@ -77,4 +77,3 @@ UParam = Union[LParam, SParam, TParam]
 
 # 5 level
 OUParam = Optional[UParam]
-

{nbforager-0.7.0 → nbforager-0.8.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nbforager"
-version = "0.7.0"
+version = "0.8.1"
 description = "Python package designed to assist in working with the Netbox REST API. The filter parameters are identical to those in the Web UI filter form. It replaces brief data with full information, and Netbox objects are represented as a recursive multidimensional dictionary."
 authors = ["Vladimirs Prusakovs <vladimir.prusakovs@gmail.com>"]
 readme = "README.rst"
@@ -19,7 +19,7 @@ classifiers = [
 homepage = "https://github.com/vladimirs-git/nbforager"
 repository = "https://github.com/vladimirs-git/nbforager"
 "Bug Tracker" = "https://github.com/vladimirs-git/nbforager/issues"
-"Download URL" = "https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.7.0.tar.gz"
+"Download URL" = "https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.8.1.tar.gz"
 
 [tool.poetry.dependencies]
 python = "^3.11"
@@ -82,6 +82,7 @@ disable = [
     "protected-access",
     "redefined-builtin",
     "redefined-outer-name",
+    "too-many-positional-arguments",
     "too-many-statements",
     "unused-import",
     "use-dict-literal",