-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Add pip completion documentation #13542
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
sepehr-rs
wants to merge
15
commits into
pypa:main
Choose a base branch
from
sepehr-rs:add-documentation
base: main
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.
+82
−0
Open
Changes from 6 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
1c9be10
Add usage to completion.py
sepehr-rs 1799410
Add pip completion documentation
sepehr-rs f422ffe
Add pip completion documentation to index.md
sepehr-rs 28ce75e
Add news entry
sepehr-rs 89a2002
Merge branch 'main' into add-documentation
sepehr-rs fd987a7
Merge branch 'main' into add-documentation
sepehr-rs 23f26cb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 3b2d24d
Update 13536.doc.rst
sepehr-rs 392f203
Update pip_completion.rst
sepehr-rs 9479bfa
Merge branch 'main' into add-documentation
sepehr-rs 7efd89e
Merge branch 'main' into add-documentation
sepehr-rs 3038a2c
Merge branch 'main' into add-documentation
sepehr-rs 9c8b02d
Update pip completion documentation
sepehr-rs e162760
Add note
sepehr-rs 3682896
Merge branch 'main' into add-documentation
sepehr-rs 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 |
---|---|---|
@@ -0,0 +1,74 @@ | ||
.. _`pip completion`: | ||
|
||
============== | ||
pip completion | ||
============== | ||
|
||
|
||
Usage | ||
===== | ||
|
||
.. tab:: Unix/macOS | ||
|
||
.. pip-command-usage:: completion "python -m pip" | ||
|
||
.. tab:: Windows | ||
|
||
.. pip-command-usage:: completion "py -m pip" | ||
|
||
|
||
Description | ||
=========== | ||
|
||
.. pip-command-description:: completion | ||
|
||
Options | ||
======= | ||
|
||
.. pip-command-options:: completion | ||
|
||
Examples | ||
======== | ||
|
||
Enable bash completion: | ||
|
||
.. code-block:: console | ||
|
||
$ python -m pip completion --bash | ||
# pip bash completion start | ||
_pip_completion() | ||
{ | ||
COMPREPLY=( $( COMP_WORDS="${COMP_WORDS[*]}" \ | ||
COMP_CWORD=$COMP_CWORD \ | ||
PIP_AUTO_COMPLETE=1 $1 2>/dev/null ) ) | ||
} | ||
complete -o default -F _pip_completion /usr/bin/python -m pip | ||
# pip bash completion end | ||
|
||
Enable PowerShell completion: | ||
|
||
.. code-block:: console | ||
|
||
> py -m pip completion --powershell | ||
if ((Test-Path Function:\\TabExpansion) -and -not ` | ||
(Test-Path Function:\\_pip_completeBackup)) {{ | ||
Rename-Item Function:\\TabExpansion _pip_completeBackup | ||
}} | ||
function TabExpansion($line, $lastWord) {{ | ||
$lastBlock = [regex]::Split($line, '[|;]')[-1].TrimStart() | ||
if ($lastBlock.StartsWith("{prog} ")) {{ | ||
$Env:COMP_WORDS=$lastBlock | ||
$Env:COMP_CWORD=$lastBlock.Split().Length - 1 | ||
$Env:PIP_AUTO_COMPLETE=1 | ||
(& {prog}).Split() | ||
Remove-Item Env:COMP_WORDS | ||
Remove-Item Env:COMP_CWORD | ||
Remove-Item Env:PIP_AUTO_COMPLETE | ||
}} | ||
elseif (Test-Path Function:\\_pip_completeBackup) {{ | ||
# Fall back on existing tab expansion | ||
_pip_completeBackup $line $lastWord | ||
}} | ||
}} | ||
|
||
|
||
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
Add `pip completion` documentation. | ||
sepehr-rs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
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
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.
Uh oh!
There was an error while loading. Please reload this page.