ipaddons 0.2.3__tar.gz → 0.3.0__tar.gz

{ipaddons-0.2.3 → ipaddons-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipaddons
-Version: 0.2.3
+Version: 0.3.0
 Summary: Additional tools for the ipaddress standard library module
 Project-URL: docs, https://ipaddress-tools.readthedocs.io/stable/
 Project-URL: homepage, https://ipaddress-tools.readthedocs.io/stable/

{ipaddons-0.2.3 → ipaddons-0.3.0}/src/ipaddons/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.3'
-__version_tuple__ = version_tuple = (0, 2, 3)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)
 
 __commit_id__ = commit_id = None

{ipaddons-0.2.3 → ipaddons-0.3.0}/src/ipaddons/tools.py

@@ -17,6 +17,10 @@ if TYPE_CHECKING:
     NetworkRange: TypeAlias = tuple[int, int]
 
 
+class IPAllocationError(Exception):
+    pass
+
+
 def ip_allocation(supernet: UnSpecNet, used_networks: UnspecNetSeq | None = None) -> IPv4Allocation | IPv6Allocation:
     """Create an IP allocation.
 
@@ -42,7 +46,11 @@ def ip_allocation(supernet: UnSpecNet, used_networks: UnspecNetSeq | None = None
     raise ValueError(msg)
 
 
-def overlap(a: NetworkRange, b: NetworkRange) -> bool:
+def _ceildiv(a: int, b: int) -> int:
+    return -(a // -b)
+
+
+def range_overlap(a: NetworkRange, b: NetworkRange) -> bool:
     """Network Range Overlap Check.
 
     :param a: a network range
@@ -52,7 +60,7 @@ def overlap(a: NetworkRange, b: NetworkRange) -> bool:
     return max(a[0], b[0]) < min(a[1], b[1])
 
 
-def overlaps(a: NetworkRange, b: list[NetworkRange]) -> NetworkRange | None:
+def range_overlaps(a: NetworkRange, b: list[NetworkRange]) -> NetworkRange | None:
     """Overlap between a network range and a list of other network ranges.
 
     :param a: Network range to check against.
@@ -60,7 +68,7 @@ def overlaps(a: NetworkRange, b: list[NetworkRange]) -> NetworkRange | None:
     :return: The first range from b that overlaps with a.
     """
     for x in b:
-        if overlap(a, x):
+        if range_overlap(a, x):
             return x
     return None
 
@@ -75,6 +83,29 @@ def netrange(network: IPNetwork) -> NetworkRange:
     return int(network[0]), int(network[-1])
 
 
+def free_ranges(superrange: NetworkRange, used_ranges: list[NetworkRange]) -> Generator[NetworkRange, None, None]:
+    """Get free ranges from a supernet with provided used ranges.
+
+    :param superrange: Covering range from where free subranges should be returned.
+    :param used_ranges: List of used network ranges.
+    :return: An interator for free ranges.
+    """
+    used_ranges = sorted(used_ranges)
+    for range in used_ranges:
+        if superrange[0] >= superrange[1]:
+            # Last range either ends at or shoots over the supernet range
+            return
+        if superrange[0] == range[0]:
+            # used range is at the beginning, shrink superrange
+            superrange = range[1] + 1, superrange[1]
+            continue
+        free_range = superrange[0], range[0] - 1
+        superrange = range[1] + 1, superrange[1]
+        yield free_range
+    # The rest of the superrange is free when there are no more used ranges left
+    yield superrange
+
+
 def merge_ranges(ranges: list[NetworkRange]) -> list[NetworkRange]:
     """Merge network ranges that overlap.
 
@@ -89,7 +120,7 @@ def merge_ranges(ranges: list[NetworkRange]) -> list[NetworkRange]:
     base = sorted_ranges.pop()
     while len(sorted_ranges):
         range = sorted_ranges.pop()
-        if overlap(base, range):
+        if range_overlap(base, range):
             base = min(base[0], range[0]), max(base[1], range[1])
         else:
             merged_ranges.append(base)
@@ -98,16 +129,28 @@ def merge_ranges(ranges: list[NetworkRange]) -> list[NetworkRange]:
     return merged_ranges
 
 
-def net_size_iterator(start: IPNetwork, cidr: int) -> Generator[NetworkRange, None, None]:
+def net_size_iterator(
+    supernet: IPNetwork, cidr: int, used_ranges: list[NetworkRange] | None = None
+) -> Generator[NetworkRange, None, None]:
     """Iterate over an ipaddr network object and return subnet network ranges of the specified cidr size.
 
