Skip to content

[3.13] gh-141497: make ipaddress.IP{v4,v6}Network.hosts() return an iterator (GH-141547) #141695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 18, 2025
Merged

[3.13] gh-141497: make ipaddress.IP{v4,v6}Network.hosts() return an iterator (GH-141547) #141695

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d8d17a
[3.13] gh-141497: Make ipaddress.IP{v4,v6}Network.hosts() always retu…
XChaitanyaX Nov 17, 2025
79ac91e
revert unrelated changes
XChaitanyaX Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Lib/ipaddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1558,8 +1558,8 @@ def __init__(self, address, strict=True):

if self._prefixlen == (self._max_prefixlen - 1):
self.hosts = self.__iter__
elif self._prefixlen == (self._max_prefixlen):
self.hosts = lambda: [IPv4Address(addr)]
elif self._prefixlen == (self.max_prefixlen):
self.hosts = lambda: iter((IPv4Address(addr),))

@property
@functools.lru_cache()
Expand Down Expand Up @@ -2358,8 +2358,8 @@ def __init__(self, address, strict=True):

if self._prefixlen == (self._max_prefixlen - 1):
self.hosts = self.__iter__
elif self._prefixlen == self._max_prefixlen:
self.hosts = lambda: [IPv6Address(addr)]
elif self._prefixlen == self.max_prefixlen:
self.hosts = lambda: iter((IPv6Address(addr),))

def hosts(self):
"""Generate Iterator over usable hosts in a network.
Expand Down
34 changes: 34 additions & 0 deletions Lib/test/test_ipaddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import pickle
import ipaddress
import weakref
from collections.abc import Iterator
from test.support import LARGEST, SMALLEST


Expand Down Expand Up @@ -1472,18 +1473,27 @@ def testGetSupernet4(self):
self.ipv6_scoped_network.supernet(new_prefix=62))

def testHosts(self):
hosts = self.ipv4_network.hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(ipaddress.IPv4Address('1.2.3.1'), next(hosts))
hosts = list(self.ipv4_network.hosts())
self.assertEqual(254, len(hosts))
self.assertEqual(ipaddress.IPv4Address('1.2.3.1'), hosts[0])
self.assertEqual(ipaddress.IPv4Address('1.2.3.254'), hosts[-1])

ipv6_network = ipaddress.IPv6Network('2001:658:22a:cafe::/120')
hosts = ipv6_network.hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(ipaddress.IPv6Address('2001:658:22a:cafe::1'), next(hosts))
hosts = list(ipv6_network.hosts())
self.assertEqual(255, len(hosts))
self.assertEqual(ipaddress.IPv6Address('2001:658:22a:cafe::1'), hosts[0])
self.assertEqual(ipaddress.IPv6Address('2001:658:22a:cafe::ff'), hosts[-1])

ipv6_scoped_network = ipaddress.IPv6Network('2001:658:22a:cafe::%scope/120')
hosts = ipv6_scoped_network.hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual((ipaddress.IPv6Address('2001:658:22a:cafe::1')), next(hosts))
hosts = list(ipv6_scoped_network.hosts())
self.assertEqual(255, len(hosts))
self.assertEqual(ipaddress.IPv6Address('2001:658:22a:cafe::1'), hosts[0])
Expand All @@ -1494,6 +1504,12 @@ def testHosts(self):
ipaddress.IPv4Address('2.0.0.1')]
str_args = '2.0.0.0/31'
tpl_args = ('2.0.0.0', 31)
hosts = ipaddress.ip_network(str_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
hosts = ipaddress.ip_network(tpl_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
self.assertEqual(addrs, list(ipaddress.ip_network(str_args).hosts()))
self.assertEqual(addrs, list(ipaddress.ip_network(tpl_args).hosts()))
self.assertEqual(list(ipaddress.ip_network(str_args).hosts()),
Expand All @@ -1503,6 +1519,12 @@ def testHosts(self):
addrs = [ipaddress.IPv4Address('1.2.3.4')]
str_args = '1.2.3.4/32'
tpl_args = ('1.2.3.4', 32)
hosts = ipaddress.ip_network(str_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
hosts = ipaddress.ip_network(tpl_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
self.assertEqual(addrs, list(ipaddress.ip_network(str_args).hosts()))
self.assertEqual(addrs, list(ipaddress.ip_network(tpl_args).hosts()))
self.assertEqual(list(ipaddress.ip_network(str_args).hosts()),
Expand All @@ -1512,6 +1534,12 @@ def testHosts(self):
ipaddress.IPv6Address('2001:658:22a:cafe::1')]
str_args = '2001:658:22a:cafe::/127'
tpl_args = ('2001:658:22a:cafe::', 127)
hosts = ipaddress.ip_network(str_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
hosts = ipaddress.ip_network(tpl_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
self.assertEqual(addrs, list(ipaddress.ip_network(str_args).hosts()))
self.assertEqual(addrs, list(ipaddress.ip_network(tpl_args).hosts()))
self.assertEqual(list(ipaddress.ip_network(str_args).hosts()),
Expand All @@ -1520,6 +1548,12 @@ def testHosts(self):
addrs = [ipaddress.IPv6Address('2001:658:22a:cafe::1'), ]
str_args = '2001:658:22a:cafe::1/128'
tpl_args = ('2001:658:22a:cafe::1', 128)
hosts = ipaddress.ip_network(str_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
hosts = ipaddress.ip_network(tpl_args).hosts()
self.assertIsInstance(hosts, Iterator)
self.assertEqual(next(hosts), addrs[0])
self.assertEqual(addrs, list(ipaddress.ip_network(str_args).hosts()))
self.assertEqual(addrs, list(ipaddress.ip_network(tpl_args).hosts()))
self.assertEqual(list(ipaddress.ip_network(str_args).hosts()),
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Library/2025-11-14-16-24-20.gh-issue-141497.L_CxDJ.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:mod:`ipaddress`: ensure that the methods
:meth:`IPv4Network.hosts() <ipaddress.IPv4Network.hosts>` and
:meth:`IPv6Network.hosts() <ipaddress.IPv6Network.hosts>` always return an
iterator.
Loading