nbforager 0.8.2__tar.gz → 0.8.4__tar.gz

{nbforager-0.8.2 → nbforager-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nbforager
-Version: 0.8.2
+Version: 0.8.4
 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
@@ -16,14 +16,13 @@ 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.17)
 Requires-Dist: pydantic (>=2,<3)
 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.8.2.tar.gz
+Project-URL: Download URL, https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.8.4.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.8.2 → nbforager-0.8.4}/nbforager/api/base_c.py

@@ -316,12 +316,7 @@ class BaseC:
 
         :return: Netbox objects. Update self _results.
         """
-        params_d = params_d.copy()
-        if "limit" not in params_d:
-            params_d["limit"] = [self.limit]
-        if "offset" not in params_d:
-            params_d["offset"] = [0]
-
+        params_d = self._add_params_limit_offset(params_d)
         params_l: LParam = vparam.from_dict(params_d)
         url = f"{self.url_base}{path}?{urllib.parse.urlencode(params_l)}"
 
@@ -359,6 +354,7 @@ class BaseC:
 
         :return: Netbox objects. Update self _results.
         """
+        params_d = self._add_params_limit_offset(params_d)
         params_l: LParam = vparam.from_dict(params_d)
         url = f"{self.url_base}{path}?{urllib.parse.urlencode(params_l)}"
 
@@ -431,6 +427,19 @@ class BaseC:
 
     # ============================== helper ==============================
 
