nbforager 0.4.1__tar.gz → 0.6.0__tar.gz

{nbforager-0.4.1 → nbforager-0.6.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: nbforager
-Version: 0.4.1
+Version: 0.6.0
 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.
-Home-page: https://github.com/vladimirs-git/nbforager
 License: Apache-2.0
 Keywords: netbox
 Author: Vladimirs Prusakovs
@@ -18,18 +17,19 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: test
 Requires-Dist: ciscoconfparse (>=1.9,<2.0)
 Requires-Dist: netports (>=0.14,<1.0.0)
 Requires-Dist: pydantic (>=2,<3)
-Requires-Dist: pynetbox (>=7.3.3,<8.0.0)
 Requires-Dist: requests (>=2,<3)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: tomli (==2.0.1)
 Requires-Dist: vhelpers (>=0.3,<1.0.0)
 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.4.1.tar.gz
-Project-URL: Repository, https://github.com/vladimirs-git/nbforager
+Project-URL: Download URL, https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.6.0.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.4.1 → nbforager-0.6.0}/nbforager/api/__init__.py

@@ -25,16 +25,3 @@ ConnectorA = Union[
     VirtualizationAC,
     WirelessAC,
 ]
-
-APPS = [
-    "circuits",
-    "core",
-    "dcim",
-    "extras",
-    "ipam",
-    "plugins",
-    "tenancy",
-    "users",
-    "virtualization",
-    "wireless",
-]

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/api/base_c.py

@@ -355,12 +355,12 @@ class BaseC:
         :return: Max limit value, update params_d["limit"] value
         """
         limit = 0
-        if limit_ := vdict.pop(params_d, key="limit") or []:
+        if limit_ := list(vdict.pop(data=params_d, key="limit") or []):
             limit = int(limit_[0])
         if not limit:
             limit = self.limit
         max_limit = 0
-        if max_limit_ := vdict.pop(params_d, key="max_limit") or []:
+        if max_limit_ := list(vdict.pop(data=params_d, key="max_limit") or []):
             max_limit = int(max_limit_[0])
         if max_limit and max_limit < limit:
             limit = max_limit

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/api/circuits.py

@@ -2,7 +2,7 @@
 
 """Circuits connectors."""
 
-from nbforager.api.base_ca import BaseAC
+from nbforager.api.base_ac import BaseAC
 from nbforager.api.connector import Connector
 
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/api/connector.py

@@ -138,7 +138,7 @@ class Connector(BaseC):
             - <Response [400]> Invalid data.
         :rtype: Response
         """
-        id_ = vdict.pop(kwargs, key="id")
+        id_ = vdict.pop(data=kwargs, key="id")
         if not id_:
             raise ValueError("id is required in the data.")
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/api/extended_get.py

@@ -1,4 +1,5 @@
 """Map parameter {name} to {name}_id."""
+
 from typing import Dict
 
 from pydantic import BaseModel, Field

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/api/ipam.py

@@ -1,6 +1,7 @@
 # pylint: disable=R0902,R0903
 
 """IPAM connectors."""
+
 from nbforager.api.connector import Connector
 from nbforager.api.ip_addresses import IpAddressesC
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/base_fa.py

@@ -4,14 +4,13 @@ from nbforager import helpers as h
 from nbforager.api import ConnectorA
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 from nbforager.types_ import LStr
 
 
 class BaseAF:
     """Base for Application Foragers."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init BaseAF.
 
         :param root: Dictionary where data from Netbox needs to be saved.
@@ -19,7 +18,6 @@ class BaseAF:
         self.api = api
         self.root: NbTree = root
         self.tree: NbTree = tree
-        self.pynb: PyTree = pynb
         self.app: str = h.attr_name(self)
         self.connector: ConnectorA = getattr(api, self.app)  # connector to application
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/circuits.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """Circuits Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class CircuitsAF(BaseAF):
     """Circuits Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init CircuitsAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.circuit_terminations = self.CircuitTerminationsF(self)
         self.circuit_types = self.CircuitTypesF(self)
         self.circuits = self.CircuitsF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/core.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """Core Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class CoreAF(BaseAF):
     """Core Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init CoreAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.data_files = self.DataFilesF(self)
         self.data_sources = self.DataSourcesF(self)
         self.jobs = self.JobsF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/dcim.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """DCIM Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class DcimAF(BaseAF):
     """DCIM Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init DcimAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.cable_terminations = self.CableTerminationsF(self)
         self.cables = self.CablesF(self)
         # connected_device, is not model

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/extras.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """Extras Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class ExtrasAF(BaseAF):
     """Extras Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init ExtrasAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.bookmarks = self.BookmarksF(self)
         self.config_contexts = self.ConfigContextsF(self)
         self.config_templates = self.ConfigTemplatesF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/forager.py

@@ -16,8 +16,7 @@ from nbforager import nb_tree
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
 from nbforager.parser import nb_parser
-from nbforager.py_tree import PyTree
-from nbforager.types_ import LDAny, DiDAny, LStr, LT2StrDAny, DList, LDList, DiAny, SInt, DAny
+from nbforager.types_ import LDAny, DiDAny, LStr, LT2StrDAny, DList, LDList, SInt, DAny
 
 
 class Forager:
@@ -40,7 +39,6 @@ class Forager:
         self.root_d: DiDAny = getattr(getattr(self.root, app), model)
         self.tree: NbTree = forager_a.tree
         self.tree_d: DiDAny = getattr(getattr(self.tree, app), model)
-        self.pynb: PyTree = forager_a.pynb
 
     def __repr__(self) -> str:
         """__repr__."""
@@ -340,17 +338,6 @@ class Forager:
                 data["_nested"] = False
                 model_d[idx] = data
 
-    def _get_pynb_data(self, path: str) -> DiAny:
-        """Get data in self pynb by app/model path.
-
-        :param path: The app/model path.
-
-        :return: The model data.
-        """
-        app, model = h.path_to_attrs(path)
-        data = getattr(getattr(self.pynb, app), model)
-        return data
-
     def _get_root_data(self, path: str) -> DiDAny:
         """Get data in self root by app/model path.
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/ipam.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """IPAM Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class IpamAF(BaseAF):
     """IPAM Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init IpamAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.aggregates = self.AggregatesF(self)
         self.asn_ranges = self.AsnRangesF(self)
         self.asns = self.AsnsF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/ipv4.py

