feature request: --advanced-help feature for argparse

Open
#98,664 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Start by reading the argparse feature request and the linked discussion about advanced help. Establish the intended behavior for hiding parameters from -h and exposing them through --advanced-help; the issue does not identify implementation files or tests, so those would need to be located before work can begin.

Written by the indexing model from the issue text.

Description

stdlib type-feature

Feature or enhancement

We have a complex CLI tool in python that our users use and we'd like to hide some parameters as "advanced" so
they only show w/ a --advanced-help command.

Pitch

Some parameters are useful for debugging of the script or for advanced features that most users won't care about.
It would be nice to hide these from the common parameters you can see w/ the -h output.

Previous discussion

https://discuss.python.org/t/advanced-help-for-argparse/20319

Dominant language
Python
Stars
77.2k
Forks
36k
Avg merge
1d 9h
Merged PRs (30d)
558

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/cpython

All issues in python/cpython

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.