-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
docs: add section on combining short options #3179
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.
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
Open
Ahmed-AdelB
wants to merge
3
commits into
pallets:stable
Choose a base branch
from
Ahmed-AdelB:docs/short-option-combining
base: stable
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+50
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -212,6 +212,54 @@ The multiple options format allows options to take an arbitrary number of argume | |
| invoke(commit, args=['-m', 'foo', '-m', 'bar', '-m', 'here']) | ||
| ``` | ||
|
|
||
| ## Combining Short Options | ||
|
|
||
| Short options that consist of a single character can be combined into a | ||
| single argument. For example, `-a -b -c` can be written as `-abc`. This | ||
| is standard POSIX behavior and applies to any short options, including | ||
| flags and options that take values. | ||
|
|
||
| ```{eval-rst} | ||
| .. click:example:: | ||
|
|
||
| @click.command() | ||
| @click.option('-a', is_flag=True) | ||
| @click.option('-b', is_flag=True) | ||
| @click.option('-c', is_flag=True) | ||
| def flags(a, b, c): | ||
| click.echo(f"a={a} b={b} c={c}") | ||
|
|
||
| .. click:run:: | ||
|
|
||
| invoke(flags, args=['-a', '-b', '-c']) | ||
| invoke(flags, args=['-abc']) | ||
| ``` | ||
|
|
||
| When combining options, the last option in the combination can take a | ||
| value. The value can be attached directly or passed as the next argument. | ||
|
|
||
| ```{eval-rst} | ||
| .. click:example:: | ||
|
|
||
| @click.command() | ||
| @click.option('-v', is_flag=True) | ||
| @click.option('-n', type=int) | ||
| def example(v, n): | ||
| click.echo(f"v={v} n={n}") | ||
|
|
||
| .. click:run:: | ||
|
|
||
| invoke(example, args=['-vn', '5']) | ||
| invoke(example, args=['-vn5']) | ||
| ``` | ||
|
|
||
| ```{note} | ||
| Multi-character short options are not supported. An argument like `-abc` | ||
| is always interpreted as the combination of `-a`, `-b`, and `-c`, not as | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. remove always |
||
| a single option named `-abc`. If you need longer option names, use long | ||
| options with `--` prefix instead (e.g., `--abc`). | ||
| ``` | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should read: with the |
||
|
|
||
| ## Counting | ||
|
|
||
| To count the occurrence of an option pass in `count=True`. If the option is not passed in, then the count is 0. Counting is commonly used for verbosity. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change to single short option