[issue5626] misleading comment in socket.gethostname() documentation

[Roundup Robot]

Roundup Robot added the comment:

New changeset e1a711808cfe by Berker Peksag in branch '3.5':
Issue #5626: Remove misleading comment from socket.gethostname() documentation
https://hg.python.org/cpython/rev/e1a711808cfe

New changeset 689f881dd5d1 by Berker Peksag in branch 'default':
Issue #5626: Remove misleading comment from socket.gethostname() documentation
https://hg.python.org/cpython/rev/689f881dd5d1

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Berker Peksag]

Changes by Berker Peksag :


--
resolution:  -> fixed
stage: commit review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Berker Peksag]

Berker Peksag added the comment:

I agree with Chris and Ned. I will apply issue5626_v1.diff today.

--
stage:  -> commit review
type:  -> behavior
versions: +Python 3.5, Python 3.6 -Python 2.6, Python 3.0, Python 3.1

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Ned Deily]

Ned Deily added the comment:

The point still stands that speaking of "the current machine's IP address" is 
misleading at best.  I'd say either apply Berker's suggested patch or expand 
the description to better reflect the real world of multiple interfaces.  Of 
course I'm biased.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Senthil Kumaran]

Senthil Kumaran added the comment:

Given that we have not received any more reports on users tripping up on this 
message, it seems to me that we could just ignore this report and close it. 
Thoughts?

--
nosy: +orsenthil

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Chris Angelico]

Chris Angelico added the comment:

Python doesn't currently have any sort of function for fetching all a 
computer's IPs, as far as I know, but if there is one (either now or in the 
future), it would be good to link to that from there. "Here's how to get your 
host name. And if you're interested, over there is how to get your IP 
addresses." Otherwise, removing the potentially-misleading information (this is 
going to return something in 127.0.0.0/8 for a lot of systems) seems the 
reasonable option.

--
nosy: +Rosuav

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Berker Peksag]

Changes by Berker Peksag :


--
nosy: +berker.peksag

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Berker Peksag]

Changes by Berker Peksag :


--
keywords: +patch
Added file: http://bugs.python.org/file24698/issue5626_v1.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Mark Lawrence]

Changes by Mark Lawrence :


--
assignee: georg.brandl -> d...@python
nosy: +d...@python

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue5626] misleading comment in socket.gethostname() documentation

[Ned Deily]

New submission from Ned Deily :

The documentation for socket.gethostname() contains the following 
comment:

"If you want to know the current machine’s IP address, you may want to 
use gethostbyname(gethostname()). This operation assumes that there is a 
valid address-to-host mapping for the host, and the assumption does not 
always hold."

This comment leads to the mistaken assumption that a machine has only 
one IP address, an assumption which results in bugs such as in 
Issue5625.  The comment also does not deal with other address families, 
i.e. IPv6 addresses.  Either the paragraph should be expanded to cover 
multiple addresses and families, requiring the use of other socket 
functions, or the paragraph should simply be removed.

--
assignee: georg.brandl
components: Documentation
messages: 84816
nosy: georg.brandl, nad
severity: normal
status: open
title: misleading comment in socket.gethostname() documentation
versions: Python 2.6, Python 2.7, Python 3.0, Python 3.1

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com