gh-141497: make `ipaddress.IP{v4,v6}Network.hosts()` return an iterator by XChaitanyaX · Pull Request #141547 · python/cpython

XChaitanyaX · 2025-11-14T05:10:35Z

Issue: Incomplete return type for ipaddress.IPv4Network.hosts() #141497

dr-carlos

A short test should be added in the relevant part(s) of test_ipaddress.py to ensure that the hosts() method always returns an iterator.

Lib/ipaddress.py

dr-carlos

The tests looks good, but this should still pass on main. Could you add similar tests for the specific cases affected by this PR?

cpython/Lib/test/test_ipaddress.py

Lines 1507 to 1510 in 17a1a05

    
           # special case where the network is a /32 
        
           addrs = [ipaddress.IPv4Address('1.2.3.4')] 
        
           str_args = '1.2.3.4/32' 
        
           tpl_args = ('1.2.3.4', 32)

cpython/Lib/test/test_ipaddress.py

Lines 1525 to 1527 in 17a1a05

    
           addrs = [ipaddress.IPv6Address('2001:658:22a:cafe::1'), ] 
        
           str_args = '2001:658:22a:cafe::1/128' 
        
           tpl_args = ('2001:658:22a:cafe::1', 128)

XChaitanyaX · 2025-11-14T13:06:15Z

but this should still pass on main

the workflow shows an error in test import, I think it is a known issue I saw it somewhere....

sharktide

LGTM

sharktide

Although we probably should re-run the failed test. It seems unrelated.

XChaitanyaX · 2025-11-15T02:45:32Z

Is there a way to rerun the workflow?? I don't see any in checks

sharktide · 2025-11-15T02:47:57Z

Is there a way to rerun the workflow?? I don't see any in checks

You can't, a core developer or official triager has to. I am not officially either. It is fine for now. They probably will when they see this PR of you haven't pushed any commits in the meantime because losing commits re-runs all tests.

sharktide

Core review? @serhiy-storchaka

Lib/test/test_ipaddress.py

Misc/NEWS.d/next/Library/2025-11-14-16-24-20.gh-issue-141497.L_CxDJ.rst

Lib/test/test_ipaddress.py

bedevere-app · 2025-11-15T09:54:17Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Lib/test/test_ipaddress.py

serhiy-storchaka

LGTM.

miss-islington-app · 2025-11-17T17:30:06Z

Thanks @XChaitanyaX for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington-app · 2025-11-17T17:30:06Z

Thanks @XChaitanyaX for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington-app · 2025-11-17T17:30:08Z

Sorry, @XChaitanyaX and @serhiy-storchaka, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 6b1bdf6c7a6c87f12a247a125e25f8e721cc731e 3.13

…ning an iterator (pythonGH-141547) (cherry picked from commit 6b1bdf6) Co-authored-by: Krishna Chaitanya <141550576+XChaitanyaX@users.noreply.github.com>

bedevere-app · 2025-11-17T17:30:18Z

GH-141673 is a backport of this pull request to the 3.14 branch.

…rning an iterator (GH-141547) (GH-141673) (cherry picked from commit 6b1bdf6) Co-authored-by: Krishna Chaitanya <141550576+XChaitanyaX@users.noreply.github.com>

XChaitanyaX · 2025-11-18T07:26:13Z

Should I make a pr for 3.13?? @serhiy-storchaka

serhiy-storchaka · 2025-11-18T07:49:01Z

If it's not too difficult for you. Otherwise, I'll do it.

bedevere-app · 2025-11-18T08:15:32Z

GH-141695 is a backport of this pull request to the 3.13 branch.

…rning an iterator (GH-141547) (GH-141695) (cherry picked from commit 6b1bdf6) Co-authored-by: Krishna Chaitanya <141550576+XChaitanyaX@users.noreply.github.com>

…ning an iterator (pythonGH-141547)

WilliamDEdwards · 2025-12-15T14:59:27Z

For other users coming across this issue: this is a breaking change.

Ran into this while upgrading a 3.11 project to 3.13. One environment uses 3.13.11 and chokes on /128s and /32s:

single_ip_address_with_cidr = '10.40.1.1/32'

    def single_ip_address_with_cidr_to_ip_address(single_ip_address_with_cidr: str) -> str:
        """Transform a single IP address with CIDR (185.233.172.0/32) to a CIDR-less version (e.g. 185.233.172.0)."""
>       return str(ipaddress.ip_network(single_ip_address_with_cidr).hosts()[0])  # type: ignore[index]
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E       TypeError: 'tuple_iterator' object is not subscriptable

... whereas another environment on 3.13.5 is fine.

picnixz · 2025-12-15T16:00:30Z

I don't think it's correct to use [0] in this case. The docs (even before this patch) say:

Returns an iterator over the usable hosts in the network

The fact that someone is using type: ignore[index] also seems to indicate that they don't want to rely on this assumption. So I would suggest you to report this to their repository instead.

make hosts an iterable

08b3c03

