Jonathan Dunn
10 months ago
1559 changed files with 122 additions and 269673 deletions
@ -1,247 +0,0 @@
|
||||
<# |
||||
.Synopsis |
||||
Activate a Python virtual environment for the current PowerShell session. |
||||
|
||||
.Description |
||||
Pushes the python executable for a virtual environment to the front of the |
||||
$Env:PATH environment variable and sets the prompt to signify that you are |
||||
in a Python virtual environment. Makes use of the command line switches as |
||||
well as the `pyvenv.cfg` file values present in the virtual environment. |
||||
|
||||
.Parameter VenvDir |
||||
Path to the directory that contains the virtual environment to activate. The |
||||
default value for this is the parent of the directory that the Activate.ps1 |
||||
script is located within. |
||||
|
||||
.Parameter Prompt |
||||
The prompt prefix to display when this virtual environment is activated. By |
||||
default, this prompt is the name of the virtual environment folder (VenvDir) |
||||
surrounded by parentheses and followed by a single space (ie. '(.venv) '). |
||||
|
||||
.Example |
||||
Activate.ps1 |
||||
Activates the Python virtual environment that contains the Activate.ps1 script. |
||||
|
||||
.Example |
||||
Activate.ps1 -Verbose |
||||
Activates the Python virtual environment that contains the Activate.ps1 script, |
||||
and shows extra information about the activation as it executes. |
||||
|
||||
.Example |
||||
Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv |
||||
Activates the Python virtual environment located in the specified location. |
||||
|
||||
.Example |
||||
Activate.ps1 -Prompt "MyPython" |
||||
Activates the Python virtual environment that contains the Activate.ps1 script, |
||||
and prefixes the current prompt with the specified string (surrounded in |
||||
parentheses) while the virtual environment is active. |
||||
|
||||
.Notes |
||||
On Windows, it may be required to enable this Activate.ps1 script by setting the |
||||
execution policy for the user. You can do this by issuing the following PowerShell |
||||
command: |
||||
|
||||
PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser |
||||
|
||||
For more information on Execution Policies: |
||||
https://go.microsoft.com/fwlink/?LinkID=135170 |
||||
|
||||
#> |
||||
Param( |
||||
[Parameter(Mandatory = $false)] |
||||
[String] |
||||
$VenvDir, |
||||
[Parameter(Mandatory = $false)] |
||||
[String] |
||||
$Prompt |
||||
) |
||||
|
||||
<# Function declarations --------------------------------------------------- #> |
||||
|
||||
<# |
||||
.Synopsis |
||||
Remove all shell session elements added by the Activate script, including the |
||||
addition of the virtual environment's Python executable from the beginning of |
||||
the PATH variable. |
||||
|
||||
.Parameter NonDestructive |
||||
If present, do not remove this function from the global namespace for the |
||||
session. |
||||
|
||||
#> |
||||
function global:deactivate ([switch]$NonDestructive) { |
||||
# Revert to original values |
||||
|
||||
# The prior prompt: |
||||
if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) { |
||||
Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt |
||||
Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT |
||||
} |
||||
|
||||
# The prior PYTHONHOME: |
||||
if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) { |
||||
Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME |
||||
Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME |
||||
} |
||||
|
||||
# The prior PATH: |
||||
if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) { |
||||
Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH |
||||
Remove-Item -Path Env:_OLD_VIRTUAL_PATH |
||||
} |
||||
|
||||
# Just remove the VIRTUAL_ENV altogether: |
||||
if (Test-Path -Path Env:VIRTUAL_ENV) { |
||||
Remove-Item -Path env:VIRTUAL_ENV |
||||
} |
||||
|
||||
# Just remove VIRTUAL_ENV_PROMPT altogether. |
||||
if (Test-Path -Path Env:VIRTUAL_ENV_PROMPT) { |
||||
Remove-Item -Path env:VIRTUAL_ENV_PROMPT |
||||
} |
||||
|
||||
# Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether: |
||||
if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) { |
||||
Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force |
||||
} |
||||
|
||||
# Leave deactivate function in the global namespace if requested: |
||||
if (-not $NonDestructive) { |
||||
Remove-Item -Path function:deactivate |
||||
} |
||||
} |
||||
|
||||
<# |
||||
.Description |
||||
Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the |
||||
given folder, and returns them in a map. |
||||
|
||||
For each line in the pyvenv.cfg file, if that line can be parsed into exactly |
||||
two strings separated by `=` (with any amount of whitespace surrounding the =) |
||||
then it is considered a `key = value` line. The left hand string is the key, |
||||
the right hand is the value. |
||||
|
||||
If the value starts with a `'` or a `"` then the first and last character is |
||||
stripped from the value before being captured. |
||||
|
||||
.Parameter ConfigDir |
||||
Path to the directory that contains the `pyvenv.cfg` file. |
||||
#> |
||||
function Get-PyVenvConfig( |
||||
[String] |
||||
$ConfigDir |
||||
) { |
||||
Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg" |
||||
|
||||
# Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue). |
||||
$pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue |
||||
|
||||
# An empty map will be returned if no config file is found. |
||||
$pyvenvConfig = @{ } |
||||
|
||||
if ($pyvenvConfigPath) { |
||||
|
||||
Write-Verbose "File exists, parse `key = value` lines" |
||||
$pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath |
||||
|
||||
$pyvenvConfigContent | ForEach-Object { |
||||
$keyval = $PSItem -split "\s*=\s*", 2 |
||||
if ($keyval[0] -and $keyval[1]) { |
||||
$val = $keyval[1] |
||||
|
||||
# Remove extraneous quotations around a string value. |
||||
if ("'""".Contains($val.Substring(0, 1))) { |
||||
$val = $val.Substring(1, $val.Length - 2) |
||||
} |
||||
|
||||
$pyvenvConfig[$keyval[0]] = $val |
||||
Write-Verbose "Adding Key: '$($keyval[0])'='$val'" |
||||
} |
||||
} |
||||
} |
||||
return $pyvenvConfig |
||||
} |
||||
|
||||
|
||||
<# Begin Activate script --------------------------------------------------- #> |
||||
|
||||
# Determine the containing directory of this script |
||||
$VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition |
||||
$VenvExecDir = Get-Item -Path $VenvExecPath |
||||
|
||||
Write-Verbose "Activation script is located in path: '$VenvExecPath'" |
||||
Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)" |
||||
Write-Verbose "VenvExecDir Name: '$($VenvExecDir.Name)" |
||||
|
||||
# Set values required in priority: CmdLine, ConfigFile, Default |
||||
# First, get the location of the virtual environment, it might not be |
||||
# VenvExecDir if specified on the command line. |
||||
if ($VenvDir) { |
||||
Write-Verbose "VenvDir given as parameter, using '$VenvDir' to determine values" |
||||
} |
||||
else { |
||||
Write-Verbose "VenvDir not given as a parameter, using parent directory name as VenvDir." |
||||
$VenvDir = $VenvExecDir.Parent.FullName.TrimEnd("\\/") |
||||
Write-Verbose "VenvDir=$VenvDir" |
||||
} |
||||
|
||||
# Next, read the `pyvenv.cfg` file to determine any required value such |
||||
# as `prompt`. |
||||
$pyvenvCfg = Get-PyVenvConfig -ConfigDir $VenvDir |
||||
|
||||
# Next, set the prompt from the command line, or the config file, or |
||||
# just use the name of the virtual environment folder. |
||||
if ($Prompt) { |
||||
Write-Verbose "Prompt specified as argument, using '$Prompt'" |
||||
} |
||||
else { |
||||
Write-Verbose "Prompt not specified as argument to script, checking pyvenv.cfg value" |
||||
if ($pyvenvCfg -and $pyvenvCfg['prompt']) { |
||||
Write-Verbose " Setting based on value in pyvenv.cfg='$($pyvenvCfg['prompt'])'" |
||||
$Prompt = $pyvenvCfg['prompt']; |
||||
} |
||||
else { |
||||
Write-Verbose " Setting prompt based on parent's directory's name. (Is the directory name passed to venv module when creating the virtual environment)" |
||||
Write-Verbose " Got leaf-name of $VenvDir='$(Split-Path -Path $venvDir -Leaf)'" |
||||
$Prompt = Split-Path -Path $venvDir -Leaf |
||||
} |
||||
} |
||||
|
||||
Write-Verbose "Prompt = '$Prompt'" |
||||
Write-Verbose "VenvDir='$VenvDir'" |
||||
|
||||
# Deactivate any currently active virtual environment, but leave the |
||||
# deactivate function in place. |
||||
deactivate -nondestructive |
||||
|
||||
# Now set the environment variable VIRTUAL_ENV, used by many tools to determine |
||||
# that there is an activated venv. |
||||
$env:VIRTUAL_ENV = $VenvDir |
||||
|
||||
if (-not $Env:VIRTUAL_ENV_DISABLE_PROMPT) { |
||||
|
||||
Write-Verbose "Setting prompt to '$Prompt'" |
||||
|
||||
# Set the prompt to include the env name |
||||
# Make sure _OLD_VIRTUAL_PROMPT is global |
||||
function global:_OLD_VIRTUAL_PROMPT { "" } |
||||
Copy-Item -Path function:prompt -Destination function:_OLD_VIRTUAL_PROMPT |
||||
New-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Description "Python virtual environment prompt prefix" -Scope Global -Option ReadOnly -Visibility Public -Value $Prompt |
||||
|
||||
function global:prompt { |
||||
Write-Host -NoNewline -ForegroundColor Green "($_PYTHON_VENV_PROMPT_PREFIX) " |
||||
_OLD_VIRTUAL_PROMPT |
||||
} |
||||
$env:VIRTUAL_ENV_PROMPT = $Prompt |
||||
} |
||||
|
||||
# Clear PYTHONHOME |
||||
if (Test-Path -Path Env:PYTHONHOME) { |
||||
Copy-Item -Path Env:PYTHONHOME -Destination Env:_OLD_VIRTUAL_PYTHONHOME |
||||
Remove-Item -Path Env:PYTHONHOME |
||||
} |
||||
|
||||
# Add the venv to the PATH |
||||
Copy-Item -Path Env:PATH -Destination Env:_OLD_VIRTUAL_PATH |
||||
$Env:PATH = "$VenvExecDir$([System.IO.Path]::PathSeparator)$Env:PATH" |
||||
@ -1,69 +0,0 @@
|
||||
# This file must be used with "source bin/activate" *from bash* |
||||
# you cannot run it directly |
||||
|
||||
deactivate () { |
||||
# reset old environment variables |
||||
if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then |
||||
PATH="${_OLD_VIRTUAL_PATH:-}" |
||||
export PATH |
||||
unset _OLD_VIRTUAL_PATH |
||||
fi |
||||
if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then |
||||
PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}" |
||||
export PYTHONHOME |
||||
unset _OLD_VIRTUAL_PYTHONHOME |
||||
fi |
||||
|
||||
# This should detect bash and zsh, which have a hash command that must |
||||
# be called to get it to forget past commands. Without forgetting |
||||
# past commands the $PATH changes we made may not be respected |
||||
if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then |
||||
hash -r 2> /dev/null |
||||
fi |
||||
|
||||
if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then |
||||
PS1="${_OLD_VIRTUAL_PS1:-}" |
||||
export PS1 |
||||
unset _OLD_VIRTUAL_PS1 |
||||
fi |
||||
|
||||
unset VIRTUAL_ENV |
||||
unset VIRTUAL_ENV_PROMPT |
||||
if [ ! "${1:-}" = "nondestructive" ] ; then |
||||
# Self destruct! |
||||
unset -f deactivate |
||||
fi |
||||
} |
||||
|
||||
# unset irrelevant variables |
||||
deactivate nondestructive |
||||
|
||||
VIRTUAL_ENV="/Users/daniel/Library/Mobile Documents/com~apple~CloudDocs/Development/fabric/client/.venv" |
||||
export VIRTUAL_ENV |
||||
|
||||
_OLD_VIRTUAL_PATH="$PATH" |
||||
PATH="$VIRTUAL_ENV/bin:$PATH" |
||||
export PATH |
||||
|
||||
# unset PYTHONHOME if set |
||||
# this will fail if PYTHONHOME is set to the empty string (which is bad anyway) |
||||
# could use `if (set -u; : $PYTHONHOME) ;` in bash |
||||
if [ -n "${PYTHONHOME:-}" ] ; then |
||||
_OLD_VIRTUAL_PYTHONHOME="${PYTHONHOME:-}" |
||||
unset PYTHONHOME |
||||
fi |
||||
|
||||
if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then |
||||
_OLD_VIRTUAL_PS1="${PS1:-}" |
||||
PS1="(.venv) ${PS1:-}" |
||||
export PS1 |
||||
VIRTUAL_ENV_PROMPT="(.venv) " |
||||
export VIRTUAL_ENV_PROMPT |
||||
fi |
||||
|
||||
# This should detect bash and zsh, which have a hash command that must |
||||
# be called to get it to forget past commands. Without forgetting |
||||
# past commands the $PATH changes we made may not be respected |
||||
if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then |
||||
hash -r 2> /dev/null |
||||
fi |
||||
@ -1,26 +0,0 @@
|
||||
# This file must be used with "source bin/activate.csh" *from csh*. |
||||
# You cannot run it directly. |
||||
# Created by Davide Di Blasi <davidedb@gmail.com>. |
||||
# Ported to Python 3.3 venv by Andrew Svetlov <andrew.svetlov@gmail.com> |
||||
|
||||
alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; unsetenv VIRTUAL_ENV_PROMPT; test "\!:*" != "nondestructive" && unalias deactivate' |
||||
|
||||
# Unset irrelevant variables. |
||||
deactivate nondestructive |
||||
|
||||
setenv VIRTUAL_ENV "/Users/daniel/Library/Mobile Documents/com~apple~CloudDocs/Development/fabric/client/.venv" |
||||
|
||||
set _OLD_VIRTUAL_PATH="$PATH" |
||||
setenv PATH "$VIRTUAL_ENV/bin:$PATH" |
||||
|
||||
|
||||
set _OLD_VIRTUAL_PROMPT="$prompt" |
||||
|
||||
if (! "$?VIRTUAL_ENV_DISABLE_PROMPT") then |
||||
set prompt = "(.venv) $prompt" |
||||
setenv VIRTUAL_ENV_PROMPT "(.venv) " |
||||
endif |
||||
|
||||
alias pydoc python -m pydoc |
||||
|
||||
rehash |
||||
@ -1,69 +0,0 @@
|
||||
# This file must be used with "source <venv>/bin/activate.fish" *from fish* |
||||
# (https://fishshell.com/); you cannot run it directly. |
||||
|
||||
function deactivate -d "Exit virtual environment and return to normal shell environment" |
||||
# reset old environment variables |
||||
if test -n "$_OLD_VIRTUAL_PATH" |
||||
set -gx PATH $_OLD_VIRTUAL_PATH |
||||
set -e _OLD_VIRTUAL_PATH |
||||
end |
||||
if test -n "$_OLD_VIRTUAL_PYTHONHOME" |
||||
set -gx PYTHONHOME $_OLD_VIRTUAL_PYTHONHOME |
||||
set -e _OLD_VIRTUAL_PYTHONHOME |
||||
end |
||||
|
||||
if test -n "$_OLD_FISH_PROMPT_OVERRIDE" |
||||
set -e _OLD_FISH_PROMPT_OVERRIDE |
||||
# prevents error when using nested fish instances (Issue #93858) |
||||
if functions -q _old_fish_prompt |
||||
functions -e fish_prompt |
||||
functions -c _old_fish_prompt fish_prompt |
||||
functions -e _old_fish_prompt |
||||
end |
||||
end |
||||
|
||||
set -e VIRTUAL_ENV |
||||
set -e VIRTUAL_ENV_PROMPT |
||||
if test "$argv[1]" != "nondestructive" |
||||
# Self-destruct! |
||||
functions -e deactivate |
||||
end |
||||
end |
||||
|
||||
# Unset irrelevant variables. |
||||
deactivate nondestructive |
||||
|
||||
set -gx VIRTUAL_ENV "/Users/daniel/Library/Mobile Documents/com~apple~CloudDocs/Development/fabric/client/.venv" |
||||
|
||||
set -gx _OLD_VIRTUAL_PATH $PATH |
||||
set -gx PATH "$VIRTUAL_ENV/bin" $PATH |
||||
|
||||
# Unset PYTHONHOME if set. |
||||
if set -q PYTHONHOME |
||||
set -gx _OLD_VIRTUAL_PYTHONHOME $PYTHONHOME |
||||
set -e PYTHONHOME |
||||
end |
||||
|
||||
if test -z "$VIRTUAL_ENV_DISABLE_PROMPT" |
||||
# fish uses a function instead of an env var to generate the prompt. |
||||
|
||||
# Save the current fish_prompt function as the function _old_fish_prompt. |
||||
functions -c fish_prompt _old_fish_prompt |
||||
|
||||
# With the original prompt function renamed, we can override with our own. |
||||
function fish_prompt |
||||
# Save the return status of the last command. |
||||
set -l old_status $status |
||||
|
||||
# Output the venv prompt; color taken from the blue of the Python logo. |
||||
printf "%s%s%s" (set_color 4B8BBE) "(.venv) " (set_color normal) |
||||
|
||||
# Restore the return status of the previous command. |
||||
echo "exit $old_status" | . |
||||
# Output the original/"old" prompt. |
||||
_old_fish_prompt |
||||
end |
||||
|
||||
set -gx _OLD_FISH_PROMPT_OVERRIDE "$VIRTUAL_ENV" |
||||
set -gx VIRTUAL_ENV_PROMPT "(.venv) " |
||||
end |
||||
@ -1,10 +0,0 @@
|
||||
#!/bin/sh |
||||
'''exec' "/Users/daniel/Library/Mobile Documents/com~apple~CloudDocs/Development/fabric/client/.venv/bin/python3.11" "$0" "$@" |
||||
' ''' |
||||
# -*- coding: utf-8 -*- |
||||
import re |
||||
import sys |
||||
from pip._internal.cli.main import main |
||||
if __name__ == '__main__': |
||||
sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) |
||||
sys.exit(main()) |
||||
@ -1,10 +0,0 @@
|
||||
#!/bin/sh |
||||
'''exec' "/Users/daniel/Library/Mobile Documents/com~apple~CloudDocs/Development/fabric/client/.venv/bin/python3.11" "$0" "$@" |
||||
' ''' |
||||
# -*- coding: utf-8 -*- |
||||
import re |
||||
import sys |
||||
from pip._internal.cli.main import main |
||||
if __name__ == '__main__': |
||||
sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) |
||||
sys.exit(main()) |
||||
@ -1,10 +0,0 @@
|
||||
#!/bin/sh |
||||
'''exec' "/Users/daniel/Library/Mobile Documents/com~apple~CloudDocs/Development/fabric/client/.venv/bin/python3.11" "$0" "$@" |
||||
' ''' |
||||
# -*- coding: utf-8 -*- |
||||
import re |
||||
import sys |
||||
from pip._internal.cli.main import main |
||||
if __name__ == '__main__': |
||||
sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) |
||||
sys.exit(main()) |
||||
@ -1 +0,0 @@
|
||||
/opt/homebrew/opt/python@3.11/bin/python3.11 |
||||
@ -1,227 +0,0 @@
|
||||
# don't import any costly modules |
||||
import sys |
||||
import os |
||||
|
||||
|
||||
is_pypy = '__pypy__' in sys.builtin_module_names |
||||
|
||||
|
||||
def warn_distutils_present(): |
||||
if 'distutils' not in sys.modules: |
||||
return |
||||
if is_pypy and sys.version_info < (3, 7): |
||||
# PyPy for 3.6 unconditionally imports distutils, so bypass the warning |
||||
# https://foss.heptapod.net/pypy/pypy/-/blob/be829135bc0d758997b3566062999ee8b23872b4/lib-python/3/site.py#L250 |
||||
return |
||||
import warnings |
||||
|
||||
warnings.warn( |
||||
"Distutils was imported before Setuptools, but importing Setuptools " |
||||
"also replaces the `distutils` module in `sys.modules`. This may lead " |
||||
"to undesirable behaviors or errors. To avoid these issues, avoid " |
||||
"using distutils directly, ensure that setuptools is installed in the " |
||||
"traditional way (e.g. not an editable install), and/or make sure " |
||||
"that setuptools is always imported before distutils." |
||||
) |
||||
|
||||
|
||||
def clear_distutils(): |
||||
if 'distutils' not in sys.modules: |
||||
return |
||||
import warnings |
||||
|
||||
warnings.warn("Setuptools is replacing distutils.") |
||||
mods = [ |
||||
name |
||||
for name in sys.modules |
||||
if name == "distutils" or name.startswith("distutils.") |
||||
] |
||||
for name in mods: |
||||
del sys.modules[name] |
||||
|
||||
|
||||
def enabled(): |
||||
""" |
||||
Allow selection of distutils by environment variable. |
||||
""" |
||||
which = os.environ.get('SETUPTOOLS_USE_DISTUTILS', 'local') |
||||
return which == 'local' |
||||
|
||||
|
||||
def ensure_local_distutils(): |
||||
import importlib |
||||
|
||||
clear_distutils() |
||||
|
||||
# With the DistutilsMetaFinder in place, |
||||
# perform an import to cause distutils to be |
||||
# loaded from setuptools._distutils. Ref #2906. |
||||
with shim(): |
||||
importlib.import_module('distutils') |
||||
|
||||
# check that submodules load as expected |
||||
core = importlib.import_module('distutils.core') |
||||
assert '_distutils' in core.__file__, core.__file__ |
||||
assert 'setuptools._distutils.log' not in sys.modules |
||||
|
||||
|
||||
def do_override(): |
||||
""" |
||||
Ensure that the local copy of distutils is preferred over stdlib. |
||||
|
||||
See https://github.com/pypa/setuptools/issues/417#issuecomment-392298401 |
||||
for more motivation. |
||||
""" |
||||
if enabled(): |
||||
warn_distutils_present() |
||||
ensure_local_distutils() |
||||
|
||||
|
||||
class _TrivialRe: |
||||
def __init__(self, *patterns): |
||||
self._patterns = patterns |
||||
|
||||
def match(self, string): |
||||
return all(pat in string for pat in self._patterns) |
||||
|
||||
|
||||
class DistutilsMetaFinder: |
||||
def find_spec(self, fullname, path, target=None): |
||||
# optimization: only consider top level modules and those |
||||
# found in the CPython test suite. |
||||
if path is not None and not fullname.startswith('test.'): |
||||
return |
||||
|
||||
method_name = 'spec_for_{fullname}'.format(**locals()) |
||||
method = getattr(self, method_name, lambda: None) |
||||
return method() |
||||
|
||||
def spec_for_distutils(self): |
||||
if self.is_cpython(): |
||||
return |
||||
|
||||
import importlib |
||||
import importlib.abc |
||||
import importlib.util |
||||
|
||||
try: |
||||
mod = importlib.import_module('setuptools._distutils') |
||||
except Exception: |
||||
# There are a couple of cases where setuptools._distutils |
||||
# may not be present: |
||||
# - An older Setuptools without a local distutils is |
||||
# taking precedence. Ref #2957. |
||||
# - Path manipulation during sitecustomize removes |
||||
# setuptools from the path but only after the hook |
||||
# has been loaded. Ref #2980. |
||||
# In either case, fall back to stdlib behavior. |
||||
return |
||||
|
||||
class DistutilsLoader(importlib.abc.Loader): |
||||
def create_module(self, spec): |
||||
mod.__name__ = 'distutils' |
||||
return mod |
||||
|
||||
def exec_module(self, module): |
||||
pass |
||||
|
||||
return importlib.util.spec_from_loader( |
||||
'distutils', DistutilsLoader(), origin=mod.__file__ |
||||
) |
||||
|
||||
@staticmethod |
||||
def is_cpython(): |
||||
""" |
||||
Suppress supplying distutils for CPython (build and tests). |
||||
Ref #2965 and #3007. |
||||
""" |
||||
return os.path.isfile('pybuilddir.txt') |
||||
|
||||
def spec_for_pip(self): |
||||
""" |
||||
Ensure stdlib distutils when running under pip. |
||||
See pypa/pip#8761 for rationale. |
||||
""" |
||||
if sys.version_info >= (3, 12) or self.pip_imported_during_build(): |
||||
return |
||||
clear_distutils() |
||||
self.spec_for_distutils = lambda: None |
||||
|
||||
@classmethod |
||||
def pip_imported_during_build(cls): |
||||
""" |
||||
Detect if pip is being imported in a build script. Ref #2355. |
||||
""" |
||||
import traceback |
||||
|
||||
return any( |
||||
cls.frame_file_is_setup(frame) for frame, line in traceback.walk_stack(None) |
||||
) |
||||
|
||||
@staticmethod |
||||
def frame_file_is_setup(frame): |
||||
""" |
||||
Return True if the indicated frame suggests a setup.py file. |
||||
""" |
||||
# some frames may not have __file__ (#2940) |
||||
return frame.f_globals.get('__file__', '').endswith('setup.py') |
||||
|
||||
def spec_for_sensitive_tests(self): |
||||
""" |
||||
Ensure stdlib distutils when running select tests under CPython. |
||||
|
||||
python/cpython#91169 |
||||
""" |
||||
clear_distutils() |
||||
self.spec_for_distutils = lambda: None |
||||
|
||||
sensitive_tests = ( |
||||
[ |
||||
'test.test_distutils', |
||||
'test.test_peg_generator', |
||||
'test.test_importlib', |
||||
] |
||||
if sys.version_info < (3, 10) |
||||
else [ |
||||
'test.test_distutils', |
||||
] |
||||
) |
||||
|
||||
|
||||
for name in DistutilsMetaFinder.sensitive_tests: |
||||
setattr( |
||||
DistutilsMetaFinder, |
||||
f'spec_for_{name}', |
||||
DistutilsMetaFinder.spec_for_sensitive_tests, |
||||
) |
||||
|
||||
|
||||
DISTUTILS_FINDER = DistutilsMetaFinder() |
||||
|
||||
|
||||
def add_shim(): |
||||
DISTUTILS_FINDER in sys.meta_path or insert_shim() |
||||
|
||||
|
||||
class shim: |
||||
def __enter__(self): |
||||
insert_shim() |
||||
|
||||
def __exit__(self, exc, value, tb): |
||||
_remove_shim() |
||||
|
||||
|
||||
def insert_shim(): |
||||
sys.meta_path.insert(0, DISTUTILS_FINDER) |
||||
|
||||
|
||||
def _remove_shim(): |
||||
try: |
||||
sys.meta_path.remove(DISTUTILS_FINDER) |
||||
except ValueError: |
||||
pass |
||||
|
||||
|
||||
if sys.version_info < (3, 12): |
||||
# DistutilsMetaFinder can only be disabled in Python < 3.12 (PEP 632) |
||||
remove_shim = _remove_shim |
||||
Binary file not shown.
Binary file not shown.
@ -1 +0,0 @@
|
||||
__import__('_distutils_hack').do_override() |
||||
@ -1 +0,0 @@
|
||||
import os; var = 'SETUPTOOLS_USE_DISTUTILS'; enabled = os.environ.get(var, 'local') == 'local'; enabled and __import__('_distutils_hack').add_shim(); |
||||
@ -1 +0,0 @@
|
||||
pip |
||||
@ -1,20 +0,0 @@
|
||||
Copyright (c) 2008-present The pip developers (see AUTHORS.txt file) |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
"Software"), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
@ -1,88 +0,0 @@
|
||||
Metadata-Version: 2.1 |
||||
Name: pip |
||||
Version: 23.3.1 |
||||
Summary: The PyPA recommended tool for installing Python packages. |
||||
Home-page: https://pip.pypa.io/ |
||||
Author: The pip developers |
||||
Author-email: distutils-sig@python.org |
||||
License: MIT |
||||
Project-URL: Documentation, https://pip.pypa.io |
||||
Project-URL: Source, https://github.com/pypa/pip |
||||
Project-URL: Changelog, https://pip.pypa.io/en/stable/news/ |
||||
Classifier: Development Status :: 5 - Production/Stable |
||||
Classifier: Intended Audience :: Developers |
||||
Classifier: License :: OSI Approved :: MIT License |
||||
Classifier: Topic :: Software Development :: Build Tools |
||||
Classifier: Programming Language :: Python |
||||
Classifier: Programming Language :: Python :: 3 |
||||
Classifier: Programming Language :: Python :: 3 :: Only |
||||
Classifier: Programming Language :: Python :: 3.7 |
||||
Classifier: Programming Language :: Python :: 3.8 |
||||
Classifier: Programming Language :: Python :: 3.9 |
||||
Classifier: Programming Language :: Python :: 3.10 |
||||
Classifier: Programming Language :: Python :: 3.11 |
||||
Classifier: Programming Language :: Python :: 3.12 |
||||
Classifier: Programming Language :: Python :: Implementation :: CPython |
||||
Classifier: Programming Language :: Python :: Implementation :: PyPy |
||||
Requires-Python: >=3.7 |
||||
License-File: LICENSE.txt |
||||
License-File: AUTHORS.txt |
||||
|
||||
pip - The Python Package Installer |
||||
================================== |
||||
|
||||
.. image:: https://img.shields.io/pypi/v/pip.svg |
||||
:target: https://pypi.org/project/pip/ |
||||
:alt: PyPI |
||||
|
||||
.. image:: https://img.shields.io/pypi/pyversions/pip |
||||
:target: https://pypi.org/project/pip |
||||
:alt: PyPI - Python Version |
||||
|
||||
.. image:: https://readthedocs.org/projects/pip/badge/?version=latest |
||||
:target: https://pip.pypa.io/en/latest |
||||
:alt: Documentation |
||||
|
||||
pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes. |
||||
|
||||
Please take a look at our documentation for how to install and use pip: |
||||
|
||||
* `Installation`_ |
||||
* `Usage`_ |
||||
|
||||
We release updates regularly, with a new version every 3 months. Find more details in our documentation: |
||||
|
||||
* `Release notes`_ |
||||
* `Release process`_ |
||||
|
||||
If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms: |
||||
|
||||
* `Issue tracking`_ |
||||
* `Discourse channel`_ |
||||
* `User IRC`_ |
||||
|
||||
If you want to get involved head over to GitHub to get the source code, look at our development documentation and feel free to jump on the developer mailing lists and chat rooms: |
||||
|
||||
* `GitHub page`_ |
||||
* `Development documentation`_ |
||||
* `Development IRC`_ |
||||
|
||||
Code of Conduct |
||||
--------------- |
||||
|
||||
Everyone interacting in the pip project's codebases, issue trackers, chat |
||||
rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_. |
||||
|
||||
.. _package installer: https://packaging.python.org/guides/tool-recommendations/ |
||||
.. _Python Package Index: https://pypi.org |
||||
.. _Installation: https://pip.pypa.io/en/stable/installation/ |
||||
.. _Usage: https://pip.pypa.io/en/stable/ |
||||
.. _Release notes: https://pip.pypa.io/en/stable/news.html |
||||
.. _Release process: https://pip.pypa.io/en/latest/development/release-process/ |
||||
.. _GitHub page: https://github.com/pypa/pip |
||||
.. _Development documentation: https://pip.pypa.io/en/latest/development |
||||
.. _Issue tracking: https://github.com/pypa/pip/issues |
||||
.. _Discourse channel: https://discuss.python.org/c/packaging |
||||
.. _User IRC: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa |
||||
.. _Development IRC: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa-dev |
||||
.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md |
||||
File diff suppressed because it is too large
Load Diff
@ -1,5 +0,0 @@
|
||||
Wheel-Version: 1.0 |
||||
Generator: bdist_wheel (0.41.3) |
||||
Root-Is-Purelib: true |
||||
Tag: py3-none-any |
||||
|
||||
@ -1,4 +0,0 @@
|
||||
[console_scripts] |
||||
pip = pip._internal.cli.main:main |
||||
pip3 = pip._internal.cli.main:main |
||||
pip3.11 = pip._internal.cli.main:main |
||||
@ -1 +0,0 @@
|
||||
pip |
||||
@ -1,13 +0,0 @@
|
||||
from typing import List, Optional |
||||
|
||||
__version__ = "23.3.1" |
||||
|
||||
|
||||
def main(args: Optional[List[str]] = None) -> int: |
||||
"""This is an internal API only meant for use by pip's own console scripts. |
||||
|
||||
For additional details, see https://github.com/pypa/pip/issues/7498. |
||||
""" |
||||
from pip._internal.utils.entrypoints import _wrapper |
||||
|
||||
return _wrapper(args) |
||||
@ -1,24 +0,0 @@
|
||||
import os |
||||
import sys |
||||
|
||||
# Remove '' and current working directory from the first entry |
||||
# of sys.path, if present to avoid using current directory |
||||
# in pip commands check, freeze, install, list and show, |
||||
# when invoked as python -m pip <command> |
||||
if sys.path[0] in ("", os.getcwd()): |
||||
sys.path.pop(0) |
||||
|
||||
# If we are running from a wheel, add the wheel to sys.path |
||||
# This allows the usage python pip-*.whl/pip install pip-*.whl |
||||
if __package__ == "": |
||||
# __file__ is pip-*.whl/pip/__main__.py |
||||
# first dirname call strips of '/__main__.py', second strips off '/pip' |
||||
# Resulting path is the name of the wheel itself |
||||
# Add that to sys.path so we can import pip |
||||
path = os.path.dirname(os.path.dirname(__file__)) |
||||
sys.path.insert(0, path) |
||||
|
||||
if __name__ == "__main__": |
||||
from pip._internal.cli.main import main as _main |
||||
|
||||
sys.exit(_main()) |
||||
@ -1,50 +0,0 @@
|
||||
"""Execute exactly this copy of pip, within a different environment. |
||||
|
||||
This file is named as it is, to ensure that this module can't be imported via |
||||
an import statement. |
||||
""" |
||||
|
||||
# /!\ This version compatibility check section must be Python 2 compatible. /!\ |
||||
|
||||
import sys |
||||
|
||||
# Copied from setup.py |
||||
PYTHON_REQUIRES = (3, 7) |
||||
|
||||
|
||||
def version_str(version): # type: ignore |
||||
return ".".join(str(v) for v in version) |
||||
|
||||
|
||||
if sys.version_info[:2] < PYTHON_REQUIRES: |
||||
raise SystemExit( |
||||
"This version of pip does not support python {} (requires >={}).".format( |
||||
version_str(sys.version_info[:2]), version_str(PYTHON_REQUIRES) |
||||
) |
||||
) |
||||
|
||||
# From here on, we can use Python 3 features, but the syntax must remain |
||||
# Python 2 compatible. |
||||
|
||||
import runpy # noqa: E402 |
||||
from importlib.machinery import PathFinder # noqa: E402 |
||||
from os.path import dirname # noqa: E402 |
||||
|
||||
PIP_SOURCES_ROOT = dirname(dirname(__file__)) |
||||
|
||||
|
||||
class PipImportRedirectingFinder: |
||||
@classmethod |
||||
def find_spec(self, fullname, path=None, target=None): # type: ignore |
||||
if fullname != "pip": |
||||
return None |
||||
|
||||
spec = PathFinder.find_spec(fullname, [PIP_SOURCES_ROOT], target) |
||||
assert spec, (PIP_SOURCES_ROOT, fullname) |
||||
return spec |
||||
|
||||
|
||||
sys.meta_path.insert(0, PipImportRedirectingFinder()) |
||||
|
||||
assert __name__ == "__main__", "Cannot run __pip-runner__.py as a non-main module" |
||||
runpy.run_module("pip", run_name="__main__", alter_sys=True) |
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,18 +0,0 @@
|
||||
from typing import List, Optional |
||||
|
||||
from pip._internal.utils import _log |
||||
|
||||
# init_logging() must be called before any call to logging.getLogger() |
||||
# which happens at import of most modules. |
||||
_log.init_logging() |
||||
|
||||
|
||||
def main(args: (Optional[List[str]]) = None) -> int: |
||||
"""This is preserved for old console scripts that may still be referencing |
||||
it. |
||||
|
||||
For additional details, see https://github.com/pypa/pip/issues/7498. |
||||
""" |
||||
from pip._internal.utils.entrypoints import _wrapper |
||||
|
||||
return _wrapper(args) |
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,311 +0,0 @@
|
||||
"""Build Environment used for isolation during sdist building |
||||
""" |
||||
|
||||
import logging |
||||
import os |
||||
import pathlib |
||||
import site |
||||
import sys |
||||
import textwrap |
||||
from collections import OrderedDict |
||||
from types import TracebackType |
||||
from typing import TYPE_CHECKING, Iterable, List, Optional, Set, Tuple, Type, Union |
||||
|
||||
from pip._vendor.certifi import where |
||||
from pip._vendor.packaging.requirements import Requirement |
||||
from pip._vendor.packaging.version import Version |
||||
|
||||
from pip import __file__ as pip_location |
||||
from pip._internal.cli.spinners import open_spinner |
||||
from pip._internal.locations import get_platlib, get_purelib, get_scheme |
||||
from pip._internal.metadata import get_default_environment, get_environment |
||||
from pip._internal.utils.subprocess import call_subprocess |
||||
from pip._internal.utils.temp_dir import TempDirectory, tempdir_kinds |
||||
|
||||
if TYPE_CHECKING: |
||||
from pip._internal.index.package_finder import PackageFinder |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
def _dedup(a: str, b: str) -> Union[Tuple[str], Tuple[str, str]]: |
||||
return (a, b) if a != b else (a,) |
||||
|
||||
|
||||
class _Prefix: |
||||
def __init__(self, path: str) -> None: |
||||
self.path = path |
||||
self.setup = False |
||||
scheme = get_scheme("", prefix=path) |
||||
self.bin_dir = scheme.scripts |
||||
self.lib_dirs = _dedup(scheme.purelib, scheme.platlib) |
||||
|
||||
|
||||
def get_runnable_pip() -> str: |
||||
"""Get a file to pass to a Python executable, to run the currently-running pip. |
||||
|
||||
This is used to run a pip subprocess, for installing requirements into the build |
||||
environment. |
||||
""" |
||||
source = pathlib.Path(pip_location).resolve().parent |
||||
|
||||
if not source.is_dir(): |
||||
# This would happen if someone is using pip from inside a zip file. In that |
||||
# case, we can use that directly. |
||||
return str(source) |
||||
|
||||
return os.fsdecode(source / "__pip-runner__.py") |
||||
|
||||
|
||||
def _get_system_sitepackages() -> Set[str]: |
||||
"""Get system site packages |
||||
|
||||
Usually from site.getsitepackages, |
||||
but fallback on `get_purelib()/get_platlib()` if unavailable |
||||
(e.g. in a virtualenv created by virtualenv<20) |
||||
|
||||
Returns normalized set of strings. |
||||
""" |
||||
if hasattr(site, "getsitepackages"): |
||||
system_sites = site.getsitepackages() |
||||
else: |
||||
# virtualenv < 20 overwrites site.py without getsitepackages |
||||
# fallback on get_purelib/get_platlib. |
||||
# this is known to miss things, but shouldn't in the cases |
||||
# where getsitepackages() has been removed (inside a virtualenv) |
||||
system_sites = [get_purelib(), get_platlib()] |
||||
return {os.path.normcase(path) for path in system_sites} |
||||
|
||||
|
||||
class BuildEnvironment: |
||||
"""Creates and manages an isolated environment to install build deps""" |
||||
|
||||
def __init__(self) -> None: |
||||
temp_dir = TempDirectory(kind=tempdir_kinds.BUILD_ENV, globally_managed=True) |
||||
|
||||
self._prefixes = OrderedDict( |
||||
(name, _Prefix(os.path.join(temp_dir.path, name))) |
||||
for name in ("normal", "overlay") |
||||
) |
||||
|
||||
self._bin_dirs: List[str] = [] |
||||
self._lib_dirs: List[str] = [] |
||||
for prefix in reversed(list(self._prefixes.values())): |
||||
self._bin_dirs.append(prefix.bin_dir) |
||||
self._lib_dirs.extend(prefix.lib_dirs) |
||||
|
||||
# Customize site to: |
||||
# - ensure .pth files are honored |
||||
# - prevent access to system site packages |
||||
system_sites = _get_system_sitepackages() |
||||
|
||||
self._site_dir = os.path.join(temp_dir.path, "site") |
||||
if not os.path.exists(self._site_dir): |
||||
os.mkdir(self._site_dir) |
||||
with open( |
||||
os.path.join(self._site_dir, "sitecustomize.py"), "w", encoding="utf-8" |
||||
) as fp: |
||||
fp.write( |
||||
textwrap.dedent( |
||||
""" |
||||
import os, site, sys |
||||
|
||||
# First, drop system-sites related paths. |
||||
original_sys_path = sys.path[:] |
||||
known_paths = set() |
||||
for path in {system_sites!r}: |
||||
site.addsitedir(path, known_paths=known_paths) |
||||
system_paths = set( |
||||
os.path.normcase(path) |
||||
for path in sys.path[len(original_sys_path):] |
||||
) |
||||
original_sys_path = [ |
||||
path for path in original_sys_path |
||||
if os.path.normcase(path) not in system_paths |
||||
] |
||||
sys.path = original_sys_path |
||||
|
||||
# Second, add lib directories. |
||||
# ensuring .pth file are processed. |
||||
for path in {lib_dirs!r}: |
||||
assert not path in sys.path |
||||
site.addsitedir(path) |
||||
""" |
||||
).format(system_sites=system_sites, lib_dirs=self._lib_dirs) |
||||
) |
||||
|
||||
def __enter__(self) -> None: |
||||
self._save_env = { |
||||
name: os.environ.get(name, None) |
||||
for name in ("PATH", "PYTHONNOUSERSITE", "PYTHONPATH") |
||||
} |
||||
|
||||
path = self._bin_dirs[:] |
||||
old_path = self._save_env["PATH"] |
||||
if old_path: |
||||
path.extend(old_path.split(os.pathsep)) |
||||
|
||||
pythonpath = [self._site_dir] |
||||
|
||||
os.environ.update( |
||||
{ |
||||
"PATH": os.pathsep.join(path), |
||||
"PYTHONNOUSERSITE": "1", |
||||
"PYTHONPATH": os.pathsep.join(pythonpath), |
||||
} |
||||
) |
||||
|
||||
def __exit__( |
||||
self, |
||||
exc_type: Optional[Type[BaseException]], |
||||
exc_val: Optional[BaseException], |
||||
exc_tb: Optional[TracebackType], |
||||
) -> None: |
||||
for varname, old_value in self._save_env.items(): |
||||
if old_value is None: |
||||
os.environ.pop(varname, None) |
||||
else: |
||||
os.environ[varname] = old_value |
||||
|
||||
def check_requirements( |
||||
self, reqs: Iterable[str] |
||||
) -> Tuple[Set[Tuple[str, str]], Set[str]]: |
||||
"""Return 2 sets: |
||||
- conflicting requirements: set of (installed, wanted) reqs tuples |
||||
- missing requirements: set of reqs |
||||
""" |
||||
missing = set() |
||||
conflicting = set() |
||||
if reqs: |
||||
env = ( |
||||
get_environment(self._lib_dirs) |
||||
if hasattr(self, "_lib_dirs") |
||||
else get_default_environment() |
||||
) |
||||
for req_str in reqs: |
||||
req = Requirement(req_str) |
||||
# We're explicitly evaluating with an empty extra value, since build |
||||
# environments are not provided any mechanism to select specific extras. |
||||
if req.marker is not None and not req.marker.evaluate({"extra": ""}): |
||||
continue |
||||
dist = env.get_distribution(req.name) |
||||
if not dist: |
||||
missing.add(req_str) |
||||
continue |
||||
if isinstance(dist.version, Version): |
||||
installed_req_str = f"{req.name}=={dist.version}" |
||||
else: |
||||
installed_req_str = f"{req.name}==={dist.version}" |
||||
if not req.specifier.contains(dist.version, prereleases=True): |
||||
conflicting.add((installed_req_str, req_str)) |
||||
# FIXME: Consider direct URL? |
||||
return conflicting, missing |
||||
|
||||
def install_requirements( |
||||
self, |
||||
finder: "PackageFinder", |
||||
requirements: Iterable[str], |
||||
prefix_as_string: str, |
||||
*, |
||||
kind: str, |
||||
) -> None: |
||||
prefix = self._prefixes[prefix_as_string] |
||||
assert not prefix.setup |
||||
prefix.setup = True |
||||
if not requirements: |
||||
return |
||||
self._install_requirements( |
||||
get_runnable_pip(), |
||||
finder, |
||||
requirements, |
||||
prefix, |
||||
kind=kind, |
||||
) |
||||
|
||||
@staticmethod |
||||
def _install_requirements( |
||||
pip_runnable: str, |
||||
finder: "PackageFinder", |
||||
requirements: Iterable[str], |
||||
prefix: _Prefix, |
||||
*, |
||||
kind: str, |
||||
) -> None: |
||||
args: List[str] = [ |
||||
sys.executable, |
||||
pip_runnable, |
||||
"install", |
||||
"--ignore-installed", |
||||
"--no-user", |
||||
"--prefix", |
||||
prefix.path, |
||||
"--no-warn-script-location", |
||||
] |
||||
if logger.getEffectiveLevel() <= logging.DEBUG: |
||||
args.append("-v") |
||||
for format_control in ("no_binary", "only_binary"): |
||||
formats = getattr(finder.format_control, format_control) |
||||
args.extend( |
||||
( |
||||
"--" + format_control.replace("_", "-"), |
||||
",".join(sorted(formats or {":none:"})), |
||||
) |
||||
) |
||||
|
||||
index_urls = finder.index_urls |
||||
if index_urls: |
||||
args.extend(["-i", index_urls[0]]) |
||||
for extra_index in index_urls[1:]: |
||||
args.extend(["--extra-index-url", extra_index]) |
||||
else: |
||||
args.append("--no-index") |
||||
for link in finder.find_links: |
||||
args.extend(["--find-links", link]) |
||||
|
||||
for host in finder.trusted_hosts: |
||||
args.extend(["--trusted-host", host]) |
||||
if finder.allow_all_prereleases: |
||||
args.append("--pre") |
||||
if finder.prefer_binary: |
||||
args.append("--prefer-binary") |
||||
args.append("--") |
||||
args.extend(requirements) |
||||
extra_environ = {"_PIP_STANDALONE_CERT": where()} |
||||
with open_spinner(f"Installing {kind}") as spinner: |
||||
call_subprocess( |
||||
args, |
||||
command_desc=f"pip subprocess to install {kind}", |
||||
spinner=spinner, |
||||
extra_environ=extra_environ, |
||||
) |
||||
|
||||
|
||||
class NoOpBuildEnvironment(BuildEnvironment): |
||||
"""A no-op drop-in replacement for BuildEnvironment""" |
||||
|
||||
def __init__(self) -> None: |
||||
pass |
||||
|
||||
def __enter__(self) -> None: |
||||
pass |
||||
|
||||
def __exit__( |
||||
self, |
||||
exc_type: Optional[Type[BaseException]], |
||||
exc_val: Optional[BaseException], |
||||
exc_tb: Optional[TracebackType], |
||||
) -> None: |
||||
pass |
||||
|
||||
def cleanup(self) -> None: |
||||
pass |
||||
|
||||
def install_requirements( |
||||
self, |
||||
finder: "PackageFinder", |
||||
requirements: Iterable[str], |
||||
prefix_as_string: str, |
||||
*, |
||||
kind: str, |
||||
) -> None: |
||||
raise NotImplementedError() |
||||
@ -1,290 +0,0 @@
|
||||
"""Cache Management |
||||
""" |
||||
|
||||
import hashlib |
||||
import json |
||||
import logging |
||||
import os |
||||
from pathlib import Path |
||||
from typing import Any, Dict, List, Optional |
||||
|
||||
from pip._vendor.packaging.tags import Tag, interpreter_name, interpreter_version |
||||
from pip._vendor.packaging.utils import canonicalize_name |
||||
|
||||
from pip._internal.exceptions import InvalidWheelFilename |
||||
from pip._internal.models.direct_url import DirectUrl |
||||
from pip._internal.models.link import Link |
||||
from pip._internal.models.wheel import Wheel |
||||
from pip._internal.utils.temp_dir import TempDirectory, tempdir_kinds |
||||
from pip._internal.utils.urls import path_to_url |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
ORIGIN_JSON_NAME = "origin.json" |
||||
|
||||
|
||||
def _hash_dict(d: Dict[str, str]) -> str: |
||||
"""Return a stable sha224 of a dictionary.""" |
||||
s = json.dumps(d, sort_keys=True, separators=(",", ":"), ensure_ascii=True) |
||||
return hashlib.sha224(s.encode("ascii")).hexdigest() |
||||
|
||||
|
||||
class Cache: |
||||
"""An abstract class - provides cache directories for data from links |
||||
|
||||
:param cache_dir: The root of the cache. |
||||
""" |
||||
|
||||
def __init__(self, cache_dir: str) -> None: |
||||
super().__init__() |
||||
assert not cache_dir or os.path.isabs(cache_dir) |
||||
self.cache_dir = cache_dir or None |
||||
|
||||
def _get_cache_path_parts(self, link: Link) -> List[str]: |
||||
"""Get parts of part that must be os.path.joined with cache_dir""" |
||||
|
||||
# We want to generate an url to use as our cache key, we don't want to |
||||
# just re-use the URL because it might have other items in the fragment |
||||
# and we don't care about those. |
||||
key_parts = {"url": link.url_without_fragment} |
||||
if link.hash_name is not None and link.hash is not None: |
||||
key_parts[link.hash_name] = link.hash |
||||
if link.subdirectory_fragment: |
||||
key_parts["subdirectory"] = link.subdirectory_fragment |
||||
|
||||
# Include interpreter name, major and minor version in cache key |
||||
# to cope with ill-behaved sdists that build a different wheel |
||||
# depending on the python version their setup.py is being run on, |
||||
# and don't encode the difference in compatibility tags. |
||||
# https://github.com/pypa/pip/issues/7296 |
||||
key_parts["interpreter_name"] = interpreter_name() |
||||
key_parts["interpreter_version"] = interpreter_version() |
||||
|
||||
# Encode our key url with sha224, we'll use this because it has similar |
||||
# security properties to sha256, but with a shorter total output (and |
||||
# thus less secure). However the differences don't make a lot of |
||||
# difference for our use case here. |
||||
hashed = _hash_dict(key_parts) |
||||
|
||||
# We want to nest the directories some to prevent having a ton of top |
||||
# level directories where we might run out of sub directories on some |
||||
# FS. |
||||
parts = [hashed[:2], hashed[2:4], hashed[4:6], hashed[6:]] |
||||
|
||||
return parts |
||||
|
||||
def _get_candidates(self, link: Link, canonical_package_name: str) -> List[Any]: |
||||
can_not_cache = not self.cache_dir or not canonical_package_name or not link |
||||
if can_not_cache: |
||||
return [] |
||||
|
||||
path = self.get_path_for_link(link) |
||||
if os.path.isdir(path): |
||||
return [(candidate, path) for candidate in os.listdir(path)] |
||||
return [] |
||||
|
||||
def get_path_for_link(self, link: Link) -> str: |
||||
"""Return a directory to store cached items in for link.""" |
||||
raise NotImplementedError() |
||||
|
||||
def get( |
||||
self, |
||||
link: Link, |
||||
package_name: Optional[str], |
||||
supported_tags: List[Tag], |
||||
) -> Link: |
||||
"""Returns a link to a cached item if it exists, otherwise returns the |
||||
passed link. |
||||
""" |
||||
raise NotImplementedError() |
||||
|
||||
|
||||
class SimpleWheelCache(Cache): |
||||
"""A cache of wheels for future installs.""" |
||||
|
||||
def __init__(self, cache_dir: str) -> None: |
||||
super().__init__(cache_dir) |
||||
|
||||
def get_path_for_link(self, link: Link) -> str: |
||||
"""Return a directory to store cached wheels for link |
||||
|
||||
Because there are M wheels for any one sdist, we provide a directory |
||||
to cache them in, and then consult that directory when looking up |
||||
cache hits. |
||||
|
||||
We only insert things into the cache if they have plausible version |
||||
numbers, so that we don't contaminate the cache with things that were |
||||
not unique. E.g. ./package might have dozens of installs done for it |
||||
and build a version of 0.0...and if we built and cached a wheel, we'd |
||||
end up using the same wheel even if the source has been edited. |
||||
|
||||
:param link: The link of the sdist for which this will cache wheels. |
||||
""" |
||||
parts = self._get_cache_path_parts(link) |
||||
assert self.cache_dir |
||||
# Store wheels within the root cache_dir |
||||
return os.path.join(self.cache_dir, "wheels", *parts) |
||||
|
||||
def get( |
||||
self, |
||||
link: Link, |
||||
package_name: Optional[str], |
||||
supported_tags: List[Tag], |
||||
) -> Link: |
||||
candidates = [] |
||||
|
||||
if not package_name: |
||||
return link |
||||
|
||||
canonical_package_name = canonicalize_name(package_name) |
||||
for wheel_name, wheel_dir in self._get_candidates(link, canonical_package_name): |
||||
try: |
||||
wheel = Wheel(wheel_name) |
||||
except InvalidWheelFilename: |
||||
continue |
||||
if canonicalize_name(wheel.name) != canonical_package_name: |
||||
logger.debug( |
||||
"Ignoring cached wheel %s for %s as it " |
||||
"does not match the expected distribution name %s.", |
||||
wheel_name, |
||||
link, |
||||
package_name, |
||||
) |
||||
continue |
||||
if not wheel.supported(supported_tags): |
||||
# Built for a different python/arch/etc |
||||
continue |
||||
candidates.append( |
||||
( |
||||
wheel.support_index_min(supported_tags), |
||||
wheel_name, |
||||
wheel_dir, |
||||
) |
||||
) |
||||
|
||||
if not candidates: |
||||
return link |
||||
|
||||
_, wheel_name, wheel_dir = min(candidates) |
||||
return Link(path_to_url(os.path.join(wheel_dir, wheel_name))) |
||||
|
||||
|
||||
class EphemWheelCache(SimpleWheelCache): |
||||
"""A SimpleWheelCache that creates it's own temporary cache directory""" |
||||
|
||||
def __init__(self) -> None: |
||||
self._temp_dir = TempDirectory( |
||||
kind=tempdir_kinds.EPHEM_WHEEL_CACHE, |
||||
globally_managed=True, |
||||
) |
||||
|
||||
super().__init__(self._temp_dir.path) |
||||
|
||||
|
||||
class CacheEntry: |
||||
def __init__( |
||||
self, |
||||
link: Link, |
||||
persistent: bool, |
||||
): |
||||
self.link = link |
||||
self.persistent = persistent |
||||
self.origin: Optional[DirectUrl] = None |
||||
origin_direct_url_path = Path(self.link.file_path).parent / ORIGIN_JSON_NAME |
||||
if origin_direct_url_path.exists(): |
||||
try: |
||||
self.origin = DirectUrl.from_json( |
||||
origin_direct_url_path.read_text(encoding="utf-8") |
||||
) |
||||
except Exception as e: |
||||
logger.warning( |
||||
"Ignoring invalid cache entry origin file %s for %s (%s)", |
||||
origin_direct_url_path, |
||||
link.filename, |
||||
e, |
||||
) |
||||
|
||||
|
||||
class WheelCache(Cache): |
||||
"""Wraps EphemWheelCache and SimpleWheelCache into a single Cache |
||||
|
||||
This Cache allows for gracefully degradation, using the ephem wheel cache |
||||
when a certain link is not found in the simple wheel cache first. |
||||
""" |
||||
|
||||
def __init__(self, cache_dir: str) -> None: |
||||
super().__init__(cache_dir) |
||||
self._wheel_cache = SimpleWheelCache(cache_dir) |
||||
self._ephem_cache = EphemWheelCache() |
||||
|
||||
def get_path_for_link(self, link: Link) -> str: |
||||
return self._wheel_cache.get_path_for_link(link) |
||||
|
||||
def get_ephem_path_for_link(self, link: Link) -> str: |
||||
return self._ephem_cache.get_path_for_link(link) |
||||
|
||||
def get( |
||||
self, |
||||
link: Link, |
||||
package_name: Optional[str], |
||||
supported_tags: List[Tag], |
||||
) -> Link: |
||||
cache_entry = self.get_cache_entry(link, package_name, supported_tags) |
||||
if cache_entry is None: |
||||
return link |
||||
return cache_entry.link |
||||
|
||||
def get_cache_entry( |
||||
self, |
||||
link: Link, |
||||
package_name: Optional[str], |
||||
supported_tags: List[Tag], |
||||
) -> Optional[CacheEntry]: |
||||
"""Returns a CacheEntry with a link to a cached item if it exists or |
||||
None. The cache entry indicates if the item was found in the persistent |
||||
or ephemeral cache. |
||||
""" |
||||
retval = self._wheel_cache.get( |
||||
link=link, |
||||
package_name=package_name, |
||||
supported_tags=supported_tags, |
||||
) |
||||
if retval is not link: |
||||
return CacheEntry(retval, persistent=True) |
||||
|
||||
retval = self._ephem_cache.get( |
||||
link=link, |
||||
package_name=package_name, |
||||
supported_tags=supported_tags, |
||||
) |
||||
if retval is not link: |
||||
return CacheEntry(retval, persistent=False) |
||||
|
||||
return None |
||||
|
||||
@staticmethod |
||||
def record_download_origin(cache_dir: str, download_info: DirectUrl) -> None: |
||||
origin_path = Path(cache_dir) / ORIGIN_JSON_NAME |
||||
if origin_path.exists(): |
||||
try: |
||||
origin = DirectUrl.from_json(origin_path.read_text(encoding="utf-8")) |
||||
except Exception as e: |
||||
logger.warning( |
||||
"Could not read origin file %s in cache entry (%s). " |
||||
"Will attempt to overwrite it.", |
||||
origin_path, |
||||
e, |
||||
) |
||||
else: |
||||
# TODO: use DirectUrl.equivalent when |
||||
# https://github.com/pypa/pip/pull/10564 is merged. |
||||
if origin.url != download_info.url: |
||||
logger.warning( |
||||
"Origin URL %s in cache entry %s does not match download URL " |
||||
"%s. This is likely a pip bug or a cache corruption issue. " |
||||
"Will overwrite it with the new value.", |
||||
origin.url, |
||||
cache_dir, |
||||
download_info.url, |
||||
) |
||||
origin_path.write_text(download_info.to_json(), encoding="utf-8") |
||||
@ -1,4 +0,0 @@
|
||||
"""Subpackage containing all of pip's command line interface related code |
||||
""" |
||||
|
||||
# This file intentionally does not import submodules |
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,172 +0,0 @@
|
||||
"""Logic that powers autocompletion installed by ``pip completion``. |
||||
""" |
||||
|
||||
import optparse |
||||
import os |
||||
import sys |
||||
from itertools import chain |
||||
from typing import Any, Iterable, List, Optional |
||||
|
||||
from pip._internal.cli.main_parser import create_main_parser |
||||
from pip._internal.commands import commands_dict, create_command |
||||
from pip._internal.metadata import get_default_environment |
||||
|
||||
|
||||
def autocomplete() -> None: |
||||
"""Entry Point for completion of main and subcommand options.""" |
||||
# Don't complete if user hasn't sourced bash_completion file. |
||||
if "PIP_AUTO_COMPLETE" not in os.environ: |
||||
return |
||||
cwords = os.environ["COMP_WORDS"].split()[1:] |
||||
cword = int(os.environ["COMP_CWORD"]) |
||||
try: |
||||
current = cwords[cword - 1] |
||||
except IndexError: |
||||
current = "" |
||||
|
||||
parser = create_main_parser() |
||||
subcommands = list(commands_dict) |
||||
options = [] |
||||
|
||||
# subcommand |
||||
subcommand_name: Optional[str] = None |
||||
for word in cwords: |
||||
if word in subcommands: |
||||
subcommand_name = word |
||||
break |
||||
# subcommand options |
||||
if subcommand_name is not None: |
||||
# special case: 'help' subcommand has no options |
||||
if subcommand_name == "help": |
||||
sys.exit(1) |
||||
# special case: list locally installed dists for show and uninstall |
||||
should_list_installed = not current.startswith("-") and subcommand_name in [ |
||||
"show", |
||||
"uninstall", |
||||
] |
||||
if should_list_installed: |
||||
env = get_default_environment() |
||||
lc = current.lower() |
||||
installed = [ |
||||
dist.canonical_name |
||||
for dist in env.iter_installed_distributions(local_only=True) |
||||
if dist.canonical_name.startswith(lc) |
||||
and dist.canonical_name not in cwords[1:] |
||||
] |
||||
# if there are no dists installed, fall back to option completion |
||||
if installed: |
||||
for dist in installed: |
||||
print(dist) |
||||
sys.exit(1) |
||||
|
||||
should_list_installables = ( |
||||
not current.startswith("-") and subcommand_name == "install" |
||||
) |
||||
if should_list_installables: |
||||
for path in auto_complete_paths(current, "path"): |
||||
print(path) |
||||
sys.exit(1) |
||||
|
||||
subcommand = create_command(subcommand_name) |
||||
|
||||
for opt in subcommand.parser.option_list_all: |
||||
if opt.help != optparse.SUPPRESS_HELP: |
||||
options += [ |
||||
(opt_str, opt.nargs) for opt_str in opt._long_opts + opt._short_opts |
||||
] |
||||
|
||||
# filter out previously specified options from available options |
||||
prev_opts = [x.split("=")[0] for x in cwords[1 : cword - 1]] |
||||
options = [(x, v) for (x, v) in options if x not in prev_opts] |
||||
# filter options by current input |
||||
options = [(k, v) for k, v in options if k.startswith(current)] |
||||
# get completion type given cwords and available subcommand options |
||||
completion_type = get_path_completion_type( |
||||
cwords, |
||||
cword, |
||||
subcommand.parser.option_list_all, |
||||
) |
||||
# get completion files and directories if ``completion_type`` is |
||||
# ``<file>``, ``<dir>`` or ``<path>`` |
||||
if completion_type: |
||||
paths = auto_complete_paths(current, completion_type) |
||||
options = [(path, 0) for path in paths] |
||||
for option in options: |
||||
opt_label = option[0] |
||||
# append '=' to options which require args |
||||
if option[1] and option[0][:2] == "--": |
||||
opt_label += "=" |
||||
print(opt_label) |
||||
else: |
||||
# show main parser options only when necessary |
||||
|
||||
opts = [i.option_list for i in parser.option_groups] |
||||
opts.append(parser.option_list) |
||||
flattened_opts = chain.from_iterable(opts) |
||||
if current.startswith("-"): |
||||
for opt in flattened_opts: |
||||
if opt.help != optparse.SUPPRESS_HELP: |
||||
subcommands += opt._long_opts + opt._short_opts |
||||
else: |
||||
# get completion type given cwords and all available options |
||||
completion_type = get_path_completion_type(cwords, cword, flattened_opts) |
||||
if completion_type: |
||||
subcommands = list(auto_complete_paths(current, completion_type)) |
||||
|
||||
print(" ".join([x for x in subcommands if x.startswith(current)])) |
||||
sys.exit(1) |
||||
|
||||
|
||||
def get_path_completion_type( |
||||
cwords: List[str], cword: int, opts: Iterable[Any] |
||||
) -> Optional[str]: |
||||
"""Get the type of path completion (``file``, ``dir``, ``path`` or None) |
||||
|
||||
:param cwords: same as the environmental variable ``COMP_WORDS`` |
||||
:param cword: same as the environmental variable ``COMP_CWORD`` |
||||
:param opts: The available options to check |
||||
:return: path completion type (``file``, ``dir``, ``path`` or None) |
||||
""" |
||||
if cword < 2 or not cwords[cword - 2].startswith("-"): |
||||
return None |
||||
for opt in opts: |
||||
if opt.help == optparse.SUPPRESS_HELP: |
||||
continue |
||||
for o in str(opt).split("/"): |
||||
if cwords[cword - 2].split("=")[0] == o: |
||||
if not opt.metavar or any( |
||||
x in ("path", "file", "dir") for x in opt.metavar.split("/") |
||||
): |
||||
return opt.metavar |
||||
return None |
||||
|
||||
|
||||
def auto_complete_paths(current: str, completion_type: str) -> Iterable[str]: |
||||
"""If ``completion_type`` is ``file`` or ``path``, list all regular files |
||||
and directories starting with ``current``; otherwise only list directories |
||||
starting with ``current``. |
||||
|
||||
:param current: The word to be completed |
||||
:param completion_type: path completion type(``file``, ``path`` or ``dir``) |
||||
:return: A generator of regular files and/or directories |
||||
""" |
||||
directory, filename = os.path.split(current) |
||||
current_path = os.path.abspath(directory) |
||||
# Don't complete paths if they can't be accessed |
||||
if not os.access(current_path, os.R_OK): |
||||
return |
||||
filename = os.path.normcase(filename) |
||||
# list all files that start with ``filename`` |
||||
file_list = ( |
||||
x for x in os.listdir(current_path) if os.path.normcase(x).startswith(filename) |
||||
) |
||||
for f in file_list: |
||||
opt = os.path.join(current_path, f) |
||||
comp_file = os.path.normcase(os.path.join(directory, f)) |
||||
# complete regular files when there is not ``<dir>`` after option |
||||
# complete directories when there is ``<file>``, ``<path>`` or |
||||
# ``<dir>``after option |
||||
if completion_type != "dir" and os.path.isfile(opt): |
||||
yield comp_file |
||||
elif os.path.isdir(opt): |
||||
yield os.path.join(comp_file, "") |
||||
@ -1,236 +0,0 @@
|
||||
"""Base Command class, and related routines""" |
||||
|
||||
import functools |
||||
import logging |
||||
import logging.config |
||||
import optparse |
||||
import os |
||||
import sys |
||||
import traceback |
||||
from optparse import Values |
||||
from typing import Any, Callable, List, Optional, Tuple |
||||
|
||||
from pip._vendor.rich import traceback as rich_traceback |
||||
|
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.command_context import CommandContextMixIn |
||||
from pip._internal.cli.parser import ConfigOptionParser, UpdatingDefaultsHelpFormatter |
||||
from pip._internal.cli.status_codes import ( |
||||
ERROR, |
||||
PREVIOUS_BUILD_DIR_ERROR, |
||||
UNKNOWN_ERROR, |
||||
VIRTUALENV_NOT_FOUND, |
||||
) |
||||
from pip._internal.exceptions import ( |
||||
BadCommand, |
||||
CommandError, |
||||
DiagnosticPipError, |
||||
InstallationError, |
||||
NetworkConnectionError, |
||||
PreviousBuildDirError, |
||||
UninstallationError, |
||||
) |
||||
from pip._internal.utils.filesystem import check_path_owner |
||||
from pip._internal.utils.logging import BrokenStdoutLoggingError, setup_logging |
||||
from pip._internal.utils.misc import get_prog, normalize_path |
||||
from pip._internal.utils.temp_dir import TempDirectoryTypeRegistry as TempDirRegistry |
||||
from pip._internal.utils.temp_dir import global_tempdir_manager, tempdir_registry |
||||
from pip._internal.utils.virtualenv import running_under_virtualenv |
||||
|
||||
__all__ = ["Command"] |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class Command(CommandContextMixIn): |
||||
usage: str = "" |
||||
ignore_require_venv: bool = False |
||||
|
||||
def __init__(self, name: str, summary: str, isolated: bool = False) -> None: |
||||
super().__init__() |
||||
|
||||
self.name = name |
||||
self.summary = summary |
||||
self.parser = ConfigOptionParser( |
||||
usage=self.usage, |
||||
prog=f"{get_prog()} {name}", |
||||
formatter=UpdatingDefaultsHelpFormatter(), |
||||
add_help_option=False, |
||||
name=name, |
||||
description=self.__doc__, |
||||
isolated=isolated, |
||||
) |
||||
|
||||
self.tempdir_registry: Optional[TempDirRegistry] = None |
||||
|
||||
# Commands should add options to this option group |
||||
optgroup_name = f"{self.name.capitalize()} Options" |
||||
self.cmd_opts = optparse.OptionGroup(self.parser, optgroup_name) |
||||
|
||||
# Add the general options |
||||
gen_opts = cmdoptions.make_option_group( |
||||
cmdoptions.general_group, |
||||
self.parser, |
||||
) |
||||
self.parser.add_option_group(gen_opts) |
||||
|
||||
self.add_options() |
||||
|
||||
def add_options(self) -> None: |
||||
pass |
||||
|
||||
def handle_pip_version_check(self, options: Values) -> None: |
||||
""" |
||||
This is a no-op so that commands by default do not do the pip version |
||||
check. |
||||
""" |
||||
# Make sure we do the pip version check if the index_group options |
||||
# are present. |
||||
assert not hasattr(options, "no_index") |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
raise NotImplementedError |
||||
|
||||
def parse_args(self, args: List[str]) -> Tuple[Values, List[str]]: |
||||
# factored out for testability |
||||
return self.parser.parse_args(args) |
||||
|
||||
def main(self, args: List[str]) -> int: |
||||
try: |
||||
with self.main_context(): |
||||
return self._main(args) |
||||
finally: |
||||
logging.shutdown() |
||||
|
||||
def _main(self, args: List[str]) -> int: |
||||
# We must initialize this before the tempdir manager, otherwise the |
||||
# configuration would not be accessible by the time we clean up the |
||||
# tempdir manager. |
||||
self.tempdir_registry = self.enter_context(tempdir_registry()) |
||||
# Intentionally set as early as possible so globally-managed temporary |
||||
# directories are available to the rest of the code. |
||||
self.enter_context(global_tempdir_manager()) |
||||
|
||||
options, args = self.parse_args(args) |
||||
|
||||
# Set verbosity so that it can be used elsewhere. |
||||
self.verbosity = options.verbose - options.quiet |
||||
|
||||
level_number = setup_logging( |
||||
verbosity=self.verbosity, |
||||
no_color=options.no_color, |
||||
user_log_file=options.log, |
||||
) |
||||
|
||||
always_enabled_features = set(options.features_enabled) & set( |
||||
cmdoptions.ALWAYS_ENABLED_FEATURES |
||||
) |
||||
if always_enabled_features: |
||||
logger.warning( |
||||
"The following features are always enabled: %s. ", |
||||
", ".join(sorted(always_enabled_features)), |
||||
) |
||||
|
||||
# Make sure that the --python argument isn't specified after the |
||||
# subcommand. We can tell, because if --python was specified, |
||||
# we should only reach this point if we're running in the created |
||||
# subprocess, which has the _PIP_RUNNING_IN_SUBPROCESS environment |
||||
# variable set. |
||||
if options.python and "_PIP_RUNNING_IN_SUBPROCESS" not in os.environ: |
||||
logger.critical( |
||||
"The --python option must be placed before the pip subcommand name" |
||||
) |
||||
sys.exit(ERROR) |
||||
|
||||
# TODO: Try to get these passing down from the command? |
||||
# without resorting to os.environ to hold these. |
||||
# This also affects isolated builds and it should. |
||||
|
||||
if options.no_input: |
||||
os.environ["PIP_NO_INPUT"] = "1" |
||||
|
||||
if options.exists_action: |
||||
os.environ["PIP_EXISTS_ACTION"] = " ".join(options.exists_action) |
||||
|
||||
if options.require_venv and not self.ignore_require_venv: |
||||
# If a venv is required check if it can really be found |
||||
if not running_under_virtualenv(): |
||||
logger.critical("Could not find an activated virtualenv (required).") |
||||
sys.exit(VIRTUALENV_NOT_FOUND) |
||||
|
||||
if options.cache_dir: |
||||
options.cache_dir = normalize_path(options.cache_dir) |
||||
if not check_path_owner(options.cache_dir): |
||||
logger.warning( |
||||
"The directory '%s' or its parent directory is not owned " |
||||
"or is not writable by the current user. The cache " |
||||
"has been disabled. Check the permissions and owner of " |
||||
"that directory. If executing pip with sudo, you should " |
||||
"use sudo's -H flag.", |
||||
options.cache_dir, |
||||
) |
||||
options.cache_dir = None |
||||
|
||||
def intercepts_unhandled_exc( |
||||
run_func: Callable[..., int] |
||||
) -> Callable[..., int]: |
||||
@functools.wraps(run_func) |
||||
def exc_logging_wrapper(*args: Any) -> int: |
||||
try: |
||||
status = run_func(*args) |
||||
assert isinstance(status, int) |
||||
return status |
||||
except DiagnosticPipError as exc: |
||||
logger.error("%s", exc, extra={"rich": True}) |
||||
logger.debug("Exception information:", exc_info=True) |
||||
|
||||
return ERROR |
||||
except PreviousBuildDirError as exc: |
||||
logger.critical(str(exc)) |
||||
logger.debug("Exception information:", exc_info=True) |
||||
|
||||
return PREVIOUS_BUILD_DIR_ERROR |
||||
except ( |
||||
InstallationError, |
||||
UninstallationError, |
||||
BadCommand, |
||||
NetworkConnectionError, |
||||
) as exc: |
||||
logger.critical(str(exc)) |
||||
logger.debug("Exception information:", exc_info=True) |
||||
|
||||
return ERROR |
||||
except CommandError as exc: |
||||
logger.critical("%s", exc) |
||||
logger.debug("Exception information:", exc_info=True) |
||||
|
||||
return ERROR |
||||
except BrokenStdoutLoggingError: |
||||
# Bypass our logger and write any remaining messages to |
||||
# stderr because stdout no longer works. |
||||
print("ERROR: Pipe to stdout was broken", file=sys.stderr) |
||||
if level_number <= logging.DEBUG: |
||||
traceback.print_exc(file=sys.stderr) |
||||
|
||||
return ERROR |
||||
except KeyboardInterrupt: |
||||
logger.critical("Operation cancelled by user") |
||||
logger.debug("Exception information:", exc_info=True) |
||||
|
||||
return ERROR |
||||
except BaseException: |
||||
logger.critical("Exception:", exc_info=True) |
||||
|
||||
return UNKNOWN_ERROR |
||||
|
||||
return exc_logging_wrapper |
||||
|
||||
try: |
||||
if not options.debug_mode: |
||||
run = intercepts_unhandled_exc(self.run) |
||||
else: |
||||
run = self.run |
||||
rich_traceback.install(show_locals=True) |
||||
return run(options, args) |
||||
finally: |
||||
self.handle_pip_version_check(options) |
||||
File diff suppressed because it is too large
Load Diff
@ -1,27 +0,0 @@
|
||||
from contextlib import ExitStack, contextmanager |
||||
from typing import ContextManager, Generator, TypeVar |
||||
|
||||
_T = TypeVar("_T", covariant=True) |
||||
|
||||
|
||||
class CommandContextMixIn: |
||||
def __init__(self) -> None: |
||||
super().__init__() |
||||
self._in_main_context = False |
||||
self._main_context = ExitStack() |
||||
|
||||
@contextmanager |
||||
def main_context(self) -> Generator[None, None, None]: |
||||
assert not self._in_main_context |
||||
|
||||
self._in_main_context = True |
||||
try: |
||||
with self._main_context: |
||||
yield |
||||
finally: |
||||
self._in_main_context = False |
||||
|
||||
def enter_context(self, context_provider: ContextManager[_T]) -> _T: |
||||
assert self._in_main_context |
||||
|
||||
return self._main_context.enter_context(context_provider) |
||||
@ -1,79 +0,0 @@
|
||||
"""Primary application entrypoint. |
||||
""" |
||||
import locale |
||||
import logging |
||||
import os |
||||
import sys |
||||
import warnings |
||||
from typing import List, Optional |
||||
|
||||
from pip._internal.cli.autocompletion import autocomplete |
||||
from pip._internal.cli.main_parser import parse_command |
||||
from pip._internal.commands import create_command |
||||
from pip._internal.exceptions import PipError |
||||
from pip._internal.utils import deprecation |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
# Do not import and use main() directly! Using it directly is actively |
||||
# discouraged by pip's maintainers. The name, location and behavior of |
||||
# this function is subject to change, so calling it directly is not |
||||
# portable across different pip versions. |
||||
|
||||
# In addition, running pip in-process is unsupported and unsafe. This is |
||||
# elaborated in detail at |
||||
# https://pip.pypa.io/en/stable/user_guide/#using-pip-from-your-program. |
||||
# That document also provides suggestions that should work for nearly |
||||
# all users that are considering importing and using main() directly. |
||||
|
||||
# However, we know that certain users will still want to invoke pip |
||||
# in-process. If you understand and accept the implications of using pip |
||||
# in an unsupported manner, the best approach is to use runpy to avoid |
||||
# depending on the exact location of this entry point. |
||||
|
||||
# The following example shows how to use runpy to invoke pip in that |
||||
# case: |
||||
# |
||||
# sys.argv = ["pip", your, args, here] |
||||
# runpy.run_module("pip", run_name="__main__") |
||||
# |
||||
# Note that this will exit the process after running, unlike a direct |
||||
# call to main. As it is not safe to do any processing after calling |
||||
# main, this should not be an issue in practice. |
||||
|
||||
|
||||
def main(args: Optional[List[str]] = None) -> int: |
||||
if args is None: |
||||
args = sys.argv[1:] |
||||
|
||||
# Suppress the pkg_resources deprecation warning |
||||
# Note - we use a module of .*pkg_resources to cover |
||||
# the normal case (pip._vendor.pkg_resources) and the |
||||
# devendored case (a bare pkg_resources) |
||||
warnings.filterwarnings( |
||||
action="ignore", category=DeprecationWarning, module=".*pkg_resources" |
||||
) |
||||
|
||||
# Configure our deprecation warnings to be sent through loggers |
||||
deprecation.install_warning_logger() |
||||
|
||||
autocomplete() |
||||
|
||||
try: |
||||
cmd_name, cmd_args = parse_command(args) |
||||
except PipError as exc: |
||||
sys.stderr.write(f"ERROR: {exc}") |
||||
sys.stderr.write(os.linesep) |
||||
sys.exit(1) |
||||
|
||||
# Needed for locale.getpreferredencoding(False) to work |
||||
# in pip._internal.utils.encoding.auto_decode |
||||
try: |
||||
locale.setlocale(locale.LC_ALL, "") |
||||
except locale.Error as e: |
||||
# setlocale can apparently crash if locale are uninitialized |
||||
logger.debug("Ignoring error %s when setting locale", e) |
||||
command = create_command(cmd_name, isolated=("--isolated" in cmd_args)) |
||||
|
||||
return command.main(cmd_args) |
||||
@ -1,134 +0,0 @@
|
||||
"""A single place for constructing and exposing the main parser |
||||
""" |
||||
|
||||
import os |
||||
import subprocess |
||||
import sys |
||||
from typing import List, Optional, Tuple |
||||
|
||||
from pip._internal.build_env import get_runnable_pip |
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.parser import ConfigOptionParser, UpdatingDefaultsHelpFormatter |
||||
from pip._internal.commands import commands_dict, get_similar_commands |
||||
from pip._internal.exceptions import CommandError |
||||
from pip._internal.utils.misc import get_pip_version, get_prog |
||||
|
||||
__all__ = ["create_main_parser", "parse_command"] |
||||
|
||||
|
||||
def create_main_parser() -> ConfigOptionParser: |
||||
"""Creates and returns the main parser for pip's CLI""" |
||||
|
||||
parser = ConfigOptionParser( |
||||
usage="\n%prog <command> [options]", |
||||
add_help_option=False, |
||||
formatter=UpdatingDefaultsHelpFormatter(), |
||||
name="global", |
||||
prog=get_prog(), |
||||
) |
||||
parser.disable_interspersed_args() |
||||
|
||||
parser.version = get_pip_version() |
||||
|
||||
# add the general options |
||||
gen_opts = cmdoptions.make_option_group(cmdoptions.general_group, parser) |
||||
parser.add_option_group(gen_opts) |
||||
|
||||
# so the help formatter knows |
||||
parser.main = True # type: ignore |
||||
|
||||
# create command listing for description |
||||
description = [""] + [ |
||||
f"{name:27} {command_info.summary}" |
||||
for name, command_info in commands_dict.items() |
||||
] |
||||
parser.description = "\n".join(description) |
||||
|
||||
return parser |
||||
|
||||
|
||||
def identify_python_interpreter(python: str) -> Optional[str]: |
||||
# If the named file exists, use it. |
||||
# If it's a directory, assume it's a virtual environment and |
||||
# look for the environment's Python executable. |
||||
if os.path.exists(python): |
||||
if os.path.isdir(python): |
||||
# bin/python for Unix, Scripts/python.exe for Windows |
||||
# Try both in case of odd cases like cygwin. |
||||
for exe in ("bin/python", "Scripts/python.exe"): |
||||
py = os.path.join(python, exe) |
||||
if os.path.exists(py): |
||||
return py |
||||
else: |
||||
return python |
||||
|
||||
# Could not find the interpreter specified |
||||
return None |
||||
|
||||
|
||||
def parse_command(args: List[str]) -> Tuple[str, List[str]]: |
||||
parser = create_main_parser() |
||||
|
||||
# Note: parser calls disable_interspersed_args(), so the result of this |
||||
# call is to split the initial args into the general options before the |
||||
# subcommand and everything else. |
||||
# For example: |
||||
# args: ['--timeout=5', 'install', '--user', 'INITools'] |
||||
# general_options: ['--timeout==5'] |
||||
# args_else: ['install', '--user', 'INITools'] |
||||
general_options, args_else = parser.parse_args(args) |
||||
|
||||
# --python |
||||
if general_options.python and "_PIP_RUNNING_IN_SUBPROCESS" not in os.environ: |
||||
# Re-invoke pip using the specified Python interpreter |
||||
interpreter = identify_python_interpreter(general_options.python) |
||||
if interpreter is None: |
||||
raise CommandError( |
||||
f"Could not locate Python interpreter {general_options.python}" |
||||
) |
||||
|
||||
pip_cmd = [ |
||||
interpreter, |
||||
get_runnable_pip(), |
||||
] |
||||
pip_cmd.extend(args) |
||||
|
||||
# Set a flag so the child doesn't re-invoke itself, causing |
||||
# an infinite loop. |
||||
os.environ["_PIP_RUNNING_IN_SUBPROCESS"] = "1" |
||||
returncode = 0 |
||||
try: |
||||
proc = subprocess.run(pip_cmd) |
||||
returncode = proc.returncode |
||||
except (subprocess.SubprocessError, OSError) as exc: |
||||
raise CommandError(f"Failed to run pip under {interpreter}: {exc}") |
||||
sys.exit(returncode) |
||||
|
||||
# --version |
||||
if general_options.version: |
||||
sys.stdout.write(parser.version) |
||||
sys.stdout.write(os.linesep) |
||||
sys.exit() |
||||
|
||||
# pip || pip help -> print_help() |
||||
if not args_else or (args_else[0] == "help" and len(args_else) == 1): |
||||
parser.print_help() |
||||
sys.exit() |
||||
|
||||
# the subcommand name |
||||
cmd_name = args_else[0] |
||||
|
||||
if cmd_name not in commands_dict: |
||||
guess = get_similar_commands(cmd_name) |
||||
|
||||
msg = [f'unknown command "{cmd_name}"'] |
||||
if guess: |
||||
msg.append(f'maybe you meant "{guess}"') |
||||
|
||||
raise CommandError(" - ".join(msg)) |
||||
|
||||
# all the args without the subcommand |
||||
cmd_args = args[:] |
||||
cmd_args.remove(cmd_name) |
||||
|
||||
return cmd_name, cmd_args |
||||
@ -1,294 +0,0 @@
|
||||
"""Base option parser setup""" |
||||
|
||||
import logging |
||||
import optparse |
||||
import shutil |
||||
import sys |
||||
import textwrap |
||||
from contextlib import suppress |
||||
from typing import Any, Dict, Generator, List, Tuple |
||||
|
||||
from pip._internal.cli.status_codes import UNKNOWN_ERROR |
||||
from pip._internal.configuration import Configuration, ConfigurationError |
||||
from pip._internal.utils.misc import redact_auth_from_url, strtobool |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class PrettyHelpFormatter(optparse.IndentedHelpFormatter): |
||||
"""A prettier/less verbose help formatter for optparse.""" |
||||
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None: |
||||
# help position must be aligned with __init__.parseopts.description |
||||
kwargs["max_help_position"] = 30 |
||||
kwargs["indent_increment"] = 1 |
||||
kwargs["width"] = shutil.get_terminal_size()[0] - 2 |
||||
super().__init__(*args, **kwargs) |
||||
|
||||
def format_option_strings(self, option: optparse.Option) -> str: |
||||
return self._format_option_strings(option) |
||||
|
||||
def _format_option_strings( |
||||
self, option: optparse.Option, mvarfmt: str = " <{}>", optsep: str = ", " |
||||
) -> str: |
||||
""" |
||||
Return a comma-separated list of option strings and metavars. |
||||
|
||||
:param option: tuple of (short opt, long opt), e.g: ('-f', '--format') |
||||
:param mvarfmt: metavar format string |
||||
:param optsep: separator |
||||
""" |
||||
opts = [] |
||||
|
||||
if option._short_opts: |
||||
opts.append(option._short_opts[0]) |
||||
if option._long_opts: |
||||
opts.append(option._long_opts[0]) |
||||
if len(opts) > 1: |
||||
opts.insert(1, optsep) |
||||
|
||||
if option.takes_value(): |
||||
assert option.dest is not None |
||||
metavar = option.metavar or option.dest.lower() |
||||
opts.append(mvarfmt.format(metavar.lower())) |
||||
|
||||
return "".join(opts) |
||||
|
||||
def format_heading(self, heading: str) -> str: |
||||
if heading == "Options": |
||||
return "" |
||||
return heading + ":\n" |
||||
|
||||
def format_usage(self, usage: str) -> str: |
||||
""" |
||||
Ensure there is only one newline between usage and the first heading |
||||
if there is no description. |
||||
""" |
||||
msg = "\nUsage: {}\n".format(self.indent_lines(textwrap.dedent(usage), " ")) |
||||
return msg |
||||
|
||||
def format_description(self, description: str) -> str: |
||||
# leave full control over description to us |
||||
if description: |
||||
if hasattr(self.parser, "main"): |
||||
label = "Commands" |
||||
else: |
||||
label = "Description" |
||||
# some doc strings have initial newlines, some don't |
||||
description = description.lstrip("\n") |
||||
# some doc strings have final newlines and spaces, some don't |
||||
description = description.rstrip() |
||||
# dedent, then reindent |
||||
description = self.indent_lines(textwrap.dedent(description), " ") |
||||
description = f"{label}:\n{description}\n" |
||||
return description |
||||
else: |
||||
return "" |
||||
|
||||
def format_epilog(self, epilog: str) -> str: |
||||
# leave full control over epilog to us |
||||
if epilog: |
||||
return epilog |
||||
else: |
||||
return "" |
||||
|
||||
def indent_lines(self, text: str, indent: str) -> str: |
||||
new_lines = [indent + line for line in text.split("\n")] |
||||
return "\n".join(new_lines) |
||||
|
||||
|
||||
class UpdatingDefaultsHelpFormatter(PrettyHelpFormatter): |
||||
"""Custom help formatter for use in ConfigOptionParser. |
||||
|
||||
This is updates the defaults before expanding them, allowing |
||||
them to show up correctly in the help listing. |
||||
|
||||
Also redact auth from url type options |
||||
""" |
||||
|
||||
def expand_default(self, option: optparse.Option) -> str: |
||||
default_values = None |
||||
if self.parser is not None: |
||||
assert isinstance(self.parser, ConfigOptionParser) |
||||
self.parser._update_defaults(self.parser.defaults) |
||||
assert option.dest is not None |
||||
default_values = self.parser.defaults.get(option.dest) |
||||
help_text = super().expand_default(option) |
||||
|
||||
if default_values and option.metavar == "URL": |
||||
if isinstance(default_values, str): |
||||
default_values = [default_values] |
||||
|
||||
# If its not a list, we should abort and just return the help text |
||||
if not isinstance(default_values, list): |
||||
default_values = [] |
||||
|
||||
for val in default_values: |
||||
help_text = help_text.replace(val, redact_auth_from_url(val)) |
||||
|
||||
return help_text |
||||
|
||||
|
||||
class CustomOptionParser(optparse.OptionParser): |
||||
def insert_option_group( |
||||
self, idx: int, *args: Any, **kwargs: Any |
||||
) -> optparse.OptionGroup: |
||||
"""Insert an OptionGroup at a given position.""" |
||||
group = self.add_option_group(*args, **kwargs) |
||||
|
||||
self.option_groups.pop() |
||||
self.option_groups.insert(idx, group) |
||||
|
||||
return group |
||||
|
||||
@property |
||||
def option_list_all(self) -> List[optparse.Option]: |
||||
"""Get a list of all options, including those in option groups.""" |
||||
res = self.option_list[:] |
||||
for i in self.option_groups: |
||||
res.extend(i.option_list) |
||||
|
||||
return res |
||||
|
||||
|
||||
class ConfigOptionParser(CustomOptionParser): |
||||
"""Custom option parser which updates its defaults by checking the |
||||
configuration files and environmental variables""" |
||||
|
||||
def __init__( |
||||
self, |
||||
*args: Any, |
||||
name: str, |
||||
isolated: bool = False, |
||||
**kwargs: Any, |
||||
) -> None: |
||||
self.name = name |
||||
self.config = Configuration(isolated) |
||||
|
||||
assert self.name |
||||
super().__init__(*args, **kwargs) |
||||
|
||||
def check_default(self, option: optparse.Option, key: str, val: Any) -> Any: |
||||
try: |
||||
return option.check_value(key, val) |
||||
except optparse.OptionValueError as exc: |
||||
print(f"An error occurred during configuration: {exc}") |
||||
sys.exit(3) |
||||
|
||||
def _get_ordered_configuration_items( |
||||
self, |
||||
) -> Generator[Tuple[str, Any], None, None]: |
||||
# Configuration gives keys in an unordered manner. Order them. |
||||
override_order = ["global", self.name, ":env:"] |
||||
|
||||
# Pool the options into different groups |
||||
section_items: Dict[str, List[Tuple[str, Any]]] = { |
||||
name: [] for name in override_order |
||||
} |
||||
for section_key, val in self.config.items(): |
||||
# ignore empty values |
||||
if not val: |
||||
logger.debug( |
||||
"Ignoring configuration key '%s' as it's value is empty.", |
||||
section_key, |
||||
) |
||||
continue |
||||
|
||||
section, key = section_key.split(".", 1) |
||||
if section in override_order: |
||||
section_items[section].append((key, val)) |
||||
|
||||
# Yield each group in their override order |
||||
for section in override_order: |
||||
for key, val in section_items[section]: |
||||
yield key, val |
||||
|
||||
def _update_defaults(self, defaults: Dict[str, Any]) -> Dict[str, Any]: |
||||
"""Updates the given defaults with values from the config files and |
||||
the environ. Does a little special handling for certain types of |
||||
options (lists).""" |
||||
|
||||
# Accumulate complex default state. |
||||
self.values = optparse.Values(self.defaults) |
||||
late_eval = set() |
||||
# Then set the options with those values |
||||
for key, val in self._get_ordered_configuration_items(): |
||||
# '--' because configuration supports only long names |
||||
option = self.get_option("--" + key) |
||||
|
||||
# Ignore options not present in this parser. E.g. non-globals put |
||||
# in [global] by users that want them to apply to all applicable |
||||
# commands. |
||||
if option is None: |
||||
continue |
||||
|
||||
assert option.dest is not None |
||||
|
||||
if option.action in ("store_true", "store_false"): |
||||
try: |
||||
val = strtobool(val) |
||||
except ValueError: |
||||
self.error( |
||||
"{} is not a valid value for {} option, " |
||||
"please specify a boolean value like yes/no, " |
||||
"true/false or 1/0 instead.".format(val, key) |
||||
) |
||||
elif option.action == "count": |
||||
with suppress(ValueError): |
||||
val = strtobool(val) |
||||
with suppress(ValueError): |
||||
val = int(val) |
||||
if not isinstance(val, int) or val < 0: |
||||
self.error( |
||||
"{} is not a valid value for {} option, " |
||||
"please instead specify either a non-negative integer " |
||||
"or a boolean value like yes/no or false/true " |
||||
"which is equivalent to 1/0.".format(val, key) |
||||
) |
||||
elif option.action == "append": |
||||
val = val.split() |
||||
val = [self.check_default(option, key, v) for v in val] |
||||
elif option.action == "callback": |
||||
assert option.callback is not None |
||||
late_eval.add(option.dest) |
||||
opt_str = option.get_opt_string() |
||||
val = option.convert_value(opt_str, val) |
||||
# From take_action |
||||
args = option.callback_args or () |
||||
kwargs = option.callback_kwargs or {} |
||||
option.callback(option, opt_str, val, self, *args, **kwargs) |
||||
else: |
||||
val = self.check_default(option, key, val) |
||||
|
||||
defaults[option.dest] = val |
||||
|
||||
for key in late_eval: |
||||
defaults[key] = getattr(self.values, key) |
||||
self.values = None |
||||
return defaults |
||||
|
||||
def get_default_values(self) -> optparse.Values: |
||||
"""Overriding to make updating the defaults after instantiation of |
||||
the option parser possible, _update_defaults() does the dirty work.""" |
||||
if not self.process_default_values: |
||||
# Old, pre-Optik 1.5 behaviour. |
||||
return optparse.Values(self.defaults) |
||||
|
||||
# Load the configuration, or error out in case of an error |
||||
try: |
||||
self.config.load() |
||||
except ConfigurationError as err: |
||||
self.exit(UNKNOWN_ERROR, str(err)) |
||||
|
||||
defaults = self._update_defaults(self.defaults.copy()) # ours |
||||
for option in self._get_all_options(): |
||||
assert option.dest is not None |
||||
default = defaults.get(option.dest) |
||||
if isinstance(default, str): |
||||
opt_str = option.get_opt_string() |
||||
defaults[option.dest] = option.check_value(opt_str, default) |
||||
return optparse.Values(defaults) |
||||
|
||||
def error(self, msg: str) -> None: |
||||
self.print_usage(sys.stderr) |
||||
self.exit(UNKNOWN_ERROR, f"{msg}\n") |
||||
@ -1,68 +0,0 @@
|
||||
import functools |
||||
from typing import Callable, Generator, Iterable, Iterator, Optional, Tuple |
||||
|
||||
from pip._vendor.rich.progress import ( |
||||
BarColumn, |
||||
DownloadColumn, |
||||
FileSizeColumn, |
||||
Progress, |
||||
ProgressColumn, |
||||
SpinnerColumn, |
||||
TextColumn, |
||||
TimeElapsedColumn, |
||||
TimeRemainingColumn, |
||||
TransferSpeedColumn, |
||||
) |
||||
|
||||
from pip._internal.utils.logging import get_indentation |
||||
|
||||
DownloadProgressRenderer = Callable[[Iterable[bytes]], Iterator[bytes]] |
||||
|
||||
|
||||
def _rich_progress_bar( |
||||
iterable: Iterable[bytes], |
||||
*, |
||||
bar_type: str, |
||||
size: int, |
||||
) -> Generator[bytes, None, None]: |
||||
assert bar_type == "on", "This should only be used in the default mode." |
||||
|
||||
if not size: |
||||
total = float("inf") |
||||
columns: Tuple[ProgressColumn, ...] = ( |
||||
TextColumn("[progress.description]{task.description}"), |
||||
SpinnerColumn("line", speed=1.5), |
||||
FileSizeColumn(), |
||||
TransferSpeedColumn(), |
||||
TimeElapsedColumn(), |
||||
) |
||||
else: |
||||
total = size |
||||
columns = ( |
||||
TextColumn("[progress.description]{task.description}"), |
||||
BarColumn(), |
||||
DownloadColumn(), |
||||
TransferSpeedColumn(), |
||||
TextColumn("eta"), |
||||
TimeRemainingColumn(), |
||||
) |
||||
|
||||
progress = Progress(*columns, refresh_per_second=30) |
||||
task_id = progress.add_task(" " * (get_indentation() + 2), total=total) |
||||
with progress: |
||||
for chunk in iterable: |
||||
yield chunk |
||||
progress.update(task_id, advance=len(chunk)) |
||||
|
||||
|
||||
def get_download_progress_renderer( |
||||
*, bar_type: str, size: Optional[int] = None |
||||
) -> DownloadProgressRenderer: |
||||
"""Get an object that can be used to render the download progress. |
||||
|
||||
Returns a callable, that takes an iterable to "wrap". |
||||
""" |
||||
if bar_type == "on": |
||||
return functools.partial(_rich_progress_bar, bar_type=bar_type, size=size) |
||||
else: |
||||
return iter # no-op, when passed an iterator |
||||
@ -1,505 +0,0 @@
|
||||
"""Contains the Command base classes that depend on PipSession. |
||||
|
||||
The classes in this module are in a separate module so the commands not |
||||
needing download / PackageFinder capability don't unnecessarily import the |
||||
PackageFinder machinery and all its vendored dependencies, etc. |
||||
""" |
||||
|
||||
import logging |
||||
import os |
||||
import sys |
||||
from functools import partial |
||||
from optparse import Values |
||||
from typing import TYPE_CHECKING, Any, List, Optional, Tuple |
||||
|
||||
from pip._internal.cache import WheelCache |
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.command_context import CommandContextMixIn |
||||
from pip._internal.exceptions import CommandError, PreviousBuildDirError |
||||
from pip._internal.index.collector import LinkCollector |
||||
from pip._internal.index.package_finder import PackageFinder |
||||
from pip._internal.models.selection_prefs import SelectionPreferences |
||||
from pip._internal.models.target_python import TargetPython |
||||
from pip._internal.network.session import PipSession |
||||
from pip._internal.operations.build.build_tracker import BuildTracker |
||||
from pip._internal.operations.prepare import RequirementPreparer |
||||
from pip._internal.req.constructors import ( |
||||
install_req_from_editable, |
||||
install_req_from_line, |
||||
install_req_from_parsed_requirement, |
||||
install_req_from_req_string, |
||||
) |
||||
from pip._internal.req.req_file import parse_requirements |
||||
from pip._internal.req.req_install import InstallRequirement |
||||
from pip._internal.resolution.base import BaseResolver |
||||
from pip._internal.self_outdated_check import pip_self_version_check |
||||
from pip._internal.utils.temp_dir import ( |
||||
TempDirectory, |
||||
TempDirectoryTypeRegistry, |
||||
tempdir_kinds, |
||||
) |
||||
from pip._internal.utils.virtualenv import running_under_virtualenv |
||||
|
||||
if TYPE_CHECKING: |
||||
from ssl import SSLContext |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
def _create_truststore_ssl_context() -> Optional["SSLContext"]: |
||||
if sys.version_info < (3, 10): |
||||
raise CommandError("The truststore feature is only available for Python 3.10+") |
||||
|
||||
try: |
||||
import ssl |
||||
except ImportError: |
||||
logger.warning("Disabling truststore since ssl support is missing") |
||||
return None |
||||
|
||||
try: |
||||
from pip._vendor import truststore |
||||
except ImportError as e: |
||||
raise CommandError(f"The truststore feature is unavailable: {e}") |
||||
|
||||
return truststore.SSLContext(ssl.PROTOCOL_TLS_CLIENT) |
||||
|
||||
|
||||
class SessionCommandMixin(CommandContextMixIn): |
||||
|
||||
""" |
||||
A class mixin for command classes needing _build_session(). |
||||
""" |
||||
|
||||
def __init__(self) -> None: |
||||
super().__init__() |
||||
self._session: Optional[PipSession] = None |
||||
|
||||
@classmethod |
||||
def _get_index_urls(cls, options: Values) -> Optional[List[str]]: |
||||
"""Return a list of index urls from user-provided options.""" |
||||
index_urls = [] |
||||
if not getattr(options, "no_index", False): |
||||
url = getattr(options, "index_url", None) |
||||
if url: |
||||
index_urls.append(url) |
||||
urls = getattr(options, "extra_index_urls", None) |
||||
if urls: |
||||
index_urls.extend(urls) |
||||
# Return None rather than an empty list |
||||
return index_urls or None |
||||
|
||||
def get_default_session(self, options: Values) -> PipSession: |
||||
"""Get a default-managed session.""" |
||||
if self._session is None: |
||||
self._session = self.enter_context(self._build_session(options)) |
||||
# there's no type annotation on requests.Session, so it's |
||||
# automatically ContextManager[Any] and self._session becomes Any, |
||||
# then https://github.com/python/mypy/issues/7696 kicks in |
||||
assert self._session is not None |
||||
return self._session |
||||
|
||||
def _build_session( |
||||
self, |
||||
options: Values, |
||||
retries: Optional[int] = None, |
||||
timeout: Optional[int] = None, |
||||
fallback_to_certifi: bool = False, |
||||
) -> PipSession: |
||||
cache_dir = options.cache_dir |
||||
assert not cache_dir or os.path.isabs(cache_dir) |
||||
|
||||
if "truststore" in options.features_enabled: |
||||
try: |
||||
ssl_context = _create_truststore_ssl_context() |
||||
except Exception: |
||||
if not fallback_to_certifi: |
||||
raise |
||||
ssl_context = None |
||||
else: |
||||
ssl_context = None |
||||
|
||||
session = PipSession( |
||||
cache=os.path.join(cache_dir, "http-v2") if cache_dir else None, |
||||
retries=retries if retries is not None else options.retries, |
||||
trusted_hosts=options.trusted_hosts, |
||||
index_urls=self._get_index_urls(options), |
||||
ssl_context=ssl_context, |
||||
) |
||||
|
||||
# Handle custom ca-bundles from the user |
||||
if options.cert: |
||||
session.verify = options.cert |
||||
|
||||
# Handle SSL client certificate |
||||
if options.client_cert: |
||||
session.cert = options.client_cert |
||||
|
||||
# Handle timeouts |
||||
if options.timeout or timeout: |
||||
session.timeout = timeout if timeout is not None else options.timeout |
||||
|
||||
# Handle configured proxies |
||||
if options.proxy: |
||||
session.proxies = { |
||||
"http": options.proxy, |
||||
"https": options.proxy, |
||||
} |
||||
|
||||
# Determine if we can prompt the user for authentication or not |
||||
session.auth.prompting = not options.no_input |
||||
session.auth.keyring_provider = options.keyring_provider |
||||
|
||||
return session |
||||
|
||||
|
||||
class IndexGroupCommand(Command, SessionCommandMixin): |
||||
|
||||
""" |
||||
Abstract base class for commands with the index_group options. |
||||
|
||||
This also corresponds to the commands that permit the pip version check. |
||||
""" |
||||
|
||||
def handle_pip_version_check(self, options: Values) -> None: |
||||
""" |
||||
Do the pip version check if not disabled. |
||||
|
||||
This overrides the default behavior of not doing the check. |
||||
""" |
||||
# Make sure the index_group options are present. |
||||
assert hasattr(options, "no_index") |
||||
|
||||
if options.disable_pip_version_check or options.no_index: |
||||
return |
||||
|
||||
# Otherwise, check if we're using the latest version of pip available. |
||||
session = self._build_session( |
||||
options, |
||||
retries=0, |
||||
timeout=min(5, options.timeout), |
||||
# This is set to ensure the function does not fail when truststore is |
||||
# specified in use-feature but cannot be loaded. This usually raises a |
||||
# CommandError and shows a nice user-facing error, but this function is not |
||||
# called in that try-except block. |
||||
fallback_to_certifi=True, |
||||
) |
||||
with session: |
||||
pip_self_version_check(session, options) |
||||
|
||||
|
||||
KEEPABLE_TEMPDIR_TYPES = [ |
||||
tempdir_kinds.BUILD_ENV, |
||||
tempdir_kinds.EPHEM_WHEEL_CACHE, |
||||
tempdir_kinds.REQ_BUILD, |
||||
] |
||||
|
||||
|
||||
def warn_if_run_as_root() -> None: |
||||
"""Output a warning for sudo users on Unix. |
||||
|
||||
In a virtual environment, sudo pip still writes to virtualenv. |
||||
On Windows, users may run pip as Administrator without issues. |
||||
This warning only applies to Unix root users outside of virtualenv. |
||||
""" |
||||
if running_under_virtualenv(): |
||||
return |
||||
if not hasattr(os, "getuid"): |
||||
return |
||||
# On Windows, there are no "system managed" Python packages. Installing as |
||||
# Administrator via pip is the correct way of updating system environments. |
||||
# |
||||
# We choose sys.platform over utils.compat.WINDOWS here to enable Mypy platform |
||||
# checks: https://mypy.readthedocs.io/en/stable/common_issues.html |
||||
if sys.platform == "win32" or sys.platform == "cygwin": |
||||
return |
||||
|
||||
if os.getuid() != 0: |
||||
return |
||||
|
||||
logger.warning( |
||||
"Running pip as the 'root' user can result in broken permissions and " |
||||
"conflicting behaviour with the system package manager. " |
||||
"It is recommended to use a virtual environment instead: " |
||||
"https://pip.pypa.io/warnings/venv" |
||||
) |
||||
|
||||
|
||||
def with_cleanup(func: Any) -> Any: |
||||
"""Decorator for common logic related to managing temporary |
||||
directories. |
||||
""" |
||||
|
||||
def configure_tempdir_registry(registry: TempDirectoryTypeRegistry) -> None: |
||||
for t in KEEPABLE_TEMPDIR_TYPES: |
||||
registry.set_delete(t, False) |
||||
|
||||
def wrapper( |
||||
self: RequirementCommand, options: Values, args: List[Any] |
||||
) -> Optional[int]: |
||||
assert self.tempdir_registry is not None |
||||
if options.no_clean: |
||||
configure_tempdir_registry(self.tempdir_registry) |
||||
|
||||
try: |
||||
return func(self, options, args) |
||||
except PreviousBuildDirError: |
||||
# This kind of conflict can occur when the user passes an explicit |
||||
# build directory with a pre-existing folder. In that case we do |
||||
# not want to accidentally remove it. |
||||
configure_tempdir_registry(self.tempdir_registry) |
||||
raise |
||||
|
||||
return wrapper |
||||
|
||||
|
||||
class RequirementCommand(IndexGroupCommand): |
||||
def __init__(self, *args: Any, **kw: Any) -> None: |
||||
super().__init__(*args, **kw) |
||||
|
||||
self.cmd_opts.add_option(cmdoptions.no_clean()) |
||||
|
||||
@staticmethod |
||||
def determine_resolver_variant(options: Values) -> str: |
||||
"""Determines which resolver should be used, based on the given options.""" |
||||
if "legacy-resolver" in options.deprecated_features_enabled: |
||||
return "legacy" |
||||
|
||||
return "resolvelib" |
||||
|
||||
@classmethod |
||||
def make_requirement_preparer( |
||||
cls, |
||||
temp_build_dir: TempDirectory, |
||||
options: Values, |
||||
build_tracker: BuildTracker, |
||||
session: PipSession, |
||||
finder: PackageFinder, |
||||
use_user_site: bool, |
||||
download_dir: Optional[str] = None, |
||||
verbosity: int = 0, |
||||
) -> RequirementPreparer: |
||||
""" |
||||
Create a RequirementPreparer instance for the given parameters. |
||||
""" |
||||
temp_build_dir_path = temp_build_dir.path |
||||
assert temp_build_dir_path is not None |
||||
legacy_resolver = False |
||||
|
||||
resolver_variant = cls.determine_resolver_variant(options) |
||||
if resolver_variant == "resolvelib": |
||||
lazy_wheel = "fast-deps" in options.features_enabled |
||||
if lazy_wheel: |
||||
logger.warning( |
||||
"pip is using lazily downloaded wheels using HTTP " |
||||
"range requests to obtain dependency information. " |
||||
"This experimental feature is enabled through " |
||||
"--use-feature=fast-deps and it is not ready for " |
||||
"production." |
||||
) |
||||
else: |
||||
legacy_resolver = True |
||||
lazy_wheel = False |
||||
if "fast-deps" in options.features_enabled: |
||||
logger.warning( |
||||
"fast-deps has no effect when used with the legacy resolver." |
||||
) |
||||
|
||||
return RequirementPreparer( |
||||
build_dir=temp_build_dir_path, |
||||
src_dir=options.src_dir, |
||||
download_dir=download_dir, |
||||
build_isolation=options.build_isolation, |
||||
check_build_deps=options.check_build_deps, |
||||
build_tracker=build_tracker, |
||||
session=session, |
||||
progress_bar=options.progress_bar, |
||||
finder=finder, |
||||
require_hashes=options.require_hashes, |
||||
use_user_site=use_user_site, |
||||
lazy_wheel=lazy_wheel, |
||||
verbosity=verbosity, |
||||
legacy_resolver=legacy_resolver, |
||||
) |
||||
|
||||
@classmethod |
||||
def make_resolver( |
||||
cls, |
||||
preparer: RequirementPreparer, |
||||
finder: PackageFinder, |
||||
options: Values, |
||||
wheel_cache: Optional[WheelCache] = None, |
||||
use_user_site: bool = False, |
||||
ignore_installed: bool = True, |
||||
ignore_requires_python: bool = False, |
||||
force_reinstall: bool = False, |
||||
upgrade_strategy: str = "to-satisfy-only", |
||||
use_pep517: Optional[bool] = None, |
||||
py_version_info: Optional[Tuple[int, ...]] = None, |
||||
) -> BaseResolver: |
||||
""" |
||||
Create a Resolver instance for the given parameters. |
||||
""" |
||||
make_install_req = partial( |
||||
install_req_from_req_string, |
||||
isolated=options.isolated_mode, |
||||
use_pep517=use_pep517, |
||||
) |
||||
resolver_variant = cls.determine_resolver_variant(options) |
||||
# The long import name and duplicated invocation is needed to convince |
||||
# Mypy into correctly typechecking. Otherwise it would complain the |
||||
# "Resolver" class being redefined. |
||||
if resolver_variant == "resolvelib": |
||||
import pip._internal.resolution.resolvelib.resolver |
||||
|
||||
return pip._internal.resolution.resolvelib.resolver.Resolver( |
||||
preparer=preparer, |
||||
finder=finder, |
||||
wheel_cache=wheel_cache, |
||||
make_install_req=make_install_req, |
||||
use_user_site=use_user_site, |
||||
ignore_dependencies=options.ignore_dependencies, |
||||
ignore_installed=ignore_installed, |
||||
ignore_requires_python=ignore_requires_python, |
||||
force_reinstall=force_reinstall, |
||||
upgrade_strategy=upgrade_strategy, |
||||
py_version_info=py_version_info, |
||||
) |
||||
import pip._internal.resolution.legacy.resolver |
||||
|
||||
return pip._internal.resolution.legacy.resolver.Resolver( |
||||
preparer=preparer, |
||||
finder=finder, |
||||
wheel_cache=wheel_cache, |
||||
make_install_req=make_install_req, |
||||
use_user_site=use_user_site, |
||||
ignore_dependencies=options.ignore_dependencies, |
||||
ignore_installed=ignore_installed, |
||||
ignore_requires_python=ignore_requires_python, |
||||
force_reinstall=force_reinstall, |
||||
upgrade_strategy=upgrade_strategy, |
||||
py_version_info=py_version_info, |
||||
) |
||||
|
||||
def get_requirements( |
||||
self, |
||||
args: List[str], |
||||
options: Values, |
||||
finder: PackageFinder, |
||||
session: PipSession, |
||||
) -> List[InstallRequirement]: |
||||
""" |
||||
Parse command-line arguments into the corresponding requirements. |
||||
""" |
||||
requirements: List[InstallRequirement] = [] |
||||
for filename in options.constraints: |
||||
for parsed_req in parse_requirements( |
||||
filename, |
||||
constraint=True, |
||||
finder=finder, |
||||
options=options, |
||||
session=session, |
||||
): |
||||
req_to_add = install_req_from_parsed_requirement( |
||||
parsed_req, |
||||
isolated=options.isolated_mode, |
||||
user_supplied=False, |
||||
) |
||||
requirements.append(req_to_add) |
||||
|
||||
for req in args: |
||||
req_to_add = install_req_from_line( |
||||
req, |
||||
comes_from=None, |
||||
isolated=options.isolated_mode, |
||||
use_pep517=options.use_pep517, |
||||
user_supplied=True, |
||||
config_settings=getattr(options, "config_settings", None), |
||||
) |
||||
requirements.append(req_to_add) |
||||
|
||||
for req in options.editables: |
||||
req_to_add = install_req_from_editable( |
||||
req, |
||||
user_supplied=True, |
||||
isolated=options.isolated_mode, |
||||
use_pep517=options.use_pep517, |
||||
config_settings=getattr(options, "config_settings", None), |
||||
) |
||||
requirements.append(req_to_add) |
||||
|
||||
# NOTE: options.require_hashes may be set if --require-hashes is True |
||||
for filename in options.requirements: |
||||
for parsed_req in parse_requirements( |
||||
filename, finder=finder, options=options, session=session |
||||
): |
||||
req_to_add = install_req_from_parsed_requirement( |
||||
parsed_req, |
||||
isolated=options.isolated_mode, |
||||
use_pep517=options.use_pep517, |
||||
user_supplied=True, |
||||
config_settings=parsed_req.options.get("config_settings") |
||||
if parsed_req.options |
||||
else None, |
||||
) |
||||
requirements.append(req_to_add) |
||||
|
||||
# If any requirement has hash options, enable hash checking. |
||||
if any(req.has_hash_options for req in requirements): |
||||
options.require_hashes = True |
||||
|
||||
if not (args or options.editables or options.requirements): |
||||
opts = {"name": self.name} |
||||
if options.find_links: |
||||
raise CommandError( |
||||
"You must give at least one requirement to {name} " |
||||
'(maybe you meant "pip {name} {links}"?)'.format( |
||||
**dict(opts, links=" ".join(options.find_links)) |
||||
) |
||||
) |
||||
else: |
||||
raise CommandError( |
||||
"You must give at least one requirement to {name} " |
||||
'(see "pip help {name}")'.format(**opts) |
||||
) |
||||
|
||||
return requirements |
||||
|
||||
@staticmethod |
||||
def trace_basic_info(finder: PackageFinder) -> None: |
||||
""" |
||||
Trace basic information about the provided objects. |
||||
""" |
||||
# Display where finder is looking for packages |
||||
search_scope = finder.search_scope |
||||
locations = search_scope.get_formatted_locations() |
||||
if locations: |
||||
logger.info(locations) |
||||
|
||||
def _build_package_finder( |
||||
self, |
||||
options: Values, |
||||
session: PipSession, |
||||
target_python: Optional[TargetPython] = None, |
||||
ignore_requires_python: Optional[bool] = None, |
||||
) -> PackageFinder: |
||||
""" |
||||
Create a package finder appropriate to this requirement command. |
||||
|
||||
:param ignore_requires_python: Whether to ignore incompatible |
||||
"Requires-Python" values in links. Defaults to False. |
||||
""" |
||||
link_collector = LinkCollector.create(session, options=options) |
||||
selection_prefs = SelectionPreferences( |
||||
allow_yanked=True, |
||||
format_control=options.format_control, |
||||
allow_all_prereleases=options.pre, |
||||
prefer_binary=options.prefer_binary, |
||||
ignore_requires_python=ignore_requires_python, |
||||
) |
||||
|
||||
return PackageFinder.create( |
||||
link_collector=link_collector, |
||||
selection_prefs=selection_prefs, |
||||
target_python=target_python, |
||||
) |
||||
@ -1,159 +0,0 @@
|
||||
import contextlib |
||||
import itertools |
||||
import logging |
||||
import sys |
||||
import time |
||||
from typing import IO, Generator, Optional |
||||
|
||||
from pip._internal.utils.compat import WINDOWS |
||||
from pip._internal.utils.logging import get_indentation |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class SpinnerInterface: |
||||
def spin(self) -> None: |
||||
raise NotImplementedError() |
||||
|
||||
def finish(self, final_status: str) -> None: |
||||
raise NotImplementedError() |
||||
|
||||
|
||||
class InteractiveSpinner(SpinnerInterface): |
||||
def __init__( |
||||
self, |
||||
message: str, |
||||
file: Optional[IO[str]] = None, |
||||
spin_chars: str = "-\\|/", |
||||
# Empirically, 8 updates/second looks nice |
||||
min_update_interval_seconds: float = 0.125, |
||||
): |
||||
self._message = message |
||||
if file is None: |
||||
file = sys.stdout |
||||
self._file = file |
||||
self._rate_limiter = RateLimiter(min_update_interval_seconds) |
||||
self._finished = False |
||||
|
||||
self._spin_cycle = itertools.cycle(spin_chars) |
||||
|
||||
self._file.write(" " * get_indentation() + self._message + " ... ") |
||||
self._width = 0 |
||||
|
||||
def _write(self, status: str) -> None: |
||||
assert not self._finished |
||||
# Erase what we wrote before by backspacing to the beginning, writing |
||||
# spaces to overwrite the old text, and then backspacing again |
||||
backup = "\b" * self._width |
||||
self._file.write(backup + " " * self._width + backup) |
||||
# Now we have a blank slate to add our status |
||||
self._file.write(status) |
||||
self._width = len(status) |
||||
self._file.flush() |
||||
self._rate_limiter.reset() |
||||
|
||||
def spin(self) -> None: |
||||
if self._finished: |
||||
return |
||||
if not self._rate_limiter.ready(): |
||||
return |
||||
self._write(next(self._spin_cycle)) |
||||
|
||||
def finish(self, final_status: str) -> None: |
||||
if self._finished: |
||||
return |
||||
self._write(final_status) |
||||
self._file.write("\n") |
||||
self._file.flush() |
||||
self._finished = True |
||||
|
||||
|
||||
# Used for dumb terminals, non-interactive installs (no tty), etc. |
||||
# We still print updates occasionally (once every 60 seconds by default) to |
||||
# act as a keep-alive for systems like Travis-CI that take lack-of-output as |
||||
# an indication that a task has frozen. |
||||
class NonInteractiveSpinner(SpinnerInterface): |
||||
def __init__(self, message: str, min_update_interval_seconds: float = 60.0) -> None: |
||||
self._message = message |
||||
self._finished = False |
||||
self._rate_limiter = RateLimiter(min_update_interval_seconds) |
||||
self._update("started") |
||||
|
||||
def _update(self, status: str) -> None: |
||||
assert not self._finished |
||||
self._rate_limiter.reset() |
||||
logger.info("%s: %s", self._message, status) |
||||
|
||||
def spin(self) -> None: |
||||
if self._finished: |
||||
return |
||||
if not self._rate_limiter.ready(): |
||||
return |
||||
self._update("still running...") |
||||
|
||||
def finish(self, final_status: str) -> None: |
||||
if self._finished: |
||||
return |
||||
self._update(f"finished with status '{final_status}'") |
||||
self._finished = True |
||||
|
||||
|
||||
class RateLimiter: |
||||
def __init__(self, min_update_interval_seconds: float) -> None: |
||||
self._min_update_interval_seconds = min_update_interval_seconds |
||||
self._last_update: float = 0 |
||||
|
||||
def ready(self) -> bool: |
||||
now = time.time() |
||||
delta = now - self._last_update |
||||
return delta >= self._min_update_interval_seconds |
||||
|
||||
def reset(self) -> None: |
||||
self._last_update = time.time() |
||||
|
||||
|
||||
@contextlib.contextmanager |
||||
def open_spinner(message: str) -> Generator[SpinnerInterface, None, None]: |
||||
# Interactive spinner goes directly to sys.stdout rather than being routed |
||||
# through the logging system, but it acts like it has level INFO, |
||||
# i.e. it's only displayed if we're at level INFO or better. |
||||
# Non-interactive spinner goes through the logging system, so it is always |
||||
# in sync with logging configuration. |
||||
if sys.stdout.isatty() and logger.getEffectiveLevel() <= logging.INFO: |
||||
spinner: SpinnerInterface = InteractiveSpinner(message) |
||||
else: |
||||
spinner = NonInteractiveSpinner(message) |
||||
try: |
||||
with hidden_cursor(sys.stdout): |
||||
yield spinner |
||||
except KeyboardInterrupt: |
||||
spinner.finish("canceled") |
||||
raise |
||||
except Exception: |
||||
spinner.finish("error") |
||||
raise |
||||
else: |
||||
spinner.finish("done") |
||||
|
||||
|
||||
HIDE_CURSOR = "\x1b[?25l" |
||||
SHOW_CURSOR = "\x1b[?25h" |
||||
|
||||
|
||||
@contextlib.contextmanager |
||||
def hidden_cursor(file: IO[str]) -> Generator[None, None, None]: |
||||
# The Windows terminal does not support the hide/show cursor ANSI codes, |
||||
# even via colorama. So don't even try. |
||||
if WINDOWS: |
||||
yield |
||||
# We don't want to clutter the output with control characters if we're |
||||
# writing to a file, or if the user is running with --quiet. |
||||
# See https://github.com/pypa/pip/issues/3418 |
||||
elif not file.isatty() or logger.getEffectiveLevel() > logging.INFO: |
||||
yield |
||||
else: |
||||
file.write(HIDE_CURSOR) |
||||
try: |
||||
yield |
||||
finally: |
||||
file.write(SHOW_CURSOR) |
||||
@ -1,6 +0,0 @@
|
||||
SUCCESS = 0 |
||||
ERROR = 1 |
||||
UNKNOWN_ERROR = 2 |
||||
VIRTUALENV_NOT_FOUND = 3 |
||||
PREVIOUS_BUILD_DIR_ERROR = 4 |
||||
NO_MATCHES_FOUND = 23 |
||||
@ -1,132 +0,0 @@
|
||||
""" |
||||
Package containing all pip commands |
||||
""" |
||||
|
||||
import importlib |
||||
from collections import namedtuple |
||||
from typing import Any, Dict, Optional |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
|
||||
CommandInfo = namedtuple("CommandInfo", "module_path, class_name, summary") |
||||
|
||||
# This dictionary does a bunch of heavy lifting for help output: |
||||
# - Enables avoiding additional (costly) imports for presenting `--help`. |
||||
# - The ordering matters for help display. |
||||
# |
||||
# Even though the module path starts with the same "pip._internal.commands" |
||||
# prefix, the full path makes testing easier (specifically when modifying |
||||
# `commands_dict` in test setup / teardown). |
||||
commands_dict: Dict[str, CommandInfo] = { |
||||
"install": CommandInfo( |
||||
"pip._internal.commands.install", |
||||
"InstallCommand", |
||||
"Install packages.", |
||||
), |
||||
"download": CommandInfo( |
||||
"pip._internal.commands.download", |
||||
"DownloadCommand", |
||||
"Download packages.", |
||||
), |
||||
"uninstall": CommandInfo( |
||||
"pip._internal.commands.uninstall", |
||||
"UninstallCommand", |
||||
"Uninstall packages.", |
||||
), |
||||
"freeze": CommandInfo( |
||||
"pip._internal.commands.freeze", |
||||
"FreezeCommand", |
||||
"Output installed packages in requirements format.", |
||||
), |
||||
"inspect": CommandInfo( |
||||
"pip._internal.commands.inspect", |
||||
"InspectCommand", |
||||
"Inspect the python environment.", |
||||
), |
||||
"list": CommandInfo( |
||||
"pip._internal.commands.list", |
||||
"ListCommand", |
||||
"List installed packages.", |
||||
), |
||||
"show": CommandInfo( |
||||
"pip._internal.commands.show", |
||||
"ShowCommand", |
||||
"Show information about installed packages.", |
||||
), |
||||
"check": CommandInfo( |
||||
"pip._internal.commands.check", |
||||
"CheckCommand", |
||||
"Verify installed packages have compatible dependencies.", |
||||
), |
||||
"config": CommandInfo( |
||||
"pip._internal.commands.configuration", |
||||
"ConfigurationCommand", |
||||
"Manage local and global configuration.", |
||||
), |
||||
"search": CommandInfo( |
||||
"pip._internal.commands.search", |
||||
"SearchCommand", |
||||
"Search PyPI for packages.", |
||||
), |
||||
"cache": CommandInfo( |
||||
"pip._internal.commands.cache", |
||||
"CacheCommand", |
||||
"Inspect and manage pip's wheel cache.", |
||||
), |
||||
"index": CommandInfo( |
||||
"pip._internal.commands.index", |
||||
"IndexCommand", |
||||
"Inspect information available from package indexes.", |
||||
), |
||||
"wheel": CommandInfo( |
||||
"pip._internal.commands.wheel", |
||||
"WheelCommand", |
||||
"Build wheels from your requirements.", |
||||
), |
||||
"hash": CommandInfo( |
||||
"pip._internal.commands.hash", |
||||
"HashCommand", |
||||
"Compute hashes of package archives.", |
||||
), |
||||
"completion": CommandInfo( |
||||
"pip._internal.commands.completion", |
||||
"CompletionCommand", |
||||
"A helper command used for command completion.", |
||||
), |
||||
"debug": CommandInfo( |
||||
"pip._internal.commands.debug", |
||||
"DebugCommand", |
||||
"Show information useful for debugging.", |
||||
), |
||||
"help": CommandInfo( |
||||
"pip._internal.commands.help", |
||||
"HelpCommand", |
||||
"Show help for commands.", |
||||
), |
||||
} |
||||
|
||||
|
||||
def create_command(name: str, **kwargs: Any) -> Command: |
||||
""" |
||||
Create an instance of the Command class with the given name. |
||||
""" |
||||
module_path, class_name, summary = commands_dict[name] |
||||
module = importlib.import_module(module_path) |
||||
command_class = getattr(module, class_name) |
||||
command = command_class(name=name, summary=summary, **kwargs) |
||||
|
||||
return command |
||||
|
||||
|
||||
def get_similar_commands(name: str) -> Optional[str]: |
||||
"""Command name auto-correct.""" |
||||
from difflib import get_close_matches |
||||
|
||||
name = name.lower() |
||||
|
||||
close_commands = get_close_matches(name, commands_dict.keys()) |
||||
|
||||
if close_commands: |
||||
return close_commands[0] |
||||
else: |
||||
return None |
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,225 +0,0 @@
|
||||
import os |
||||
import textwrap |
||||
from optparse import Values |
||||
from typing import Any, List |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import ERROR, SUCCESS |
||||
from pip._internal.exceptions import CommandError, PipError |
||||
from pip._internal.utils import filesystem |
||||
from pip._internal.utils.logging import getLogger |
||||
|
||||
logger = getLogger(__name__) |
||||
|
||||
|
||||
class CacheCommand(Command): |
||||
""" |
||||
Inspect and manage pip's wheel cache. |
||||
|
||||
Subcommands: |
||||
|
||||
- dir: Show the cache directory. |
||||
- info: Show information about the cache. |
||||
- list: List filenames of packages stored in the cache. |
||||
- remove: Remove one or more package from the cache. |
||||
- purge: Remove all items from the cache. |
||||
|
||||
``<pattern>`` can be a glob expression or a package name. |
||||
""" |
||||
|
||||
ignore_require_venv = True |
||||
usage = """ |
||||
%prog dir |
||||
%prog info |
||||
%prog list [<pattern>] [--format=[human, abspath]] |
||||
%prog remove <pattern> |
||||
%prog purge |
||||
""" |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"--format", |
||||
action="store", |
||||
dest="list_format", |
||||
default="human", |
||||
choices=("human", "abspath"), |
||||
help="Select the output format among: human (default) or abspath", |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
handlers = { |
||||
"dir": self.get_cache_dir, |
||||
"info": self.get_cache_info, |
||||
"list": self.list_cache_items, |
||||
"remove": self.remove_cache_items, |
||||
"purge": self.purge_cache, |
||||
} |
||||
|
||||
if not options.cache_dir: |
||||
logger.error("pip cache commands can not function since cache is disabled.") |
||||
return ERROR |
||||
|
||||
# Determine action |
||||
if not args or args[0] not in handlers: |
||||
logger.error( |
||||
"Need an action (%s) to perform.", |
||||
", ".join(sorted(handlers)), |
||||
) |
||||
return ERROR |
||||
|
||||
action = args[0] |
||||
|
||||
# Error handling happens here, not in the action-handlers. |
||||
try: |
||||
handlers[action](options, args[1:]) |
||||
except PipError as e: |
||||
logger.error(e.args[0]) |
||||
return ERROR |
||||
|
||||
return SUCCESS |
||||
|
||||
def get_cache_dir(self, options: Values, args: List[Any]) -> None: |
||||
if args: |
||||
raise CommandError("Too many arguments") |
||||
|
||||
logger.info(options.cache_dir) |
||||
|
||||
def get_cache_info(self, options: Values, args: List[Any]) -> None: |
||||
if args: |
||||
raise CommandError("Too many arguments") |
||||
|
||||
num_http_files = len(self._find_http_files(options)) |
||||
num_packages = len(self._find_wheels(options, "*")) |
||||
|
||||
http_cache_location = self._cache_dir(options, "http-v2") |
||||
old_http_cache_location = self._cache_dir(options, "http") |
||||
wheels_cache_location = self._cache_dir(options, "wheels") |
||||
http_cache_size = filesystem.format_size( |
||||
filesystem.directory_size(http_cache_location) |
||||
+ filesystem.directory_size(old_http_cache_location) |
||||
) |
||||
wheels_cache_size = filesystem.format_directory_size(wheels_cache_location) |
||||
|
||||
message = ( |
||||
textwrap.dedent( |
||||
""" |
||||
Package index page cache location (pip v23.3+): {http_cache_location} |
||||
Package index page cache location (older pips): {old_http_cache_location} |
||||
Package index page cache size: {http_cache_size} |
||||
Number of HTTP files: {num_http_files} |
||||
Locally built wheels location: {wheels_cache_location} |
||||
Locally built wheels size: {wheels_cache_size} |
||||
Number of locally built wheels: {package_count} |
||||
""" # noqa: E501 |
||||
) |
||||
.format( |
||||
http_cache_location=http_cache_location, |
||||
old_http_cache_location=old_http_cache_location, |
||||
http_cache_size=http_cache_size, |
||||
num_http_files=num_http_files, |
||||
wheels_cache_location=wheels_cache_location, |
||||
package_count=num_packages, |
||||
wheels_cache_size=wheels_cache_size, |
||||
) |
||||
.strip() |
||||
) |
||||
|
||||
logger.info(message) |
||||
|
||||
def list_cache_items(self, options: Values, args: List[Any]) -> None: |
||||
if len(args) > 1: |
||||
raise CommandError("Too many arguments") |
||||
|
||||
if args: |
||||
pattern = args[0] |
||||
else: |
||||
pattern = "*" |
||||
|
||||
files = self._find_wheels(options, pattern) |
||||
if options.list_format == "human": |
||||
self.format_for_human(files) |
||||
else: |
||||
self.format_for_abspath(files) |
||||
|
||||
def format_for_human(self, files: List[str]) -> None: |
||||
if not files: |
||||
logger.info("No locally built wheels cached.") |
||||
return |
||||
|
||||
results = [] |
||||
for filename in files: |
||||
wheel = os.path.basename(filename) |
||||
size = filesystem.format_file_size(filename) |
||||
results.append(f" - {wheel} ({size})") |
||||
logger.info("Cache contents:\n") |
||||
logger.info("\n".join(sorted(results))) |
||||
|
||||
def format_for_abspath(self, files: List[str]) -> None: |
||||
if files: |
||||
logger.info("\n".join(sorted(files))) |
||||
|
||||
def remove_cache_items(self, options: Values, args: List[Any]) -> None: |
||||
if len(args) > 1: |
||||
raise CommandError("Too many arguments") |
||||
|
||||
if not args: |
||||
raise CommandError("Please provide a pattern") |
||||
|
||||
files = self._find_wheels(options, args[0]) |
||||
|
||||
no_matching_msg = "No matching packages" |
||||
if args[0] == "*": |
||||
# Only fetch http files if no specific pattern given |
||||
files += self._find_http_files(options) |
||||
else: |
||||
# Add the pattern to the log message |
||||
no_matching_msg += ' for pattern "{}"'.format(args[0]) |
||||
|
||||
if not files: |
||||
logger.warning(no_matching_msg) |
||||
|
||||
for filename in files: |
||||
os.unlink(filename) |
||||
logger.verbose("Removed %s", filename) |
||||
logger.info("Files removed: %s", len(files)) |
||||
|
||||
def purge_cache(self, options: Values, args: List[Any]) -> None: |
||||
if args: |
||||
raise CommandError("Too many arguments") |
||||
|
||||
return self.remove_cache_items(options, ["*"]) |
||||
|
||||
def _cache_dir(self, options: Values, subdir: str) -> str: |
||||
return os.path.join(options.cache_dir, subdir) |
||||
|
||||
def _find_http_files(self, options: Values) -> List[str]: |
||||
old_http_dir = self._cache_dir(options, "http") |
||||
new_http_dir = self._cache_dir(options, "http-v2") |
||||
return filesystem.find_files(old_http_dir, "*") + filesystem.find_files( |
||||
new_http_dir, "*" |
||||
) |
||||
|
||||
def _find_wheels(self, options: Values, pattern: str) -> List[str]: |
||||
wheel_dir = self._cache_dir(options, "wheels") |
||||
|
||||
# The wheel filename format, as specified in PEP 427, is: |
||||
# {distribution}-{version}(-{build})?-{python}-{abi}-{platform}.whl |
||||
# |
||||
# Additionally, non-alphanumeric values in the distribution are |
||||
# normalized to underscores (_), meaning hyphens can never occur |
||||
# before `-{version}`. |
||||
# |
||||
# Given that information: |
||||
# - If the pattern we're given contains a hyphen (-), the user is |
||||
# providing at least the version. Thus, we can just append `*.whl` |
||||
# to match the rest of it. |
||||
# - If the pattern we're given doesn't contain a hyphen (-), the |
||||
# user is only providing the name. Thus, we append `-*.whl` to |
||||
# match the hyphen before the version, followed by anything else. |
||||
# |
||||
# PEP 427: https://www.python.org/dev/peps/pep-0427/ |
||||
pattern = pattern + ("*.whl" if "-" in pattern else "-*.whl") |
||||
|
||||
return filesystem.find_files(wheel_dir, pattern) |
||||
@ -1,54 +0,0 @@
|
||||
import logging |
||||
from optparse import Values |
||||
from typing import List |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import ERROR, SUCCESS |
||||
from pip._internal.operations.check import ( |
||||
check_package_set, |
||||
create_package_set_from_installed, |
||||
warn_legacy_versions_and_specifiers, |
||||
) |
||||
from pip._internal.utils.misc import write_output |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class CheckCommand(Command): |
||||
"""Verify installed packages have compatible dependencies.""" |
||||
|
||||
usage = """ |
||||
%prog [options]""" |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
package_set, parsing_probs = create_package_set_from_installed() |
||||
warn_legacy_versions_and_specifiers(package_set) |
||||
missing, conflicting = check_package_set(package_set) |
||||
|
||||
for project_name in missing: |
||||
version = package_set[project_name].version |
||||
for dependency in missing[project_name]: |
||||
write_output( |
||||
"%s %s requires %s, which is not installed.", |
||||
project_name, |
||||
version, |
||||
dependency[0], |
||||
) |
||||
|
||||
for project_name in conflicting: |
||||
version = package_set[project_name].version |
||||
for dep_name, dep_version, req in conflicting[project_name]: |
||||
write_output( |
||||
"%s %s has requirement %s, but you have %s %s.", |
||||
project_name, |
||||
version, |
||||
req, |
||||
dep_name, |
||||
dep_version, |
||||
) |
||||
|
||||
if missing or conflicting or parsing_probs: |
||||
return ERROR |
||||
else: |
||||
write_output("No broken requirements found.") |
||||
return SUCCESS |
||||
@ -1,130 +0,0 @@
|
||||
import sys |
||||
import textwrap |
||||
from optparse import Values |
||||
from typing import List |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import SUCCESS |
||||
from pip._internal.utils.misc import get_prog |
||||
|
||||
BASE_COMPLETION = """ |
||||
# pip {shell} completion start{script}# pip {shell} completion end |
||||
""" |
||||
|
||||
COMPLETION_SCRIPTS = { |
||||
"bash": """ |
||||
_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 {prog} |
||||
""", |
||||
"zsh": """ |
||||
#compdef -P pip[0-9.]# |
||||
__pip() {{ |
||||
compadd $( COMP_WORDS="$words[*]" \\ |
||||
COMP_CWORD=$((CURRENT-1)) \\ |
||||
PIP_AUTO_COMPLETE=1 $words[1] 2>/dev/null ) |
||||
}} |
||||
if [[ $zsh_eval_context[-1] == loadautofunc ]]; then |
||||
# autoload from fpath, call function directly |
||||
__pip "$@" |
||||
else |
||||
# eval/source/. command, register function for later |
||||
compdef __pip -P 'pip[0-9.]#' |
||||
fi |
||||
""", |
||||
"fish": """ |
||||
function __fish_complete_pip |
||||
set -lx COMP_WORDS (commandline -o) "" |
||||
set -lx COMP_CWORD ( \\ |
||||
math (contains -i -- (commandline -t) $COMP_WORDS)-1 \\ |
||||
) |
||||
set -lx PIP_AUTO_COMPLETE 1 |
||||
string split \\ -- (eval $COMP_WORDS[1]) |
||||
end |
||||
complete -fa "(__fish_complete_pip)" -c {prog} |
||||
""", |
||||
"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 |
||||
}} |
||||
}} |
||||
""", |
||||
} |
||||
|
||||
|
||||
class CompletionCommand(Command): |
||||
"""A helper command to be used for command completion.""" |
||||
|
||||
ignore_require_venv = True |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"--bash", |
||||
"-b", |
||||
action="store_const", |
||||
const="bash", |
||||
dest="shell", |
||||
help="Emit completion code for bash", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--zsh", |
||||
"-z", |
||||
action="store_const", |
||||
const="zsh", |
||||
dest="shell", |
||||
help="Emit completion code for zsh", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--fish", |
||||
"-f", |
||||
action="store_const", |
||||
const="fish", |
||||
dest="shell", |
||||
help="Emit completion code for fish", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--powershell", |
||||
"-p", |
||||
action="store_const", |
||||
const="powershell", |
||||
dest="shell", |
||||
help="Emit completion code for powershell", |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
"""Prints the completion code of the given shell""" |
||||
shells = COMPLETION_SCRIPTS.keys() |
||||
shell_options = ["--" + shell for shell in sorted(shells)] |
||||
if options.shell in shells: |
||||
script = textwrap.dedent( |
||||
COMPLETION_SCRIPTS.get(options.shell, "").format(prog=get_prog()) |
||||
) |
||||
print(BASE_COMPLETION.format(script=script, shell=options.shell)) |
||||
return SUCCESS |
||||
else: |
||||
sys.stderr.write( |
||||
"ERROR: You must pass {}\n".format(" or ".join(shell_options)) |
||||
) |
||||
return SUCCESS |
||||
@ -1,282 +0,0 @@
|
||||
import logging |
||||
import os |
||||
import subprocess |
||||
from optparse import Values |
||||
from typing import Any, List, Optional |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import ERROR, SUCCESS |
||||
from pip._internal.configuration import ( |
||||
Configuration, |
||||
Kind, |
||||
get_configuration_files, |
||||
kinds, |
||||
) |
||||
from pip._internal.exceptions import PipError |
||||
from pip._internal.utils.logging import indent_log |
||||
from pip._internal.utils.misc import get_prog, write_output |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class ConfigurationCommand(Command): |
||||
""" |
||||
Manage local and global configuration. |
||||
|
||||
Subcommands: |
||||
|
||||
- list: List the active configuration (or from the file specified) |
||||
- edit: Edit the configuration file in an editor |
||||
- get: Get the value associated with command.option |
||||
- set: Set the command.option=value |
||||
- unset: Unset the value associated with command.option |
||||
- debug: List the configuration files and values defined under them |
||||
|
||||
Configuration keys should be dot separated command and option name, |
||||
with the special prefix "global" affecting any command. For example, |
||||
"pip config set global.index-url https://example.org/" would configure |
||||
the index url for all commands, but "pip config set download.timeout 10" |
||||
would configure a 10 second timeout only for "pip download" commands. |
||||
|
||||
If none of --user, --global and --site are passed, a virtual |
||||
environment configuration file is used if one is active and the file |
||||
exists. Otherwise, all modifications happen to the user file by |
||||
default. |
||||
""" |
||||
|
||||
ignore_require_venv = True |
||||
usage = """ |
||||
%prog [<file-option>] list |
||||
%prog [<file-option>] [--editor <editor-path>] edit |
||||
|
||||
%prog [<file-option>] get command.option |
||||
%prog [<file-option>] set command.option value |
||||
%prog [<file-option>] unset command.option |
||||
%prog [<file-option>] debug |
||||
""" |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"--editor", |
||||
dest="editor", |
||||
action="store", |
||||
default=None, |
||||
help=( |
||||
"Editor to use to edit the file. Uses VISUAL or EDITOR " |
||||
"environment variables if not provided." |
||||
), |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--global", |
||||
dest="global_file", |
||||
action="store_true", |
||||
default=False, |
||||
help="Use the system-wide configuration file only", |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--user", |
||||
dest="user_file", |
||||
action="store_true", |
||||
default=False, |
||||
help="Use the user configuration file only", |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--site", |
||||
dest="site_file", |
||||
action="store_true", |
||||
default=False, |
||||
help="Use the current environment configuration file only", |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
handlers = { |
||||
"list": self.list_values, |
||||
"edit": self.open_in_editor, |
||||
"get": self.get_name, |
||||
"set": self.set_name_value, |
||||
"unset": self.unset_name, |
||||
"debug": self.list_config_values, |
||||
} |
||||
|
||||
# Determine action |
||||
if not args or args[0] not in handlers: |
||||
logger.error( |
||||
"Need an action (%s) to perform.", |
||||
", ".join(sorted(handlers)), |
||||
) |
||||
return ERROR |
||||
|
||||
action = args[0] |
||||
|
||||
# Determine which configuration files are to be loaded |
||||
# Depends on whether the command is modifying. |
||||
try: |
||||
load_only = self._determine_file( |
||||
options, need_value=(action in ["get", "set", "unset", "edit"]) |
||||
) |
||||
except PipError as e: |
||||
logger.error(e.args[0]) |
||||
return ERROR |
||||
|
||||
# Load a new configuration |
||||
self.configuration = Configuration( |
||||
isolated=options.isolated_mode, load_only=load_only |
||||
) |
||||
self.configuration.load() |
||||
|
||||
# Error handling happens here, not in the action-handlers. |
||||
try: |
||||
handlers[action](options, args[1:]) |
||||
except PipError as e: |
||||
logger.error(e.args[0]) |
||||
return ERROR |
||||
|
||||
return SUCCESS |
||||
|
||||
def _determine_file(self, options: Values, need_value: bool) -> Optional[Kind]: |
||||
file_options = [ |
||||
key |
||||
for key, value in ( |
||||
(kinds.USER, options.user_file), |
||||
(kinds.GLOBAL, options.global_file), |
||||
(kinds.SITE, options.site_file), |
||||
) |
||||
if value |
||||
] |
||||
|
||||
if not file_options: |
||||
if not need_value: |
||||
return None |
||||
# Default to user, unless there's a site file. |
||||
elif any( |
||||
os.path.exists(site_config_file) |
||||
for site_config_file in get_configuration_files()[kinds.SITE] |
||||
): |
||||
return kinds.SITE |
||||
else: |
||||
return kinds.USER |
||||
elif len(file_options) == 1: |
||||
return file_options[0] |
||||
|
||||
raise PipError( |
||||
"Need exactly one file to operate upon " |
||||
"(--user, --site, --global) to perform." |
||||
) |
||||
|
||||
def list_values(self, options: Values, args: List[str]) -> None: |
||||
self._get_n_args(args, "list", n=0) |
||||
|
||||
for key, value in sorted(self.configuration.items()): |
||||
write_output("%s=%r", key, value) |
||||
|
||||
def get_name(self, options: Values, args: List[str]) -> None: |
||||
key = self._get_n_args(args, "get [name]", n=1) |
||||
value = self.configuration.get_value(key) |
||||
|
||||
write_output("%s", value) |
||||
|
||||
def set_name_value(self, options: Values, args: List[str]) -> None: |
||||
key, value = self._get_n_args(args, "set [name] [value]", n=2) |
||||
self.configuration.set_value(key, value) |
||||
|
||||
self._save_configuration() |
||||
|
||||
def unset_name(self, options: Values, args: List[str]) -> None: |
||||
key = self._get_n_args(args, "unset [name]", n=1) |
||||
self.configuration.unset_value(key) |
||||
|
||||
self._save_configuration() |
||||
|
||||
def list_config_values(self, options: Values, args: List[str]) -> None: |
||||
"""List config key-value pairs across different config files""" |
||||
self._get_n_args(args, "debug", n=0) |
||||
|
||||
self.print_env_var_values() |
||||
# Iterate over config files and print if they exist, and the |
||||
# key-value pairs present in them if they do |
||||
for variant, files in sorted(self.configuration.iter_config_files()): |
||||
write_output("%s:", variant) |
||||
for fname in files: |
||||
with indent_log(): |
||||
file_exists = os.path.exists(fname) |
||||
write_output("%s, exists: %r", fname, file_exists) |
||||
if file_exists: |
||||
self.print_config_file_values(variant) |
||||
|
||||
def print_config_file_values(self, variant: Kind) -> None: |
||||
"""Get key-value pairs from the file of a variant""" |
||||
for name, value in self.configuration.get_values_in_config(variant).items(): |
||||
with indent_log(): |
||||
write_output("%s: %s", name, value) |
||||
|
||||
def print_env_var_values(self) -> None: |
||||
"""Get key-values pairs present as environment variables""" |
||||
write_output("%s:", "env_var") |
||||
with indent_log(): |
||||
for key, value in sorted(self.configuration.get_environ_vars()): |
||||
env_var = f"PIP_{key.upper()}" |
||||
write_output("%s=%r", env_var, value) |
||||
|
||||
def open_in_editor(self, options: Values, args: List[str]) -> None: |
||||
editor = self._determine_editor(options) |
||||
|
||||
fname = self.configuration.get_file_to_edit() |
||||
if fname is None: |
||||
raise PipError("Could not determine appropriate file.") |
||||
elif '"' in fname: |
||||
# This shouldn't happen, unless we see a username like that. |
||||
# If that happens, we'd appreciate a pull request fixing this. |
||||
raise PipError( |
||||
f'Can not open an editor for a file name containing "\n{fname}' |
||||
) |
||||
|
||||
try: |
||||
subprocess.check_call(f'{editor} "{fname}"', shell=True) |
||||
except FileNotFoundError as e: |
||||
if not e.filename: |
||||
e.filename = editor |
||||
raise |
||||
except subprocess.CalledProcessError as e: |
||||
raise PipError( |
||||
"Editor Subprocess exited with exit code {}".format(e.returncode) |
||||
) |
||||
|
||||
def _get_n_args(self, args: List[str], example: str, n: int) -> Any: |
||||
"""Helper to make sure the command got the right number of arguments""" |
||||
if len(args) != n: |
||||
msg = ( |
||||
"Got unexpected number of arguments, expected {}. " |
||||
'(example: "{} config {}")' |
||||
).format(n, get_prog(), example) |
||||
raise PipError(msg) |
||||
|
||||
if n == 1: |
||||
return args[0] |
||||
else: |
||||
return args |
||||
|
||||
def _save_configuration(self) -> None: |
||||
# We successfully ran a modifying command. Need to save the |
||||
# configuration. |
||||
try: |
||||
self.configuration.save() |
||||
except Exception: |
||||
logger.exception( |
||||
"Unable to save configuration. Please report this as a bug." |
||||
) |
||||
raise PipError("Internal Error.") |
||||
|
||||
def _determine_editor(self, options: Values) -> str: |
||||
if options.editor is not None: |
||||
return options.editor |
||||
elif "VISUAL" in os.environ: |
||||
return os.environ["VISUAL"] |
||||
elif "EDITOR" in os.environ: |
||||
return os.environ["EDITOR"] |
||||
else: |
||||
raise PipError("Could not determine editor to use.") |
||||
@ -1,203 +0,0 @@
|
||||
import importlib.resources |
||||
import locale |
||||
import logging |
||||
import os |
||||
import sys |
||||
from optparse import Values |
||||
from types import ModuleType |
||||
from typing import Any, Dict, List, Optional |
||||
|
||||
import pip._vendor |
||||
from pip._vendor.certifi import where |
||||
from pip._vendor.packaging.version import parse as parse_version |
||||
|
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.cmdoptions import make_target_python |
||||
from pip._internal.cli.status_codes import SUCCESS |
||||
from pip._internal.configuration import Configuration |
||||
from pip._internal.metadata import get_environment |
||||
from pip._internal.utils.logging import indent_log |
||||
from pip._internal.utils.misc import get_pip_version |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
def show_value(name: str, value: Any) -> None: |
||||
logger.info("%s: %s", name, value) |
||||
|
||||
|
||||
def show_sys_implementation() -> None: |
||||
logger.info("sys.implementation:") |
||||
implementation_name = sys.implementation.name |
||||
with indent_log(): |
||||
show_value("name", implementation_name) |
||||
|
||||
|
||||
def create_vendor_txt_map() -> Dict[str, str]: |
||||
with importlib.resources.open_text("pip._vendor", "vendor.txt") as f: |
||||
# Purge non version specifying lines. |
||||
# Also, remove any space prefix or suffixes (including comments). |
||||
lines = [ |
||||
line.strip().split(" ", 1)[0] for line in f.readlines() if "==" in line |
||||
] |
||||
|
||||
# Transform into "module" -> version dict. |
||||
return dict(line.split("==", 1) for line in lines) |
||||
|
||||
|
||||
def get_module_from_module_name(module_name: str) -> Optional[ModuleType]: |
||||
# Module name can be uppercase in vendor.txt for some reason... |
||||
module_name = module_name.lower().replace("-", "_") |
||||
# PATCH: setuptools is actually only pkg_resources. |
||||
if module_name == "setuptools": |
||||
module_name = "pkg_resources" |
||||
|
||||
try: |
||||
__import__(f"pip._vendor.{module_name}", globals(), locals(), level=0) |
||||
return getattr(pip._vendor, module_name) |
||||
except ImportError: |
||||
# We allow 'truststore' to fail to import due |
||||
# to being unavailable on Python 3.9 and earlier. |
||||
if module_name == "truststore" and sys.version_info < (3, 10): |
||||
return None |
||||
raise |
||||
|
||||
|
||||
def get_vendor_version_from_module(module_name: str) -> Optional[str]: |
||||
module = get_module_from_module_name(module_name) |
||||
version = getattr(module, "__version__", None) |
||||
|
||||
if module and not version: |
||||
# Try to find version in debundled module info. |
||||
assert module.__file__ is not None |
||||
env = get_environment([os.path.dirname(module.__file__)]) |
||||
dist = env.get_distribution(module_name) |
||||
if dist: |
||||
version = str(dist.version) |
||||
|
||||
return version |
||||
|
||||
|
||||
def show_actual_vendor_versions(vendor_txt_versions: Dict[str, str]) -> None: |
||||
"""Log the actual version and print extra info if there is |
||||
a conflict or if the actual version could not be imported. |
||||
""" |
||||
for module_name, expected_version in vendor_txt_versions.items(): |
||||
extra_message = "" |
||||
actual_version = get_vendor_version_from_module(module_name) |
||||
if not actual_version: |
||||
extra_message = ( |
||||
" (Unable to locate actual module version, using" |
||||
" vendor.txt specified version)" |
||||
) |
||||
actual_version = expected_version |
||||
elif parse_version(actual_version) != parse_version(expected_version): |
||||
extra_message = ( |
||||
" (CONFLICT: vendor.txt suggests version should" |
||||
" be {})".format(expected_version) |
||||
) |
||||
logger.info("%s==%s%s", module_name, actual_version, extra_message) |
||||
|
||||
|
||||
def show_vendor_versions() -> None: |
||||
logger.info("vendored library versions:") |
||||
|
||||
vendor_txt_versions = create_vendor_txt_map() |
||||
with indent_log(): |
||||
show_actual_vendor_versions(vendor_txt_versions) |
||||
|
||||
|
||||
def show_tags(options: Values) -> None: |
||||
tag_limit = 10 |
||||
|
||||
target_python = make_target_python(options) |
||||
tags = target_python.get_sorted_tags() |
||||
|
||||
# Display the target options that were explicitly provided. |
||||
formatted_target = target_python.format_given() |
||||
suffix = "" |
||||
if formatted_target: |
||||
suffix = f" (target: {formatted_target})" |
||||
|
||||
msg = "Compatible tags: {}{}".format(len(tags), suffix) |
||||
logger.info(msg) |
||||
|
||||
if options.verbose < 1 and len(tags) > tag_limit: |
||||
tags_limited = True |
||||
tags = tags[:tag_limit] |
||||
else: |
||||
tags_limited = False |
||||
|
||||
with indent_log(): |
||||
for tag in tags: |
||||
logger.info(str(tag)) |
||||
|
||||
if tags_limited: |
||||
msg = ( |
||||
"...\n[First {tag_limit} tags shown. Pass --verbose to show all.]" |
||||
).format(tag_limit=tag_limit) |
||||
logger.info(msg) |
||||
|
||||
|
||||
def ca_bundle_info(config: Configuration) -> str: |
||||
levels = {key.split(".", 1)[0] for key, _ in config.items()} |
||||
if not levels: |
||||
return "Not specified" |
||||
|
||||
levels_that_override_global = ["install", "wheel", "download"] |
||||
global_overriding_level = [ |
||||
level for level in levels if level in levels_that_override_global |
||||
] |
||||
if not global_overriding_level: |
||||
return "global" |
||||
|
||||
if "global" in levels: |
||||
levels.remove("global") |
||||
return ", ".join(levels) |
||||
|
||||
|
||||
class DebugCommand(Command): |
||||
""" |
||||
Display debug information. |
||||
""" |
||||
|
||||
usage = """ |
||||
%prog <options>""" |
||||
ignore_require_venv = True |
||||
|
||||
def add_options(self) -> None: |
||||
cmdoptions.add_target_python_options(self.cmd_opts) |
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
self.parser.config.load() |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
logger.warning( |
||||
"This command is only meant for debugging. " |
||||
"Do not use this with automation for parsing and getting these " |
||||
"details, since the output and options of this command may " |
||||
"change without notice." |
||||
) |
||||
show_value("pip version", get_pip_version()) |
||||
show_value("sys.version", sys.version) |
||||
show_value("sys.executable", sys.executable) |
||||
show_value("sys.getdefaultencoding", sys.getdefaultencoding()) |
||||
show_value("sys.getfilesystemencoding", sys.getfilesystemencoding()) |
||||
show_value( |
||||
"locale.getpreferredencoding", |
||||
locale.getpreferredencoding(), |
||||
) |
||||
show_value("sys.platform", sys.platform) |
||||
show_sys_implementation() |
||||
|
||||
show_value("'cert' config value", ca_bundle_info(self.parser.config)) |
||||
show_value("REQUESTS_CA_BUNDLE", os.environ.get("REQUESTS_CA_BUNDLE")) |
||||
show_value("CURL_CA_BUNDLE", os.environ.get("CURL_CA_BUNDLE")) |
||||
show_value("pip._vendor.certifi.where()", where()) |
||||
show_value("pip._vendor.DEBUNDLED", pip._vendor.DEBUNDLED) |
||||
|
||||
show_vendor_versions() |
||||
|
||||
show_tags(options) |
||||
|
||||
return SUCCESS |
||||
@ -1,147 +0,0 @@
|
||||
import logging |
||||
import os |
||||
from optparse import Values |
||||
from typing import List |
||||
|
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.cmdoptions import make_target_python |
||||
from pip._internal.cli.req_command import RequirementCommand, with_cleanup |
||||
from pip._internal.cli.status_codes import SUCCESS |
||||
from pip._internal.operations.build.build_tracker import get_build_tracker |
||||
from pip._internal.req.req_install import check_legacy_setup_py_options |
||||
from pip._internal.utils.misc import ensure_dir, normalize_path, write_output |
||||
from pip._internal.utils.temp_dir import TempDirectory |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class DownloadCommand(RequirementCommand): |
||||
""" |
||||
Download packages from: |
||||
|
||||
- PyPI (and other indexes) using requirement specifiers. |
||||
- VCS project urls. |
||||
- Local project directories. |
||||
- Local or remote source archives. |
||||
|
||||
pip also supports downloading from "requirements files", which provide |
||||
an easy way to specify a whole environment to be downloaded. |
||||
""" |
||||
|
||||
usage = """ |
||||
%prog [options] <requirement specifier> [package-index-options] ... |
||||
%prog [options] -r <requirements file> [package-index-options] ... |
||||
%prog [options] <vcs project url> ... |
||||
%prog [options] <local project path> ... |
||||
%prog [options] <archive url/path> ...""" |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option(cmdoptions.constraints()) |
||||
self.cmd_opts.add_option(cmdoptions.requirements()) |
||||
self.cmd_opts.add_option(cmdoptions.no_deps()) |
||||
self.cmd_opts.add_option(cmdoptions.global_options()) |
||||
self.cmd_opts.add_option(cmdoptions.no_binary()) |
||||
self.cmd_opts.add_option(cmdoptions.only_binary()) |
||||
self.cmd_opts.add_option(cmdoptions.prefer_binary()) |
||||
self.cmd_opts.add_option(cmdoptions.src()) |
||||
self.cmd_opts.add_option(cmdoptions.pre()) |
||||
self.cmd_opts.add_option(cmdoptions.require_hashes()) |
||||
self.cmd_opts.add_option(cmdoptions.progress_bar()) |
||||
self.cmd_opts.add_option(cmdoptions.no_build_isolation()) |
||||
self.cmd_opts.add_option(cmdoptions.use_pep517()) |
||||
self.cmd_opts.add_option(cmdoptions.no_use_pep517()) |
||||
self.cmd_opts.add_option(cmdoptions.check_build_deps()) |
||||
self.cmd_opts.add_option(cmdoptions.ignore_requires_python()) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"-d", |
||||
"--dest", |
||||
"--destination-dir", |
||||
"--destination-directory", |
||||
dest="download_dir", |
||||
metavar="dir", |
||||
default=os.curdir, |
||||
help="Download packages into <dir>.", |
||||
) |
||||
|
||||
cmdoptions.add_target_python_options(self.cmd_opts) |
||||
|
||||
index_opts = cmdoptions.make_option_group( |
||||
cmdoptions.index_group, |
||||
self.parser, |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, index_opts) |
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
@with_cleanup |
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
options.ignore_installed = True |
||||
# editable doesn't really make sense for `pip download`, but the bowels |
||||
# of the RequirementSet code require that property. |
||||
options.editables = [] |
||||
|
||||
cmdoptions.check_dist_restriction(options) |
||||
|
||||
options.download_dir = normalize_path(options.download_dir) |
||||
ensure_dir(options.download_dir) |
||||
|
||||
session = self.get_default_session(options) |
||||
|
||||
target_python = make_target_python(options) |
||||
finder = self._build_package_finder( |
||||
options=options, |
||||
session=session, |
||||
target_python=target_python, |
||||
ignore_requires_python=options.ignore_requires_python, |
||||
) |
||||
|
||||
build_tracker = self.enter_context(get_build_tracker()) |
||||
|
||||
directory = TempDirectory( |
||||
delete=not options.no_clean, |
||||
kind="download", |
||||
globally_managed=True, |
||||
) |
||||
|
||||
reqs = self.get_requirements(args, options, finder, session) |
||||
check_legacy_setup_py_options(options, reqs) |
||||
|
||||
preparer = self.make_requirement_preparer( |
||||
temp_build_dir=directory, |
||||
options=options, |
||||
build_tracker=build_tracker, |
||||
session=session, |
||||
finder=finder, |
||||
download_dir=options.download_dir, |
||||
use_user_site=False, |
||||
verbosity=self.verbosity, |
||||
) |
||||
|
||||
resolver = self.make_resolver( |
||||
preparer=preparer, |
||||
finder=finder, |
||||
options=options, |
||||
ignore_requires_python=options.ignore_requires_python, |
||||
use_pep517=options.use_pep517, |
||||
py_version_info=options.python_version, |
||||
) |
||||
|
||||
self.trace_basic_info(finder) |
||||
|
||||
requirement_set = resolver.resolve(reqs, check_supported_wheels=True) |
||||
|
||||
downloaded: List[str] = [] |
||||
for req in requirement_set.requirements.values(): |
||||
if req.satisfied_by is None: |
||||
assert req.name is not None |
||||
preparer.save_linked_requirement(req) |
||||
downloaded.append(req.name) |
||||
|
||||
preparer.prepare_linked_requirements_more(requirement_set.requirements.values()) |
||||
requirement_set.warn_legacy_versions_and_specifiers() |
||||
|
||||
if downloaded: |
||||
write_output("Successfully downloaded %s", " ".join(downloaded)) |
||||
|
||||
return SUCCESS |
||||
@ -1,108 +0,0 @@
|
||||
import sys |
||||
from optparse import Values |
||||
from typing import AbstractSet, List |
||||
|
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import SUCCESS |
||||
from pip._internal.operations.freeze import freeze |
||||
from pip._internal.utils.compat import stdlib_pkgs |
||||
|
||||
|
||||
def _should_suppress_build_backends() -> bool: |
||||
return sys.version_info < (3, 12) |
||||
|
||||
|
||||
def _dev_pkgs() -> AbstractSet[str]: |
||||
pkgs = {"pip"} |
||||
|
||||
if _should_suppress_build_backends(): |
||||
pkgs |= {"setuptools", "distribute", "wheel"} |
||||
|
||||
return pkgs |
||||
|
||||
|
||||
class FreezeCommand(Command): |
||||
""" |
||||
Output installed packages in requirements format. |
||||
|
||||
packages are listed in a case-insensitive sorted order. |
||||
""" |
||||
|
||||
usage = """ |
||||
%prog [options]""" |
||||
log_streams = ("ext://sys.stderr", "ext://sys.stderr") |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"-r", |
||||
"--requirement", |
||||
dest="requirements", |
||||
action="append", |
||||
default=[], |
||||
metavar="file", |
||||
help=( |
||||
"Use the order in the given requirements file and its " |
||||
"comments when generating output. This option can be " |
||||
"used multiple times." |
||||
), |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"-l", |
||||
"--local", |
||||
dest="local", |
||||
action="store_true", |
||||
default=False, |
||||
help=( |
||||
"If in a virtualenv that has global access, do not output " |
||||
"globally-installed packages." |
||||
), |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--user", |
||||
dest="user", |
||||
action="store_true", |
||||
default=False, |
||||
help="Only output packages installed in user-site.", |
||||
) |
||||
self.cmd_opts.add_option(cmdoptions.list_path()) |
||||
self.cmd_opts.add_option( |
||||
"--all", |
||||
dest="freeze_all", |
||||
action="store_true", |
||||
help=( |
||||
"Do not skip these packages in the output:" |
||||
" {}".format(", ".join(_dev_pkgs())) |
||||
), |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--exclude-editable", |
||||
dest="exclude_editable", |
||||
action="store_true", |
||||
help="Exclude editable package from output.", |
||||
) |
||||
self.cmd_opts.add_option(cmdoptions.list_exclude()) |
||||
|
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
skip = set(stdlib_pkgs) |
||||
if not options.freeze_all: |
||||
skip.update(_dev_pkgs()) |
||||
|
||||
if options.excludes: |
||||
skip.update(options.excludes) |
||||
|
||||
cmdoptions.check_list_path_option(options) |
||||
|
||||
for line in freeze( |
||||
requirement=options.requirements, |
||||
local_only=options.local, |
||||
user_only=options.user, |
||||
paths=options.path, |
||||
isolated=options.isolated_mode, |
||||
skip=skip, |
||||
exclude_editable=options.exclude_editable, |
||||
): |
||||
sys.stdout.write(line + "\n") |
||||
return SUCCESS |
||||
@ -1,59 +0,0 @@
|
||||
import hashlib |
||||
import logging |
||||
import sys |
||||
from optparse import Values |
||||
from typing import List |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import ERROR, SUCCESS |
||||
from pip._internal.utils.hashes import FAVORITE_HASH, STRONG_HASHES |
||||
from pip._internal.utils.misc import read_chunks, write_output |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class HashCommand(Command): |
||||
""" |
||||
Compute a hash of a local package archive. |
||||
|
||||
These can be used with --hash in a requirements file to do repeatable |
||||
installs. |
||||
""" |
||||
|
||||
usage = "%prog [options] <file> ..." |
||||
ignore_require_venv = True |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"-a", |
||||
"--algorithm", |
||||
dest="algorithm", |
||||
choices=STRONG_HASHES, |
||||
action="store", |
||||
default=FAVORITE_HASH, |
||||
help="The hash algorithm to use: one of {}".format( |
||||
", ".join(STRONG_HASHES) |
||||
), |
||||
) |
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
if not args: |
||||
self.parser.print_usage(sys.stderr) |
||||
return ERROR |
||||
|
||||
algorithm = options.algorithm |
||||
for path in args: |
||||
write_output( |
||||
"%s:\n--hash=%s:%s", path, algorithm, _hash_of_file(path, algorithm) |
||||
) |
||||
return SUCCESS |
||||
|
||||
|
||||
def _hash_of_file(path: str, algorithm: str) -> str: |
||||
"""Return the hash digest of a file.""" |
||||
with open(path, "rb") as archive: |
||||
hash = hashlib.new(algorithm) |
||||
for chunk in read_chunks(archive): |
||||
hash.update(chunk) |
||||
return hash.hexdigest() |
||||
@ -1,41 +0,0 @@
|
||||
from optparse import Values |
||||
from typing import List |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import SUCCESS |
||||
from pip._internal.exceptions import CommandError |
||||
|
||||
|
||||
class HelpCommand(Command): |
||||
"""Show help for commands""" |
||||
|
||||
usage = """ |
||||
%prog <command>""" |
||||
ignore_require_venv = True |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
from pip._internal.commands import ( |
||||
commands_dict, |
||||
create_command, |
||||
get_similar_commands, |
||||
) |
||||
|
||||
try: |
||||
# 'pip help' with no args is handled by pip.__init__.parseopt() |
||||
cmd_name = args[0] # the command we need help for |
||||
except IndexError: |
||||
return SUCCESS |
||||
|
||||
if cmd_name not in commands_dict: |
||||
guess = get_similar_commands(cmd_name) |
||||
|
||||
msg = [f'unknown command "{cmd_name}"'] |
||||
if guess: |
||||
msg.append(f'maybe you meant "{guess}"') |
||||
|
||||
raise CommandError(" - ".join(msg)) |
||||
|
||||
command = create_command(cmd_name) |
||||
command.parser.print_help() |
||||
|
||||
return SUCCESS |
||||
@ -1,139 +0,0 @@
|
||||
import logging |
||||
from optparse import Values |
||||
from typing import Any, Iterable, List, Optional, Union |
||||
|
||||
from pip._vendor.packaging.version import LegacyVersion, Version |
||||
|
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.req_command import IndexGroupCommand |
||||
from pip._internal.cli.status_codes import ERROR, SUCCESS |
||||
from pip._internal.commands.search import print_dist_installation_info |
||||
from pip._internal.exceptions import CommandError, DistributionNotFound, PipError |
||||
from pip._internal.index.collector import LinkCollector |
||||
from pip._internal.index.package_finder import PackageFinder |
||||
from pip._internal.models.selection_prefs import SelectionPreferences |
||||
from pip._internal.models.target_python import TargetPython |
||||
from pip._internal.network.session import PipSession |
||||
from pip._internal.utils.misc import write_output |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class IndexCommand(IndexGroupCommand): |
||||
""" |
||||
Inspect information available from package indexes. |
||||
""" |
||||
|
||||
ignore_require_venv = True |
||||
usage = """ |
||||
%prog versions <package> |
||||
""" |
||||
|
||||
def add_options(self) -> None: |
||||
cmdoptions.add_target_python_options(self.cmd_opts) |
||||
|
||||
self.cmd_opts.add_option(cmdoptions.ignore_requires_python()) |
||||
self.cmd_opts.add_option(cmdoptions.pre()) |
||||
self.cmd_opts.add_option(cmdoptions.no_binary()) |
||||
self.cmd_opts.add_option(cmdoptions.only_binary()) |
||||
|
||||
index_opts = cmdoptions.make_option_group( |
||||
cmdoptions.index_group, |
||||
self.parser, |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, index_opts) |
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
handlers = { |
||||
"versions": self.get_available_package_versions, |
||||
} |
||||
|
||||
logger.warning( |
||||
"pip index is currently an experimental command. " |
||||
"It may be removed/changed in a future release " |
||||
"without prior warning." |
||||
) |
||||
|
||||
# Determine action |
||||
if not args or args[0] not in handlers: |
||||
logger.error( |
||||
"Need an action (%s) to perform.", |
||||
", ".join(sorted(handlers)), |
||||
) |
||||
return ERROR |
||||
|
||||
action = args[0] |
||||
|
||||
# Error handling happens here, not in the action-handlers. |
||||
try: |
||||
handlers[action](options, args[1:]) |
||||
except PipError as e: |
||||
logger.error(e.args[0]) |
||||
return ERROR |
||||
|
||||
return SUCCESS |
||||
|
||||
def _build_package_finder( |
||||
self, |
||||
options: Values, |
||||
session: PipSession, |
||||
target_python: Optional[TargetPython] = None, |
||||
ignore_requires_python: Optional[bool] = None, |
||||
) -> PackageFinder: |
||||
""" |
||||
Create a package finder appropriate to the index command. |
||||
""" |
||||
link_collector = LinkCollector.create(session, options=options) |
||||
|
||||
# Pass allow_yanked=False to ignore yanked versions. |
||||
selection_prefs = SelectionPreferences( |
||||
allow_yanked=False, |
||||
allow_all_prereleases=options.pre, |
||||
ignore_requires_python=ignore_requires_python, |
||||
) |
||||
|
||||
return PackageFinder.create( |
||||
link_collector=link_collector, |
||||
selection_prefs=selection_prefs, |
||||
target_python=target_python, |
||||
) |
||||
|
||||
def get_available_package_versions(self, options: Values, args: List[Any]) -> None: |
||||
if len(args) != 1: |
||||
raise CommandError("You need to specify exactly one argument") |
||||
|
||||
target_python = cmdoptions.make_target_python(options) |
||||
query = args[0] |
||||
|
||||
with self._build_session(options) as session: |
||||
finder = self._build_package_finder( |
||||
options=options, |
||||
session=session, |
||||
target_python=target_python, |
||||
ignore_requires_python=options.ignore_requires_python, |
||||
) |
||||
|
||||
versions: Iterable[Union[LegacyVersion, Version]] = ( |
||||
candidate.version for candidate in finder.find_all_candidates(query) |
||||
) |
||||
|
||||
if not options.pre: |
||||
# Remove prereleases |
||||
versions = ( |
||||
version for version in versions if not version.is_prerelease |
||||
) |
||||
versions = set(versions) |
||||
|
||||
if not versions: |
||||
raise DistributionNotFound( |
||||
"No matching distribution found for {}".format(query) |
||||
) |
||||
|
||||
formatted_versions = [str(ver) for ver in sorted(versions, reverse=True)] |
||||
latest = formatted_versions[0] |
||||
|
||||
write_output("{} ({})".format(query, latest)) |
||||
write_output("Available versions: {}".format(", ".join(formatted_versions))) |
||||
print_dist_installation_info(query, latest) |
||||
@ -1,92 +0,0 @@
|
||||
import logging |
||||
from optparse import Values |
||||
from typing import Any, Dict, List |
||||
|
||||
from pip._vendor.packaging.markers import default_environment |
||||
from pip._vendor.rich import print_json |
||||
|
||||
from pip import __version__ |
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.req_command import Command |
||||
from pip._internal.cli.status_codes import SUCCESS |
||||
from pip._internal.metadata import BaseDistribution, get_environment |
||||
from pip._internal.utils.compat import stdlib_pkgs |
||||
from pip._internal.utils.urls import path_to_url |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class InspectCommand(Command): |
||||
""" |
||||
Inspect the content of a Python environment and produce a report in JSON format. |
||||
""" |
||||
|
||||
ignore_require_venv = True |
||||
usage = """ |
||||
%prog [options]""" |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"--local", |
||||
action="store_true", |
||||
default=False, |
||||
help=( |
||||
"If in a virtualenv that has global access, do not list " |
||||
"globally-installed packages." |
||||
), |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--user", |
||||
dest="user", |
||||
action="store_true", |
||||
default=False, |
||||
help="Only output packages installed in user-site.", |
||||
) |
||||
self.cmd_opts.add_option(cmdoptions.list_path()) |
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
cmdoptions.check_list_path_option(options) |
||||
dists = get_environment(options.path).iter_installed_distributions( |
||||
local_only=options.local, |
||||
user_only=options.user, |
||||
skip=set(stdlib_pkgs), |
||||
) |
||||
output = { |
||||
"version": "1", |
||||
"pip_version": __version__, |
||||
"installed": [self._dist_to_dict(dist) for dist in dists], |
||||
"environment": default_environment(), |
||||
# TODO tags? scheme? |
||||
} |
||||
print_json(data=output) |
||||
return SUCCESS |
||||
|
||||
def _dist_to_dict(self, dist: BaseDistribution) -> Dict[str, Any]: |
||||
res: Dict[str, Any] = { |
||||
"metadata": dist.metadata_dict, |
||||
"metadata_location": dist.info_location, |
||||
} |
||||
# direct_url. Note that we don't have download_info (as in the installation |
||||
# report) since it is not recorded in installed metadata. |
||||
direct_url = dist.direct_url |
||||
if direct_url is not None: |
||||
res["direct_url"] = direct_url.to_dict() |
||||
else: |
||||
# Emulate direct_url for legacy editable installs. |
||||
editable_project_location = dist.editable_project_location |
||||
if editable_project_location is not None: |
||||
res["direct_url"] = { |
||||
"url": path_to_url(editable_project_location), |
||||
"dir_info": { |
||||
"editable": True, |
||||
}, |
||||
} |
||||
# installer |
||||
installer = dist.installer |
||||
if dist.installer: |
||||
res["installer"] = installer |
||||
# requested |
||||
if dist.installed_with_dist_info: |
||||
res["requested"] = dist.requested |
||||
return res |
||||
@ -1,778 +0,0 @@
|
||||
import errno |
||||
import json |
||||
import operator |
||||
import os |
||||
import shutil |
||||
import site |
||||
from optparse import SUPPRESS_HELP, Values |
||||
from typing import List, Optional |
||||
|
||||
from pip._vendor.rich import print_json |
||||
|
||||
from pip._internal.cache import WheelCache |
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.cmdoptions import make_target_python |
||||
from pip._internal.cli.req_command import ( |
||||
RequirementCommand, |
||||
warn_if_run_as_root, |
||||
with_cleanup, |
||||
) |
||||
from pip._internal.cli.status_codes import ERROR, SUCCESS |
||||
from pip._internal.exceptions import CommandError, InstallationError |
||||
from pip._internal.locations import get_scheme |
||||
from pip._internal.metadata import get_environment |
||||
from pip._internal.models.installation_report import InstallationReport |
||||
from pip._internal.operations.build.build_tracker import get_build_tracker |
||||
from pip._internal.operations.check import ConflictDetails, check_install_conflicts |
||||
from pip._internal.req import install_given_reqs |
||||
from pip._internal.req.req_install import ( |
||||
InstallRequirement, |
||||
check_legacy_setup_py_options, |
||||
) |
||||
from pip._internal.utils.compat import WINDOWS |
||||
from pip._internal.utils.filesystem import test_writable_dir |
||||
from pip._internal.utils.logging import getLogger |
||||
from pip._internal.utils.misc import ( |
||||
check_externally_managed, |
||||
ensure_dir, |
||||
get_pip_version, |
||||
protect_pip_from_modification_on_windows, |
||||
write_output, |
||||
) |
||||
from pip._internal.utils.temp_dir import TempDirectory |
||||
from pip._internal.utils.virtualenv import ( |
||||
running_under_virtualenv, |
||||
virtualenv_no_global, |
||||
) |
||||
from pip._internal.wheel_builder import build, should_build_for_install_command |
||||
|
||||
logger = getLogger(__name__) |
||||
|
||||
|
||||
class InstallCommand(RequirementCommand): |
||||
""" |
||||
Install packages from: |
||||
|
||||
- PyPI (and other indexes) using requirement specifiers. |
||||
- VCS project urls. |
||||
- Local project directories. |
||||
- Local or remote source archives. |
||||
|
||||
pip also supports installing from "requirements files", which provide |
||||
an easy way to specify a whole environment to be installed. |
||||
""" |
||||
|
||||
usage = """ |
||||
%prog [options] <requirement specifier> [package-index-options] ... |
||||
%prog [options] -r <requirements file> [package-index-options] ... |
||||
%prog [options] [-e] <vcs project url> ... |
||||
%prog [options] [-e] <local project path> ... |
||||
%prog [options] <archive url/path> ...""" |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option(cmdoptions.requirements()) |
||||
self.cmd_opts.add_option(cmdoptions.constraints()) |
||||
self.cmd_opts.add_option(cmdoptions.no_deps()) |
||||
self.cmd_opts.add_option(cmdoptions.pre()) |
||||
|
||||
self.cmd_opts.add_option(cmdoptions.editable()) |
||||
self.cmd_opts.add_option( |
||||
"--dry-run", |
||||
action="store_true", |
||||
dest="dry_run", |
||||
default=False, |
||||
help=( |
||||
"Don't actually install anything, just print what would be. " |
||||
"Can be used in combination with --ignore-installed " |
||||
"to 'resolve' the requirements." |
||||
), |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"-t", |
||||
"--target", |
||||
dest="target_dir", |
||||
metavar="dir", |
||||
default=None, |
||||
help=( |
||||
"Install packages into <dir>. " |
||||
"By default this will not replace existing files/folders in " |
||||
"<dir>. Use --upgrade to replace existing packages in <dir> " |
||||
"with new versions." |
||||
), |
||||
) |
||||
cmdoptions.add_target_python_options(self.cmd_opts) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--user", |
||||
dest="use_user_site", |
||||
action="store_true", |
||||
help=( |
||||
"Install to the Python user install directory for your " |
||||
"platform. Typically ~/.local/, or %APPDATA%\\Python on " |
||||
"Windows. (See the Python documentation for site.USER_BASE " |
||||
"for full details.)" |
||||
), |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--no-user", |
||||
dest="use_user_site", |
||||
action="store_false", |
||||
help=SUPPRESS_HELP, |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--root", |
||||
dest="root_path", |
||||
metavar="dir", |
||||
default=None, |
||||
help="Install everything relative to this alternate root directory.", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--prefix", |
||||
dest="prefix_path", |
||||
metavar="dir", |
||||
default=None, |
||||
help=( |
||||
"Installation prefix where lib, bin and other top-level " |
||||
"folders are placed. Note that the resulting installation may " |
||||
"contain scripts and other resources which reference the " |
||||
"Python interpreter of pip, and not that of ``--prefix``. " |
||||
"See also the ``--python`` option if the intention is to " |
||||
"install packages into another (possibly pip-free) " |
||||
"environment." |
||||
), |
||||
) |
||||
|
||||
self.cmd_opts.add_option(cmdoptions.src()) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"-U", |
||||
"--upgrade", |
||||
dest="upgrade", |
||||
action="store_true", |
||||
help=( |
||||
"Upgrade all specified packages to the newest available " |
||||
"version. The handling of dependencies depends on the " |
||||
"upgrade-strategy used." |
||||
), |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--upgrade-strategy", |
||||
dest="upgrade_strategy", |
||||
default="only-if-needed", |
||||
choices=["only-if-needed", "eager"], |
||||
help=( |
||||
"Determines how dependency upgrading should be handled " |
||||
"[default: %default]. " |
||||
'"eager" - dependencies are upgraded regardless of ' |
||||
"whether the currently installed version satisfies the " |
||||
"requirements of the upgraded package(s). " |
||||
'"only-if-needed" - are upgraded only when they do not ' |
||||
"satisfy the requirements of the upgraded package(s)." |
||||
), |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--force-reinstall", |
||||
dest="force_reinstall", |
||||
action="store_true", |
||||
help="Reinstall all packages even if they are already up-to-date.", |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"-I", |
||||
"--ignore-installed", |
||||
dest="ignore_installed", |
||||
action="store_true", |
||||
help=( |
||||
"Ignore the installed packages, overwriting them. " |
||||
"This can break your system if the existing package " |
||||
"is of a different version or was installed " |
||||
"with a different package manager!" |
||||
), |
||||
) |
||||
|
||||
self.cmd_opts.add_option(cmdoptions.ignore_requires_python()) |
||||
self.cmd_opts.add_option(cmdoptions.no_build_isolation()) |
||||
self.cmd_opts.add_option(cmdoptions.use_pep517()) |
||||
self.cmd_opts.add_option(cmdoptions.no_use_pep517()) |
||||
self.cmd_opts.add_option(cmdoptions.check_build_deps()) |
||||
self.cmd_opts.add_option(cmdoptions.override_externally_managed()) |
||||
|
||||
self.cmd_opts.add_option(cmdoptions.config_settings()) |
||||
self.cmd_opts.add_option(cmdoptions.global_options()) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--compile", |
||||
action="store_true", |
||||
dest="compile", |
||||
default=True, |
||||
help="Compile Python source files to bytecode", |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--no-compile", |
||||
action="store_false", |
||||
dest="compile", |
||||
help="Do not compile Python source files to bytecode", |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--no-warn-script-location", |
||||
action="store_false", |
||||
dest="warn_script_location", |
||||
default=True, |
||||
help="Do not warn when installing scripts outside PATH", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--no-warn-conflicts", |
||||
action="store_false", |
||||
dest="warn_about_conflicts", |
||||
default=True, |
||||
help="Do not warn about broken dependencies", |
||||
) |
||||
self.cmd_opts.add_option(cmdoptions.no_binary()) |
||||
self.cmd_opts.add_option(cmdoptions.only_binary()) |
||||
self.cmd_opts.add_option(cmdoptions.prefer_binary()) |
||||
self.cmd_opts.add_option(cmdoptions.require_hashes()) |
||||
self.cmd_opts.add_option(cmdoptions.progress_bar()) |
||||
self.cmd_opts.add_option(cmdoptions.root_user_action()) |
||||
|
||||
index_opts = cmdoptions.make_option_group( |
||||
cmdoptions.index_group, |
||||
self.parser, |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, index_opts) |
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--report", |
||||
dest="json_report_file", |
||||
metavar="file", |
||||
default=None, |
||||
help=( |
||||
"Generate a JSON file describing what pip did to install " |
||||
"the provided requirements. " |
||||
"Can be used in combination with --dry-run and --ignore-installed " |
||||
"to 'resolve' the requirements. " |
||||
"When - is used as file name it writes to stdout. " |
||||
"When writing to stdout, please combine with the --quiet option " |
||||
"to avoid mixing pip logging output with JSON output." |
||||
), |
||||
) |
||||
|
||||
@with_cleanup |
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
if options.use_user_site and options.target_dir is not None: |
||||
raise CommandError("Can not combine '--user' and '--target'") |
||||
|
||||
# Check whether the environment we're installing into is externally |
||||
# managed, as specified in PEP 668. Specifying --root, --target, or |
||||
# --prefix disables the check, since there's no reliable way to locate |
||||
# the EXTERNALLY-MANAGED file for those cases. An exception is also |
||||
# made specifically for "--dry-run --report" for convenience. |
||||
installing_into_current_environment = ( |
||||
not (options.dry_run and options.json_report_file) |
||||
and options.root_path is None |
||||
and options.target_dir is None |
||||
and options.prefix_path is None |
||||
) |
||||
if ( |
||||
installing_into_current_environment |
||||
and not options.override_externally_managed |
||||
): |
||||
check_externally_managed() |
||||
|
||||
upgrade_strategy = "to-satisfy-only" |
||||
if options.upgrade: |
||||
upgrade_strategy = options.upgrade_strategy |
||||
|
||||
cmdoptions.check_dist_restriction(options, check_target=True) |
||||
|
||||
logger.verbose("Using %s", get_pip_version()) |
||||
options.use_user_site = decide_user_install( |
||||
options.use_user_site, |
||||
prefix_path=options.prefix_path, |
||||
target_dir=options.target_dir, |
||||
root_path=options.root_path, |
||||
isolated_mode=options.isolated_mode, |
||||
) |
||||
|
||||
target_temp_dir: Optional[TempDirectory] = None |
||||
target_temp_dir_path: Optional[str] = None |
||||
if options.target_dir: |
||||
options.ignore_installed = True |
||||
options.target_dir = os.path.abspath(options.target_dir) |
||||
if ( |
||||
# fmt: off |
||||
os.path.exists(options.target_dir) and |
||||
not os.path.isdir(options.target_dir) |
||||
# fmt: on |
||||
): |
||||
raise CommandError( |
||||
"Target path exists but is not a directory, will not continue." |
||||
) |
||||
|
||||
# Create a target directory for using with the target option |
||||
target_temp_dir = TempDirectory(kind="target") |
||||
target_temp_dir_path = target_temp_dir.path |
||||
self.enter_context(target_temp_dir) |
||||
|
||||
global_options = options.global_options or [] |
||||
|
||||
session = self.get_default_session(options) |
||||
|
||||
target_python = make_target_python(options) |
||||
finder = self._build_package_finder( |
||||
options=options, |
||||
session=session, |
||||
target_python=target_python, |
||||
ignore_requires_python=options.ignore_requires_python, |
||||
) |
||||
build_tracker = self.enter_context(get_build_tracker()) |
||||
|
||||
directory = TempDirectory( |
||||
delete=not options.no_clean, |
||||
kind="install", |
||||
globally_managed=True, |
||||
) |
||||
|
||||
try: |
||||
reqs = self.get_requirements(args, options, finder, session) |
||||
check_legacy_setup_py_options(options, reqs) |
||||
|
||||
wheel_cache = WheelCache(options.cache_dir) |
||||
|
||||
# Only when installing is it permitted to use PEP 660. |
||||
# In other circumstances (pip wheel, pip download) we generate |
||||
# regular (i.e. non editable) metadata and wheels. |
||||
for req in reqs: |
||||
req.permit_editable_wheels = True |
||||
|
||||
preparer = self.make_requirement_preparer( |
||||
temp_build_dir=directory, |
||||
options=options, |
||||
build_tracker=build_tracker, |
||||
session=session, |
||||
finder=finder, |
||||
use_user_site=options.use_user_site, |
||||
verbosity=self.verbosity, |
||||
) |
||||
resolver = self.make_resolver( |
||||
preparer=preparer, |
||||
finder=finder, |
||||
options=options, |
||||
wheel_cache=wheel_cache, |
||||
use_user_site=options.use_user_site, |
||||
ignore_installed=options.ignore_installed, |
||||
ignore_requires_python=options.ignore_requires_python, |
||||
force_reinstall=options.force_reinstall, |
||||
upgrade_strategy=upgrade_strategy, |
||||
use_pep517=options.use_pep517, |
||||
) |
||||
|
||||
self.trace_basic_info(finder) |
||||
|
||||
requirement_set = resolver.resolve( |
||||
reqs, check_supported_wheels=not options.target_dir |
||||
) |
||||
|
||||
if options.json_report_file: |
||||
report = InstallationReport(requirement_set.requirements_to_install) |
||||
if options.json_report_file == "-": |
||||
print_json(data=report.to_dict()) |
||||
else: |
||||
with open(options.json_report_file, "w", encoding="utf-8") as f: |
||||
json.dump(report.to_dict(), f, indent=2, ensure_ascii=False) |
||||
|
||||
if options.dry_run: |
||||
# In non dry-run mode, the legacy versions and specifiers check |
||||
# will be done as part of conflict detection. |
||||
requirement_set.warn_legacy_versions_and_specifiers() |
||||
would_install_items = sorted( |
||||
(r.metadata["name"], r.metadata["version"]) |
||||
for r in requirement_set.requirements_to_install |
||||
) |
||||
if would_install_items: |
||||
write_output( |
||||
"Would install %s", |
||||
" ".join("-".join(item) for item in would_install_items), |
||||
) |
||||
return SUCCESS |
||||
|
||||
try: |
||||
pip_req = requirement_set.get_requirement("pip") |
||||
except KeyError: |
||||
modifying_pip = False |
||||
else: |
||||
# If we're not replacing an already installed pip, |
||||
# we're not modifying it. |
||||
modifying_pip = pip_req.satisfied_by is None |
||||
protect_pip_from_modification_on_windows(modifying_pip=modifying_pip) |
||||
|
||||
reqs_to_build = [ |
||||
r |
||||
for r in requirement_set.requirements.values() |
||||
if should_build_for_install_command(r) |
||||
] |
||||
|
||||
_, build_failures = build( |
||||
reqs_to_build, |
||||
wheel_cache=wheel_cache, |
||||
verify=True, |
||||
build_options=[], |
||||
global_options=global_options, |
||||
) |
||||
|
||||
if build_failures: |
||||
raise InstallationError( |
||||
"Could not build wheels for {}, which is required to " |
||||
"install pyproject.toml-based projects".format( |
||||
", ".join(r.name for r in build_failures) # type: ignore |
||||
) |
||||
) |
||||
|
||||
to_install = resolver.get_installation_order(requirement_set) |
||||
|
||||
# Check for conflicts in the package set we're installing. |
||||
conflicts: Optional[ConflictDetails] = None |
||||
should_warn_about_conflicts = ( |
||||
not options.ignore_dependencies and options.warn_about_conflicts |
||||
) |
||||
if should_warn_about_conflicts: |
||||
conflicts = self._determine_conflicts(to_install) |
||||
|
||||
# Don't warn about script install locations if |
||||
# --target or --prefix has been specified |
||||
warn_script_location = options.warn_script_location |
||||
if options.target_dir or options.prefix_path: |
||||
warn_script_location = False |
||||
|
||||
installed = install_given_reqs( |
||||
to_install, |
||||
global_options, |
||||
root=options.root_path, |
||||
home=target_temp_dir_path, |
||||
prefix=options.prefix_path, |
||||
warn_script_location=warn_script_location, |
||||
use_user_site=options.use_user_site, |
||||
pycompile=options.compile, |
||||
) |
||||
|
||||
lib_locations = get_lib_location_guesses( |
||||
user=options.use_user_site, |
||||
home=target_temp_dir_path, |
||||
root=options.root_path, |
||||
prefix=options.prefix_path, |
||||
isolated=options.isolated_mode, |
||||
) |
||||
env = get_environment(lib_locations) |
||||
|
||||
installed.sort(key=operator.attrgetter("name")) |
||||
items = [] |
||||
for result in installed: |
||||
item = result.name |
||||
try: |
||||
installed_dist = env.get_distribution(item) |
||||
if installed_dist is not None: |
||||
item = f"{item}-{installed_dist.version}" |
||||
except Exception: |
||||
pass |
||||
items.append(item) |
||||
|
||||
if conflicts is not None: |
||||
self._warn_about_conflicts( |
||||
conflicts, |
||||
resolver_variant=self.determine_resolver_variant(options), |
||||
) |
||||
|
||||
installed_desc = " ".join(items) |
||||
if installed_desc: |
||||
write_output( |
||||
"Successfully installed %s", |
||||
installed_desc, |
||||
) |
||||
except OSError as error: |
||||
show_traceback = self.verbosity >= 1 |
||||
|
||||
message = create_os_error_message( |
||||
error, |
||||
show_traceback, |
||||
options.use_user_site, |
||||
) |
||||
logger.error(message, exc_info=show_traceback) |
||||
|
||||
return ERROR |
||||
|
||||
if options.target_dir: |
||||
assert target_temp_dir |
||||
self._handle_target_dir( |
||||
options.target_dir, target_temp_dir, options.upgrade |
||||
) |
||||
if options.root_user_action == "warn": |
||||
warn_if_run_as_root() |
||||
return SUCCESS |
||||
|
||||
def _handle_target_dir( |
||||
self, target_dir: str, target_temp_dir: TempDirectory, upgrade: bool |
||||
) -> None: |
||||
ensure_dir(target_dir) |
||||
|
||||
# Checking both purelib and platlib directories for installed |
||||
# packages to be moved to target directory |
||||
lib_dir_list = [] |
||||
|
||||
# Checking both purelib and platlib directories for installed |
||||
# packages to be moved to target directory |
||||
scheme = get_scheme("", home=target_temp_dir.path) |
||||
purelib_dir = scheme.purelib |
||||
platlib_dir = scheme.platlib |
||||
data_dir = scheme.data |
||||
|
||||
if os.path.exists(purelib_dir): |
||||
lib_dir_list.append(purelib_dir) |
||||
if os.path.exists(platlib_dir) and platlib_dir != purelib_dir: |
||||
lib_dir_list.append(platlib_dir) |
||||
if os.path.exists(data_dir): |
||||
lib_dir_list.append(data_dir) |
||||
|
||||
for lib_dir in lib_dir_list: |
||||
for item in os.listdir(lib_dir): |
||||
if lib_dir == data_dir: |
||||
ddir = os.path.join(data_dir, item) |
||||
if any(s.startswith(ddir) for s in lib_dir_list[:-1]): |
||||
continue |
||||
target_item_dir = os.path.join(target_dir, item) |
||||
if os.path.exists(target_item_dir): |
||||
if not upgrade: |
||||
logger.warning( |
||||
"Target directory %s already exists. Specify " |
||||
"--upgrade to force replacement.", |
||||
target_item_dir, |
||||
) |
||||
continue |
||||
if os.path.islink(target_item_dir): |
||||
logger.warning( |
||||
"Target directory %s already exists and is " |
||||
"a link. pip will not automatically replace " |
||||
"links, please remove if replacement is " |
||||
"desired.", |
||||
target_item_dir, |
||||
) |
||||
continue |
||||
if os.path.isdir(target_item_dir): |
||||
shutil.rmtree(target_item_dir) |
||||
else: |
||||
os.remove(target_item_dir) |
||||
|
||||
shutil.move(os.path.join(lib_dir, item), target_item_dir) |
||||
|
||||
def _determine_conflicts( |
||||
self, to_install: List[InstallRequirement] |
||||
) -> Optional[ConflictDetails]: |
||||
try: |
||||
return check_install_conflicts(to_install) |
||||
except Exception: |
||||
logger.exception( |
||||
"Error while checking for conflicts. Please file an issue on " |
||||
"pip's issue tracker: https://github.com/pypa/pip/issues/new" |
||||
) |
||||
return None |
||||
|
||||
def _warn_about_conflicts( |
||||
self, conflict_details: ConflictDetails, resolver_variant: str |
||||
) -> None: |
||||
package_set, (missing, conflicting) = conflict_details |
||||
if not missing and not conflicting: |
||||
return |
||||
|
||||
parts: List[str] = [] |
||||
if resolver_variant == "legacy": |
||||
parts.append( |
||||
"pip's legacy dependency resolver does not consider dependency " |
||||
"conflicts when selecting packages. This behaviour is the " |
||||
"source of the following dependency conflicts." |
||||
) |
||||
else: |
||||
assert resolver_variant == "resolvelib" |
||||
parts.append( |
||||
"pip's dependency resolver does not currently take into account " |
||||
"all the packages that are installed. This behaviour is the " |
||||
"source of the following dependency conflicts." |
||||
) |
||||
|
||||
# NOTE: There is some duplication here, with commands/check.py |
||||
for project_name in missing: |
||||
version = package_set[project_name][0] |
||||
for dependency in missing[project_name]: |
||||
message = ( |
||||
"{name} {version} requires {requirement}, " |
||||
"which is not installed." |
||||
).format( |
||||
name=project_name, |
||||
version=version, |
||||
requirement=dependency[1], |
||||
) |
||||
parts.append(message) |
||||
|
||||
for project_name in conflicting: |
||||
version = package_set[project_name][0] |
||||
for dep_name, dep_version, req in conflicting[project_name]: |
||||
message = ( |
||||
"{name} {version} requires {requirement}, but {you} have " |
||||
"{dep_name} {dep_version} which is incompatible." |
||||
).format( |
||||
name=project_name, |
||||
version=version, |
||||
requirement=req, |
||||
dep_name=dep_name, |
||||
dep_version=dep_version, |
||||
you=("you" if resolver_variant == "resolvelib" else "you'll"), |
||||
) |
||||
parts.append(message) |
||||
|
||||
logger.critical("\n".join(parts)) |
||||
|
||||
|
||||
def get_lib_location_guesses( |
||||
user: bool = False, |
||||
home: Optional[str] = None, |
||||
root: Optional[str] = None, |
||||
isolated: bool = False, |
||||
prefix: Optional[str] = None, |
||||
) -> List[str]: |
||||
scheme = get_scheme( |
||||
"", |
||||
user=user, |
||||
home=home, |
||||
root=root, |
||||
isolated=isolated, |
||||
prefix=prefix, |
||||
) |
||||
return [scheme.purelib, scheme.platlib] |
||||
|
||||
|
||||
def site_packages_writable(root: Optional[str], isolated: bool) -> bool: |
||||
return all( |
||||
test_writable_dir(d) |
||||
for d in set(get_lib_location_guesses(root=root, isolated=isolated)) |
||||
) |
||||
|
||||
|
||||
def decide_user_install( |
||||
use_user_site: Optional[bool], |
||||
prefix_path: Optional[str] = None, |
||||
target_dir: Optional[str] = None, |
||||
root_path: Optional[str] = None, |
||||
isolated_mode: bool = False, |
||||
) -> bool: |
||||
"""Determine whether to do a user install based on the input options. |
||||
|
||||
If use_user_site is False, no additional checks are done. |
||||
If use_user_site is True, it is checked for compatibility with other |
||||
options. |
||||
If use_user_site is None, the default behaviour depends on the environment, |
||||
which is provided by the other arguments. |
||||
""" |
||||
# In some cases (config from tox), use_user_site can be set to an integer |
||||
# rather than a bool, which 'use_user_site is False' wouldn't catch. |
||||
if (use_user_site is not None) and (not use_user_site): |
||||
logger.debug("Non-user install by explicit request") |
||||
return False |
||||
|
||||
if use_user_site: |
||||
if prefix_path: |
||||
raise CommandError( |
||||
"Can not combine '--user' and '--prefix' as they imply " |
||||
"different installation locations" |
||||
) |
||||
if virtualenv_no_global(): |
||||
raise InstallationError( |
||||
"Can not perform a '--user' install. User site-packages " |
||||
"are not visible in this virtualenv." |
||||
) |
||||
logger.debug("User install by explicit request") |
||||
return True |
||||
|
||||
# If we are here, user installs have not been explicitly requested/avoided |
||||
assert use_user_site is None |
||||
|
||||
# user install incompatible with --prefix/--target |
||||
if prefix_path or target_dir: |
||||
logger.debug("Non-user install due to --prefix or --target option") |
||||
return False |
||||
|
||||
# If user installs are not enabled, choose a non-user install |
||||
if not site.ENABLE_USER_SITE: |
||||
logger.debug("Non-user install because user site-packages disabled") |
||||
return False |
||||
|
||||
# If we have permission for a non-user install, do that, |
||||
# otherwise do a user install. |
||||
if site_packages_writable(root=root_path, isolated=isolated_mode): |
||||
logger.debug("Non-user install because site-packages writeable") |
||||
return False |
||||
|
||||
logger.info( |
||||
"Defaulting to user installation because normal site-packages " |
||||
"is not writeable" |
||||
) |
||||
return True |
||||
|
||||
|
||||
def create_os_error_message( |
||||
error: OSError, show_traceback: bool, using_user_site: bool |
||||
) -> str: |
||||
"""Format an error message for an OSError |
||||
|
||||
It may occur anytime during the execution of the install command. |
||||
""" |
||||
parts = [] |
||||
|
||||
# Mention the error if we are not going to show a traceback |
||||
parts.append("Could not install packages due to an OSError") |
||||
if not show_traceback: |
||||
parts.append(": ") |
||||
parts.append(str(error)) |
||||
else: |
||||
parts.append(".") |
||||
|
||||
# Spilt the error indication from a helper message (if any) |
||||
parts[-1] += "\n" |
||||
|
||||
# Suggest useful actions to the user: |
||||
# (1) using user site-packages or (2) verifying the permissions |
||||
if error.errno == errno.EACCES: |
||||
user_option_part = "Consider using the `--user` option" |
||||
permissions_part = "Check the permissions" |
||||
|
||||
if not running_under_virtualenv() and not using_user_site: |
||||
parts.extend( |
||||
[ |
||||
user_option_part, |
||||
" or ", |
||||
permissions_part.lower(), |
||||
] |
||||
) |
||||
else: |
||||
parts.append(permissions_part) |
||||
parts.append(".\n") |
||||
|
||||
# Suggest the user to enable Long Paths if path length is |
||||
# more than 260 |
||||
if ( |
||||
WINDOWS |
||||
and error.errno == errno.ENOENT |
||||
and error.filename |
||||
and len(error.filename) > 260 |
||||
): |
||||
parts.append( |
||||
"HINT: This error might have occurred since " |
||||
"this system does not have Windows Long Path " |
||||
"support enabled. You can find information on " |
||||
"how to enable this at " |
||||
"https://pip.pypa.io/warnings/enable-long-paths\n" |
||||
) |
||||
|
||||
return "".join(parts).strip() + "\n" |
||||
@ -1,368 +0,0 @@
|
||||
import json |
||||
import logging |
||||
from optparse import Values |
||||
from typing import TYPE_CHECKING, Generator, List, Optional, Sequence, Tuple, cast |
||||
|
||||
from pip._vendor.packaging.utils import canonicalize_name |
||||
|
||||
from pip._internal.cli import cmdoptions |
||||
from pip._internal.cli.req_command import IndexGroupCommand |
||||
from pip._internal.cli.status_codes import SUCCESS |
||||
from pip._internal.exceptions import CommandError |
||||
from pip._internal.index.collector import LinkCollector |
||||
from pip._internal.index.package_finder import PackageFinder |
||||
from pip._internal.metadata import BaseDistribution, get_environment |
||||
from pip._internal.models.selection_prefs import SelectionPreferences |
||||
from pip._internal.network.session import PipSession |
||||
from pip._internal.utils.compat import stdlib_pkgs |
||||
from pip._internal.utils.misc import tabulate, write_output |
||||
|
||||
if TYPE_CHECKING: |
||||
from pip._internal.metadata.base import DistributionVersion |
||||
|
||||
class _DistWithLatestInfo(BaseDistribution): |
||||
"""Give the distribution object a couple of extra fields. |
||||
|
||||
These will be populated during ``get_outdated()``. This is dirty but |
||||
makes the rest of the code much cleaner. |
||||
""" |
||||
|
||||
latest_version: DistributionVersion |
||||
latest_filetype: str |
||||
|
||||
_ProcessedDists = Sequence[_DistWithLatestInfo] |
||||
|
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class ListCommand(IndexGroupCommand): |
||||
""" |
||||
List installed packages, including editables. |
||||
|
||||
Packages are listed in a case-insensitive sorted order. |
||||
""" |
||||
|
||||
ignore_require_venv = True |
||||
usage = """ |
||||
%prog [options]""" |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"-o", |
||||
"--outdated", |
||||
action="store_true", |
||||
default=False, |
||||
help="List outdated packages", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"-u", |
||||
"--uptodate", |
||||
action="store_true", |
||||
default=False, |
||||
help="List uptodate packages", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"-e", |
||||
"--editable", |
||||
action="store_true", |
||||
default=False, |
||||
help="List editable projects.", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"-l", |
||||
"--local", |
||||
action="store_true", |
||||
default=False, |
||||
help=( |
||||
"If in a virtualenv that has global access, do not list " |
||||
"globally-installed packages." |
||||
), |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--user", |
||||
dest="user", |
||||
action="store_true", |
||||
default=False, |
||||
help="Only output packages installed in user-site.", |
||||
) |
||||
self.cmd_opts.add_option(cmdoptions.list_path()) |
||||
self.cmd_opts.add_option( |
||||
"--pre", |
||||
action="store_true", |
||||
default=False, |
||||
help=( |
||||
"Include pre-release and development versions. By default, " |
||||
"pip only finds stable versions." |
||||
), |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--format", |
||||
action="store", |
||||
dest="list_format", |
||||
default="columns", |
||||
choices=("columns", "freeze", "json"), |
||||
help=( |
||||
"Select the output format among: columns (default), freeze, or json. " |
||||
"The 'freeze' format cannot be used with the --outdated option." |
||||
), |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--not-required", |
||||
action="store_true", |
||||
dest="not_required", |
||||
help="List packages that are not dependencies of installed packages.", |
||||
) |
||||
|
||||
self.cmd_opts.add_option( |
||||
"--exclude-editable", |
||||
action="store_false", |
||||
dest="include_editable", |
||||
help="Exclude editable package from output.", |
||||
) |
||||
self.cmd_opts.add_option( |
||||
"--include-editable", |
||||
action="store_true", |
||||
dest="include_editable", |
||||
help="Include editable package from output.", |
||||
default=True, |
||||
) |
||||
self.cmd_opts.add_option(cmdoptions.list_exclude()) |
||||
index_opts = cmdoptions.make_option_group(cmdoptions.index_group, self.parser) |
||||
|
||||
self.parser.insert_option_group(0, index_opts) |
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def _build_package_finder( |
||||
self, options: Values, session: PipSession |
||||
) -> PackageFinder: |
||||
""" |
||||
Create a package finder appropriate to this list command. |
||||
""" |
||||
link_collector = LinkCollector.create(session, options=options) |
||||
|
||||
# Pass allow_yanked=False to ignore yanked versions. |
||||
selection_prefs = SelectionPreferences( |
||||
allow_yanked=False, |
||||
allow_all_prereleases=options.pre, |
||||
) |
||||
|
||||
return PackageFinder.create( |
||||
link_collector=link_collector, |
||||
selection_prefs=selection_prefs, |
||||
) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
if options.outdated and options.uptodate: |
||||
raise CommandError("Options --outdated and --uptodate cannot be combined.") |
||||
|
||||
if options.outdated and options.list_format == "freeze": |
||||
raise CommandError( |
||||
"List format 'freeze' cannot be used with the --outdated option." |
||||
) |
||||
|
||||
cmdoptions.check_list_path_option(options) |
||||
|
||||
skip = set(stdlib_pkgs) |
||||
if options.excludes: |
||||
skip.update(canonicalize_name(n) for n in options.excludes) |
||||
|
||||
packages: "_ProcessedDists" = [ |
||||
cast("_DistWithLatestInfo", d) |
||||
for d in get_environment(options.path).iter_installed_distributions( |
||||
local_only=options.local, |
||||
user_only=options.user, |
||||
editables_only=options.editable, |
||||
include_editables=options.include_editable, |
||||
skip=skip, |
||||
) |
||||
] |
||||
|
||||
# get_not_required must be called firstly in order to find and |
||||
# filter out all dependencies correctly. Otherwise a package |
||||
# can't be identified as requirement because some parent packages |
||||
# could be filtered out before. |
||||
if options.not_required: |
||||
packages = self.get_not_required(packages, options) |
||||
|
||||
if options.outdated: |
||||
packages = self.get_outdated(packages, options) |
||||
elif options.uptodate: |
||||
packages = self.get_uptodate(packages, options) |
||||
|
||||
self.output_package_listing(packages, options) |
||||
return SUCCESS |
||||
|
||||
def get_outdated( |
||||
self, packages: "_ProcessedDists", options: Values |
||||
) -> "_ProcessedDists": |
||||
return [ |
||||
dist |
||||
for dist in self.iter_packages_latest_infos(packages, options) |
||||
if dist.latest_version > dist.version |
||||
] |
||||
|
||||
def get_uptodate( |
||||
self, packages: "_ProcessedDists", options: Values |
||||
) -> "_ProcessedDists": |
||||
return [ |
||||
dist |
||||
for dist in self.iter_packages_latest_infos(packages, options) |
||||
if dist.latest_version == dist.version |
||||
] |
||||
|
||||
def get_not_required( |
||||
self, packages: "_ProcessedDists", options: Values |
||||
) -> "_ProcessedDists": |
||||
dep_keys = { |
||||
canonicalize_name(dep.name) |
||||
for dist in packages |
||||
for dep in (dist.iter_dependencies() or ()) |
||||
} |
||||
|
||||
# Create a set to remove duplicate packages, and cast it to a list |
||||
# to keep the return type consistent with get_outdated and |
||||
# get_uptodate |
||||
return list({pkg for pkg in packages if pkg.canonical_name not in dep_keys}) |
||||
|
||||
def iter_packages_latest_infos( |
||||
self, packages: "_ProcessedDists", options: Values |
||||
) -> Generator["_DistWithLatestInfo", None, None]: |
||||
with self._build_session(options) as session: |
||||
finder = self._build_package_finder(options, session) |
||||
|
||||
def latest_info( |
||||
dist: "_DistWithLatestInfo", |
||||
) -> Optional["_DistWithLatestInfo"]: |
||||
all_candidates = finder.find_all_candidates(dist.canonical_name) |
||||
if not options.pre: |
||||
# Remove prereleases |
||||
all_candidates = [ |
||||
candidate |
||||
for candidate in all_candidates |
||||
if not candidate.version.is_prerelease |
||||
] |
||||
|
||||
evaluator = finder.make_candidate_evaluator( |
||||
project_name=dist.canonical_name, |
||||
) |
||||
best_candidate = evaluator.sort_best_candidate(all_candidates) |
||||
if best_candidate is None: |
||||
return None |
||||
|
||||
remote_version = best_candidate.version |
||||
if best_candidate.link.is_wheel: |
||||
typ = "wheel" |
||||
else: |
||||
typ = "sdist" |
||||
dist.latest_version = remote_version |
||||
dist.latest_filetype = typ |
||||
return dist |
||||
|
||||
for dist in map(latest_info, packages): |
||||
if dist is not None: |
||||
yield dist |
||||
|
||||
def output_package_listing( |
||||
self, packages: "_ProcessedDists", options: Values |
||||
) -> None: |
||||
packages = sorted( |
||||
packages, |
||||
key=lambda dist: dist.canonical_name, |
||||
) |
||||
if options.list_format == "columns" and packages: |
||||
data, header = format_for_columns(packages, options) |
||||
self.output_package_listing_columns(data, header) |
||||
elif options.list_format == "freeze": |
||||
for dist in packages: |
||||
if options.verbose >= 1: |
||||
write_output( |
||||
"%s==%s (%s)", dist.raw_name, dist.version, dist.location |
||||
) |
||||
else: |
||||
write_output("%s==%s", dist.raw_name, dist.version) |
||||
elif options.list_format == "json": |
||||
write_output(format_for_json(packages, options)) |
||||
|
||||
def output_package_listing_columns( |
||||
self, data: List[List[str]], header: List[str] |
||||
) -> None: |
||||
# insert the header first: we need to know the size of column names |
||||
if len(data) > 0: |
||||
data.insert(0, header) |
||||
|
||||
pkg_strings, sizes = tabulate(data) |
||||
|
||||
# Create and add a separator. |
||||
if len(data) > 0: |
||||
pkg_strings.insert(1, " ".join("-" * x for x in sizes)) |
||||
|
||||
for val in pkg_strings: |
||||
write_output(val) |
||||
|
||||
|
||||
def format_for_columns( |
||||
pkgs: "_ProcessedDists", options: Values |
||||
) -> Tuple[List[List[str]], List[str]]: |
||||
""" |
||||
Convert the package data into something usable |
||||
by output_package_listing_columns. |
||||
""" |
||||
header = ["Package", "Version"] |
||||
|
||||
running_outdated = options.outdated |
||||
if running_outdated: |
||||
header.extend(["Latest", "Type"]) |
||||
|
||||
has_editables = any(x.editable for x in pkgs) |
||||
if has_editables: |
||||
header.append("Editable project location") |
||||
|
||||
if options.verbose >= 1: |
||||
header.append("Location") |
||||
if options.verbose >= 1: |
||||
header.append("Installer") |
||||
|
||||
data = [] |
||||
for proj in pkgs: |
||||
# if we're working on the 'outdated' list, separate out the |
||||
# latest_version and type |
||||
row = [proj.raw_name, str(proj.version)] |
||||
|
||||
if running_outdated: |
||||
row.append(str(proj.latest_version)) |
||||
row.append(proj.latest_filetype) |
||||
|
||||
if has_editables: |
||||
row.append(proj.editable_project_location or "") |
||||
|
||||
if options.verbose >= 1: |
||||
row.append(proj.location or "") |
||||
if options.verbose >= 1: |
||||
row.append(proj.installer) |
||||
|
||||
data.append(row) |
||||
|
||||
return data, header |
||||
|
||||
|
||||
def format_for_json(packages: "_ProcessedDists", options: Values) -> str: |
||||
data = [] |
||||
for dist in packages: |
||||
info = { |
||||
"name": dist.raw_name, |
||||
"version": str(dist.version), |
||||
} |
||||
if options.verbose >= 1: |
||||
info["location"] = dist.location or "" |
||||
info["installer"] = dist.installer |
||||
if options.outdated: |
||||
info["latest_version"] = str(dist.latest_version) |
||||
info["latest_filetype"] = dist.latest_filetype |
||||
editable_project_location = dist.editable_project_location |
||||
if editable_project_location: |
||||
info["editable_project_location"] = editable_project_location |
||||
data.append(info) |
||||
return json.dumps(data) |
||||
@ -1,174 +0,0 @@
|
||||
import logging |
||||
import shutil |
||||
import sys |
||||
import textwrap |
||||
import xmlrpc.client |
||||
from collections import OrderedDict |
||||
from optparse import Values |
||||
from typing import TYPE_CHECKING, Dict, List, Optional |
||||
|
||||
from pip._vendor.packaging.version import parse as parse_version |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.req_command import SessionCommandMixin |
||||
from pip._internal.cli.status_codes import NO_MATCHES_FOUND, SUCCESS |
||||
from pip._internal.exceptions import CommandError |
||||
from pip._internal.metadata import get_default_environment |
||||
from pip._internal.models.index import PyPI |
||||
from pip._internal.network.xmlrpc import PipXmlrpcTransport |
||||
from pip._internal.utils.logging import indent_log |
||||
from pip._internal.utils.misc import write_output |
||||
|
||||
if TYPE_CHECKING: |
||||
from typing import TypedDict |
||||
|
||||
class TransformedHit(TypedDict): |
||||
name: str |
||||
summary: str |
||||
versions: List[str] |
||||
|
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class SearchCommand(Command, SessionCommandMixin): |
||||
"""Search for PyPI packages whose name or summary contains <query>.""" |
||||
|
||||
usage = """ |
||||
%prog [options] <query>""" |
||||
ignore_require_venv = True |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"-i", |
||||
"--index", |
||||
dest="index", |
||||
metavar="URL", |
||||
default=PyPI.pypi_url, |
||||
help="Base URL of Python Package Index (default %default)", |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
if not args: |
||||
raise CommandError("Missing required argument (search query).") |
||||
query = args |
||||
pypi_hits = self.search(query, options) |
||||
hits = transform_hits(pypi_hits) |
||||
|
||||
terminal_width = None |
||||
if sys.stdout.isatty(): |
||||
terminal_width = shutil.get_terminal_size()[0] |
||||
|
||||
print_results(hits, terminal_width=terminal_width) |
||||
if pypi_hits: |
||||
return SUCCESS |
||||
return NO_MATCHES_FOUND |
||||
|
||||
def search(self, query: List[str], options: Values) -> List[Dict[str, str]]: |
||||
index_url = options.index |
||||
|
||||
session = self.get_default_session(options) |
||||
|
||||
transport = PipXmlrpcTransport(index_url, session) |
||||
pypi = xmlrpc.client.ServerProxy(index_url, transport) |
||||
try: |
||||
hits = pypi.search({"name": query, "summary": query}, "or") |
||||
except xmlrpc.client.Fault as fault: |
||||
message = "XMLRPC request failed [code: {code}]\n{string}".format( |
||||
code=fault.faultCode, |
||||
string=fault.faultString, |
||||
) |
||||
raise CommandError(message) |
||||
assert isinstance(hits, list) |
||||
return hits |
||||
|
||||
|
||||
def transform_hits(hits: List[Dict[str, str]]) -> List["TransformedHit"]: |
||||
""" |
||||
The list from pypi is really a list of versions. We want a list of |
||||
packages with the list of versions stored inline. This converts the |
||||
list from pypi into one we can use. |
||||
""" |
||||
packages: Dict[str, "TransformedHit"] = OrderedDict() |
||||
for hit in hits: |
||||
name = hit["name"] |
||||
summary = hit["summary"] |
||||
version = hit["version"] |
||||
|
||||
if name not in packages.keys(): |
||||
packages[name] = { |
||||
"name": name, |
||||
"summary": summary, |
||||
"versions": [version], |
||||
} |
||||
else: |
||||
packages[name]["versions"].append(version) |
||||
|
||||
# if this is the highest version, replace summary and score |
||||
if version == highest_version(packages[name]["versions"]): |
||||
packages[name]["summary"] = summary |
||||
|
||||
return list(packages.values()) |
||||
|
||||
|
||||
def print_dist_installation_info(name: str, latest: str) -> None: |
||||
env = get_default_environment() |
||||
dist = env.get_distribution(name) |
||||
if dist is not None: |
||||
with indent_log(): |
||||
if dist.version == latest: |
||||
write_output("INSTALLED: %s (latest)", dist.version) |
||||
else: |
||||
write_output("INSTALLED: %s", dist.version) |
||||
if parse_version(latest).pre: |
||||
write_output( |
||||
"LATEST: %s (pre-release; install" |
||||
" with `pip install --pre`)", |
||||
latest, |
||||
) |
||||
else: |
||||
write_output("LATEST: %s", latest) |
||||
|
||||
|
||||
def print_results( |
||||
hits: List["TransformedHit"], |
||||
name_column_width: Optional[int] = None, |
||||
terminal_width: Optional[int] = None, |
||||
) -> None: |
||||
if not hits: |
||||
return |
||||
if name_column_width is None: |
||||
name_column_width = ( |
||||
max( |
||||
[ |
||||
len(hit["name"]) + len(highest_version(hit.get("versions", ["-"]))) |
||||
for hit in hits |
||||
] |
||||
) |
||||
+ 4 |
||||
) |
||||
|
||||
for hit in hits: |
||||
name = hit["name"] |
||||
summary = hit["summary"] or "" |
||||
latest = highest_version(hit.get("versions", ["-"])) |
||||
if terminal_width is not None: |
||||
target_width = terminal_width - name_column_width - 5 |
||||
if target_width > 10: |
||||
# wrap and indent summary to fit terminal |
||||
summary_lines = textwrap.wrap(summary, target_width) |
||||
summary = ("\n" + " " * (name_column_width + 3)).join(summary_lines) |
||||
|
||||
name_latest = f"{name} ({latest})" |
||||
line = f"{name_latest:{name_column_width}} - {summary}" |
||||
try: |
||||
write_output(line) |
||||
print_dist_installation_info(name, latest) |
||||
except UnicodeEncodeError: |
||||
pass |
||||
|
||||
|
||||
def highest_version(versions: List[str]) -> str: |
||||
return max(versions, key=parse_version) |
||||
@ -1,189 +0,0 @@
|
||||
import logging |
||||
from optparse import Values |
||||
from typing import Generator, Iterable, Iterator, List, NamedTuple, Optional |
||||
|
||||
from pip._vendor.packaging.utils import canonicalize_name |
||||
|
||||
from pip._internal.cli.base_command import Command |
||||
from pip._internal.cli.status_codes import ERROR, SUCCESS |
||||
from pip._internal.metadata import BaseDistribution, get_default_environment |
||||
from pip._internal.utils.misc import write_output |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
|
||||
class ShowCommand(Command): |
||||
""" |
||||
Show information about one or more installed packages. |
||||
|
||||
The output is in RFC-compliant mail header format. |
||||
""" |
||||
|
||||
usage = """ |
||||
%prog [options] <package> ...""" |
||||
ignore_require_venv = True |
||||
|
||||
def add_options(self) -> None: |
||||
self.cmd_opts.add_option( |
||||
"-f", |
||||
"--files", |
||||
dest="files", |
||||
action="store_true", |
||||
default=False, |
||||
help="Show the full list of installed files for each package.", |
||||
) |
||||
|
||||
self.parser.insert_option_group(0, self.cmd_opts) |
||||
|
||||
def run(self, options: Values, args: List[str]) -> int: |
||||
if not args: |
||||
logger.warning("ERROR: Please provide a package name or names.") |
||||
return ERROR |
||||
query = args |
||||
|
||||
results = search_packages_info(query) |
||||
if not print_results( |
||||
results, list_files=options.files, verbose=options.verbose |
||||
): |
||||
return ERROR |
||||
return SUCCESS |
||||
|
||||
|
||||
class _PackageInfo(NamedTuple): |
||||
name: str |
||||
version: str |
||||
location: str |
||||
editable_project_location: Optional[str] |
||||
requires: List[str] |
||||
required_by: List[str] |
||||
installer: str |
||||
metadata_version: str |
||||
classifiers: List[str] |
||||
summary: str |
||||
homepage: str |
||||
project_urls: List[str] |
||||
author: str |
||||
author_email: str |
||||
license: str |
||||
entry_points: List[str] |
||||
files: Optional[List[str]] |
||||
|
||||
|
||||
def search_packages_info(query: List[str]) -> Generator[_PackageInfo, None, None]: |
||||
""" |
||||
Gather details from installed distributions. Print distribution name, |
||||
version, location, and installed files. Installed files requires a |
||||
pip generated 'installed-files.txt' in the distributions '.egg-info' |
||||
directory. |
||||
""" |
||||
env = get_default_environment() |
||||
|
||||
installed = {dist.canonical_name: dist for dist in env.iter_all_distributions()} |
||||
query_names = [canonicalize_name(name) for name in query] |
||||
missing = sorted( |
||||
[name for name, pkg in zip(query, query_names) if pkg not in installed] |
||||
) |
||||
if missing: |
||||
logger.warning("Package(s) not found: %s", ", ".join(missing)) |
||||
|
||||
def _get_requiring_packages(current_dist: BaseDistribution) -> Iterator[str]: |
||||
return ( |
||||
dist.metadata["Name"] or "UNKNOWN" |
||||
for dist in installed.values() |
||||
if current_dist.canonical_name |
||||
in {canonicalize_name(d.name) for d in dist.iter_dependencies()} |
||||
) |
||||
|
||||
for query_name in query_names: |
||||
try: |
||||
dist = installed[query_name] |
||||
except KeyError: |
||||
continue |
||||
|
||||
requires = sorted((req.name for req in dist.iter_dependencies()), key=str.lower) |
||||
required_by = sorted(_get_requiring_packages(dist), key=str.lower) |
||||
|
||||
try: |
||||
entry_points_text = dist.read_text("entry_points.txt") |
||||
entry_points = entry_points_text.splitlines(keepends=False) |
||||
except FileNotFoundError: |
||||
entry_points = [] |
||||
|
||||
files_iter = dist.iter_declared_entries() |
||||
if files_iter is None: |
||||
files: Optional[List[str]] = None |
||||
else: |
||||
files = sorted(files_iter) |
||||
|
||||
metadata = dist.metadata |
||||
|
||||
yield _PackageInfo( |
||||
name=dist.raw_name, |
||||
version=str(dist.version), |
||||
location=dist.location or "", |
||||
editable_project_location=dist.editable_project_location, |
||||
requires=requires, |
||||
required_by=required_by, |
||||
installer=dist.installer, |
||||
metadata_version=dist.metadata_version or "", |
||||
classifiers=metadata.get_all("Classifier", []), |
||||
summary=metadata.get("Summary", ""), |
||||
homepage=metadata.get("Home-page", ""), |
||||
project_urls=metadata.get_all("Project-URL", []), |
||||
author=metadata.get("Author", ""), |
||||
author_email=metadata.get("Author-email", ""), |
||||
license=metadata.get("License", ""), |
||||
entry_points=entry_points, |
||||
files=files, |
||||
) |
||||
|
||||
|
||||
def print_results( |
||||
distributions: Iterable[_PackageInfo], |
||||
list_files: bool, |
||||
verbose: bool, |
||||
) -> bool: |
||||
""" |
||||
Print the information from installed distributions found. |
||||
""" |
||||
results_printed = False |
||||
for i, dist in enumerate(distributions): |
||||
results_printed = True |
||||
if i > 0: |
||||
write_output("---") |
||||
|
||||
write_output("Name: %s", dist.name) |
||||
write_output("Version: %s", dist.version) |
||||
write_output("Summary: %s", dist.summary) |
||||
write_output("Home-page: %s", dist.homepage) |
||||
write_output("Author: %s", dist.author) |
||||
write_output("Author-email: %s", dist.author_email) |
||||
write_output("License: %s", dist.license) |
||||
write_output("Location: %s", dist.location) |
||||
if dist.editable_project_location is not None: |
||||
write_output( |
||||
"Editable project location: %s", dist.editable_project_location |
||||
) |
||||
write_output("Requires: %s", ", ".join(dist.requires)) |
||||
write_output("Required-by: %s", ", ".join(dist.required_by)) |
||||
|
||||
if verbose: |
||||
write_output("Metadata-Version: %s", dist.metadata_version) |
||||
write_output("Installer: %s", dist.installer) |
||||
write_output("Classifiers:") |
||||
for classifier in dist.classifiers: |
||||
write_output(" %s", classifier) |
||||
write_output("Entry-points:") |
||||
for entry in dist.entry_points: |
||||
write_output(" %s", entry.strip()) |
||||
write_output("Project-URLs:") |
||||
for project_url in dist.project_urls: |
||||
write_output(" %s", project_url) |
||||
if list_files: |
||||
write_output("Files:") |
||||
if dist.files is None: |
||||
write_output("Cannot locate RECORD or installed-files.txt") |
||||
else: |
||||
for line in dist.files: |
||||
write_output(" %s", line.strip()) |
||||
return results_printed |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue