Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Private stdlib API: getopt, getpass, glob, gzip, genericpath, gettext #55104

Closed
SilentGhost mannequin opened this issue Jan 12, 2011 · 7 comments
Closed

Private stdlib API: getopt, getpass, glob, gzip, genericpath, gettext #55104

SilentGhost mannequin opened this issue Jan 12, 2011 · 7 comments
Labels
stdlib Python modules in the Lib dir

Comments

@SilentGhost
Copy link
Mannequin

SilentGhost mannequin commented Jan 12, 2011

BPO 10895
Nosy @brettcannon, @rhettinger, @merwok
Files
  • getopt_api.diff
  • glob_api.diff
  • gzip_api.diff
  • getpass_api.diff
  • gettext_api.diff
    		•

    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 = None
closed_at = <Date 2013-01-11.16:23:41.316>
created_at = <Date 2011-01-12.13:20:59.879>
labels = ['library']
title = 'Private stdlib API: getopt, getpass, glob, gzip, genericpath, gettext'
updated_at = <Date 2013-01-11.16:23:41.313>
user = 'https://bugs.python.org/SilentGhost'

    bugs.python.org fields:

    activity = <Date 2013-01-11.16:23:41.313>
actor = 'brett.cannon'
assignee = 'none'
closed = True
closed_date = <Date 2013-01-11.16:23:41.316>
closer = 'brett.cannon'
components = ['Library (Lib)']
creation = <Date 2011-01-12.13:20:59.879>
creator = 'SilentGhost'
dependencies = []
files = ['20365', '20366', '20371', '20372', '20379']
hgrepos = []
issue_num = 10895
keywords = ['patch']
message_count = 7.0
messages = ['126095', '126099', '126100', '126103', '126114', '126123', '179698']
nosy_count = 4.0
nosy_names = ['brett.cannon', 'rhettinger', 'eric.araujo', 'SilentGhost']
pr_nums = []
priority = 'low'
resolution = 'wont fix'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue10895'
versions = ['Python 3.4']
    @SilentGhost
    Copy link
    Mannequin Author

    SilentGhost mannequin commented Jan 12, 2011

    Module generic path is in order (added here only for completeness).

    Attached patch is for getopt.

    @SilentGhost SilentGhost mannequin added the stdlib Python modules in the Lib dir label Jan 12, 2011
    @SilentGhost
    Copy link
    Mannequin Author

    SilentGhost mannequin commented Jan 12, 2011

    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.

    @SilentGhost
    Copy link
    Mannequin Author

    SilentGhost mannequin commented Jan 12, 2011

    Attached patch is for getpass.

    Additionally, I let myself remove superfluous import.

    @SilentGhost
    Copy link
    Mannequin Author

    SilentGhost mannequin commented Jan 12, 2011

    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.

    @SilentGhost
    Copy link
    Mannequin Author

    SilentGhost mannequin commented Jan 12, 2011

    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.

    @rhettinger
    Copy link
    Contributor

    -0

    It is questionable whether this should be done at all. Either it is irrelevant or it will break someone's code.

    @brettcannon
    Copy link
    Member

    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.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    stdlib Python modules in the Lib dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @brettcannon @rhettinger