+    def _add_params_limit_offset(self, params_d: DList) -> DList:
+        """Add `limit` and `offset` default values to the params_d if they are not already present.
+
+        :param params_d: Parameters that need to update.
+        :return: Updated parameters.
+        """
+        params_d = params_d.copy()
+        if "limit" not in params_d:
+            params_d["limit"] = [self.limit]
+        if "offset" not in params_d:
+            params_d["offset"] = [0]
+        return params_d
+
     def _get_d(self) -> DAny:
         """Get dictionary from the Netbox.
 

{nbforager-0.8.2 → nbforager-0.8.4}/nbforager/api/connector.py

@@ -102,13 +102,6 @@ class Connector(BaseC):
         - Examples https://github.com/vladimirs-git/nbforager/tree/main/examples,
         - Official documentation (if you're lucky).
 
-
-        :param max_limit: Maximum count of objects that need to be requested.
-            This is useful in development to prevent script blocking when
-            receiving only part of the requested data is acceptable.
-            Default is `0` no limit.
-        :type max_limit: int
-
         :param or_{parameter}: List of parameters that need to be requested
             in an ``OR`` manner, where ``{parameter}`` is the name of the
             Netbox REST API `Schema ip_addresses`_.

{nbforager-0.8.2 → nbforager-0.8.4}/nbforager/api/ip_addresses.py

@@ -21,12 +21,6 @@ class IpAddressesC(Connector):
 
         NbApi parameters:
 
-        :param max_limit: Maximum count of objects that need to be requested.
-            This is useful in development to prevent script blocking when
-            receiving only part of the requested data is acceptable.
-            Default is `0` no limit.
-        :type max_limit: int
-
         :param or_{parameter}: List of parameters that need to be requested
             in an ``OR`` manner, where ``{parameter}`` is the name of the
             Netbox REST API `Schema ip_addresses`_.

nbforager-0.8.4/nbforager/foragers/ipv4.py

@@ -0,0 +1,79 @@
+"""IPv4 address representation in CIDR notation."""
+
+from __future__ import annotations
+
+from functools import total_ordering
+from ipaddress import IPv4Interface, IPv4Network
+
+
+@total_ordering
+class IPv4:
+    """IPv4 address representation in CIDR notation."""
+
+    def __init__(self, cidr: str, strict: bool = False):
+        """Initialize IPv4 object with the given CIDR notation.
+
+        :param cidr: A string like '192.168.1.1/24'
+        :param strict: If True, IP must be valid network address (not host address).
+        :raises ValueError: If strict is True and a network address is not supplied.
+        """
+        _ = IPv4Network(cidr, strict=strict)  # Validate network with strictness
+        self._interface = IPv4Interface(cidr)
+
+    def __repr__(self):
+        """Representation of the object."""
+        return f"IPv4('{self.ipv4}')"
+
+    def __str__(self):
+        """String representation
+
+        :return: IPv4 address with prefixlen, A.B.C.D/LEN.
+        """
+        return self.ipv4
+
+    def __hash__(self) -> int:
+        """Hash value of the object."""
+        return hash(self._interface.network)
+
+    def __eq__(self, other: IPv4, /) -> bool:
+        """Check if two objects are equal.
+
+        :param other: Another object to compare.
+        :return: True if objects are equal, False otherwise.
+        """
+        if not isinstance(other, IPv4):
+            return False
+        return self._interface == other._interface
+
+    def __lt__(self, other: IPv4, /) -> bool:
+        """Compare two objects.
+
+        :param other: Another object to compare with.
+        """
+        if not isinstance(other, IPv4):
+            return False
+        return self._interface < other._interface
+
+    def __contains__(self, other: IPv4, /) -> bool:
+        """Check if all IPs in the other subnet are part of this network."""
+        return other._interface.network.subnet_of(self._interface.network)
+
+    @property
+    def ip(self) -> str:
+        """IPv4 address without prefixlen, A.B.C.D."""
+        return str(self._interface.ip)
+
+    @property
+    def ipv4(self) -> str:
+        """IPv4 address with prefixlen, A.B.C.D/LEN."""
+        return str(self._interface.with_prefixlen)
+
+    @property
+    def net(self) -> str:
+        """IPv4 network with prefixlen, A.B.C.D/LEN."""
+        return str(self._interface.network)
+
+    @property
+    def prefixlen(self) -> int:
+        """IPv4 network with prefixlen, A.B.C.D/LEN."""
+        return self._interface.network.prefixlen

{nbforager-0.8.2 → nbforager-0.8.4}/nbforager/foragers/joiner.py

@@ -189,7 +189,7 @@ class Joiner:
 
             Add new attributes in ipam.aggregate, ipam.prefixes, ipam.ip_addresses:
 
-            - ``_ipv4`` IPv4 object, child of ciscoconfparse.IPv4Obj
+            - ``_ipv4`` IPv4 object
             - ``_aggregate`` Aggregate data for ipam.prefixes and ipam.ip_addresses
             - ``_super_prefix`` Related parent prefix data for ipam.prefixes and ipam.ip_addresses
             - ``_sub_prefixes`` Related child prefixes data for ipam.prefixes and ipam.ip_addresses

{nbforager-0.8.2 → nbforager-0.8.4}/nbforager/nb_forager.py

@@ -304,7 +304,7 @@ class NbForager:
 
             In ipam.aggregate, ipam.prefixes, ipam.ip_addresses:
 
-            - ``_ipv4`` IPv4 object, child of ciscoconfparse.IPv4Obj
+            - ``_ipv4`` IPv4 object
             - ``_aggregate`` Aggregate data for ipam.prefixes and ipam.ip_addresses
             - ``_super_prefix`` Related parent prefix data for ipam.prefixes and ipam.ip_addresses
             - ``_sub_prefixes`` Related child prefixes data for ipam.prefixes and ipam.ip_addresses

{nbforager-0.8.2 → nbforager-0.8.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nbforager"
-version = "0.8.2"
+version = "0.8.4"
 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,12 +19,11 @@ 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.8.2.tar.gz"
+"Download URL" = "https://github.com/vladimirs-git/nbforager/archive/refs/tags/0.8.4.tar.gz"
 
 [tool.poetry.dependencies]
 python = "^3.11"
 #
-ciscoconfparse = "^1.9"
 netports = ">=0.17"
 pydantic = "^2"
 requests = "^2"

nbforager-0.8.2/nbforager/foragers/ipv4.py

@@ -1,22 +0,0 @@
-"""IPv4"""
-
-from ciscoconfparse import IPv4Obj  # type: ignore
-
-
-class IPv4(IPv4Obj):
-    """IPv4, support prefixlen for ip-address."""
-
-    @property
-    def ip(self) -> str:
-        """IPv4 address without prefixlen, A.B.C.D."""
-        return self.exploded
-
-    @property
-    def ipv4(self) -> str:
-        """IPv4 address with prefixlen, A.B.C.D/LEN."""
-        return self.as_cidr_addr
-
-    @property
-    def net(self) -> str:
-        """IPv4 network with prefixlen, A.B.C.D/LEN."""
-        return self.as_cidr_net