Implement PEP 3144 (the ipaddress module)

[ncoghlan]

BPO	14814
Nosy	@birkenfeld, @terryjreedy, @ncoghlan, @giampaolo, @ezio-melotti, @merwok, @sandrotosi, @hynek, @serhiy-storchaka
Files	issue14814-ipaddress-howto.diff ipaddress_improvements.diff ipaddress-pep8-and-dead-code.diff ipaddress-pep8-and-dead-code-v2.diff fix-type-error.diff ipaddress_module_doc.diff ipaddress-refactor-and-bump-coverage.diff ipaddress-ipv6network-constructor.diff ipaddress-bytes-str.diff ipaddress-bytes-str-v6-parsing.diff ipaddr_howto.1.patch ipaddress-modernize.patch ipaddr_refdoc.1.patch ipaddr_refdoc_network.1.patch ipaddr_refdoc_network.2.patch ipaddr_refdoc_interface.1.patch ipaddr_interface.2.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/ncoghlan'
closed_at = <Date 2012-08-20.00:19:37.566>
created_at = <Date 2012-05-15.12:00:08.295>
labels = ['type-feature', 'release-blocker', 'docs']
title = 'Implement PEP 3144 (the ipaddress module)'
updated_at = <Date 2012-08-20.00:19:37.542>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2012-08-20.00:19:37.542>
actor = 'python-dev'
assignee = 'ncoghlan'
closed = True
closed_date = <Date 2012-08-20.00:19:37.566>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2012-05-15.12:00:08.295>
creator = 'ncoghlan'
dependencies = []
files = ['25654', '25675', '25694', '25702', '25775', '25800', '25824', '25829', '26210', '26211', '26612', '26620', '26621', '26626', '26643', '26736', '26754']
hgrepos = []
issue_num = 14814
keywords = ['patch']
message_count = 118.0
messages = ['160719', '161200', '161201', '161211', '161230', '161238', '161243', '161375', '161379', '161380', '161452', '161454', '161455', '161458', '161495', '161559', '161658', '161659', '161661', '161664', '161665', '161666', '161668', '161669', '161670', '161840', '162018', '162028', '162066', '162094', '162140', '162144', '162145', '162147', '162235', '162258', '162273', '162301', '162308', '162309', '162337', '162338', '162526', '163019', '163022', '163023', '163074', '163075', '163087', '163088', '163108', '163962', '163983', '164001', '164103', '164209', '164228', '164341', '164346', '164728', '164730', '164778', '164786', '164793', '164794', '164795', '164824', '164827', '164830', '164834', '164838', '164860', '164863', '164868', '164870', '164878', '164951', '164970', '164978', '165005', '165013', '165489', '166032', '166965', '166966', '166967', '166968', '166972', '166974', '166975', '166984', '166986', '166990', '166994', '167001', '167002', '167003', '167004', '167023', '167059', '167089', '167490', '167491', '167492', '167494', '167495', '167496', '167498', '167773', '167792', '167804', '167806', '167852', '168556', '168565', '168569', '168607', '168608']
nosy_count = 15.0
nosy_names = ['georg.brandl', 'terry.reedy', 'ncoghlan', 'giampaolo.rodola', 'amak', 'ezio.melotti', 'eric.araujo', 'pmoody', 'eli.bendersky', 'sandro.tosi', 'tshepang', 'python-dev', 'Ramchandra Apte', 'hynek', 'serhiy.storchaka']
pr_nums = []
priority = 'release blocker'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue14814'
versions = ['Python 3.3']

[ncoghlan]

This issue tracks the incorporation of the ipaddress module into Python 3.3.

Tasks to be completed:

• add Lib/ipaddress.py from [1]
• add Lib/test_ipaddress.py from [1]
• create module reference docs from docstrings in [1]
• add Doc/library/ipaddress.py and link from index
• create howto guide from wiki page [2]
• add Doc/howto/ipaddress.rst and link from index

[1] https://code.google.com/p/ipaddress-py/source/browse/

[2] https://code.google.com/p/ipaddr-py/wiki/Using3144

[python-dev]

New changeset 82a649047272 by Nick Coghlan in branch 'default':
Issue bpo-14814: addition of the ipaddress module (stage 1 - code and tests)
http://hg.python.org/cpython/rev/82a649047272

[ncoghlan]

Stage 1 complete - the code and tests are in (along with the other miscellaneous updates to ACKS, NEWS and What's New).

Next steps are to convert the wiki page into a HOWTO and the docstrings into a module API reference. Georg offered to help with the first pass at the latter.

The module and its test suite were the main thing I really wanted in place for the alpha 4 deadline - with the frequent updates to the online docs, we have a bit more leeway with the timing.

[RamchandraApte]

Looking at the code at http://code.google.com/p/ipaddress-py/source/browse/ipaddress.py I see a few classes which could benefit from functools.total_ordering.

[merwok]

Great to get this in the standard library!

I noticed the ipaddress module contains an unnecessary shebang. I also was under the impression that “Licensed to the PSF under a contributor agreement” was sufficient and the whole license text could be removed.

[sandrotosi]

I'm attaching a very preliminary draft of the howto, any comment is welcome. Of course, it misses several references to the API doc; I'll see if I can beat Georg and post a preliminary version of that too :)

[ncoghlan]

Review comments from Terry Reedy:
http://mail.python.org/pipermail/python-dev/2012-May/119548.html

The PEP review focused mainly on the API, Terry's comments focus on code readability and the docstrings.

[sandrotosi]

Thank Nick for pointing to Terry's review! I'm attaching here a patch addressing the points Terry highlighed. probably we should review this patch before moving forward with the API doc?

[terryjreedy]

[Agreed that spacing comments were bogus.]

As for the rest, patch looks good except for 'is is' in
+ ValueError: If the integer is is negative or...

I am glad I could help improve things a bit.
I will try to look at the how-to by tomorrow to see if I understand it.

[tshepang]

looks easy enough for me; I've marked a bunch of minor issues with the code review tool

[python-dev]

New changeset 0be296605165 by Sandro Tosi in branch 'default':
Issue bpo-14814: improve docstrings and arguments value handling, as per Terry J. Reedy's comments
http://hg.python.org/cpython/rev/0be296605165