Skip to content

Commit 8750d38

Browse files
authored
gh-87027: Add prev_network function to ipaddress library (follow-up to GH-24180) (#154041)
bpo-42861: Added prev_network method, required refactor of next_network to prevent duplication.
1 parent 60eca2d commit 8750d38

5 files changed

Lines changed: 154 additions & 30 deletions

File tree

‎Doc/library/ipaddress.rst‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -739,7 +739,7 @@ dictionaries.
739739
Traceback (most recent call last):
740740
File "<stdin>", line 1, in <module>
741741
raise ValueError(
742-
ValueError: next prefix must be between 1 and 32
742+
ValueError: prefix must be between 1 and 32
743743
>>> IPv4Network('255.255.255.0/24').next_network()
744744
Traceback (most recent call last):
745745
File "<stdin>", line 1, in <module>
@@ -748,6 +748,36 @@ dictionaries.
748748

749749
.. versionadded:: 3.16
750750

751+
.. method:: prev_network(prev_prefix=None)
752+
753+
Finds the previous closest network of prefix size *prev_prefix*. If
754+
*prev_prefix=None*, then the current network prefix will be used.
755+
Returns a single network object.
756+
757+
Raises :exc:`ValueError` if *prev_prefix* is out of range or no further
758+
network of the requested size exists.
759+
760+
>>> IPv4Network('192.0.2.0/24').prev_network()
761+
IPv4Network('192.0.1.0/24')
762+
>>> IPv4Network('192.0.2.0/24').prev_network(prev_prefix=25)
763+
IPv4Network('192.0.1.128/25')
764+
>>> IPv4Network('192.0.2.0/24').prev_network(prev_prefix=23)
765+
IPv4Network('192.0.0.0/23')
766+
>>> IPv4Network('192.0.80.0/22').prev_network(prev_prefix=18)
767+
IPv4Network('192.0.0.0/18')
768+
>>> IPv4Network('192.0.80.0/22').prev_network(prev_prefix=50)
769+
Traceback (most recent call last):
770+
File "<stdin>", line 1, in <module>
771+
raise ValueError(
772+
ValueError: prefix must be between 1 and 32
773+
>>> IPv4Network('0.0.0.0/24').prev_network()
774+
Traceback (most recent call last):
775+
File "<stdin>", line 1, in <module>
776+
raise ValueError(
777+
ValueError: out of address space, cannot make another /24 network
778+
779+
.. versionadded:: 3.16
780+
751781
.. class:: IPv6Network(address, strict=True)
752782

753783
Construct an IPv6 network definition. *address* can be one of the following:
@@ -820,6 +850,7 @@ dictionaries.
820850
.. method:: subnet_of(other)
821851
.. method:: supernet_of(other)
822852
.. method:: next_network(next_prefix=None)
853+
.. method:: prev_network(prev_prefix=None)
823854
.. method:: compare_networks(other)
824855

825856
Refer to the corresponding attribute documentation in

‎Doc/whatsnew/3.16.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -601,6 +601,10 @@ ipaddress
601601
and :meth:`IPv6Network.next_network() <ipaddress.IPv6Network.next_network>`
602602
methods to find the next nearest network with a specific prefix size.
603603
(Contributed by Faisal Mahmood in :gh:`87027`.)
604+
* Add :meth:`IPv4Network.prev_network() <ipaddress.IPv4Network.prev_network>`
605+
and :meth:`IPv6Network.prev_network() <ipaddress.IPv6Network.prev_network>`
606+
methods to find the previous nearest network with a specific prefix size.
607+
(Contributed by Faisal Mahmood in :gh:`87027`.)
604608

605609

606610
logging

‎Lib/ipaddress.py‎

Lines changed: 55 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1119,6 +1119,46 @@ def is_loopback(self):
11191119
return (self.network_address.is_loopback and
11201120
self.broadcast_address.is_loopback)
11211121

1122+
def _network_by_offset(self, prefix, offset):
1123+
"""Get the network offset from this network.
1124+
1125+
Args:
1126+
prefix: Target prefix length.
1127+
offset: Number of networks to move (+1 or -1).
1128+
1129+
Returns:
1130+
An IPv(4|6) Network object.
1131+
1132+
"""
1133+
if prefix < 1 or prefix > self.max_prefixlen:
1134+
raise ValueError(
1135+
f"prefix must be between 1 and {self.max_prefixlen}"
1136+
)
1137+
new_netmask, _ = self._make_netmask(prefix)
1138+
error = f"out of address space, cannot make another /{prefix} network"
1139+
1140+
if prefix > self.prefixlen:
1141+
if offset < 0:
1142+
new_ip = self.network_address._ip - 1
1143+
else:
1144+
new_ip = self.broadcast_address._ip + 1
1145+
if new_ip < 0 or new_ip > self._ALL_ONES:
1146+
raise ValueError(error)
1147+
1148+
new_ip &= new_netmask._ip
1149+
else:
1150+
bit_shift = self.max_prefixlen - prefix
1151+
new_ip = (
1152+
((new_netmask._ip & self.network_address._ip) >> bit_shift)
1153+
+ offset
1154+
) << bit_shift
1155+
if not 0 <= new_ip <= self._ALL_ONES:
1156+
raise ValueError(error)
1157+
1158+
return self.__class__(
1159+
f"{self._string_from_ip_int(new_ip)}/{prefix}"
1160+
)
1161+
11221162
def next_network(self, next_prefix=None):
11231163
"""Get the next closest network with a specific prefix.
11241164
@@ -1136,31 +1176,25 @@ def next_network(self, next_prefix=None):
11361176
"""
11371177
if next_prefix is None:
11381178
next_prefix = self.prefixlen
1139-
new_netmask = self.netmask
1140-
else:
1141-
if next_prefix < 1 or next_prefix > self.max_prefixlen:
1142-
raise ValueError(
1143-
f"next prefix must be between 1 and {self.max_prefixlen}"
1144-
)
1145-
new_netmask, _ = self._make_netmask(next_prefix)
11461179

1147-
bit_shift = (
1148-
self.max_prefixlen - next_prefix
1149-
if next_prefix <= self.prefixlen
1150-
else self.max_prefixlen - self.prefixlen
1151-
)
1180+
return self._network_by_offset(next_prefix, 1)
11521181

1153-
next_ip = (
1154-
((new_netmask._ip & self.network_address._ip) >> bit_shift) + 1
1155-
) << bit_shift
11561182

1157-
if next_ip > self._ALL_ONES:
1158-
raise ValueError(
1159-
f"out of address space, cannot make another /{next_prefix} "
1160-
"network"
1161-
)
1183+
def prev_network(self, prev_prefix=None):
1184+
"""Get the previous closest network with a specific prefix.
1185+
1186+
Args:
1187+
prev_prefix: The desired previous prefix length, if not specified the
1188+
same self.prefixlen will be used
1189+
1190+
Returns:
1191+
An IPv(4|6) Network object of the previous closest network.
1192+
1193+
"""
1194+
if prev_prefix is None:
1195+
prev_prefix = self.prefixlen
11621196

1163-
return self.__class__((next_ip, next_prefix))
1197+
return self._network_by_offset(prev_prefix, -1)
11641198

11651199

11661200
class _BaseConstants:

‎Lib/test/test_ipaddress.py‎

Lines changed: 61 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1596,16 +1596,69 @@ def testNextNetworkWithBadPrefix(self):
15961596
self.assertRaises(ValueError, self.ipv6_network.next_network, 150)
15971597

15981598
def testNextNetworkOutOfAddressSpace(self):
1599+
error = r"out of address space, cannot make another /{} network"
15991600
ipv4 = ipaddress.IPv4Network('255.255.255.0/24')
1600-
self.assertRaisesRegex(
1601-
ValueError,
1602-
'out of address space, cannot make another /24 network',
1603-
ipv4.next_network)
1601+
with self.assertRaisesRegex(ValueError, error.format(24)):
1602+
ipv4.next_network()
1603+
with self.assertRaisesRegex(ValueError, error.format(25)):
1604+
ipv4.next_network(25)
16041605
ipv6 = ipaddress.IPv6Network('ffff:ffff:ffff:ffff:ffff:ffff:ffff:0/112')
1605-
self.assertRaisesRegex(
1606-
ValueError,
1607-
'out of address space, cannot make another /112 network',
1608-
ipv6.next_network)
1606+
with self.assertRaisesRegex(ValueError, error.format(112)):
1607+
ipv6.next_network()
1608+
with self.assertRaisesRegex(ValueError, error.format(120)):
1609+
ipv6.next_network(120)
1610+
1611+
def testPrevNetwork(self):
1612+
ipv4 = ipaddress.IPv4Network('1.2.3.0/24')
1613+
self.assertEqual(
1614+
ipv4.prev_network(),
1615+
ipaddress.IPv4Network('1.2.2.0/24'),
1616+
)
1617+
self.assertEqual(
1618+
ipv4.prev_network(prev_prefix=16),
1619+
ipaddress.IPv4Network('1.1.0.0/16'),
1620+
)
1621+
self.assertEqual(
1622+
ipv4.prev_network(prev_prefix=25),
1623+
ipaddress.IPv4Network('1.2.2.128/25'),
1624+
)
1625+
self.assertEqual(
1626+
ipv4.prev_network(prev_prefix=23),
1627+
ipaddress.IPv4Network('1.2.0.0/23'),
1628+
)
1629+
1630+
ipv6 = ipaddress.IPv6Network('2001:dbb8:aaaa:aaaa::/64')
1631+
self.assertEqual(
1632+
ipv6.prev_network(),
1633+
ipaddress.IPv6Network('2001:dbb8:aaaa:aaa9::/64'),
1634+
)
1635+
self.assertEqual(
1636+
ipv6.prev_network(prev_prefix=48),
1637+
ipaddress.IPv6Network('2001:dbb8:aaa9::/48'),
1638+
)
1639+
self.assertEqual(
1640+
ipv6.prev_network(prev_prefix=88),
1641+
ipaddress.IPv6Network('2001:dbb8:aaaa:aaa9:ffff:ff00::/88'),
1642+
)
1643+
1644+
def testPrevNetworkWithBadPrefix(self):
1645+
self.assertRaises(ValueError, self.ipv4_network.prev_network, 0)
1646+
self.assertRaises(ValueError, self.ipv4_network.prev_network, 35)
1647+
self.assertRaises(ValueError, self.ipv6_network.prev_network, 0)
1648+
self.assertRaises(ValueError, self.ipv6_network.prev_network, 150)
1649+
1650+
def testPrevNetworkOutOfAddressSpace(self):
1651+
error = r"out of address space, cannot make another /{} network"
1652+
ipv4 = ipaddress.IPv4Network('0.0.0.0/24')
1653+
with self.assertRaisesRegex(ValueError, error.format(24)):
1654+
ipv4.prev_network()
1655+
with self.assertRaisesRegex(ValueError, error.format(25)):
1656+
ipv4.prev_network(25)
1657+
ipv6 = ipaddress.IPv6Network('::/112')
1658+
with self.assertRaisesRegex(ValueError, error.format(112)):
1659+
ipv6.prev_network()
1660+
with self.assertRaisesRegex(ValueError, error.format(120)):
1661+
ipv6.prev_network(120)
16091662

16101663
def testFancySubnetting(self):
16111664
self.assertEqual(sorted(self.ipv4_network.subnets(prefixlen_diff=3)),
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Add :meth:`~ipaddress.IPv4Network.prev_network` and
2+
:meth:`~ipaddress.IPv6Network.prev_network`. Patch by Faisal Mahmood.

0 commit comments

Comments
 (0)