bedevere-app bot added the awaiting review label Nov 14, 2025

bedevere-app bot mentioned this pull request Nov 14, 2025

Incomplete return type for ipaddress.IPv4Network.hosts() #141497

Closed

dr-carlos suggested changes Nov 14, 2025

View reviewed changes

Lib/ipaddress.py Outdated Show resolved Hide resolved

bedevere-app bot added awaiting core review and removed awaiting review labels Nov 14, 2025

XChaitanyaX added 3 commits November 14, 2025 16:15

code review changes

f7c1803

tests

dd8d1f2

news entry

17a1a05

dr-carlos approved these changes Nov 14, 2025

View reviewed changes

dr-carlos suggested changes Nov 14, 2025

View reviewed changes

more tests

54043df

dr-carlos approved these changes Nov 14, 2025

View reviewed changes

sharktide approved these changes Nov 15, 2025

View reviewed changes

sharktide reviewed Nov 15, 2025

View reviewed changes

sharktide approved these changes Nov 15, 2025

View reviewed changes

serhiy-storchaka reviewed Nov 15, 2025

View reviewed changes

Lib/test/test_ipaddress.py Outdated Show resolved Hide resolved

picnixz changed the title ~~gh-141497: make hosts an iterable~~ gh-141497: make ipaddress.IPv4Network.hosts() an iterable Nov 15, 2025

picnixz changed the title ~~gh-141497: make ipaddress.IPv4Network.hosts() an iterable~~ gh-141497: make ipaddress.IP{v4,v6}Network.hosts() an iterable Nov 15, 2025

picnixz changed the title ~~gh-141497: make ipaddress.IP{v4,v6}Network.hosts() an iterable~~ gh-141497: make ipaddress.IP{v4,v6}Network.hosts() return an iterator Nov 15, 2025

picnixz previously requested changes Nov 15, 2025

View reviewed changes

bedevere-app bot removed the awaiting core review label Nov 15, 2025

bedevere-app bot added the awaiting changes label Nov 15, 2025

XChaitanyaX added 2 commits November 15, 2025 19:31

more tests

cee691a

news entry changes

5e6bf4f

XChaitanyaX requested a review from serhiy-storchaka November 15, 2025 14:03

bedevere-app bot added the awaiting core review label Nov 15, 2025

XChaitanyaX added 2 commits November 16, 2025 07:51

more tests

2bc46e7

news entry fix

3add543

XChaitanyaX requested a review from picnixz November 16, 2025 06:04

serhiy-storchaka reviewed Nov 17, 2025

View reviewed changes

tests

ccdf951

serhiy-storchaka approved these changes Nov 17, 2025

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting core review labels Nov 17, 2025

serhiy-storchaka merged commit 6b1bdf6 into python:main Nov 17, 2025
50 checks passed

bedevere-app bot removed the awaiting merge label Nov 17, 2025

serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 17, 2025

miss-islington-app bot assigned serhiy-storchaka Nov 17, 2025

bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Nov 17, 2025

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Nov 18, 2025

XChaitanyaX deleted the pr_141497 branch November 18, 2025 09:47

StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025

pythongh-141497: Make ipaddress.IP{v4,v6}Network.hosts() always retur…

70ed842

…ning an iterator (pythonGH-141547)

	# special case where the network is a /32
	addrs = [ipaddress.IPv4Address('1.2.3.4')]
	str_args = '1.2.3.4/32'
	tpl_args = ('1.2.3.4', 32)

	addrs = [ipaddress.IPv6Address('2001:658:22a:cafe::1'), ]
	str_args = '2001:658:22a:cafe::1/128'
	tpl_args = ('2001:658:22a:cafe::1', 128)

Uh oh!

Conversation

XChaitanyaX commented Nov 14, 2025 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dr-carlos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dr-carlos left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

XChaitanyaX commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sharktide left a comment

Choose a reason for hiding this comment

Uh oh!

sharktide left a comment

Choose a reason for hiding this comment

Uh oh!

XChaitanyaX commented Nov 15, 2025

Uh oh!

sharktide commented Nov 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sharktide left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-app bot commented Nov 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-app bot commented Nov 17, 2025

Uh oh!

miss-islington-app bot commented Nov 17, 2025

Uh oh!

miss-islington-app bot commented Nov 17, 2025

Uh oh!

bedevere-app bot commented Nov 17, 2025

Uh oh!

XChaitanyaX commented Nov 18, 2025

Uh oh!

serhiy-storchaka commented Nov 18, 2025

Uh oh!

bedevere-app bot commented Nov 18, 2025

Uh oh!

WilliamDEdwards commented Dec 15, 2025

Uh oh!

picnixz commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

XChaitanyaX commented Nov 14, 2025 •

edited by bedevere-app bot

Loading

dr-carlos left a comment •

edited

Loading

XChaitanyaX commented Nov 14, 2025 •

edited

Loading

sharktide commented Nov 15, 2025 •

edited

Loading

picnixz commented Dec 15, 2025 •

edited

Loading