classification
Title: inet_aton documentation kind of lies
Type: Stage:
Components: Documentation Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: dsvensson, georg.brandl
Priority: normal Keywords:

Created on 2009-06-02 08:06 by dsvensson, last changed 2009-06-04 10:27 by georg.brandl. This issue is now closed.

Messages (2)
msg88725 - (view) Author: Daniel Svensson (dsvensson) Date: 2009-06-02 08:06
The documentation for inet_aton specifically says that it's used to
"Convert an IPv4 address from dotted-quad string format". This however
is not really true, it does accept dotted-quad, but not dotted-quad
alone, but also these forms from inet(3) man page:

       a.b.c.d   Each of the four numeric parts specifies a byte of the
address; the bytes are assigned in left-to-right order to produce the
binary address.

       a.b.c     Parts a and b specify the first two bytes of the binary
address.  Part c is interpreted as a 16-bit value that defines the
rightmost two bytes of the binary address.  This notation is suitable
for specifying (outmoded) Class B network addresses.

       a.b       Part a specifies the first byte of the binary address.
 Part b is interpreted as a 24-bit value that defines the rightmost
three bytes of the binary address.  This notation is suitable for
specifying (outmoded) Class C network addresses.

       a         The value a is interpreted as a 32-bit value that is
stored directly into the binary address without any byte rearrangement.

Sure, it references the man-page, but if anything it should say among
the formats it supports, dotted-quad is *one* of them.

http://docs.python.org/library/socket.html#socket.inet_aton
msg88877 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-06-04 10:27
Thanks, updated the docs in r73217.
History
Date User Action Args
2009-06-04 10:27:41georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg88877
2009-06-02 08:06:06dsvenssoncreate