@@ -1,4 +1,5 @@
 """IPv4"""
+
 from ciscoconfparse import IPv4Obj  # type: ignore
 
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/joiner.py

@@ -1,4 +1,5 @@
 """Joiner."""
+
 from operator import itemgetter
 
 from vhelpers import vlist

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/tenancy.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """Tenancy Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class TenancyAF(BaseAF):
     """Tenancy Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init TenancyAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.contact_assignments = self.ContactAssignmentsF(self)
         self.contact_groups = self.ContactGroupsF(self)
         self.contact_roles = self.ContactRolesF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/users.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """Users Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class UsersAF(BaseAF):
     """Users Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init UsersAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         # config: is not DiDAny
         self.groups = self.GroupsF(self)
         self.permissions = self.PermissionsF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/virtualization.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """Tenancy Virtualization."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class VirtualizationAF(BaseAF):
     """Virtualization Virtualization."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init VirtualizationAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.cluster_groups = self.ClusterGroupsF(self)
         self.cluster_types = self.ClusterTypesF(self)
         self.clusters = self.ClustersF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/foragers/wireless.py

@@ -1,24 +1,24 @@
 # pylint: disable=R0902,R0903
 
 """Wireless Forager."""
+
 from nbforager.foragers.base_fa import BaseAF
 from nbforager.foragers.forager import Forager
 from nbforager.nb_api import NbApi
 from nbforager.nb_tree import NbTree
-from nbforager.py_tree import PyTree
 
 
 class WirelessAF(BaseAF):
     """Wireless Forager."""
 
-    def __init__(self, api: NbApi, root: NbTree, tree: NbTree, pynb: PyTree):
+    def __init__(self, api: NbApi, root: NbTree, tree: NbTree):
         """Init WirelessAF.
 
         :param api: NbApi object, connector to Netbox API.
         :param root: NbTree object where raw data from Netbox needs to be saved.
         :param tree: NbTree object where transformed data from Netbox needs to be saved.
         """
-        super().__init__(api, root, tree, pynb)
+        super().__init__(api, root, tree)
         self.wireless_lan_groups = self.WirelessLanGroupsF(self)
         self.wireless_lans = self.WirelessLansF(self)
         self.wireless_links = self.WirelessLinksF(self)

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/helpers.py

@@ -1,6 +1,6 @@
 """Helper functions."""
+
 import itertools
-import re
 import urllib
 from typing import Any
 from urllib.parse import ParseResult, urlencode, urlparse, parse_qs
@@ -14,6 +14,7 @@ from nbforager.types_ import LTInt2, DAny, SeqStr, SStr, TValues, TLists, T2Str,
 
 # =========================== app model id ===========================
 
+
 def am_to_object_type(app: str, model: str) -> str:
     """Convert application and model to object_type.
 
@@ -30,6 +31,7 @@ def am_to_object_type(app: str, model: str) -> str:
             model_singular = f"vm{model_singular}"
     return f"{app}.{model_singular}"
 
+
 def attr_name(obj: Any) -> str:
     """Transform the class name to the attribute name, lowercase without postfix.
 
@@ -170,6 +172,7 @@ def path_to_attrs(path: str) -> T2Str:
     model = model_to_attr(model)
     return app, model
 
+
 def plural_to_singular(plural: str) -> str:
     """Convert a plural model name to a singular model name.
 
@@ -189,6 +192,7 @@ def plural_to_singular(plural: str) -> str:
         singular = singular[:-1]  # types -> type
     return singular
 
+
 def replace_upper(word: str) -> str:
     """Replace upper character with underscore and lower.
 