-    :param start: An ipaddr network object.
+    :param supernet: An ipaddr network object.
     :param cidr: CIDR size of the subnets.
+    :param used_ranges: A list of used network ranges.
     :return: An interator over all subnets in the network in the specified CIDR size.
     """
-    cidr_size = 2 ** (start.max_prefixlen - cidr)
-    for s in range(int(start[0]), int(start[-1]), cidr_size):
-        yield s, s + cidr_size - 1
+    cidr_size = 2 ** (supernet.max_prefixlen - cidr)
+    supernet_range = int(supernet[0]), int(supernet[-1])
+    if used_ranges is None:
+        used_ranges = []
+    for free_range in free_ranges(supernet_range, used_ranges):
+        free_range_boundary = (
+            # Large IPv6 integers are tricky...
+            _ceildiv(free_range[0], cidr_size) * cidr_size,
+            free_range[1] // cidr_size * cidr_size - 1,
+        )
+        for s in range(free_range_boundary[0], free_range_boundary[1] + cidr_size, cidr_size):
+            yield s, s + cidr_size - 1
 
 
 class _BaseIPAllocation(ABC, Generic[_N]):
@@ -195,9 +238,10 @@ class _BaseIPAllocation(ABC, Generic[_N]):
         :param prefixlen: Size of the free subnets returned in CIDR notation.
         :return: An iterator for free subnets of :py:attr:`prefixlen` size.
         """
-        for n in net_size_iterator(self.supernet, prefixlen):
-            if overlaps(n, self._used_network_ranges):
-                continue
+        for n in net_size_iterator(self.supernet, prefixlen, self._used_network_ranges):
+            if range_overlaps(n, self._used_network_ranges):
+                msg = "This should never happen!"
+                raise IPAllocationError(msg)
             yield self._network_class((n[0], prefixlen))
 
 

{ipaddons-0.2.3 → ipaddons-0.3.0}/tests/test_ip_allocation.py

@@ -98,12 +98,45 @@ def test_merge(subnets):
     covering_prefix = subnets[0]
     assert tools.merge_ranges(subnets) == [covering_prefix]
 
+
 @pytest.mark.parametrize(
     "subnets",
     mergeable_subnets,
 )
 def test_merge_one(subnets):
-    assert tools.merge_ranges(subnets[:1]) == subnets[:1]
+    assert subnets[:1] == tools.merge_ranges(subnets[:1])
+
 
 def test_merge_empty():
     assert tools.merge_ranges([]) == []
+
+
+@pytest.mark.parametrize(
+    ("supernet", "used_nets", "cidr", "first_free"),
+    [
+        ("2001:db8::/32", ["2001:db8::/48", "2001:db8:1::/120"], 64, "2001:db8:1:1::/64"),
+        ("10.0.0.0/8", ["10.0.0.0/16", "10.1.0.0/24"], 16, "10.2.0.0/16"),
+    ],
+)
+def test_netsize_iterator(supernet, used_nets, cidr, first_free):
+    supernet = ipaddress.ip_network(supernet)
+    used_nets = [(int(ipaddress.ip_network(n)[0]), int(ipaddress.ip_network(n)[-1])) for n in used_nets]
+    i = tools.net_size_iterator(supernet, cidr, used_nets)
+    first_ip, last_ip = next(i)
+    net = next(ipaddress.summarize_address_range(ipaddress.ip_address(first_ip), ipaddress.ip_address(last_ip)))
+    assert first_free == str(net)
+
+
+@pytest.mark.parametrize(
+    ("supernet", "used_nets", "cidr", "last_free"),
+    [
+        ("10.0.0.0/24", ["10.0.0.0/29", "10.0.0.96/30"], 30, "10.0.0.252/30"),
+    ],
+)
+def test_netsize_iterator_last(supernet, used_nets, cidr, last_free):
+    supernet = ipaddress.ip_network(supernet)
+    used_nets = [(int(ipaddress.ip_network(n)[0]), int(ipaddress.ip_network(n)[-1])) for n in used_nets]
+    i = tools.net_size_iterator(supernet, cidr, used_nets)
+    first_ip, last_ip = list(i)[-1]
+    net = next(ipaddress.summarize_address_range(ipaddress.ip_address(first_ip), ipaddress.ip_address(last_ip)))
+    assert last_free == str(net)