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

Lib/cmd.py: Hide undocumented commands in help and completenames #81211

Open
aldwinaldwin mannequin opened this issue May 24, 2019 · 6 comments
Open

Lib/cmd.py: Hide undocumented commands in help and completenames #81211

aldwinaldwin mannequin opened this issue May 24, 2019 · 6 comments
Labels
3.8 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@aldwinaldwin
Copy link
Mannequin

aldwinaldwin mannequin commented May 24, 2019

BPO 37030
Nosy @remilapeyre, @tirkarthi, @aldwinaldwin
PRs
  • bpo-37030: hide undocumented commands in cmd module #13536
    		•

    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 = None
created_at = <Date 2019-05-24.07:25:53.817>
labels = ['3.8', 'type-feature', 'library']
title = 'Lib/cmd.py: Hide undocumented commands in help and completenames'
updated_at = <Date 2019-06-07.13:34:33.567>
user = 'https://github.com/aldwinaldwin'

    bugs.python.org fields:

    activity = <Date 2019-06-07.13:34:33.567>
actor = 'aldwinaldwin'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2019-05-24.07:25:53.817>
creator = 'aldwinaldwin'
dependencies = []
files = []
hgrepos = []
issue_num = 37030
keywords = ['patch']
message_count = 6.0
messages = ['343346', '343361', '343873', '344346', '344422', '344935']
nosy_count = 3.0
nosy_names = ['remi.lapeyre', 'xtreak', 'aldwinaldwin']
pr_nums = ['13536']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue37030'
versions = ['Python 3.8']
    @aldwinaldwin
    Copy link
    Mannequin Author

    aldwinaldwin mannequin commented May 24, 2019

    A flag, defaulting to false. If true, :meth:`do_help` and :meth:`completenames` won't include undocumented commands (that is, there are do_() methods without corresponding help_() methods).

    @aldwinaldwin aldwinaldwin mannequin added 3.8 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement labels May 24, 2019
    @tirkarthi
    Copy link
    Member

    I believe this PR at least addresses the concern raised at [0] to provide a way where internal and undocumented commands can be hidden from the user.

    [0] https://bugs.python.org/issue13214#msg309788

    @aldwinaldwin
    Copy link
    Mannequin Author

    aldwinaldwin mannequin commented May 29, 2019

    The EOF mentioned in [0] is indeed the same and was the first reason why I searched in the library code for a solution. Then saw it as an opportunity to create hidden functions in the shell.

    [0] https://bugs.python.org/issue13214#msg309788

    @aldwinaldwin
    Copy link
    Mannequin Author

    aldwinaldwin mannequin commented Jun 3, 2019

    How to add a label 'awaiting core review' to pull request?

    tirkarthi: "Left comment for doc and test. But in general would like to hear from a core dev on this."

    @remilapeyre
    Copy link
    Mannequin

    remilapeyre mannequin commented Jun 3, 2019

    It will be done automatically after someone validated the PR.

    @aldwinaldwin
    Copy link
    Mannequin Author

    aldwinaldwin mannequin commented Jun 7, 2019

    Can there be a review of the PR to let me know if all changes are correct?

    @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
    3.8 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @tirkarthi