@@ -339,7 +343,7 @@ def url_to_object_type(url: str) -> str:
     :example:
         url_to_object_type("/api/ipam/ip-addresses/1/") -> "ipam.ipaddress"
     """
-    app, model, id_ = url_to_ami(url)
+    app, model, _ = url_to_ami(url)
     object_type = am_to_object_type(app, model)
     return object_type
 
@@ -361,7 +365,6 @@ def url_to_ui_url(url: str) -> str:
     return ui_url
 
 
-
 # ============================== params ==============================
 
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/log.py

@@ -1,4 +1,5 @@
 """Wrappers for logging."""
+
 import logging
 import time
 

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/messages.py

@@ -59,7 +59,7 @@ class Messages:
 
     def clear(self) -> None:
         """Delete all messages."""
-        self.items = []
+        self.items.clear()
 
     def add(self, level: str, name: str, text: str) -> None:
         """Add message to messages."""

{nbforager-0.4.1 → nbforager-0.6.0}/nbforager/nb_api.py

@@ -20,9 +20,21 @@ 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.nb_tree import NbTree
 from nbforager.parser.nb_parser import NbParser
-from nbforager.types_ import ODLStr, ODDAny, DAny, LDAny
+from nbforager.types_ import ODLStr, ODDAny, DAny, LDAny, LStr, LT2Str
+
+APPS = (
+    "circuits",
+    "core",
+    "dcim",
+    "extras",
+    "ipam",
+    "plugins",
+    "tenancy",
+    "users",
+    "virtualization",
+    "wireless",
+)
 
 
 class NbApi:
@@ -48,27 +60,27 @@ class NbApi:
     """
 
     def __init__(
-            self,
-            host: str,
-            token: str = "",
-            scheme: str = "https",
-            port: int = 0,
-            verify: bool = True,
-            limit: int = 1000,
-            url_length: int = 2047,
-            # Multithreading
-            threads: int = 1,
-            interval: float = 0.0,
-            # Errors processing
-            timeout: int = 60,
-            max_retries: int = 0,
-            sleep: int = 10,
-            strict: bool = False,
-            # Settings
-            extended_get: bool = True,
-            default_get: ODDAny = None,
-            loners: ODLStr = None,
-            **kwargs,
+        self,
+        host: str,
+        token: str = "",
+        scheme: str = "https",
+        port: int = 0,
+        verify: bool = True,
+        limit: int = 1000,
+        url_length: int = 2047,
+        # Multithreading
+        threads: int = 1,
+        interval: float = 0.0,
+        # Errors processing
+        timeout: int = 60,
+        max_retries: int = 0,
+        sleep: int = 10,
+        strict: bool = False,
+        # Settings
+        extended_get: bool = True,
+        default_get: ODDAny = None,
+        loners: ODLStr = None,
+        **kwargs,
     ):
         """Init NbApi.
 
@@ -199,6 +211,8 @@ class NbApi:
             loners=connector.loners,
         )
 
+    # ============================= property =============================
+
     @property
     def host(self) -> str:
         """Netbox host name."""
@@ -222,12 +236,52 @@ class NbApi:
 
         :return: None. Update threads in all connectors.
         """
-        tree = NbTree()
-        for app in tree.apps():
-            for model in getattr(tree, app).models():
+        for app in self.apps():
+            models: LStr = [s for s in dir(getattr(self, app)) if s[0].islower()]
+            for model in models:
                 connector = getattr(getattr(self, app), model)
                 setattr(connector, "threads", threads)
 
+    # ============================= methods ==============================
+
+    @staticmethod
+    def apps() -> LStr:
+        """Get list of application names.
+
+        :return: Applications.
+        :rtype: List[str]
+        """
+        return list(APPS)
+
+    def app_models(self) -> LT2Str:
+        """Get list of application model names.
+
+        :return: Application model names.
+        :rtype: List[Tuple[str, str]]
+        """
+        app_models: LT2Str = []
+        for app in self.apps():
+            models: LStr = [s for s in dir(getattr(self, app)) if s[0].islower()]
+            for model in models:
+                app_models.append((app, model))
+        return app_models
+
+    def app_paths(self) -> LStr:
+        """Get list of application/model paths.
+
+        :return: Application/model paths.
+        :rtype: List[str]
+        """
+        app_paths: LStr = []
+        for app in self.apps():
+            models: LStr = [s for s in dir(getattr(self, app)) if s[0].islower()]
+            for model in models:
+                connector = getattr(getattr(self, app), model)
+                path = getattr(connector, "path")
+                path = path.rstrip("/")
+                app_paths.append(path)
+        return app_paths
+
     def copy(self, **kwargs) -> NbApi:
         """Create a duplicate of the object.
 
@@ -317,7 +371,7 @@ class NbApi:
         url = str(kwargs.get("url") or "")
         app, model, _ = h.url_to_ami(url)
         data: DAny = {k: v for k, v in kwargs.items() if k not in ["url", "id"]}
-        method: Callable = getattr(getattr(getattr(self, app), model), "create")
+        method: Callable = getattr(getattr(getattr(self, app), model), "create_d")
         return method(**data)
 
     def delete(self, **kwargs) -> Response: