nbforager 0.4.1__tar.gz → 0.5.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbforager
-Version: 0.4.1
+Version: 0.5.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
@@ -28,7 +28,7 @@ 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: Download URL, https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.5.0.tar.gz
 Project-URL: Repository, https://github.com/vladimirs-git/nbforager
 Description-Content-Type: text/x-rst
 

{nbforager-0.4.1 → nbforager-0.5.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.5.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.5.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.5.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.5.0}/nbforager/foragers/circuits.py

@@ -1,6 +1,7 @@
 # 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

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

@@ -1,6 +1,7 @@
 # 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

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

@@ -1,6 +1,7 @@
 # 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

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

@@ -1,6 +1,7 @@
 # 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

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

@@ -1,6 +1,7 @@
 # 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

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

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

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

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

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

@@ -1,6 +1,7 @@
 # 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

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

@@ -1,6 +1,7 @@
 # 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

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

@@ -1,6 +1,7 @@
 # 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

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

@@ -1,6 +1,7 @@
 # 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

{nbforager-0.4.1 → nbforager-0.5.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.5.0}/nbforager/log.py

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

{nbforager-0.4.1 → nbforager-0.5.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.5.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:

{nbforager-0.4.1 → nbforager-0.5.0}/nbforager/nb_forager.py

@@ -246,7 +246,7 @@ class NbForager:
                     data: dict = getattr(getattr(self.root, app), model)
                     data.clear()
         if tree:
-            self.tree = NbTree()
+            self.tree.clear()
 
     def copy(self) -> NbForager:
         """Copy data in the NbForager.root and NbForager.tree.

{nbforager-0.4.1 → nbforager-0.5.0}/nbforager/nb_tree.py

@@ -1,4 +1,5 @@
 """Tree of Netbox model objects."""
+
 import logging
 from copy import deepcopy
 from typing import Optional
@@ -240,9 +241,6 @@ class NbTree(BaseModel):
 ONbTree = Optional[NbTree]
 
 
-
-
-
 def insert_tree(src: NbTree, dst: NbTree) -> None:
     """Insert the data from the source NbTree object into the destination NbTree object.
 
@@ -313,7 +311,6 @@ def missed_urls(urls: LStr, tree: NbTree) -> LStr:
     return urls_
 
 
-
 def object_type_to_am(object_type: str, path: bool = False) -> T2Str:
     """Convert object_type value (used in extras/changelog) to app/model values.
 
@@ -348,9 +345,6 @@ def object_type_to_am(object_type: str, path: bool = False) -> T2Str:
     raise ValueError(f"{object_type=} is not defined.")
 
 
-
-
-
 # ============================= helpers ==============================
 
 
@@ -378,5 +372,3 @@ def _get_child(child: DAny, tree: NbTree) -> DAny:
             return {}
 
     return {}
-
-

{nbforager-0.4.1 → nbforager-0.5.0}/nbforager/parser/nb_custom.py

@@ -1,4 +1,5 @@
 """NbCustom."""
+
 import re
 import string
 

{nbforager-0.4.1 → nbforager-0.5.0}/nbforager/parser/nb_parser.py

@@ -1,6 +1,7 @@
 # pylint: disable=R0904
 
 """NbParser."""
+
 from functools import wraps
 from typing import Any, Type, Dict, List
 

{nbforager-0.4.1 → nbforager-0.5.0}/nbforager/parser/nb_value.py

@@ -1,6 +1,7 @@
 # pylint: disable=too-many-public-methods
 
 """NbValue."""
+
 import re
 
 from nbforager.exceptions import NbParserError

{nbforager-0.4.1 → nbforager-0.5.0}/nbforager/py_tree.py

@@ -1,4 +1,5 @@
 """Tree of pynetbox model objects."""
+
 from typing import Dict
 
 from pydantic import BaseModel, Field, ConfigDict

{nbforager-0.4.1 → nbforager-0.5.0}/nbforager/types_.py

@@ -1,4 +1,5 @@
 """Typing."""
+
 from datetime import datetime
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Set, Tuple, Union, Sequence, TypeVar
@@ -32,7 +33,6 @@ TValues = (str, int, float)
 Value = Union[str, int, float]
 
 # 2 level
-SeqUIntStr = Sequence[IntStr]
 DDAny = Dict[str, DAny]
 DDStr = Dict[str, DStr]
 DLInt = Dict[str, LInt]
@@ -46,14 +46,15 @@ LDAny = List[DAny]
 LDStr = List[DStr]
 LParam = List[Param]
 LT = List[T]
+LT2Str = List[T2Str]
 LT2StrDAny = List[Tuple[str, DAny]]
-LTup2 = List[T2Str]
 LValue = List[Value]
 ODAny = Optional[DAny]
 OSeqStr = Optional[SeqStr]
 SParam = Set[Param]
 SeqDAny = Sequence[DAny]
 SeqT = Sequence[T]
+SeqUIntStr = Sequence[IntStr]
 T3SStr = Tuple[SStr, SStr, SStr]
 TParam = Tuple[Param, ...]
 UStr = Union[str, SeqStr]
@@ -76,4 +77,3 @@ UParam = Union[LParam, SParam, TParam]
 
 # 5 level
 OUParam = Optional[UParam]
-

{nbforager-0.4.1 → nbforager-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nbforager"
-version = "0.4.1"
+version = "0.5.0"
 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"
@@ -29,17 +29,17 @@ vhelpers = ">=0.3,<1.0.0"
 
 [tool.poetry.group.dev.dependencies]
 dictdiffer = "0.9.0"
-mypy = "^1.11.1"
+mypy = "^1.14.1"
 poetry = "^1.8.3"
 pygments = "^2.16.1"
-pylint = "^3.2.6"
-pytest = "^8.3.2"
+pylint = "^3.2.7"
+pytest = "^8.3.4"
 pytest-cov = "^5.0.0"
 pytest-mock = "^3.14.0"
 readthedocs-sphinx-search = "^0.3.1"
 requests-mock = "^1.12.1"
 restructuredtext-lint = "^1.4.0"
-ruff = "^0.6.1"
+ruff = "^0.9.9"
 sphinx = "7.1.2"
 sphinx-rtd-theme = "^1.3.0"
 sphinxnotes-strike = "^1.2"
@@ -57,7 +57,7 @@ test = ["pytest"]
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/vladimirs-git/nbforager/issues"
-"Download URL" = "https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.4.1.tar.gz"
+"Download URL" = "https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.5.0.tar.gz"
 
 [tool.pylint]
 disable = "fixme"