classification
Title: Private stdlib API: getopt, getpass, glob, gzip, genericpath, gettext
Type: Stage:
Components: Library (Lib) Versions: Python 3.4
process
Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: Nosy List: SilentGhost, brett.cannon, eric.araujo, rhettinger
Priority: low Keywords: patch

Created on 2011-01-12 13:20 by SilentGhost, last changed 2013-01-11 16:23 by brett.cannon. This issue is now closed.

Files
File name Uploaded Description Edit
getopt_api.diff SilentGhost, 2011-01-12 13:20 review
glob_api.diff SilentGhost, 2011-01-12 14:13 review
gzip_api.diff SilentGhost, 2011-01-12 15:08 review
getpass_api.diff SilentGhost, 2011-01-12 15:14 review
gettext_api.diff SilentGhost, 2011-01-12 17:31 review
Messages (7)
msg126095 - (view) Author: SilentGhost (SilentGhost) * (Python triager) Date: 2011-01-12 13:20
Module generic path is in order (added here only for completeness).

Attached patch is for getopt.
msg126099 - (view) Author: SilentGhost (SilentGhost) * (Python triager) Date: 2011-01-12 14:13
Attached patch is for glob.

While I haven't touched it, I find it strange that Doc/library/glob.rst draws special attention to the actual source code of the glob module. Since, in my view, it's pertaining to the public API, I would consider deleting that "See also" note.
msg126100 - (view) Author: SilentGhost (SilentGhost) * (Python triager) Date: 2011-01-12 14:33
Attached patch is for getpass.

Additionally, I let myself remove superfluous import.
msg126103 - (view) Author: SilentGhost (SilentGhost) * (Python triager) Date: 2011-01-12 15:08
Attached patch is for gzip.

Additionally, I had to fix import and removed two unused (?) functions. Let me know if that's inappropriate. I wasn't sure what to do about constants (all caps vars) so I left them as they were.
msg126114 - (view) Author: SilentGhost (SilentGhost) * (Python triager) Date: 2011-01-12 17:31
Attached patch is fro gettext

None of the public members of the module has any docstrings. I'm not sure that simple copying from Doc/library/gettext.rst would be satisfactory. But if it is, please let me know.
msg126123 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2011-01-12 18:44
-0

It is questionable whether this should be done at all.  Either it is irrelevant or it will break someone's code.
msg179698 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2013-01-11 16:23
While I appreciate the effort, SilentGhost, I'm going to make a call and say Raymond is right; this isn't worth the code breakage. While all new code should make sure to use the underscore prefix, proactively adding it to pre-existing code just isn't worth the risk.
History
Date User Action Args
2013-01-11 16:23:41brett.cannonsetstatus: open -> closed
resolution: wont fix
messages: + msg179698

versions: + Python 3.4, - Python 3.3
2011-01-12 18:44:43rhettingersetpriority: normal -> low
nosy: brett.cannon, rhettinger, eric.araujo, SilentGhost
messages: + msg126123
2011-01-12 17:37:04eric.araujosetnosy: + rhettinger, eric.araujo, brett.cannon
2011-01-12 17:31:15SilentGhostsetfiles: + gettext_api.diff

messages: + msg126114
2011-01-12 17:25:11benjamin.petersonlinkissue10894 dependencies
2011-01-12 15:14:45SilentGhostsetfiles: + getpass_api.diff
2011-01-12 15:14:25SilentGhostsetfiles: - getpass_api.diff
2011-01-12 15:08:59SilentGhostsetfiles: + gzip_api.diff

messages: + msg126103
2011-01-12 14:33:24SilentGhostsetfiles: + getpass_api.diff

messages: + msg126100
2011-01-12 14:13:42SilentGhostsetfiles: + glob_api.diff

messages: + msg126099
2011-01-12 13:20:59SilentGhostcreate