first commit
This commit is contained in:
2
.env
2
.env
@@ -1,2 +0,0 @@
|
|||||||
HCLOUD_TOKEN=Ry2s7iWfsp1qPQ9rkQURxOfOXMpdKKZuD07K0oSiarj1Y9jLZKSYxr99x2nFeErY
|
|
||||||
SUPABASE_SERVICE_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InNhbXFoampnYXphdm55dWlwcmFoIiwicm9sZSI6ImFub24iLCJpYXQiOjE3NzExNDc4NDUsImV4cCI6MjA4NjcyMzg0NX0.q2UH5sKhSOR7FBkzblxDuQje0gvmRtzl2CK7sKYY4GI"
|
|
||||||
@@ -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,70 +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
|
|
||||||
|
|
||||||
# Call hash to forget past commands. Without forgetting
|
|
||||||
# past commands the $PATH changes we made may not be respected
|
|
||||||
hash -r 2> /dev/null
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
# on Windows, a path can contain colons and backslashes and has to be converted:
|
|
||||||
if [ "${OSTYPE:-}" = "cygwin" ] || [ "${OSTYPE:-}" = "msys" ] ; then
|
|
||||||
# transform D:\path\to\venv to /d/path/to/venv on MSYS
|
|
||||||
# and to /cygdrive/d/path/to/venv on Cygwin
|
|
||||||
export VIRTUAL_ENV=$(cygpath /home/joachim/git/hetzner/.venv)
|
|
||||||
else
|
|
||||||
# use the path as-is
|
|
||||||
export VIRTUAL_ENV=/home/joachim/git/hetzner/.venv
|
|
||||||
fi
|
|
||||||
|
|
||||||
_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
|
|
||||||
|
|
||||||
# Call hash to forget past commands. Without forgetting
|
|
||||||
# past commands the $PATH changes we made may not be respected
|
|
||||||
hash -r 2> /dev/null
|
|
||||||
@@ -1,27 +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 /home/joachim/git/hetzner/.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 /home/joachim/git/hetzner/.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,414 +0,0 @@
|
|||||||
#!/home/joachim/git/hetzner/.venv/bin/python3
|
|
||||||
import sys
|
|
||||||
import locale
|
|
||||||
import warnings
|
|
||||||
import argparse
|
|
||||||
|
|
||||||
from os.path import expanduser
|
|
||||||
|
|
||||||
from hetzner.robot import Robot
|
|
||||||
|
|
||||||
import logging
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ConfigParser import RawConfigParser
|
|
||||||
except ImportError:
|
|
||||||
from configparser import RawConfigParser
|
|
||||||
|
|
||||||
|
|
||||||
def make_option(*args, **kwargs):
|
|
||||||
return (args, kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class SubCommand(object):
|
|
||||||
command = None
|
|
||||||
description = None
|
|
||||||
long_description = None
|
|
||||||
option_list = []
|
|
||||||
requires_robot = True
|
|
||||||
|
|
||||||
def __init__(self, configfile):
|
|
||||||
self.config = RawConfigParser()
|
|
||||||
self.config.read(configfile)
|
|
||||||
|
|
||||||
def putline(self, line):
|
|
||||||
data = line + u"\n"
|
|
||||||
try:
|
|
||||||
sys.stdout.write(data)
|
|
||||||
except UnicodeEncodeError:
|
|
||||||
preferred = locale.getpreferredencoding()
|
|
||||||
sys.stdout.write(data.encode(preferred, 'replace'))
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class Reboot(SubCommand):
|
|
||||||
command = 'reboot'
|
|
||||||
description = "Reboot a server"
|
|
||||||
option_list = [
|
|
||||||
make_option('-m', '--method', dest='method',
|
|
||||||
choices=['soft', 'hard', 'manual'], default='soft',
|
|
||||||
help="The method to use for the reboot"),
|
|
||||||
make_option('ip', metavar='IP', nargs='+',
|
|
||||||
help="IP address of the server to reboot"),
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
for ip in args.ip:
|
|
||||||
server = robot.servers.get(ip)
|
|
||||||
if server:
|
|
||||||
server.reboot(args.method)
|
|
||||||
|
|
||||||
|
|
||||||
class Rescue(SubCommand):
|
|
||||||
command = 'rescue'
|
|
||||||
description = "Activate rescue system"
|
|
||||||
long_description = ("Reboot into rescue system, spawn a shell and"
|
|
||||||
" after the shell is closed, reboot back into"
|
|
||||||
" the normal system.")
|
|
||||||
option_list = [
|
|
||||||
make_option('-p', '--patience', dest='patience', type=int,
|
|
||||||
default=300, help=("The time to wait between subsequent"
|
|
||||||
" reboot tries")),
|
|
||||||
make_option('-m', '--manual', dest='manual', action='store_true',
|
|
||||||
default=False, help=("If all reboot tries fail,"
|
|
||||||
" automatically send a support"
|
|
||||||
" request")),
|
|
||||||
make_option('-n', '--noshell', dest='noshell', action='store_true',
|
|
||||||
default=False, help=("Don't drop into a shell, only print"
|
|
||||||
" rescue password")),
|
|
||||||
make_option('ip', metavar='IP', nargs='+',
|
|
||||||
help="IP address of the server to put into rescue system"),
|
|
||||||
]
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
for ip in args.ip:
|
|
||||||
server = robot.servers.get(ip)
|
|
||||||
if not server:
|
|
||||||
continue
|
|
||||||
|
|
||||||
kwargs = {
|
|
||||||
'patience': args.patience,
|
|
||||||
'manual': args.manual,
|
|
||||||
}
|
|
||||||
|
|
||||||
if args.noshell:
|
|
||||||
server.rescue.observed_activate(**kwargs)
|
|
||||||
msg = u"Password for {0}: {1}".format(server.ip,
|
|
||||||
server.rescue.password)
|
|
||||||
self.putline(msg)
|
|
||||||
else:
|
|
||||||
with warnings.catch_warnings():
|
|
||||||
warnings.simplefilter("ignore")
|
|
||||||
server.rescue.shell(**kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class SetName(SubCommand):
|
|
||||||
command = "set-name"
|
|
||||||
description = "Change the name of a server"
|
|
||||||
|
|
||||||
option_list = [
|
|
||||||
make_option('ip', metavar='IP', help="IP address of the server"),
|
|
||||||
make_option('name', metavar='NAME', nargs='?', default='',
|
|
||||||
help="New name of the server"),
|
|
||||||
]
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
robot.servers.get(args.ip).set_name(args.name)
|
|
||||||
|
|
||||||
|
|
||||||
class ListServers(SubCommand):
|
|
||||||
command = 'list'
|
|
||||||
description = "List all servers"
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
for server in robot.servers:
|
|
||||||
info = {
|
|
||||||
'id': server.number,
|
|
||||||
'model': server.product
|
|
||||||
}
|
|
||||||
|
|
||||||
if server.name != "":
|
|
||||||
info['name'] = server.name
|
|
||||||
|
|
||||||
infolist = [u"{0}: {1}".format(key, val)
|
|
||||||
for key, val in info.items()]
|
|
||||||
|
|
||||||
self.putline(u"{0} ({1})".format(server.ip, u", ".join(infolist)))
|
|
||||||
|
|
||||||
|
|
||||||
class ShowServer(SubCommand):
|
|
||||||
command = 'show'
|
|
||||||
description = "Show details about a server"
|
|
||||||
option_list = [
|
|
||||||
make_option('ip', nargs='+', metavar='IP',
|
|
||||||
help="IP address of the server"),
|
|
||||||
]
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
for ip in args.ip:
|
|
||||||
self.print_serverinfo(robot.servers.get(ip))
|
|
||||||
|
|
||||||
def print_line(self, key, val):
|
|
||||||
self.putline(u"{0:<15}{1}".format(key + u":", val))
|
|
||||||
|
|
||||||
def print_serverinfo(self, server):
|
|
||||||
info = [
|
|
||||||
("Number", server.number),
|
|
||||||
("Main IP", server.ip),
|
|
||||||
("Name", server.name),
|
|
||||||
("Product", server.product),
|
|
||||||
("Data center", server.datacenter),
|
|
||||||
("Traffic", server.traffic),
|
|
||||||
("Status", server.status),
|
|
||||||
("Cancelled", server.cancelled),
|
|
||||||
("Paid until", server.paid_until),
|
|
||||||
]
|
|
||||||
|
|
||||||
for key, val in info:
|
|
||||||
self.print_line(key, val)
|
|
||||||
|
|
||||||
for ip in server.ips:
|
|
||||||
if ip.rdns.ptr is None:
|
|
||||||
addr = ip.ip
|
|
||||||
else:
|
|
||||||
addr = u"{0} (rPTR: {1})".format(ip.ip, ip.rdns.ptr)
|
|
||||||
self.print_line(u"IP address", addr)
|
|
||||||
|
|
||||||
for net in server.subnets:
|
|
||||||
addrtype = u"IPv6" if net.is_ipv6 else u"IPv4"
|
|
||||||
addr = u"{0}/{1} ({2})".format(net.net_ip, net.mask, addrtype)
|
|
||||||
self.print_line(u"Subnet", addr)
|
|
||||||
self.print_line(u"Gateway", net.gateway)
|
|
||||||
|
|
||||||
for rdns in server.rdns:
|
|
||||||
rptr = u"{0} -> {1}".format(rdns.ip, rdns.ptr)
|
|
||||||
self.print_line(u"Reverse PTR", rptr)
|
|
||||||
|
|
||||||
|
|
||||||
class ReverseDNS(SubCommand):
|
|
||||||
command = 'rdns'
|
|
||||||
description = "List and set reverse DNS records"
|
|
||||||
option_list = [
|
|
||||||
make_option('-s', '--set', dest='setptr', action='store_true',
|
|
||||||
default=False, help="Set a new reverse PTR"),
|
|
||||||
make_option('-d', '--delete', dest='delptr', action='store_true',
|
|
||||||
default=False, help="Delete reverse PTR"),
|
|
||||||
make_option('ip', metavar='IP', nargs='?', default=None,
|
|
||||||
help="IP address of the server"),
|
|
||||||
make_option('value', metavar='RPTR', nargs='?', default=None,
|
|
||||||
help="New reverse record to set"),
|
|
||||||
]
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
if args.ip is None:
|
|
||||||
for rdns in robot.rdns:
|
|
||||||
self.putline("{0} -> {1}".format(rdns.ip, rdns.ptr))
|
|
||||||
elif args.delptr:
|
|
||||||
robot.rdns.get(args.ip).remove()
|
|
||||||
elif args.setptr:
|
|
||||||
if args.ip is None or args.value is None:
|
|
||||||
parser.error("Need exactly two arguments: IP address and new"
|
|
||||||
" reverse FQDN.")
|
|
||||||
else:
|
|
||||||
rdns = robot.rdns.get(args.ip)
|
|
||||||
rdns.set(args.value)
|
|
||||||
else:
|
|
||||||
rdns = robot.rdns.get(args.ip)
|
|
||||||
if rdns.ptr is None:
|
|
||||||
self.putline("No reverse record set for {0}.".format(rdns.ip))
|
|
||||||
else:
|
|
||||||
self.putline("{0} -> {1}".format(rdns.ip, rdns.ptr))
|
|
||||||
|
|
||||||
|
|
||||||
class Failover(SubCommand):
|
|
||||||
command = 'failover'
|
|
||||||
description = 'List and set failover IP addresses'
|
|
||||||
|
|
||||||
option_list = [
|
|
||||||
make_option('-s', '--set', dest='setfailover', action='store_true',
|
|
||||||
default=False,
|
|
||||||
help="Assign failover IP address to server"),
|
|
||||||
make_option('ip', nargs='?', default=None,
|
|
||||||
help="Failover IP address to assign"),
|
|
||||||
make_option('destination', nargs='?', default=None,
|
|
||||||
help="IP address of new failover destination")
|
|
||||||
]
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
if args.setfailover:
|
|
||||||
errs = []
|
|
||||||
if not args.ip:
|
|
||||||
errs.append("Error: you need to set the failover IP you"
|
|
||||||
" want to assign. Option 'ip'")
|
|
||||||
if not args.destination:
|
|
||||||
errs.append("Error: you need to set the new destination of"
|
|
||||||
" the failover IP. Option 'dest'")
|
|
||||||
if len(errs) > 0:
|
|
||||||
for err in errs:
|
|
||||||
self.putline(err)
|
|
||||||
else:
|
|
||||||
failover = robot.failover.set(args.ip, args.destination)
|
|
||||||
self.putline("Failover IP successfully assigned to new"
|
|
||||||
" destination")
|
|
||||||
self.putline(str(failover))
|
|
||||||
else:
|
|
||||||
failovers = robot.failover.list()
|
|
||||||
if len(failovers) > 0:
|
|
||||||
self.putline("Found %s failover IPs" % len(failovers))
|
|
||||||
for failover in failovers.values():
|
|
||||||
self.putline(str(failover))
|
|
||||||
|
|
||||||
|
|
||||||
class Admin(SubCommand):
|
|
||||||
command = 'admin'
|
|
||||||
description = "Create/delete dedicated admin accounts"
|
|
||||||
option_list = [
|
|
||||||
make_option('-C', '--create', dest='addadmin', action='store_true',
|
|
||||||
default=False, help="Create admin account"),
|
|
||||||
make_option('-d', '--delete', dest='deladmin', action='store_true',
|
|
||||||
default=False, help="Delete admin account"),
|
|
||||||
make_option('-p', '--password', dest='admpasswd', metavar='PASSWORD',
|
|
||||||
help="Use this password instead of generating one"),
|
|
||||||
make_option('ip', metavar='IP', nargs='+', default=None,
|
|
||||||
help="IP address of the server"),
|
|
||||||
]
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
for ip in args.ip:
|
|
||||||
server = robot.servers.get(ip)
|
|
||||||
if args.addadmin:
|
|
||||||
login, passwd = server.admin.create(passwd=args.admpasswd)
|
|
||||||
msg = "{0}: {1} -> {2}".format(server.ip, login, passwd)
|
|
||||||
self.putline(msg)
|
|
||||||
elif args.deladmin:
|
|
||||||
server.admin.delete()
|
|
||||||
else:
|
|
||||||
if server.admin.exists:
|
|
||||||
msg = "{0}: {1}".format(server.ip, server.admin.login)
|
|
||||||
else:
|
|
||||||
msg = "No admin account for {0}.".format(server.ip)
|
|
||||||
self.putline(msg)
|
|
||||||
|
|
||||||
|
|
||||||
class Config(SubCommand):
|
|
||||||
command = 'config'
|
|
||||||
description = "Get or set options"
|
|
||||||
long_description = ("Set options by just using `config section.option"
|
|
||||||
" value' or list options by not providing any"
|
|
||||||
" arguments.")
|
|
||||||
option_list = [
|
|
||||||
make_option('-d', '--delete', dest='delete', action='store_true',
|
|
||||||
default=False, help="Delete an option"),
|
|
||||||
make_option('name', nargs='?', help="Section and name of the option"),
|
|
||||||
make_option('value', nargs='?', default=None,
|
|
||||||
help="New value of the option"),
|
|
||||||
]
|
|
||||||
requires_robot = False
|
|
||||||
|
|
||||||
def execute(self, robot, parser, args):
|
|
||||||
if args.name is None:
|
|
||||||
for section in self.config.sections():
|
|
||||||
for key, value in self.config.items(section):
|
|
||||||
self.putline("{0}.{1}={2!r}".format(section, key, value))
|
|
||||||
else:
|
|
||||||
if '.' not in args.name:
|
|
||||||
parser.error("Option name needs to be in the form"
|
|
||||||
" <section>.<name>.")
|
|
||||||
section, name = args.name.split('.', 1)
|
|
||||||
if args.value is None:
|
|
||||||
if not args.delete:
|
|
||||||
parser.error("In order to delete/unset an option, please"
|
|
||||||
" use -d.")
|
|
||||||
self.config.remove_option(section, name)
|
|
||||||
if len(self.config.options(section)) == 0:
|
|
||||||
self.config.remove_section(section)
|
|
||||||
else:
|
|
||||||
if not self.config.has_section(section):
|
|
||||||
self.config.add_section(section)
|
|
||||||
self.config.set(section, name, args.value)
|
|
||||||
with open(args.configfile, 'w') as fp:
|
|
||||||
self.config.write(fp)
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
subcommands = [
|
|
||||||
Config,
|
|
||||||
Reboot,
|
|
||||||
Rescue,
|
|
||||||
SetName,
|
|
||||||
ListServers,
|
|
||||||
ShowServer,
|
|
||||||
ReverseDNS,
|
|
||||||
Admin,
|
|
||||||
Failover,
|
|
||||||
]
|
|
||||||
|
|
||||||
common_parser = argparse.ArgumentParser(
|
|
||||||
description="Common options",
|
|
||||||
add_help=False
|
|
||||||
)
|
|
||||||
global_options = common_parser.add_argument_group(title="global options")
|
|
||||||
global_options.add_argument('-c', '--config', dest='configfile',
|
|
||||||
default='~/.hetznerrc', type=expanduser,
|
|
||||||
help="The location of the configuration file")
|
|
||||||
global_options.add_argument('--debug', action='store_true',
|
|
||||||
help="Show debug output.")
|
|
||||||
|
|
||||||
parser = argparse.ArgumentParser(
|
|
||||||
description="Hetzner Robot commandline interface",
|
|
||||||
prog='hetznerctl',
|
|
||||||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
|
||||||
parents=[common_parser]
|
|
||||||
)
|
|
||||||
|
|
||||||
subparsers = parser.add_subparsers(
|
|
||||||
title="available commands",
|
|
||||||
metavar="command",
|
|
||||||
help="description",
|
|
||||||
)
|
|
||||||
|
|
||||||
for cmd in subcommands:
|
|
||||||
subparser = subparsers.add_parser(
|
|
||||||
cmd.command,
|
|
||||||
help=cmd.description,
|
|
||||||
description=cmd.long_description,
|
|
||||||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
|
||||||
parents=[common_parser]
|
|
||||||
)
|
|
||||||
for args, kwargs in cmd.option_list:
|
|
||||||
subparser.add_argument(*args, **kwargs)
|
|
||||||
subparser.set_defaults(cmdclass=cmd)
|
|
||||||
|
|
||||||
args = parser.parse_args()
|
|
||||||
|
|
||||||
logging.basicConfig(format='%(name)s: %(message)s',
|
|
||||||
level=logging.DEBUG if args.debug else logging.INFO)
|
|
||||||
|
|
||||||
if getattr(args, 'cmdclass', None) is None:
|
|
||||||
parser.print_help()
|
|
||||||
parser.exit(1)
|
|
||||||
subcommand = args.cmdclass(args.configfile)
|
|
||||||
|
|
||||||
if subcommand.requires_robot:
|
|
||||||
if not subcommand.config.has_option('login', 'username') or \
|
|
||||||
not subcommand.config.has_option('login', 'password'):
|
|
||||||
parser.error((
|
|
||||||
"You need to set a user and password in {0} in order to"
|
|
||||||
" continue with this operation. You can do this using"
|
|
||||||
" `hetznerctl config login.username <your-robot-username>' and"
|
|
||||||
" `hetznerctl config login.password <your-robot-password>'."
|
|
||||||
).format(args.configfile))
|
|
||||||
robot = Robot(
|
|
||||||
subcommand.config.get('login', 'username'),
|
|
||||||
subcommand.config.get('login', 'password'),
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
robot = None
|
|
||||||
subcommand.execute(robot, parser, args)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
main()
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
#!/home/joachim/git/hetzner/.venv/bin/python3
|
|
||||||
# -*- 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,8 +0,0 @@
|
|||||||
#!/home/joachim/git/hetzner/.venv/bin/python3
|
|
||||||
# -*- 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,8 +0,0 @@
|
|||||||
#!/home/joachim/git/hetzner/.venv/bin/python3
|
|
||||||
# -*- 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 @@
|
|||||||
python3
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
/usr/bin/python3
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
python3
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
pip
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
Metadata-Version: 2.4
|
|
||||||
Name: hetzner
|
|
||||||
Version: 0.8.3
|
|
||||||
Summary: High level access to the Hetzner robot
|
|
||||||
Home-page: https://github.com/aszlig/hetzner
|
|
||||||
Author: aszlig
|
|
||||||
Author-email: aszlig@nix.build
|
|
||||||
License: BSD
|
|
||||||
Dynamic: author
|
|
||||||
Dynamic: author-email
|
|
||||||
Dynamic: home-page
|
|
||||||
Dynamic: license
|
|
||||||
Dynamic: summary
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
../../../bin/hetznerctl,sha256=KSgjdGnZfnrwkVGYEHJUvBsBhHOTnv1RFZ2sdO6o8VE,14791
|
|
||||||
hetzner-0.8.3.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
|
||||||
hetzner-0.8.3.dist-info/METADATA,sha256=3ptqiaYSw4XM4Hxa8FWZTOYEjPa7Q99vmiD550H6H1g,294
|
|
||||||
hetzner-0.8.3.dist-info/RECORD,,
|
|
||||||
hetzner-0.8.3.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
||||||
hetzner-0.8.3.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
|
|
||||||
hetzner-0.8.3.dist-info/top_level.txt,sha256=DI0xgYJvZBQ3CchTWQjPLO0suBeQJYqVICLfB0BtafI,8
|
|
||||||
hetzner/__init__.py,sha256=rc32-sN4PVymZy9keZeN9RR5RNOz9lFA2kj0WNhCTkc,371
|
|
||||||
hetzner/__pycache__/__init__.cpython-312.pyc,,
|
|
||||||
hetzner/__pycache__/failover.cpython-312.pyc,,
|
|
||||||
hetzner/__pycache__/rdns.cpython-312.pyc,,
|
|
||||||
hetzner/__pycache__/reset.cpython-312.pyc,,
|
|
||||||
hetzner/__pycache__/robot.cpython-312.pyc,,
|
|
||||||
hetzner/__pycache__/server.cpython-312.pyc,,
|
|
||||||
hetzner/failover.py,sha256=b31m6miUlELgAtUzZETKnYJz5p1gHtHnsrDSWLU054g,1994
|
|
||||||
hetzner/rdns.py,sha256=uxCuONRcOxJGAheOB-Lzy2La3IzRRfohktIQcAZqDx4,1740
|
|
||||||
hetzner/reset.py,sha256=J_Mm4IuzyOWWY9uSBv05K0M0KxHNAtbablM_Zgt2vOk,3815
|
|
||||||
hetzner/robot.py,sha256=sUb2fnEXEMm9xSBAm6lW6-rp41rr7zmJF2pL-2WaIhw,15431
|
|
||||||
hetzner/server.py,sha256=6e2e_kvg5DTE31U9oECDbM3iJmnxiyuUyGkiTBkm7bw,15736
|
|
||||||
hetzner/tests/__init__.py,sha256=B1LT32BhoorlmES6gVdnTmxzf0UDWa7LF5Pz59d0flo,51
|
|
||||||
hetzner/tests/__pycache__/__init__.cpython-312.pyc,,
|
|
||||||
hetzner/tests/__pycache__/test_util_addr.cpython-312.pyc,,
|
|
||||||
hetzner/tests/test_util_addr.py,sha256=GUfS9g4Wr0RIzLWndPYf1GwbfcoTWy7Mela_woDPT7Y,3998
|
|
||||||
hetzner/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
||||||
hetzner/util/__pycache__/__init__.cpython-312.pyc,,
|
|
||||||
hetzner/util/__pycache__/addr.cpython-312.pyc,,
|
|
||||||
hetzner/util/__pycache__/http.cpython-312.pyc,,
|
|
||||||
hetzner/util/__pycache__/scraping.cpython-312.pyc,,
|
|
||||||
hetzner/util/addr.py,sha256=JGZmPJzeqjRgveRTQKmIEqTw6iqyGEEjCackkJSopJ4,2610
|
|
||||||
hetzner/util/http.py,sha256=Q0Sav6jpG8PzDkrxyojgy0eaUy8vx7qJTub1-5ZY0XE,3018
|
|
||||||
hetzner/util/scraping.py,sha256=Injn0ZT4JnRc3_OaXJq-Rw3JBC8L8NM7B7AUaqnFXxE,548
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
Wheel-Version: 1.0
|
|
||||||
Generator: setuptools (82.0.0)
|
|
||||||
Root-Is-Purelib: true
|
|
||||||
Tag: py3-none-any
|
|
||||||
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
hetzner
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
class RobotError(Exception):
|
|
||||||
def __init__(self, message, status=None):
|
|
||||||
if status is not None:
|
|
||||||
message = "{0} ({1})".format(message, status)
|
|
||||||
super(RobotError, self).__init__(message)
|
|
||||||
self.status = status
|
|
||||||
|
|
||||||
|
|
||||||
class ManualReboot(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class ConnectError(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class WebRobotError(RobotError):
|
|
||||||
pass
|
|
||||||
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,60 +0,0 @@
|
|||||||
from hetzner import RobotError
|
|
||||||
|
|
||||||
__all__ = ['Failover', 'FailoverManager']
|
|
||||||
|
|
||||||
|
|
||||||
class Failover(object):
|
|
||||||
ip = None
|
|
||||||
server_ip = None
|
|
||||||
server_number = None
|
|
||||||
active_server_ip = None
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return "%s (destination: %s, booked on %s (%s))" % (
|
|
||||||
self.ip, self.active_server_ip, self.server_number, self.server_ip)
|
|
||||||
|
|
||||||
def __init__(self, data):
|
|
||||||
for attr, value in data.items():
|
|
||||||
if hasattr(self, attr):
|
|
||||||
setattr(self, attr, value)
|
|
||||||
|
|
||||||
|
|
||||||
class FailoverManager(object):
|
|
||||||
def __init__(self, conn, servers):
|
|
||||||
self.conn = conn
|
|
||||||
self.servers = servers
|
|
||||||
|
|
||||||
def list(self):
|
|
||||||
failovers = {}
|
|
||||||
try:
|
|
||||||
ips = self.conn.get('/failover')
|
|
||||||
except RobotError as err:
|
|
||||||
if err.status == 404:
|
|
||||||
return failovers
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
for ip in ips:
|
|
||||||
failover = Failover(ip.get('failover'))
|
|
||||||
failovers[failover.ip] = failover
|
|
||||||
return failovers
|
|
||||||
|
|
||||||
def set(self, ip, new_destination):
|
|
||||||
failovers = self.list()
|
|
||||||
if ip not in failovers.keys():
|
|
||||||
raise RobotError(
|
|
||||||
"Invalid IP address '%s'. Failover IP addresses are %s"
|
|
||||||
% (ip, failovers.keys()))
|
|
||||||
failover = failovers.get(ip)
|
|
||||||
if new_destination == failover.active_server_ip:
|
|
||||||
raise RobotError(
|
|
||||||
"%s is already the active destination of failover IP %s"
|
|
||||||
% (new_destination, ip))
|
|
||||||
available_dests = [s.ip for s in list(self.servers)]
|
|
||||||
if new_destination not in available_dests:
|
|
||||||
raise RobotError(
|
|
||||||
"Invalid destination '%s'. "
|
|
||||||
"The destination is not in your server list: %s"
|
|
||||||
% (new_destination, available_dests))
|
|
||||||
result = self.conn.post('/failover/%s'
|
|
||||||
% ip, {'active_server_ip': new_destination})
|
|
||||||
return Failover(result.get('failover'))
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
try:
|
|
||||||
from urllib import urlencode
|
|
||||||
except ImportError:
|
|
||||||
from urllib.parse import urlencode
|
|
||||||
|
|
||||||
from hetzner import RobotError
|
|
||||||
|
|
||||||
__all__ = ['ReverseDNS', 'ReverseDNSManager']
|
|
||||||
|
|
||||||
|
|
||||||
class ReverseDNS(object):
|
|
||||||
def __init__(self, conn, ip=None, result=None):
|
|
||||||
self.conn = conn
|
|
||||||
self.ip = ip
|
|
||||||
self.update_info(result)
|
|
||||||
|
|
||||||
def update_info(self, result=None):
|
|
||||||
if result is None:
|
|
||||||
try:
|
|
||||||
result = self.conn.get('/rdns/{0}'.format(self.ip))
|
|
||||||
except RobotError as err:
|
|
||||||
if err.status == 404:
|
|
||||||
result = None
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
|
|
||||||
if result is not None:
|
|
||||||
data = result['rdns']
|
|
||||||
self.ip = data['ip']
|
|
||||||
self.ptr = data['ptr']
|
|
||||||
else:
|
|
||||||
self.ptr = None
|
|
||||||
|
|
||||||
def set(self, value):
|
|
||||||
self.conn.post('/rdns/{0}'.format(self.ip), {'ptr': value})
|
|
||||||
|
|
||||||
def remove(self):
|
|
||||||
self.conn.delete('/rdns/{0}'.format(self.ip))
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return "<ReverseDNS PTR: {0}>".format(self.ptr)
|
|
||||||
|
|
||||||
|
|
||||||
class ReverseDNSManager(object):
|
|
||||||
def __init__(self, conn, main_ip=None):
|
|
||||||
self.conn = conn
|
|
||||||
self.main_ip = main_ip
|
|
||||||
|
|
||||||
def get(self, ip):
|
|
||||||
return ReverseDNS(self.conn, ip)
|
|
||||||
|
|
||||||
def __iter__(self):
|
|
||||||
if self.main_ip is None:
|
|
||||||
url = '/rdns'
|
|
||||||
else:
|
|
||||||
data = urlencode({'server_ip': self.main_ip})
|
|
||||||
url = '/rdns?{0}'.format(data)
|
|
||||||
try:
|
|
||||||
result = self.conn.get(url)
|
|
||||||
except RobotError as err:
|
|
||||||
if err.status == 404:
|
|
||||||
result = []
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
return iter([ReverseDNS(self.conn, result=rdns) for rdns in result])
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
import socket
|
|
||||||
import time
|
|
||||||
|
|
||||||
from hetzner import ConnectError, ManualReboot
|
|
||||||
|
|
||||||
|
|
||||||
class Reset(object):
|
|
||||||
def __init__(self, server):
|
|
||||||
self.server = server
|
|
||||||
self.conn = server.conn
|
|
||||||
|
|
||||||
def check_ssh(self, port=22, timeout=5):
|
|
||||||
"""
|
|
||||||
Check if the current server has an open SSH port. Return True if port
|
|
||||||
is reachable, otherwise false. Time out after 'timeout' seconds.
|
|
||||||
"""
|
|
||||||
success = True
|
|
||||||
old_timeout = socket.getdefaulttimeout()
|
|
||||||
socket.setdefaulttimeout(5)
|
|
||||||
|
|
||||||
try:
|
|
||||||
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
||||||
s.connect((self.server.ip, port))
|
|
||||||
s.close()
|
|
||||||
except socket.error:
|
|
||||||
success = False
|
|
||||||
|
|
||||||
socket.setdefaulttimeout(old_timeout)
|
|
||||||
return success
|
|
||||||
|
|
||||||
def observed_reboot(self, patience=300, tries=None, manual=False):
|
|
||||||
"""
|
|
||||||
Reboot and wait patience seconds until the system comes back.
|
|
||||||
If not, retry with the next step in tries and wait another patience
|
|
||||||
seconds. Repeat until there are no more tries left.
|
|
||||||
|
|
||||||
If manual is true, do a manual reboot in case the server doesn't come
|
|
||||||
up again. Raises a ManualReboot exception if that is the case.
|
|
||||||
|
|
||||||
Return True on success and False if the system didn't come up.
|
|
||||||
"""
|
|
||||||
is_down = False
|
|
||||||
|
|
||||||
if tries is None:
|
|
||||||
if self.server.is_vserver:
|
|
||||||
tries = ['hard']
|
|
||||||
else:
|
|
||||||
tries = ['soft', 'hard']
|
|
||||||
|
|
||||||
for mode in tries:
|
|
||||||
self.server.logger.info("Tring to reboot using the %r method.",
|
|
||||||
mode)
|
|
||||||
self.reboot(mode)
|
|
||||||
|
|
||||||
start_time = time.time()
|
|
||||||
self.server.logger.info("Waiting for machine to become available.")
|
|
||||||
while True:
|
|
||||||
current_time = time.time()
|
|
||||||
if current_time > start_time + patience:
|
|
||||||
self.server.logger.info(
|
|
||||||
"Machine didn't come up after %d seconds.",
|
|
||||||
patience
|
|
||||||
)
|
|
||||||
break
|
|
||||||
|
|
||||||
is_up = self.check_ssh()
|
|
||||||
time.sleep(1)
|
|
||||||
|
|
||||||
if is_up and is_down:
|
|
||||||
self.server.logger.info("Machine just became available.")
|
|
||||||
return
|
|
||||||
elif not is_down:
|
|
||||||
is_down = not is_up
|
|
||||||
if manual:
|
|
||||||
self.reboot('manual')
|
|
||||||
raise ManualReboot("Issued a manual reboot because the server"
|
|
||||||
" did not come back to life.")
|
|
||||||
else:
|
|
||||||
raise ConnectError("Server keeps playing dead after reboot :-(")
|
|
||||||
|
|
||||||
def reboot(self, mode='soft'):
|
|
||||||
"""
|
|
||||||
Reboot the server, modes are "soft" for reboot by triggering Ctrl-Alt-
|
|
||||||
Del, "hard" for triggering a hardware reset and "manual" for requesting
|
|
||||||
a poor devil from the data center to go to your server and press the
|
|
||||||
power button.
|
|
||||||
|
|
||||||
On a vServer, rebooting with mode="soft" is a no-op, any other value
|
|
||||||
results in a hard reset.
|
|
||||||
"""
|
|
||||||
if self.server.is_vserver:
|
|
||||||
if mode == 'soft':
|
|
||||||
return
|
|
||||||
|
|
||||||
self.conn.scraper.login(force=True)
|
|
||||||
baseurl = '/server/vserverCommand/id/{0}/command/reset'
|
|
||||||
url = baseurl.format(self.server.number)
|
|
||||||
response = self.conn.scraper.request(url, method='POST')
|
|
||||||
assert "msgbox_success" in response.read().decode('utf-8')
|
|
||||||
return response
|
|
||||||
|
|
||||||
modes = {
|
|
||||||
'manual': 'man',
|
|
||||||
'hard': 'hw',
|
|
||||||
'soft': 'sw',
|
|
||||||
}
|
|
||||||
|
|
||||||
modekey = modes.get(mode, modes['soft'])
|
|
||||||
return self.conn.post('/reset/{0}'.format(self.server.ip),
|
|
||||||
{'type': modekey})
|
|
||||||
@@ -1,399 +0,0 @@
|
|||||||
import re
|
|
||||||
import json
|
|
||||||
import logging
|
|
||||||
|
|
||||||
from base64 import b64encode
|
|
||||||
|
|
||||||
try:
|
|
||||||
from httplib import BadStatusLine, ResponseNotReady
|
|
||||||
except ImportError:
|
|
||||||
from http.client import BadStatusLine, ResponseNotReady
|
|
||||||
|
|
||||||
try:
|
|
||||||
from urllib import urlencode
|
|
||||||
except ImportError:
|
|
||||||
from urllib.parse import urlencode
|
|
||||||
|
|
||||||
from hetzner import WebRobotError, RobotError
|
|
||||||
from hetzner.server import Server
|
|
||||||
from hetzner.rdns import ReverseDNSManager
|
|
||||||
from hetzner.failover import FailoverManager
|
|
||||||
from hetzner.util.http import ValidatedHTTPSConnection
|
|
||||||
|
|
||||||
ROBOT_HOST = "robot-ws.your-server.de"
|
|
||||||
ROBOT_WEBHOST = "robot.your-server.de"
|
|
||||||
ROBOT_LOGINHOST = "accounts.hetzner.com"
|
|
||||||
|
|
||||||
RE_CSRF_TOKEN = re.compile(
|
|
||||||
r'<input[^>]*?name="_csrf_token"[^>]*?value="([^">]+)"'
|
|
||||||
)
|
|
||||||
|
|
||||||
__all__ = ['Robot', 'RobotConnection', 'RobotWebInterface', 'ServerManager']
|
|
||||||
|
|
||||||
|
|
||||||
class RobotWebInterface(object):
|
|
||||||
"""
|
|
||||||
This is for scraping the web interface and can be used to implement
|
|
||||||
features that are not yet available in the official API.
|
|
||||||
"""
|
|
||||||
def __init__(self, user=None, passwd=None):
|
|
||||||
self.conn = None
|
|
||||||
self.session_cookie = None
|
|
||||||
self.user = user
|
|
||||||
self.passwd = passwd
|
|
||||||
self.logged_in = False
|
|
||||||
self.logger = logging.getLogger("Robot scraper for {0}".format(user))
|
|
||||||
|
|
||||||
def _parse_cookies(self, response):
|
|
||||||
"""
|
|
||||||
Return a dictionary consisting of the cookies from the given response.
|
|
||||||
"""
|
|
||||||
result = {}
|
|
||||||
cookies = response.getheader('set-cookie')
|
|
||||||
if cookies is None:
|
|
||||||
return result
|
|
||||||
|
|
||||||
# Not very accurate but sufficent enough for our use case.
|
|
||||||
for cookieval in cookies.split(','):
|
|
||||||
cookieattrs = cookieval.strip().split(';')
|
|
||||||
if len(cookieattrs) <= 1:
|
|
||||||
continue
|
|
||||||
cookie = cookieattrs[0].strip().split('=', 1)
|
|
||||||
if len(cookie) != 2:
|
|
||||||
continue
|
|
||||||
result[cookie[0]] = cookie[1]
|
|
||||||
|
|
||||||
return result
|
|
||||||
|
|
||||||
def update_session(self, response):
|
|
||||||
"""
|
|
||||||
Parses the session cookie from the given response instance and updates
|
|
||||||
self.session_cookie accordingly if a session cookie was recognized.
|
|
||||||
"""
|
|
||||||
session = self._parse_cookies(response).get('robot')
|
|
||||||
if session is not None:
|
|
||||||
self.session_cookie = "robot=" + session
|
|
||||||
|
|
||||||
def connect(self, force=False):
|
|
||||||
"""
|
|
||||||
Establish a connection to the robot web interface if we're not yet
|
|
||||||
connected. If 'force' is set to True, throw away the old connection and
|
|
||||||
establish a new one, regardless of whether we are connected or not.
|
|
||||||
"""
|
|
||||||
if force and self.conn is not None:
|
|
||||||
self.conn.close()
|
|
||||||
self.conn = None
|
|
||||||
if self.conn is None:
|
|
||||||
self.conn = ValidatedHTTPSConnection(ROBOT_WEBHOST)
|
|
||||||
|
|
||||||
def login(self, user=None, passwd=None, force=False):
|
|
||||||
"""
|
|
||||||
Log into the robot web interface using self.user and self.passwd. If
|
|
||||||
user/passwd is provided as arguments, those are used instead and
|
|
||||||
self.user/self.passwd are updated accordingly.
|
|
||||||
"""
|
|
||||||
if self.logged_in and not force:
|
|
||||||
return
|
|
||||||
|
|
||||||
self.connect(force=force)
|
|
||||||
|
|
||||||
# Update self.user and self.passwd in case we need to re-establish the
|
|
||||||
# connection.
|
|
||||||
if user is not None:
|
|
||||||
self.user = user
|
|
||||||
if passwd is not None:
|
|
||||||
self.passwd = passwd
|
|
||||||
|
|
||||||
if self.user is None or self.passwd is None:
|
|
||||||
raise WebRobotError("Login credentials for the web user interface "
|
|
||||||
"are missing.")
|
|
||||||
|
|
||||||
if self.user.startswith("#ws+"):
|
|
||||||
raise WebRobotError("The user {0} is a dedicated web service user "
|
|
||||||
"and cannot be used for scraping the web user "
|
|
||||||
"interface.".format(self.user))
|
|
||||||
|
|
||||||
# We need to first visit the Robot so that we later get an OAuth token
|
|
||||||
# for the Robot from the authentication site.
|
|
||||||
self.logger.debug("Visiting Robot web frontend for the first time.")
|
|
||||||
auth_url = self.request('/', xhr=False).getheader('location')
|
|
||||||
|
|
||||||
if not auth_url.startswith('https://' + ROBOT_LOGINHOST + '/'):
|
|
||||||
msg = "https://{0}/ does not redirect to https://{1}/ " \
|
|
||||||
"but instead redirects to: {2}"
|
|
||||||
raise WebRobotError(msg.format(ROBOT_WEBHOST, ROBOT_LOGINHOST,
|
|
||||||
auth_url))
|
|
||||||
|
|
||||||
self.logger.debug("Following authentication redirect to %r.", auth_url)
|
|
||||||
|
|
||||||
# This is primarily for getting a first session cookie.
|
|
||||||
login_conn = ValidatedHTTPSConnection(ROBOT_LOGINHOST)
|
|
||||||
login_conn.request('GET', auth_url[len(ROBOT_LOGINHOST) + 8:], None)
|
|
||||||
|
|
||||||
response = login_conn.getresponse()
|
|
||||||
if response.status != 302:
|
|
||||||
raise WebRobotError("Invalid status code {0} while visiting auth"
|
|
||||||
" URL".format(response.status))
|
|
||||||
|
|
||||||
cookies = self._parse_cookies(response)
|
|
||||||
if "PHPSESSID" not in cookies:
|
|
||||||
msg = "Auth site didn't respond with a session cookie."
|
|
||||||
raise WebRobotError(msg)
|
|
||||||
|
|
||||||
self.logger.debug("Session ID for auth site is %r.",
|
|
||||||
cookies['PHPSESSID'])
|
|
||||||
|
|
||||||
# Make sure that we always send the auth site's session ID in
|
|
||||||
# subsequent requests.
|
|
||||||
cookieval = '; '.join([k + '=' + v for k, v in cookies.items()])
|
|
||||||
headers = {'Cookie': cookieval}
|
|
||||||
|
|
||||||
self.logger.debug("Visiting login page at https://%s/login.",
|
|
||||||
ROBOT_LOGINHOST)
|
|
||||||
|
|
||||||
# Note that the auth site doesn't seem to support keep-alives, so we
|
|
||||||
# need to reconnect here.
|
|
||||||
login_conn = ValidatedHTTPSConnection(ROBOT_LOGINHOST)
|
|
||||||
login_conn.request('GET', "/login", None, headers)
|
|
||||||
|
|
||||||
response = login_conn.getresponse()
|
|
||||||
if response.status != 200:
|
|
||||||
raise WebRobotError("Invalid status code {0} while visiting login"
|
|
||||||
" page".format(response.status))
|
|
||||||
|
|
||||||
# Find the CSRF token
|
|
||||||
haystack = response.read()
|
|
||||||
token = RE_CSRF_TOKEN.search(str(haystack))
|
|
||||||
if token is None:
|
|
||||||
raise WebRobotError("Unable to find CSRF token for login form")
|
|
||||||
|
|
||||||
data = urlencode({'_username': self.user, '_password': self.passwd,
|
|
||||||
'_csrf_token': token.group(1)})
|
|
||||||
self.logger.debug("Logging in to auth site with user %s.", self.user)
|
|
||||||
|
|
||||||
# Again, we need to reconnect here.
|
|
||||||
login_conn = ValidatedHTTPSConnection(ROBOT_LOGINHOST)
|
|
||||||
post_headers = headers.copy()
|
|
||||||
post_headers['Content-Type'] = 'application/x-www-form-urlencoded'
|
|
||||||
login_conn.request('POST', '/login_check', data, post_headers)
|
|
||||||
response = login_conn.getresponse()
|
|
||||||
|
|
||||||
# Here, if the authentication is successful another session is started
|
|
||||||
# and we get a new session ID.
|
|
||||||
cookies = self._parse_cookies(response)
|
|
||||||
if "PHPSESSID" not in cookies:
|
|
||||||
raise WebRobotError("Login to robot web interface failed.")
|
|
||||||
self.logger.debug("New session ID for auth site after login is %r.",
|
|
||||||
cookies['PHPSESSID'])
|
|
||||||
cookieval = '; '.join([k + '=' + v for k, v in cookies.items()])
|
|
||||||
headers['Cookie'] = cookieval
|
|
||||||
|
|
||||||
# This should be the actual OAuth authorization URL.
|
|
||||||
location = response.getheader('Location')
|
|
||||||
|
|
||||||
if response.status != 302 or location is None:
|
|
||||||
raise WebRobotError("Unable to get OAuth authorization URL.")
|
|
||||||
|
|
||||||
if not location.startswith('https://' + ROBOT_LOGINHOST + '/'):
|
|
||||||
msg = "https://{0}/ does not redirect to https://{1}/ " \
|
|
||||||
"but instead redirects to: {2}"
|
|
||||||
raise WebRobotError(msg.format(ROBOT_LOGINHOST, ROBOT_LOGINHOST,
|
|
||||||
location))
|
|
||||||
|
|
||||||
self.logger.debug("Got redirected, visiting %r.", location)
|
|
||||||
|
|
||||||
login_conn = ValidatedHTTPSConnection(ROBOT_LOGINHOST)
|
|
||||||
login_conn.request('GET', location[len(ROBOT_LOGINHOST) + 8:], None,
|
|
||||||
headers)
|
|
||||||
response = login_conn.getresponse()
|
|
||||||
|
|
||||||
# We now should get an URL back to the Robot web interface.
|
|
||||||
location = response.getheader('Location')
|
|
||||||
if response.status != 302 or location is None:
|
|
||||||
raise WebRobotError("Failed to get OAuth URL for Robot.")
|
|
||||||
if not location.startswith('https://' + ROBOT_WEBHOST + '/'):
|
|
||||||
msg = "https://{0}/ does not redirect to https://{1}/ " \
|
|
||||||
"but instead redirects to: {2}"
|
|
||||||
raise WebRobotError(msg.format(ROBOT_LOGINHOST, ROBOT_WEBHOST,
|
|
||||||
auth_url))
|
|
||||||
|
|
||||||
self.logger.debug("Going back to Robot web interface via %r.",
|
|
||||||
location)
|
|
||||||
|
|
||||||
# Reconnect to Robot with the OAuth token.
|
|
||||||
self.connect(force=True)
|
|
||||||
response = self.request(location[len(ROBOT_WEBHOST) + 8:], xhr=False)
|
|
||||||
|
|
||||||
if response.status != 302:
|
|
||||||
raise WebRobotError("Status after providing OAuth token should be"
|
|
||||||
" 302 and not {0}".format(response.status))
|
|
||||||
|
|
||||||
if response.getheader('location') != 'https://' + ROBOT_WEBHOST + '/':
|
|
||||||
raise WebRobotError("Robot login with OAuth token has failed.")
|
|
||||||
|
|
||||||
self.logged_in = True
|
|
||||||
|
|
||||||
def request(self, path, data=None, xhr=True, method=None, log=True):
|
|
||||||
"""
|
|
||||||
Send a request to the web interface, using 'data' for urlencoded POST
|
|
||||||
data. If 'data' is None (which it is by default), a GET request is sent
|
|
||||||
instead. A httplib.HTTPResponse is returned on success.
|
|
||||||
|
|
||||||
By default this method uses headers for XMLHttpRequests, so if the
|
|
||||||
request should be an ordinary HTTP request, set 'xhr' to False.
|
|
||||||
|
|
||||||
If 'log' is set to False, don't log anything containing data. This is
|
|
||||||
useful to prevent logging sensible information such as passwords.
|
|
||||||
"""
|
|
||||||
self.connect()
|
|
||||||
|
|
||||||
headers = {'Connection': 'keep-alive'}
|
|
||||||
if self.session_cookie is not None:
|
|
||||||
headers['Cookie'] = self.session_cookie
|
|
||||||
if xhr:
|
|
||||||
headers['X-Requested-With'] = 'XMLHttpRequest'
|
|
||||||
|
|
||||||
if data is None:
|
|
||||||
if method is None:
|
|
||||||
method = 'GET'
|
|
||||||
encoded = None
|
|
||||||
else:
|
|
||||||
if method is None:
|
|
||||||
method = 'POST'
|
|
||||||
encoded = urlencode(data)
|
|
||||||
headers['Content-Type'] = 'application/x-www-form-urlencoded'
|
|
||||||
|
|
||||||
if log:
|
|
||||||
self.logger.debug("Sending %s request to Robot web frontend "
|
|
||||||
"at %s with data %r.",
|
|
||||||
("XHR " if xhr else "") + method, path, encoded)
|
|
||||||
self.conn.request(method, path, encoded, headers)
|
|
||||||
|
|
||||||
try:
|
|
||||||
response = self.conn.getresponse()
|
|
||||||
except ResponseNotReady:
|
|
||||||
self.logger.debug("Connection closed by Robot web frontend,"
|
|
||||||
" retrying.")
|
|
||||||
# Connection closed, so we need to reconnect.
|
|
||||||
# FIXME: Try to avoid endless loops here!
|
|
||||||
self.connect(force=True)
|
|
||||||
return self.request(path, data=data, xhr=xhr, log=log)
|
|
||||||
|
|
||||||
if log:
|
|
||||||
self.logger.debug("Got response from web frontend with status %d.",
|
|
||||||
response.status)
|
|
||||||
|
|
||||||
self.update_session(response)
|
|
||||||
return response
|
|
||||||
|
|
||||||
|
|
||||||
class RobotConnection(object):
|
|
||||||
def __init__(self, user, passwd):
|
|
||||||
self.user = user
|
|
||||||
self.passwd = passwd
|
|
||||||
self.conn = ValidatedHTTPSConnection(ROBOT_HOST)
|
|
||||||
self.logger = logging.getLogger("Robot of {0}".format(user))
|
|
||||||
|
|
||||||
# Provide this as a way to easily add unsupported API features.
|
|
||||||
self.scraper = RobotWebInterface(user, passwd)
|
|
||||||
|
|
||||||
def _request(self, method, path, data, headers, retry=1):
|
|
||||||
self.conn.request(method.upper(), path, data, headers)
|
|
||||||
try:
|
|
||||||
return self.conn.getresponse()
|
|
||||||
except BadStatusLine:
|
|
||||||
# XXX: Sometimes, the API server seems to have a problem with
|
|
||||||
# keepalives.
|
|
||||||
if retry <= 0:
|
|
||||||
raise
|
|
||||||
|
|
||||||
self.conn.close()
|
|
||||||
self.conn.connect()
|
|
||||||
return self._request(method, path, data, headers, retry - 1)
|
|
||||||
|
|
||||||
def request(self, method, path, data=None, allow_empty=False):
|
|
||||||
if data is not None:
|
|
||||||
data = urlencode(data)
|
|
||||||
|
|
||||||
auth = 'Basic {0}'.format(b64encode(
|
|
||||||
"{0}:{1}".format(self.user, self.passwd).encode('ascii')
|
|
||||||
).decode('ascii'))
|
|
||||||
|
|
||||||
headers = {'Authorization': auth}
|
|
||||||
|
|
||||||
if data is not None:
|
|
||||||
headers['Content-Type'] = 'application/x-www-form-urlencoded'
|
|
||||||
|
|
||||||
self.logger.debug("Sending %s request to Robot at %s with data %r.",
|
|
||||||
method, path, data)
|
|
||||||
response = self._request(method, path, data, headers)
|
|
||||||
raw_data = response.read().decode('utf-8')
|
|
||||||
if len(raw_data) == 0 and not allow_empty:
|
|
||||||
msg = "Empty response, status {0}."
|
|
||||||
raise RobotError(msg.format(response.status), response.status)
|
|
||||||
elif not allow_empty:
|
|
||||||
try:
|
|
||||||
data = json.loads(raw_data)
|
|
||||||
except ValueError:
|
|
||||||
msg = "Response is not JSON (status {0}): {1}"
|
|
||||||
raise RobotError(msg.format(response.status, repr(raw_data)))
|
|
||||||
else:
|
|
||||||
data = None
|
|
||||||
self.logger.debug(
|
|
||||||
"Got response from Robot with status %d and data %r.",
|
|
||||||
response.status, data
|
|
||||||
)
|
|
||||||
|
|
||||||
if 200 <= response.status < 300:
|
|
||||||
return data
|
|
||||||
else:
|
|
||||||
error = data.get('error', None)
|
|
||||||
if error is None:
|
|
||||||
raise RobotError("Unknown error: {0}".format(data),
|
|
||||||
response.status)
|
|
||||||
else:
|
|
||||||
err = "{0} - {1}".format(error['status'], error['message'])
|
|
||||||
missing = error.get('missing', [])
|
|
||||||
invalid = error.get('invalid', [])
|
|
||||||
fields = []
|
|
||||||
if missing is not None:
|
|
||||||
fields += missing
|
|
||||||
if invalid is not None:
|
|
||||||
fields += invalid
|
|
||||||
if len(fields) > 0:
|
|
||||||
err += ", fields: {0}".format(', '.join(fields))
|
|
||||||
raise RobotError(err, response.status)
|
|
||||||
|
|
||||||
def get(self, path):
|
|
||||||
return self.request('GET', path)
|
|
||||||
|
|
||||||
def post(self, path, data):
|
|
||||||
return self.request('POST', path, data)
|
|
||||||
|
|
||||||
def put(self, path, data):
|
|
||||||
return self.request('PUT', path, data)
|
|
||||||
|
|
||||||
def delete(self, path, data=None):
|
|
||||||
return self.request('DELETE', path, data, allow_empty=True)
|
|
||||||
|
|
||||||
|
|
||||||
class ServerManager(object):
|
|
||||||
def __init__(self, conn):
|
|
||||||
self.conn = conn
|
|
||||||
|
|
||||||
def get(self, ip):
|
|
||||||
"""
|
|
||||||
Get server by providing its main IP address.
|
|
||||||
"""
|
|
||||||
return Server(self.conn, self.conn.get('/server/{0}'.format(ip)))
|
|
||||||
|
|
||||||
def __iter__(self):
|
|
||||||
return iter([Server(self.conn, s) for s in self.conn.get('/server')])
|
|
||||||
|
|
||||||
|
|
||||||
class Robot(object):
|
|
||||||
def __init__(self, user, passwd):
|
|
||||||
self.conn = RobotConnection(user, passwd)
|
|
||||||
self.servers = ServerManager(self.conn)
|
|
||||||
self.rdns = ReverseDNSManager(self.conn)
|
|
||||||
self.failover = FailoverManager(self.conn, self.servers)
|
|
||||||
@@ -1,467 +0,0 @@
|
|||||||
import os
|
|
||||||
import re
|
|
||||||
import random
|
|
||||||
import string
|
|
||||||
import subprocess
|
|
||||||
import warnings
|
|
||||||
import logging
|
|
||||||
|
|
||||||
from tempfile import mkdtemp
|
|
||||||
from datetime import datetime
|
|
||||||
from functools import reduce
|
|
||||||
|
|
||||||
try:
|
|
||||||
from urllib import urlencode
|
|
||||||
except ImportError:
|
|
||||||
from urllib.parse import urlencode
|
|
||||||
|
|
||||||
from hetzner import RobotError, WebRobotError
|
|
||||||
from hetzner.rdns import ReverseDNS, ReverseDNSManager
|
|
||||||
from hetzner.reset import Reset
|
|
||||||
from hetzner.util import addr, scraping
|
|
||||||
|
|
||||||
__all__ = ['AdminAccount', 'IpAddress', 'RescueSystem', 'Server', 'Subnet',
|
|
||||||
'IpManager', 'SubnetManager']
|
|
||||||
|
|
||||||
|
|
||||||
class SSHAskPassHelper(object):
|
|
||||||
"""
|
|
||||||
This creates a temporary SSH askpass helper script, which just passes the
|
|
||||||
provided password.
|
|
||||||
"""
|
|
||||||
def __init__(self, passwd):
|
|
||||||
self.passwd = passwd
|
|
||||||
self.tempdir = None
|
|
||||||
self.script = None
|
|
||||||
|
|
||||||
def __enter__(self):
|
|
||||||
self.tempdir = mkdtemp()
|
|
||||||
script = os.path.join(self.tempdir, "askpass")
|
|
||||||
fd = os.open(script, os.O_WRONLY | os.O_CREAT | os.O_NOFOLLOW, 0o700)
|
|
||||||
self.script = script
|
|
||||||
esc_passwd = self.passwd.replace("'", r"'\''")
|
|
||||||
askpass = "#!/bin/sh\necho -n '{0}'".format(esc_passwd).encode('ascii')
|
|
||||||
os.write(fd, askpass)
|
|
||||||
os.close(fd)
|
|
||||||
return script
|
|
||||||
|
|
||||||
def __exit__(self, type, value, traceback):
|
|
||||||
if self.script is not None:
|
|
||||||
os.unlink(self.script)
|
|
||||||
if self.tempdir is not None:
|
|
||||||
os.rmdir(self.tempdir)
|
|
||||||
|
|
||||||
|
|
||||||
class RescueSystem(object):
|
|
||||||
def __init__(self, server):
|
|
||||||
self.server = server
|
|
||||||
self.conn = server.conn
|
|
||||||
|
|
||||||
self._active = None
|
|
||||||
self._password = None
|
|
||||||
|
|
||||||
def _fetch_status(self):
|
|
||||||
reply = self.conn.get('/boot/{0}/rescue'.format(self.server.ip))
|
|
||||||
data = reply['rescue']
|
|
||||||
self._active = data['active']
|
|
||||||
self._password = data['password']
|
|
||||||
|
|
||||||
@property
|
|
||||||
def active(self):
|
|
||||||
if self._active is not None:
|
|
||||||
return self._active
|
|
||||||
self._fetch_status()
|
|
||||||
return self._active
|
|
||||||
|
|
||||||
@property
|
|
||||||
def password(self):
|
|
||||||
if self._password is not None:
|
|
||||||
return self._password
|
|
||||||
self._fetch_status()
|
|
||||||
return self._password
|
|
||||||
|
|
||||||
def _rescue_action(self, method, opts=None):
|
|
||||||
reply = self.conn.request(
|
|
||||||
method,
|
|
||||||
'/boot/{0}/rescue'.format(self.server.ip),
|
|
||||||
opts
|
|
||||||
)
|
|
||||||
|
|
||||||
data = reply['rescue']
|
|
||||||
self._active = data['active']
|
|
||||||
self._password = data['password']
|
|
||||||
|
|
||||||
def activate(self, bits=64, os='linux'):
|
|
||||||
"""
|
|
||||||
Activate the rescue system if necessary.
|
|
||||||
"""
|
|
||||||
if not self.active:
|
|
||||||
opts = {'os': os, 'arch': bits}
|
|
||||||
return self._rescue_action('post', opts)
|
|
||||||
|
|
||||||
def deactivate(self):
|
|
||||||
"""
|
|
||||||
Deactivate the rescue system if necessary.
|
|
||||||
"""
|
|
||||||
if self.active:
|
|
||||||
return self._rescue_action('delete')
|
|
||||||
|
|
||||||
def observed_activate(self, *args, **kwargs):
|
|
||||||
"""
|
|
||||||
Activate the rescue system and reboot into it.
|
|
||||||
Look at Server.observed_reboot() for options.
|
|
||||||
"""
|
|
||||||
self.activate()
|
|
||||||
self.server.observed_reboot(*args, **kwargs)
|
|
||||||
|
|
||||||
def observed_deactivate(self, *args, **kwargs):
|
|
||||||
"""
|
|
||||||
Deactivate the rescue system and reboot into normal system.
|
|
||||||
Look at Server.observed_reboot() for options.
|
|
||||||
"""
|
|
||||||
self.deactivate()
|
|
||||||
self.server.observed_reboot(*args, **kwargs)
|
|
||||||
|
|
||||||
def shell(self, *args, **kwargs):
|
|
||||||
"""
|
|
||||||
Reboot into rescue system, spawn a shell and after the shell is
|
|
||||||
closed, reboot back into the normal system.
|
|
||||||
|
|
||||||
Look at Server.observed_reboot() for further options.
|
|
||||||
"""
|
|
||||||
msg = ("The RescueSystem.shell() method will be removed from the API"
|
|
||||||
" in version 1.0.0, please do not use it! See"
|
|
||||||
" https://github.com/aszlig/hetzner/issues/13"
|
|
||||||
" for details.")
|
|
||||||
warnings.warn(msg, FutureWarning)
|
|
||||||
self.observed_activate(*args, **kwargs)
|
|
||||||
|
|
||||||
with SSHAskPassHelper(self.password) as askpass:
|
|
||||||
ssh_options = [
|
|
||||||
'CheckHostIP=no',
|
|
||||||
'GlobalKnownHostsFile=/dev/null',
|
|
||||||
'UserKnownHostsFile=/dev/null',
|
|
||||||
'StrictHostKeyChecking=no',
|
|
||||||
'LogLevel=quiet',
|
|
||||||
]
|
|
||||||
ssh_args = reduce(lambda acc, opt: acc + ['-o', opt],
|
|
||||||
ssh_options, [])
|
|
||||||
cmd = ['ssh'] + ssh_args + ["root@{0}".format(self.server.ip)]
|
|
||||||
env = dict(os.environ)
|
|
||||||
env['DISPLAY'] = ":666"
|
|
||||||
env['SSH_ASKPASS'] = askpass
|
|
||||||
subprocess.check_call(cmd, env=env, preexec_fn=os.setsid)
|
|
||||||
|
|
||||||
self.observed_deactivate(*args, **kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class AdminAccount(object):
|
|
||||||
def __init__(self, server):
|
|
||||||
# XXX: This is preliminary, because we don't have such functionality in
|
|
||||||
# the official API yet.
|
|
||||||
self._scraper = server.conn.scraper
|
|
||||||
self._serverid = server.number
|
|
||||||
self.exists = False
|
|
||||||
self.login = None
|
|
||||||
self.passwd = None
|
|
||||||
self.update_info()
|
|
||||||
|
|
||||||
def update_info(self):
|
|
||||||
"""
|
|
||||||
Get information about currently active admin login.
|
|
||||||
"""
|
|
||||||
self._scraper.login()
|
|
||||||
login_re = re.compile(r'"label_req">Login.*?"element">([^<]+)',
|
|
||||||
re.DOTALL)
|
|
||||||
|
|
||||||
path = '/server/admin/id/{0}'.format(self._serverid)
|
|
||||||
response = self._scraper.request(path)
|
|
||||||
assert response.status == 200
|
|
||||||
match = login_re.search(response.read().decode('utf-8'))
|
|
||||||
if match is None:
|
|
||||||
self.exists = False
|
|
||||||
else:
|
|
||||||
self.exists = True
|
|
||||||
self.login = match.group(1)
|
|
||||||
|
|
||||||
def _genpasswd(self):
|
|
||||||
random.seed(os.urandom(512))
|
|
||||||
chars = string.ascii_letters + string.digits + "/()-=+_,;.^~#*@"
|
|
||||||
length = random.randint(20, 40)
|
|
||||||
return ''.join(random.choice(chars) for i in range(length))
|
|
||||||
|
|
||||||
def create(self, passwd=None):
|
|
||||||
"""
|
|
||||||
Create a new admin account if missing. If passwd is supplied, use it
|
|
||||||
instead of generating a random one.
|
|
||||||
"""
|
|
||||||
if passwd is None:
|
|
||||||
passwd = self._genpasswd()
|
|
||||||
|
|
||||||
form_path = '/server/admin/id/{0}'.format(self._serverid)
|
|
||||||
form_response = self._scraper.request(form_path, method='POST')
|
|
||||||
|
|
||||||
parser = scraping.CSRFParser('password[_csrf_token]')
|
|
||||||
parser.feed(form_response.read().decode('utf-8'))
|
|
||||||
assert parser.csrf_token is not None
|
|
||||||
|
|
||||||
data = {
|
|
||||||
'password[new_password]': passwd,
|
|
||||||
'password[new_password_repeat]': passwd,
|
|
||||||
'password[_csrf_token]': parser.csrf_token,
|
|
||||||
}
|
|
||||||
|
|
||||||
if not self.exists:
|
|
||||||
failmsg = "Unable to create admin account"
|
|
||||||
path = '/server/adminCreate/id/{0}'.format(self._serverid)
|
|
||||||
else:
|
|
||||||
failmsg = "Unable to update admin account password"
|
|
||||||
path = '/server/adminUpdate'
|
|
||||||
data['id'] = self._serverid
|
|
||||||
|
|
||||||
response = self._scraper.request(path, data)
|
|
||||||
data = response.read().decode('utf-8')
|
|
||||||
if "msgbox_success" not in data:
|
|
||||||
ul_re = re.compile(r'<ul\s+class="error_list">(.*?)</ul>',
|
|
||||||
re.DOTALL)
|
|
||||||
li_re = re.compile(r'<li>\s*([^<]*?)\s*</li>')
|
|
||||||
ul_match = ul_re.search(data)
|
|
||||||
if ul_match is not None:
|
|
||||||
errors = [error.group(1)
|
|
||||||
for error in li_re.finditer(ul_match.group(0))]
|
|
||||||
msg = failmsg + ': ' + ', '.join(errors)
|
|
||||||
raise WebRobotError(msg)
|
|
||||||
raise WebRobotError(failmsg)
|
|
||||||
self.update_info()
|
|
||||||
self.passwd = passwd
|
|
||||||
return self.login, self.passwd
|
|
||||||
|
|
||||||
def delete(self):
|
|
||||||
"""
|
|
||||||
Remove the admin account.
|
|
||||||
"""
|
|
||||||
if not self.exists:
|
|
||||||
return
|
|
||||||
path = '/server/adminDelete/id/{0}'.format(self._serverid)
|
|
||||||
assert "msgbox_success" in \
|
|
||||||
self._scraper.request(path).read().decode('utf-8')
|
|
||||||
self.update_info()
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
if self.exists:
|
|
||||||
return "<AdminAccount login: {0}>".format(self.login)
|
|
||||||
else:
|
|
||||||
return "<AdminAccount missing>"
|
|
||||||
|
|
||||||
|
|
||||||
class IpAddress(object):
|
|
||||||
def __init__(self, conn, result, subnet_ip=None):
|
|
||||||
self.conn = conn
|
|
||||||
self.subnet_ip = subnet_ip
|
|
||||||
self.update_info(result)
|
|
||||||
self._rdns = None
|
|
||||||
|
|
||||||
@property
|
|
||||||
def rdns(self):
|
|
||||||
"""
|
|
||||||
Get or set reverse DNS PTRs.
|
|
||||||
"""
|
|
||||||
if self._rdns is None:
|
|
||||||
self._rdns = ReverseDNS(self.conn, self.ip)
|
|
||||||
return self._rdns
|
|
||||||
|
|
||||||
def update_info(self, result=None):
|
|
||||||
"""
|
|
||||||
Update the information of the current IP address and all related
|
|
||||||
information such as traffic warnings. If result is omitted, a new
|
|
||||||
request is sent to the robot to gather the information.
|
|
||||||
"""
|
|
||||||
if self.subnet_ip is not None:
|
|
||||||
if result is None:
|
|
||||||
result = self.conn.get('/subnet/{0}'.format(self._subnet_addr))
|
|
||||||
data = result['subnet']
|
|
||||||
self._subnet_addr = data['ip']
|
|
||||||
data['ip'] = self.subnet_ip
|
|
||||||
# Does not exist in subnets
|
|
||||||
data['separate_mac'] = None
|
|
||||||
else:
|
|
||||||
if result is None:
|
|
||||||
result = self.conn.get('/ip/{0}'.format(self.ip))
|
|
||||||
data = result['ip']
|
|
||||||
|
|
||||||
self.ip = data['ip']
|
|
||||||
self.server_ip = data['server_ip']
|
|
||||||
self.locked = data['locked']
|
|
||||||
self.separate_mac = data['separate_mac']
|
|
||||||
self.traffic_warnings = data['traffic_warnings']
|
|
||||||
self.traffic_hourly = data['traffic_hourly']
|
|
||||||
self.traffic_daily = data['traffic_daily']
|
|
||||||
self.traffic_monthly = data['traffic_monthly']
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return "<IpAddress {0}>".format(self.ip)
|
|
||||||
|
|
||||||
|
|
||||||
class IpManager(object):
|
|
||||||
def __init__(self, conn, main_ip):
|
|
||||||
self.conn = conn
|
|
||||||
self.main_ip = main_ip
|
|
||||||
|
|
||||||
def get(self, ip):
|
|
||||||
"""
|
|
||||||
Get a specific IP address of a server.
|
|
||||||
"""
|
|
||||||
return IpAddress(self.conn, self.conn.get('/ip/{0}'.format(ip)))
|
|
||||||
|
|
||||||
def __iter__(self):
|
|
||||||
data = urlencode({'server_ip': self.main_ip})
|
|
||||||
result = self.conn.get('/ip?{0}'.format(data))
|
|
||||||
return iter([IpAddress(self.conn, ip) for ip in result])
|
|
||||||
|
|
||||||
|
|
||||||
class Subnet(object):
|
|
||||||
def __init__(self, conn, result):
|
|
||||||
self.conn = conn
|
|
||||||
self.update_info(result)
|
|
||||||
|
|
||||||
def update_info(self, result=None):
|
|
||||||
"""
|
|
||||||
Update the information of the subnet. If result is omitted, a new
|
|
||||||
request is sent to the robot to gather the information.
|
|
||||||
"""
|
|
||||||
if result is None:
|
|
||||||
result = self.conn.get('/subnet/{0}'.format(self.net_ip))
|
|
||||||
|
|
||||||
data = result['subnet']
|
|
||||||
|
|
||||||
self.net_ip = data['ip']
|
|
||||||
self.mask = data['mask']
|
|
||||||
self.gateway = data['gateway']
|
|
||||||
self.server_ip = data['server_ip']
|
|
||||||
self.failover = data['failover']
|
|
||||||
self.locked = data['locked']
|
|
||||||
self.traffic_warnings = data['traffic_warnings']
|
|
||||||
self.traffic_hourly = data['traffic_hourly']
|
|
||||||
self.traffic_daily = data['traffic_daily']
|
|
||||||
self.traffic_monthly = data['traffic_monthly']
|
|
||||||
|
|
||||||
self.is_ipv6, self.numeric_net_ip = addr.parse_ipaddr(self.net_ip)
|
|
||||||
self.numeric_gateway = addr.parse_ipaddr(self.gateway, self.is_ipv6)
|
|
||||||
getrange = addr.get_ipv6_range if self.is_ipv6 else addr.get_ipv4_range
|
|
||||||
self.numeric_range = getrange(self.numeric_net_ip, self.mask)
|
|
||||||
|
|
||||||
def get_ip_range(self):
|
|
||||||
"""
|
|
||||||
Return the smallest and biggest possible IP address of the current
|
|
||||||
subnet.
|
|
||||||
"""
|
|
||||||
convert = addr.ipv6_bin2addr if self.is_ipv6 else addr.ipv4_bin2addr
|
|
||||||
return convert(self.numeric_range[0]), convert(self.numeric_range[1])
|
|
||||||
|
|
||||||
def __contains__(self, addr):
|
|
||||||
"""
|
|
||||||
Check whether a specific IP address is within the current subnet.
|
|
||||||
"""
|
|
||||||
numeric_addr = addr.parse_ipaddr(addr, self.is_ipv6)
|
|
||||||
return self.numeric_range[0] <= numeric_addr <= self.numeric_range[1]
|
|
||||||
|
|
||||||
def get_ip(self, addr):
|
|
||||||
"""
|
|
||||||
Return an IpAddress object for the specified IPv4 or IPv6 address or
|
|
||||||
None if the IP address doesn't exist in the current subnet.
|
|
||||||
"""
|
|
||||||
if addr in self:
|
|
||||||
result = self.conn.get('/subnet/{0}'.format(self.net_ip))
|
|
||||||
return IpAddress(self.conn, result, addr)
|
|
||||||
else:
|
|
||||||
return None
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return "<Subnet {0}/{1} (Gateway: {2})>".format(self.net_ip, self.mask,
|
|
||||||
self.gateway)
|
|
||||||
|
|
||||||
|
|
||||||
class SubnetManager(object):
|
|
||||||
def __init__(self, conn, main_ip):
|
|
||||||
self.conn = conn
|
|
||||||
self.main_ip = main_ip
|
|
||||||
|
|
||||||
def get(self, net_ip):
|
|
||||||
"""
|
|
||||||
Get a specific subnet of a server.
|
|
||||||
"""
|
|
||||||
return Subnet(self.conn, self.conn.get('/subnet/{0}'.format(net_ip)))
|
|
||||||
|
|
||||||
def __iter__(self):
|
|
||||||
data = urlencode({'server_ip': self.main_ip})
|
|
||||||
try:
|
|
||||||
result = self.conn.get('/subnet?{0}'.format(data))
|
|
||||||
except RobotError as err:
|
|
||||||
# If there are no subnets a 404 is returned rather than just an
|
|
||||||
# empty list.
|
|
||||||
if err.status == 404:
|
|
||||||
result = []
|
|
||||||
return iter([Subnet(self.conn, net) for net in result])
|
|
||||||
|
|
||||||
|
|
||||||
class Server(object):
|
|
||||||
def __init__(self, conn, result):
|
|
||||||
self.conn = conn
|
|
||||||
self.update_info(result)
|
|
||||||
self.rescue = RescueSystem(self)
|
|
||||||
self.reset = Reset(self)
|
|
||||||
self.ips = IpManager(self.conn, self.ip)
|
|
||||||
self.subnets = SubnetManager(self.conn, self.ip)
|
|
||||||
self.rdns = ReverseDNSManager(self.conn, self.ip)
|
|
||||||
self._admin_account = None
|
|
||||||
self.logger = logging.getLogger("Server #{0}".format(self.number))
|
|
||||||
|
|
||||||
@property
|
|
||||||
def admin(self):
|
|
||||||
"""
|
|
||||||
Update, create and delete admin accounts.
|
|
||||||
"""
|
|
||||||
if self._admin_account is None:
|
|
||||||
self._admin_account = AdminAccount(self)
|
|
||||||
return self._admin_account
|
|
||||||
|
|
||||||
def update_info(self, result=None):
|
|
||||||
"""
|
|
||||||
Updates the information of the current Server instance either by
|
|
||||||
sending a new GET request or by parsing the response given by result.
|
|
||||||
"""
|
|
||||||
if result is None:
|
|
||||||
result = self.conn.get('/server/{0}'.format(self.ip))
|
|
||||||
|
|
||||||
data = result['server']
|
|
||||||
|
|
||||||
self.ip = data['server_ip']
|
|
||||||
self.number = data['server_number']
|
|
||||||
self.name = data['server_name']
|
|
||||||
self.product = data['product']
|
|
||||||
self.datacenter = data['dc']
|
|
||||||
self.traffic = data['traffic']
|
|
||||||
self.status = data['status']
|
|
||||||
self.cancelled = data['cancelled']
|
|
||||||
self.paid_until = datetime.strptime(data['paid_until'], '%Y-%m-%d')
|
|
||||||
self.is_vserver = self.product.startswith('VQ')
|
|
||||||
|
|
||||||
def observed_reboot(self, *args, **kwargs):
|
|
||||||
msg = ("Server.observed_reboot() is deprecated. Please use"
|
|
||||||
" Server.reset.observed_reboot() instead.")
|
|
||||||
warnings.warn(msg, DeprecationWarning)
|
|
||||||
return self.reset.observed_reboot(*args, **kwargs)
|
|
||||||
|
|
||||||
def reboot(self, *args, **kwargs):
|
|
||||||
msg = ("Server.reboot() is deprecated. Please use"
|
|
||||||
" Server.reset.reboot() instead.")
|
|
||||||
warnings.warn(msg, DeprecationWarning)
|
|
||||||
return self.reset.reboot(*args, **kwargs)
|
|
||||||
|
|
||||||
def set_name(self, name):
|
|
||||||
result = self.conn.post('/server/{0}'.format(self.ip),
|
|
||||||
{'server_name': name})
|
|
||||||
self.update_info(result)
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return "<{0} (#{1} {2})>".format(self.ip, self.number, self.product)
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
from hetzner.tests.test_util_addr import * # NOQA
|
|
||||||
Binary file not shown.
Binary file not shown.
@@ -1,85 +0,0 @@
|
|||||||
import unittest
|
|
||||||
import struct
|
|
||||||
import socket
|
|
||||||
|
|
||||||
from hetzner.util.addr import (parse_ipv4, parse_ipv6, parse_ipaddr,
|
|
||||||
get_ipv4_range, get_ipv6_range,
|
|
||||||
ipv4_bin2addr, ipv6_bin2addr)
|
|
||||||
|
|
||||||
|
|
||||||
class UtilAddrTestCase(unittest.TestCase):
|
|
||||||
def test_parse_ipv4(self):
|
|
||||||
self.assertEqual(parse_ipv4('174.26.72.88'), 2920958040)
|
|
||||||
self.assertEqual(parse_ipv4('0.0.0.0'), 0)
|
|
||||||
self.assertEqual(parse_ipv4('255.255.255.255'), 4294967295)
|
|
||||||
self.assertRaises(socket.error, parse_ipv4, '999.999.999.999')
|
|
||||||
self.assertRaises(socket.error, parse_ipv4, '::ffff:192.168.0.1')
|
|
||||||
|
|
||||||
def test_parse_ipv6(self):
|
|
||||||
self.assertEqual(parse_ipv6('::ffff:192.168.0.1'), 281473913978881)
|
|
||||||
self.assertEqual(parse_ipv6('fe80::fbd6:7860'),
|
|
||||||
338288524927261089654018896845572831328)
|
|
||||||
self.assertEqual(parse_ipv6('ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff'),
|
|
||||||
340282366920938463463374607431768211455)
|
|
||||||
self.assertEqual(parse_ipv6('::'), 0)
|
|
||||||
self.assertRaises(socket.error, parse_ipv6, '174.26.72.88')
|
|
||||||
|
|
||||||
def test_parse_ipaddr(self):
|
|
||||||
self.assertEqual(parse_ipaddr('1.2.3.4'), (False, 16909060))
|
|
||||||
self.assertEqual(parse_ipaddr('255.255.0.0', False), 4294901760)
|
|
||||||
self.assertEqual(parse_ipaddr('dead::beef'),
|
|
||||||
(True, 295986882420777848964380943247191621359))
|
|
||||||
self.assertEqual(parse_ipaddr('ffff::ffff', True),
|
|
||||||
340277174624079928635746076935439056895)
|
|
||||||
self.assertRaises(socket.error, parse_ipaddr, '1.2.3.4', True)
|
|
||||||
self.assertRaises(socket.error, parse_ipaddr, 'dead::beef', False)
|
|
||||||
self.assertRaises(socket.error, parse_ipaddr, 'invalid')
|
|
||||||
|
|
||||||
def test_get_ipv4_range(self):
|
|
||||||
self.assertEqual(get_ipv4_range(0xac100000, 12),
|
|
||||||
(2886729728, 2887778303))
|
|
||||||
self.assertEqual(get_ipv4_range(0xa1b2c3d4, 16),
|
|
||||||
(2712797184, 2712862719))
|
|
||||||
self.assertEqual(get_ipv4_range(0xa1b2c3d4, 32),
|
|
||||||
(2712847316, 2712847316))
|
|
||||||
self.assertEqual(get_ipv4_range(0xa1b2c3d4, 0),
|
|
||||||
(0, 4294967295))
|
|
||||||
self.assertRaises(ValueError, get_ipv4_range, 0x01, 64)
|
|
||||||
|
|
||||||
def test_get_ipv6_range(self):
|
|
||||||
self.assertEqual(
|
|
||||||
get_ipv6_range(0x00010203ff05060708091a1b1c1d1e1f, 36),
|
|
||||||
(5233173638632030885207665411096576,
|
|
||||||
5233178590392188026728765007593471)
|
|
||||||
)
|
|
||||||
self.assertEqual(
|
|
||||||
get_ipv6_range(0x000102030405060708091a1b1c1d1e1f, 64),
|
|
||||||
(5233100606242805471950326074441728,
|
|
||||||
5233100606242823918694399783993343)
|
|
||||||
)
|
|
||||||
self.assertEqual(
|
|
||||||
get_ipv6_range(0x000102030405060708091a1b1c1d1e1f, 128),
|
|
||||||
(5233100606242806050973056906370591,
|
|
||||||
5233100606242806050973056906370591)
|
|
||||||
)
|
|
||||||
self.assertEqual(
|
|
||||||
get_ipv6_range(0x000102030405060708091a1b1c1d1e1f, 0),
|
|
||||||
(0, 340282366920938463463374607431768211455)
|
|
||||||
)
|
|
||||||
self.assertRaises(ValueError, get_ipv6_range, 0x01, 256)
|
|
||||||
|
|
||||||
def test_ipv4_bin2addr(self):
|
|
||||||
self.assertEqual(ipv4_bin2addr(0x01020304), '1.2.3.4')
|
|
||||||
self.assertEqual(ipv4_bin2addr(0x0000ffff), '0.0.255.255')
|
|
||||||
self.assertEqual(ipv4_bin2addr(0xffff0000), '255.255.0.0')
|
|
||||||
self.assertRaises(struct.error, ipv4_bin2addr, 0xa1ffff0000)
|
|
||||||
|
|
||||||
def test_ipv6_bin2addr(self):
|
|
||||||
self.assertEqual(ipv6_bin2addr(0x01020304050607080910111213141516),
|
|
||||||
'102:304:506:708:910:1112:1314:1516')
|
|
||||||
self.assertEqual(ipv6_bin2addr(0xffff000000000dead00000beef000000),
|
|
||||||
'ffff::dea:d000:be:ef00:0')
|
|
||||||
self.assertEqual(ipv6_bin2addr(0x123400000000000000000000000000ff),
|
|
||||||
'1234::ff')
|
|
||||||
self.assertRaises(struct.error, ipv6_bin2addr,
|
|
||||||
0xa1ffff0000000000000000000000000000)
|
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -1,84 +0,0 @@
|
|||||||
import socket
|
|
||||||
import struct
|
|
||||||
|
|
||||||
|
|
||||||
def parse_ipv4(addr):
|
|
||||||
"""
|
|
||||||
Return a numeric representation of the given IPv4 address.
|
|
||||||
"""
|
|
||||||
binary_ip = socket.inet_pton(socket.AF_INET, addr)
|
|
||||||
return struct.unpack('!L', binary_ip)[0]
|
|
||||||
|
|
||||||
|
|
||||||
def parse_ipv6(addr):
|
|
||||||
"""
|
|
||||||
Return a numeric representation of the given IPv6 address.
|
|
||||||
"""
|
|
||||||
binary_ip = socket.inet_pton(socket.AF_INET6, addr)
|
|
||||||
high, low = struct.unpack('!QQ', binary_ip)
|
|
||||||
return high << 64 | low
|
|
||||||
|
|
||||||
|
|
||||||
def parse_ipaddr(addr, is_ipv6=None):
|
|
||||||
"""
|
|
||||||
Parse IP address and return a tuple consisting of a boolean indicating
|
|
||||||
whether the given address is an IPv6 address and the numeric representation
|
|
||||||
of the address.
|
|
||||||
|
|
||||||
If is_ipv6 is either True or False, the specific address type is enforced
|
|
||||||
and only the parsed address is returned instead of a tuple.
|
|
||||||
"""
|
|
||||||
if is_ipv6 is None:
|
|
||||||
try:
|
|
||||||
return False, parse_ipv4(addr)
|
|
||||||
except socket.error:
|
|
||||||
return True, parse_ipv6(addr)
|
|
||||||
elif is_ipv6:
|
|
||||||
return parse_ipv6(addr)
|
|
||||||
else:
|
|
||||||
return parse_ipv4(addr)
|
|
||||||
|
|
||||||
|
|
||||||
def get_ipv4_range(numeric_netaddr, prefix_len):
|
|
||||||
"""
|
|
||||||
Return the smallest and biggest possible IPv4 address of the specified
|
|
||||||
network address (in numeric representation) and prefix length.
|
|
||||||
"""
|
|
||||||
mask_inverted = 32 - prefix_len
|
|
||||||
mask_bin = 0xffffffff >> mask_inverted << mask_inverted
|
|
||||||
range_start = numeric_netaddr & mask_bin
|
|
||||||
range_end = range_start | (1 << mask_inverted) - 1
|
|
||||||
return range_start, range_end
|
|
||||||
|
|
||||||
|
|
||||||
def get_ipv6_range(numeric_netaddr, prefix_len):
|
|
||||||
"""
|
|
||||||
Return the smallest and biggest possible IPv6 address of the specified
|
|
||||||
network address (in numeric representation) and prefix length.
|
|
||||||
"""
|
|
||||||
mask_bin_full = 0xffffffffffffffffffffffffffffffff
|
|
||||||
mask_inverted = 128 - prefix_len
|
|
||||||
mask_bin = mask_bin_full >> mask_inverted << mask_inverted
|
|
||||||
range_start = numeric_netaddr & mask_bin
|
|
||||||
range_end = range_start | (1 << mask_inverted) - 1
|
|
||||||
return range_start, range_end
|
|
||||||
|
|
||||||
|
|
||||||
def ipv4_bin2addr(numeric_addr):
|
|
||||||
"""
|
|
||||||
Convert a numeric representation of the given IPv4 address into quad-dotted
|
|
||||||
notation.
|
|
||||||
"""
|
|
||||||
packed = struct.pack('!L', numeric_addr)
|
|
||||||
return socket.inet_ntop(socket.AF_INET, packed)
|
|
||||||
|
|
||||||
|
|
||||||
def ipv6_bin2addr(numeric_addr):
|
|
||||||
"""
|
|
||||||
Convert a numeric representation of the given IPv6 address into a shortened
|
|
||||||
hexadecimal notiation separated by colons.
|
|
||||||
"""
|
|
||||||
high = numeric_addr >> 64
|
|
||||||
low = numeric_addr & 0xffffffffffffffff
|
|
||||||
packed = struct.pack('!QQ', high, low)
|
|
||||||
return socket.inet_ntop(socket.AF_INET6, packed)
|
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
import os
|
|
||||||
import ssl
|
|
||||||
import socket
|
|
||||||
|
|
||||||
from tempfile import NamedTemporaryFile
|
|
||||||
|
|
||||||
try:
|
|
||||||
from httplib import HTTPSConnection
|
|
||||||
except ImportError:
|
|
||||||
from http.client import HTTPSConnection
|
|
||||||
|
|
||||||
|
|
||||||
class ValidatedHTTPSConnection(HTTPSConnection):
|
|
||||||
CA_ROOT_CERT_FALLBACK = '''
|
|
||||||
DigiCert Global Root G2
|
|
||||||
-----BEGIN CERTIFICATE-----
|
|
||||||
MIIDjjCCAnagAwIBAgIQAzrx5qcRqaC7KGSxHQn65TANBgkqhkiG9w0BAQsFADBh
|
|
||||||
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
|
|
||||||
d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBH
|
|
||||||
MjAeFw0xMzA4MDExMjAwMDBaFw0zODAxMTUxMjAwMDBaMGExCzAJBgNVBAYTAlVT
|
|
||||||
MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j
|
|
||||||
b20xIDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IEcyMIIBIjANBgkqhkiG
|
|
||||||
9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuzfNNNx7a8myaJCtSnX/RrohCgiN9RlUyfuI
|
|
||||||
2/Ou8jqJkTx65qsGGmvPrC3oXgkkRLpimn7Wo6h+4FR1IAWsULecYxpsMNzaHxmx
|
|
||||||
1x7e/dfgy5SDN67sH0NO3Xss0r0upS/kqbitOtSZpLYl6ZtrAGCSYP9PIUkY92eQ
|
|
||||||
q2EGnI/yuum06ZIya7XzV+hdG82MHauVBJVJ8zUtluNJbd134/tJS7SsVQepj5Wz
|
|
||||||
tCO7TG1F8PapspUwtP1MVYwnSlcUfIKdzXOS0xZKBgyMUNGPHgm+F6HmIcr9g+UQ
|
|
||||||
vIOlCsRnKPZzFBQ9RnbDhxSJITRNrw9FDKZJobq7nMWxM4MphQIDAQABo0IwQDAP
|
|
||||||
BgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBhjAdBgNVHQ4EFgQUTiJUIBiV
|
|
||||||
5uNu5g/6+rkS7QYXjzkwDQYJKoZIhvcNAQELBQADggEBAGBnKJRvDkhj6zHd6mcY
|
|
||||||
1Yl9PMWLSn/pvtsrF9+wX3N3KjITOYFnQoQj8kVnNeyIv/iPsGEMNKSuIEyExtv4
|
|
||||||
NeF22d+mQrvHRAiGfzZ0JFrabA0UWTW98kndth/Jsw1HKj2ZL7tcu7XUIOGZX1NG
|
|
||||||
Fdtom/DzMNU+MeKNhJ7jitralj41E6Vf8PlwUHBHQRFXGU7Aj64GxJUTFy8bJZ91
|
|
||||||
8rGOmaFvE7FBcf6IKshPECBV1/MUReXgRPTqh5Uykw7+U0b6LJ3/iyK5S9kJRaTe
|
|
||||||
pLiaWN0bfVKfjllDiIGknibVb63dDcY3fe0Dkhvld1927jyNxF1WW6LZZm6zNTfl
|
|
||||||
MrY=
|
|
||||||
-----END CERTIFICATE-----
|
|
||||||
'''
|
|
||||||
|
|
||||||
def get_ca_cert_bundle(self):
|
|
||||||
via_env = os.getenv('SSL_CERT_FILE')
|
|
||||||
if via_env is not None and os.path.exists(via_env):
|
|
||||||
return via_env
|
|
||||||
probe_paths = [
|
|
||||||
"/etc/ssl/certs/ca-certificates.crt",
|
|
||||||
"/etc/ssl/certs/ca-bundle.crt",
|
|
||||||
"/etc/pki/tls/certs/ca-bundle.crt",
|
|
||||||
]
|
|
||||||
for path in probe_paths:
|
|
||||||
if os.path.exists(path):
|
|
||||||
return path
|
|
||||||
return None
|
|
||||||
|
|
||||||
def connect(self):
|
|
||||||
sock = socket.create_connection((self.host, self.port),
|
|
||||||
self.timeout,
|
|
||||||
self.source_address)
|
|
||||||
bundle = cafile = self.get_ca_cert_bundle()
|
|
||||||
if bundle is None:
|
|
||||||
ca_certs = NamedTemporaryFile()
|
|
||||||
ca_certs.write('\n'.join(
|
|
||||||
map(str.strip, self.CA_ROOT_CERT_FALLBACK.splitlines())
|
|
||||||
).encode('ascii'))
|
|
||||||
ca_certs.flush()
|
|
||||||
cafile = ca_certs.name
|
|
||||||
self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file,
|
|
||||||
cert_reqs=ssl.CERT_REQUIRED,
|
|
||||||
ca_certs=cafile)
|
|
||||||
if bundle is None:
|
|
||||||
ca_certs.close()
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
try:
|
|
||||||
from HTMLParser import HTMLParser
|
|
||||||
except ImportError:
|
|
||||||
from html.parser import HTMLParser
|
|
||||||
|
|
||||||
|
|
||||||
class CSRFParser(HTMLParser):
|
|
||||||
def __init__(self, field_name):
|
|
||||||
HTMLParser.__init__(self)
|
|
||||||
self.field_name = field_name
|
|
||||||
self.csrf_token = None
|
|
||||||
|
|
||||||
def handle_starttag(self, tag, attrs):
|
|
||||||
if tag != 'input':
|
|
||||||
return
|
|
||||||
attrdict = dict(attrs)
|
|
||||||
if attrdict.get('name', '') == self.field_name:
|
|
||||||
self.csrf_token = attrdict.get('value', None)
|
|
||||||
handle_startendtag = handle_starttag
|
|
||||||
@@ -1,760 +0,0 @@
|
|||||||
@Switch01
|
|
||||||
A_Rog
|
|
||||||
Aakanksha Agrawal
|
|
||||||
Abhinav Sagar
|
|
||||||
ABHYUDAY PRATAP SINGH
|
|
||||||
abs51295
|
|
||||||
AceGentile
|
|
||||||
Adam Chainz
|
|
||||||
Adam Tse
|
|
||||||
Adam Wentz
|
|
||||||
admin
|
|
||||||
Adrien Morison
|
|
||||||
ahayrapetyan
|
|
||||||
Ahilya
|
|
||||||
AinsworthK
|
|
||||||
Akash Srivastava
|
|
||||||
Alan Yee
|
|
||||||
Albert Tugushev
|
|
||||||
Albert-Guan
|
|
||||||
albertg
|
|
||||||
Alberto Sottile
|
|
||||||
Aleks Bunin
|
|
||||||
Ales Erjavec
|
|
||||||
Alethea Flowers
|
|
||||||
Alex Gaynor
|
|
||||||
Alex Grönholm
|
|
||||||
Alex Hedges
|
|
||||||
Alex Loosley
|
|
||||||
Alex Morega
|
|
||||||
Alex Stachowiak
|
|
||||||
Alexander Shtyrov
|
|
||||||
Alexandre Conrad
|
|
||||||
Alexey Popravka
|
|
||||||
Aleš Erjavec
|
|
||||||
Alli
|
|
||||||
Ami Fischman
|
|
||||||
Ananya Maiti
|
|
||||||
Anatoly Techtonik
|
|
||||||
Anders Kaseorg
|
|
||||||
Andre Aguiar
|
|
||||||
Andreas Lutro
|
|
||||||
Andrei Geacar
|
|
||||||
Andrew Gaul
|
|
||||||
Andrew Shymanel
|
|
||||||
Andrey Bienkowski
|
|
||||||
Andrey Bulgakov
|
|
||||||
Andrés Delfino
|
|
||||||
Andy Freeland
|
|
||||||
Andy Kluger
|
|
||||||
Ani Hayrapetyan
|
|
||||||
Aniruddha Basak
|
|
||||||
Anish Tambe
|
|
||||||
Anrs Hu
|
|
||||||
Anthony Sottile
|
|
||||||
Antoine Musso
|
|
||||||
Anton Ovchinnikov
|
|
||||||
Anton Patrushev
|
|
||||||
Antonio Alvarado Hernandez
|
|
||||||
Antony Lee
|
|
||||||
Antti Kaihola
|
|
||||||
Anubhav Patel
|
|
||||||
Anudit Nagar
|
|
||||||
Anuj Godase
|
|
||||||
AQNOUCH Mohammed
|
|
||||||
AraHaan
|
|
||||||
Arindam Choudhury
|
|
||||||
Armin Ronacher
|
|
||||||
Artem
|
|
||||||
Arun Babu Neelicattu
|
|
||||||
Ashley Manton
|
|
||||||
Ashwin Ramaswami
|
|
||||||
atse
|
|
||||||
Atsushi Odagiri
|
|
||||||
Avinash Karhana
|
|
||||||
Avner Cohen
|
|
||||||
Awit (Ah-Wit) Ghirmai
|
|
||||||
Baptiste Mispelon
|
|
||||||
Barney Gale
|
|
||||||
barneygale
|
|
||||||
Bartek Ogryczak
|
|
||||||
Bastian Venthur
|
|
||||||
Ben Bodenmiller
|
|
||||||
Ben Darnell
|
|
||||||
Ben Hoyt
|
|
||||||
Ben Mares
|
|
||||||
Ben Rosser
|
|
||||||
Bence Nagy
|
|
||||||
Benjamin Peterson
|
|
||||||
Benjamin VanEvery
|
|
||||||
Benoit Pierre
|
|
||||||
Berker Peksag
|
|
||||||
Bernard
|
|
||||||
Bernard Tyers
|
|
||||||
Bernardo B. Marques
|
|
||||||
Bernhard M. Wiedemann
|
|
||||||
Bertil Hatt
|
|
||||||
Bhavam Vidyarthi
|
|
||||||
Blazej Michalik
|
|
||||||
Bogdan Opanchuk
|
|
||||||
BorisZZZ
|
|
||||||
Brad Erickson
|
|
||||||
Bradley Ayers
|
|
||||||
Brandon L. Reiss
|
|
||||||
Brandt Bucher
|
|
||||||
Brett Randall
|
|
||||||
Brett Rosen
|
|
||||||
Brian Cristante
|
|
||||||
Brian Rosner
|
|
||||||
briantracy
|
|
||||||
BrownTruck
|
|
||||||
Bruno Oliveira
|
|
||||||
Bruno Renié
|
|
||||||
Bruno S
|
|
||||||
Bstrdsmkr
|
|
||||||
Buck Golemon
|
|
||||||
burrows
|
|
||||||
Bussonnier Matthias
|
|
||||||
bwoodsend
|
|
||||||
c22
|
|
||||||
Caleb Martinez
|
|
||||||
Calvin Smith
|
|
||||||
Carl Meyer
|
|
||||||
Carlos Liam
|
|
||||||
Carol Willing
|
|
||||||
Carter Thayer
|
|
||||||
Cass
|
|
||||||
Chandrasekhar Atina
|
|
||||||
Chih-Hsuan Yen
|
|
||||||
Chris Brinker
|
|
||||||
Chris Hunt
|
|
||||||
Chris Jerdonek
|
|
||||||
Chris Kuehl
|
|
||||||
Chris McDonough
|
|
||||||
Chris Pawley
|
|
||||||
Chris Pryer
|
|
||||||
Chris Wolfe
|
|
||||||
Christian Clauss
|
|
||||||
Christian Heimes
|
|
||||||
Christian Oudard
|
|
||||||
Christoph Reiter
|
|
||||||
Christopher Hunt
|
|
||||||
Christopher Snyder
|
|
||||||
cjc7373
|
|
||||||
Clark Boylan
|
|
||||||
Claudio Jolowicz
|
|
||||||
Clay McClure
|
|
||||||
Cody
|
|
||||||
Cody Soyland
|
|
||||||
Colin Watson
|
|
||||||
Collin Anderson
|
|
||||||
Connor Osborn
|
|
||||||
Cooper Lees
|
|
||||||
Cooper Ry Lees
|
|
||||||
Cory Benfield
|
|
||||||
Cory Wright
|
|
||||||
Craig Kerstiens
|
|
||||||
Cristian Sorinel
|
|
||||||
Cristina
|
|
||||||
Cristina Muñoz
|
|
||||||
Curtis Doty
|
|
||||||
cytolentino
|
|
||||||
Daan De Meyer
|
|
||||||
Dale
|
|
||||||
Damian
|
|
||||||
Damian Quiroga
|
|
||||||
Damian Shaw
|
|
||||||
Dan Black
|
|
||||||
Dan Savilonis
|
|
||||||
Dan Sully
|
|
||||||
Dane Hillard
|
|
||||||
daniel
|
|
||||||
Daniel Collins
|
|
||||||
Daniel Hahler
|
|
||||||
Daniel Holth
|
|
||||||
Daniel Jost
|
|
||||||
Daniel Katz
|
|
||||||
Daniel Shaulov
|
|
||||||
Daniele Esposti
|
|
||||||
Daniele Nicolodi
|
|
||||||
Daniele Procida
|
|
||||||
Daniil Konovalenko
|
|
||||||
Danny Hermes
|
|
||||||
Danny McClanahan
|
|
||||||
Darren Kavanagh
|
|
||||||
Dav Clark
|
|
||||||
Dave Abrahams
|
|
||||||
Dave Jones
|
|
||||||
David Aguilar
|
|
||||||
David Black
|
|
||||||
David Bordeynik
|
|
||||||
David Caro
|
|
||||||
David D Lowe
|
|
||||||
David Evans
|
|
||||||
David Hewitt
|
|
||||||
David Linke
|
|
||||||
David Poggi
|
|
||||||
David Pursehouse
|
|
||||||
David Runge
|
|
||||||
David Tucker
|
|
||||||
David Wales
|
|
||||||
Davidovich
|
|
||||||
ddelange
|
|
||||||
Deepak Sharma
|
|
||||||
Deepyaman Datta
|
|
||||||
Denise Yu
|
|
||||||
dependabot[bot]
|
|
||||||
derwolfe
|
|
||||||
Desetude
|
|
||||||
Devesh Kumar Singh
|
|
||||||
Diego Caraballo
|
|
||||||
Diego Ramirez
|
|
||||||
DiegoCaraballo
|
|
||||||
Dimitri Merejkowsky
|
|
||||||
Dimitri Papadopoulos
|
|
||||||
Dirk Stolle
|
|
||||||
Dmitry Gladkov
|
|
||||||
Dmitry Volodin
|
|
||||||
Domen Kožar
|
|
||||||
Dominic Davis-Foster
|
|
||||||
Donald Stufft
|
|
||||||
Dongweiming
|
|
||||||
doron zarhi
|
|
||||||
Dos Moonen
|
|
||||||
Douglas Thor
|
|
||||||
DrFeathers
|
|
||||||
Dustin Ingram
|
|
||||||
Dwayne Bailey
|
|
||||||
Ed Morley
|
|
||||||
Edgar Ramírez
|
|
||||||
Edgar Ramírez Mondragón
|
|
||||||
Ee Durbin
|
|
||||||
Efflam Lemaillet
|
|
||||||
efflamlemaillet
|
|
||||||
Eitan Adler
|
|
||||||
ekristina
|
|
||||||
elainechan
|
|
||||||
Eli Schwartz
|
|
||||||
Elisha Hollander
|
|
||||||
Ellen Marie Dash
|
|
||||||
Emil Burzo
|
|
||||||
Emil Styrke
|
|
||||||
Emmanuel Arias
|
|
||||||
Endoh Takanao
|
|
||||||
enoch
|
|
||||||
Erdinc Mutlu
|
|
||||||
Eric Cousineau
|
|
||||||
Eric Gillingham
|
|
||||||
Eric Hanchrow
|
|
||||||
Eric Hopper
|
|
||||||
Erik M. Bray
|
|
||||||
Erik Rose
|
|
||||||
Erwin Janssen
|
|
||||||
Eugene Vereshchagin
|
|
||||||
everdimension
|
|
||||||
Federico
|
|
||||||
Felipe Peter
|
|
||||||
Felix Yan
|
|
||||||
fiber-space
|
|
||||||
Filip Kokosiński
|
|
||||||
Filipe Laíns
|
|
||||||
Finn Womack
|
|
||||||
finnagin
|
|
||||||
Flavio Amurrio
|
|
||||||
Florian Briand
|
|
||||||
Florian Rathgeber
|
|
||||||
Francesco
|
|
||||||
Francesco Montesano
|
|
||||||
Frost Ming
|
|
||||||
Gabriel Curio
|
|
||||||
Gabriel de Perthuis
|
|
||||||
Garry Polley
|
|
||||||
gavin
|
|
||||||
gdanielson
|
|
||||||
Geoffrey Sneddon
|
|
||||||
George Song
|
|
||||||
Georgi Valkov
|
|
||||||
Georgy Pchelkin
|
|
||||||
ghost
|
|
||||||
Giftlin Rajaiah
|
|
||||||
gizmoguy1
|
|
||||||
gkdoc
|
|
||||||
Godefroid Chapelle
|
|
||||||
Gopinath M
|
|
||||||
GOTO Hayato
|
|
||||||
gousaiyang
|
|
||||||
gpiks
|
|
||||||
Greg Roodt
|
|
||||||
Greg Ward
|
|
||||||
Guilherme Espada
|
|
||||||
Guillaume Seguin
|
|
||||||
gutsytechster
|
|
||||||
Guy Rozendorn
|
|
||||||
Guy Tuval
|
|
||||||
gzpan123
|
|
||||||
Hanjun Kim
|
|
||||||
Hari Charan
|
|
||||||
Harsh Vardhan
|
|
||||||
harupy
|
|
||||||
Harutaka Kawamura
|
|
||||||
hauntsaninja
|
|
||||||
Henrich Hartzer
|
|
||||||
Henry Schreiner
|
|
||||||
Herbert Pfennig
|
|
||||||
Holly Stotelmyer
|
|
||||||
Honnix
|
|
||||||
Hsiaoming Yang
|
|
||||||
Hugo Lopes Tavares
|
|
||||||
Hugo van Kemenade
|
|
||||||
Hugues Bruant
|
|
||||||
Hynek Schlawack
|
|
||||||
Ian Bicking
|
|
||||||
Ian Cordasco
|
|
||||||
Ian Lee
|
|
||||||
Ian Stapleton Cordasco
|
|
||||||
Ian Wienand
|
|
||||||
Igor Kuzmitshov
|
|
||||||
Igor Sobreira
|
|
||||||
Ilan Schnell
|
|
||||||
Illia Volochii
|
|
||||||
Ilya Baryshev
|
|
||||||
Inada Naoki
|
|
||||||
Ionel Cristian Mărieș
|
|
||||||
Ionel Maries Cristian
|
|
||||||
Itamar Turner-Trauring
|
|
||||||
Ivan Pozdeev
|
|
||||||
J. Nick Koston
|
|
||||||
Jacob Kim
|
|
||||||
Jacob Walls
|
|
||||||
Jaime Sanz
|
|
||||||
jakirkham
|
|
||||||
Jakub Kuczys
|
|
||||||
Jakub Stasiak
|
|
||||||
Jakub Vysoky
|
|
||||||
Jakub Wilk
|
|
||||||
James Cleveland
|
|
||||||
James Curtin
|
|
||||||
James Firth
|
|
||||||
James Gerity
|
|
||||||
James Polley
|
|
||||||
Jan Pokorný
|
|
||||||
Jannis Leidel
|
|
||||||
Jarek Potiuk
|
|
||||||
jarondl
|
|
||||||
Jason Curtis
|
|
||||||
Jason R. Coombs
|
|
||||||
JasonMo
|
|
||||||
JasonMo1
|
|
||||||
Jay Graves
|
|
||||||
Jean Abou Samra
|
|
||||||
Jean-Christophe Fillion-Robin
|
|
||||||
Jeff Barber
|
|
||||||
Jeff Dairiki
|
|
||||||
Jeff Widman
|
|
||||||
Jelmer Vernooij
|
|
||||||
jenix21
|
|
||||||
Jeremy Stanley
|
|
||||||
Jeremy Zafran
|
|
||||||
Jesse Rittner
|
|
||||||
Jiashuo Li
|
|
||||||
Jim Fisher
|
|
||||||
Jim Garrison
|
|
||||||
Jiun Bae
|
|
||||||
Jivan Amara
|
|
||||||
Joe Bylund
|
|
||||||
Joe Michelini
|
|
||||||
John Paton
|
|
||||||
John T. Wodder II
|
|
||||||
John-Scott Atlakson
|
|
||||||
johnthagen
|
|
||||||
Jon Banafato
|
|
||||||
Jon Dufresne
|
|
||||||
Jon Parise
|
|
||||||
Jonas Nockert
|
|
||||||
Jonathan Herbert
|
|
||||||
Joonatan Partanen
|
|
||||||
Joost Molenaar
|
|
||||||
Jorge Niedbalski
|
|
||||||
Joseph Bylund
|
|
||||||
Joseph Long
|
|
||||||
Josh Bronson
|
|
||||||
Josh Hansen
|
|
||||||
Josh Schneier
|
|
||||||
Joshua
|
|
||||||
Juan Luis Cano Rodríguez
|
|
||||||
Juanjo Bazán
|
|
||||||
Judah Rand
|
|
||||||
Julian Berman
|
|
||||||
Julian Gethmann
|
|
||||||
Julien Demoor
|
|
||||||
Jussi Kukkonen
|
|
||||||
jwg4
|
|
||||||
Jyrki Pulliainen
|
|
||||||
Kai Chen
|
|
||||||
Kai Mueller
|
|
||||||
Kamal Bin Mustafa
|
|
||||||
kasium
|
|
||||||
kaustav haldar
|
|
||||||
keanemind
|
|
||||||
Keith Maxwell
|
|
||||||
Kelsey Hightower
|
|
||||||
Kenneth Belitzky
|
|
||||||
Kenneth Reitz
|
|
||||||
Kevin Burke
|
|
||||||
Kevin Carter
|
|
||||||
Kevin Frommelt
|
|
||||||
Kevin R Patterson
|
|
||||||
Kexuan Sun
|
|
||||||
Kit Randel
|
|
||||||
Klaas van Schelven
|
|
||||||
KOLANICH
|
|
||||||
kpinc
|
|
||||||
Krishna Oza
|
|
||||||
Kumar McMillan
|
|
||||||
Kurt McKee
|
|
||||||
Kyle Persohn
|
|
||||||
lakshmanaram
|
|
||||||
Laszlo Kiss-Kollar
|
|
||||||
Laurent Bristiel
|
|
||||||
Laurent LAPORTE
|
|
||||||
Laurie O
|
|
||||||
Laurie Opperman
|
|
||||||
layday
|
|
||||||
Leon Sasson
|
|
||||||
Lev Givon
|
|
||||||
Lincoln de Sousa
|
|
||||||
Lipis
|
|
||||||
lorddavidiii
|
|
||||||
Loren Carvalho
|
|
||||||
Lucas Cimon
|
|
||||||
Ludovic Gasc
|
|
||||||
Lukas Geiger
|
|
||||||
Lukas Juhrich
|
|
||||||
Luke Macken
|
|
||||||
Luo Jiebin
|
|
||||||
luojiebin
|
|
||||||
luz.paz
|
|
||||||
László Kiss Kollár
|
|
||||||
M00nL1ght
|
|
||||||
Marc Abramowitz
|
|
||||||
Marc Tamlyn
|
|
||||||
Marcus Smith
|
|
||||||
Mariatta
|
|
||||||
Mark Kohler
|
|
||||||
Mark Williams
|
|
||||||
Markus Hametner
|
|
||||||
Martey Dodoo
|
|
||||||
Martin Fischer
|
|
||||||
Martin Häcker
|
|
||||||
Martin Pavlasek
|
|
||||||
Masaki
|
|
||||||
Masklinn
|
|
||||||
Matej Stuchlik
|
|
||||||
Mathew Jennings
|
|
||||||
Mathieu Bridon
|
|
||||||
Mathieu Kniewallner
|
|
||||||
Matt Bacchi
|
|
||||||
Matt Good
|
|
||||||
Matt Maker
|
|
||||||
Matt Robenolt
|
|
||||||
matthew
|
|
||||||
Matthew Einhorn
|
|
||||||
Matthew Feickert
|
|
||||||
Matthew Gilliard
|
|
||||||
Matthew Iversen
|
|
||||||
Matthew Treinish
|
|
||||||
Matthew Trumbell
|
|
||||||
Matthew Willson
|
|
||||||
Matthias Bussonnier
|
|
||||||
mattip
|
|
||||||
Maurits van Rees
|
|
||||||
Max W Chase
|
|
||||||
Maxim Kurnikov
|
|
||||||
Maxime Rouyrre
|
|
||||||
mayeut
|
|
||||||
mbaluna
|
|
||||||
mdebi
|
|
||||||
memoselyk
|
|
||||||
meowmeowcat
|
|
||||||
Michael
|
|
||||||
Michael Aquilina
|
|
||||||
Michael E. Karpeles
|
|
||||||
Michael Klich
|
|
||||||
Michael Mintz
|
|
||||||
Michael Williamson
|
|
||||||
michaelpacer
|
|
||||||
Michał Górny
|
|
||||||
Mickaël Schoentgen
|
|
||||||
Miguel Araujo Perez
|
|
||||||
Mihir Singh
|
|
||||||
Mike
|
|
||||||
Mike Hendricks
|
|
||||||
Min RK
|
|
||||||
MinRK
|
|
||||||
Miro Hrončok
|
|
||||||
Monica Baluna
|
|
||||||
montefra
|
|
||||||
Monty Taylor
|
|
||||||
Muha Ajjan
|
|
||||||
Nadav Wexler
|
|
||||||
Nahuel Ambrosini
|
|
||||||
Nate Coraor
|
|
||||||
Nate Prewitt
|
|
||||||
Nathan Houghton
|
|
||||||
Nathaniel J. Smith
|
|
||||||
Nehal J Wani
|
|
||||||
Neil Botelho
|
|
||||||
Nguyễn Gia Phong
|
|
||||||
Nicholas Serra
|
|
||||||
Nick Coghlan
|
|
||||||
Nick Stenning
|
|
||||||
Nick Timkovich
|
|
||||||
Nicolas Bock
|
|
||||||
Nicole Harris
|
|
||||||
Nikhil Benesch
|
|
||||||
Nikhil Ladha
|
|
||||||
Nikita Chepanov
|
|
||||||
Nikolay Korolev
|
|
||||||
Nipunn Koorapati
|
|
||||||
Nitesh Sharma
|
|
||||||
Niyas Sait
|
|
||||||
Noah
|
|
||||||
Noah Gorny
|
|
||||||
Nowell Strite
|
|
||||||
NtaleGrey
|
|
||||||
nvdv
|
|
||||||
OBITORASU
|
|
||||||
Ofek Lev
|
|
||||||
ofrinevo
|
|
||||||
Oliver Freund
|
|
||||||
Oliver Jeeves
|
|
||||||
Oliver Mannion
|
|
||||||
Oliver Tonnhofer
|
|
||||||
Olivier Girardot
|
|
||||||
Olivier Grisel
|
|
||||||
Ollie Rutherfurd
|
|
||||||
OMOTO Kenji
|
|
||||||
Omry Yadan
|
|
||||||
onlinejudge95
|
|
||||||
Oren Held
|
|
||||||
Oscar Benjamin
|
|
||||||
Oz N Tiram
|
|
||||||
Pachwenko
|
|
||||||
Patrick Dubroy
|
|
||||||
Patrick Jenkins
|
|
||||||
Patrick Lawson
|
|
||||||
patricktokeeffe
|
|
||||||
Patrik Kopkan
|
|
||||||
Paul Ganssle
|
|
||||||
Paul Kehrer
|
|
||||||
Paul Moore
|
|
||||||
Paul Nasrat
|
|
||||||
Paul Oswald
|
|
||||||
Paul van der Linden
|
|
||||||
Paulus Schoutsen
|
|
||||||
Pavel Safronov
|
|
||||||
Pavithra Eswaramoorthy
|
|
||||||
Pawel Jasinski
|
|
||||||
Paweł Szramowski
|
|
||||||
Pekka Klärck
|
|
||||||
Peter Gessler
|
|
||||||
Peter Lisák
|
|
||||||
Peter Waller
|
|
||||||
petr-tik
|
|
||||||
Phaneendra Chiruvella
|
|
||||||
Phil Elson
|
|
||||||
Phil Freo
|
|
||||||
Phil Pennock
|
|
||||||
Phil Whelan
|
|
||||||
Philip Jägenstedt
|
|
||||||
Philip Molloy
|
|
||||||
Philippe Ombredanne
|
|
||||||
Pi Delport
|
|
||||||
Pierre-Yves Rofes
|
|
||||||
Pieter Degroote
|
|
||||||
pip
|
|
||||||
Prabakaran Kumaresshan
|
|
||||||
Prabhjyotsing Surjit Singh Sodhi
|
|
||||||
Prabhu Marappan
|
|
||||||
Pradyun Gedam
|
|
||||||
Prashant Sharma
|
|
||||||
Pratik Mallya
|
|
||||||
pre-commit-ci[bot]
|
|
||||||
Preet Thakkar
|
|
||||||
Preston Holmes
|
|
||||||
Przemek Wrzos
|
|
||||||
Pulkit Goyal
|
|
||||||
q0w
|
|
||||||
Qiangning Hong
|
|
||||||
Qiming Xu
|
|
||||||
Quentin Lee
|
|
||||||
Quentin Pradet
|
|
||||||
R. David Murray
|
|
||||||
Rafael Caricio
|
|
||||||
Ralf Schmitt
|
|
||||||
Razzi Abuissa
|
|
||||||
rdb
|
|
||||||
Reece Dunham
|
|
||||||
Remi Rampin
|
|
||||||
Rene Dudfield
|
|
||||||
Riccardo Magliocchetti
|
|
||||||
Riccardo Schirone
|
|
||||||
Richard Jones
|
|
||||||
Richard Si
|
|
||||||
Ricky Ng-Adam
|
|
||||||
Rishi
|
|
||||||
RobberPhex
|
|
||||||
Robert Collins
|
|
||||||
Robert McGibbon
|
|
||||||
Robert Pollak
|
|
||||||
Robert T. McGibbon
|
|
||||||
robin elisha robinson
|
|
||||||
Roey Berman
|
|
||||||
Rohan Jain
|
|
||||||
Roman Bogorodskiy
|
|
||||||
Roman Donchenko
|
|
||||||
Romuald Brunet
|
|
||||||
ronaudinho
|
|
||||||
Ronny Pfannschmidt
|
|
||||||
Rory McCann
|
|
||||||
Ross Brattain
|
|
||||||
Roy Wellington Ⅳ
|
|
||||||
Ruairidh MacLeod
|
|
||||||
Russell Keith-Magee
|
|
||||||
Ryan Shepherd
|
|
||||||
Ryan Wooden
|
|
||||||
ryneeverett
|
|
||||||
Sachi King
|
|
||||||
Salvatore Rinchiera
|
|
||||||
sandeepkiran-js
|
|
||||||
Sander Van Balen
|
|
||||||
Savio Jomton
|
|
||||||
schlamar
|
|
||||||
Scott Kitterman
|
|
||||||
Sean
|
|
||||||
seanj
|
|
||||||
Sebastian Jordan
|
|
||||||
Sebastian Schaetz
|
|
||||||
Segev Finer
|
|
||||||
SeongSoo Cho
|
|
||||||
Sergey Vasilyev
|
|
||||||
Seth Michael Larson
|
|
||||||
Seth Woodworth
|
|
||||||
Shahar Epstein
|
|
||||||
Shantanu
|
|
||||||
shireenrao
|
|
||||||
Shivansh-007
|
|
||||||
Shlomi Fish
|
|
||||||
Shovan Maity
|
|
||||||
Simeon Visser
|
|
||||||
Simon Cross
|
|
||||||
Simon Pichugin
|
|
||||||
sinoroc
|
|
||||||
sinscary
|
|
||||||
snook92
|
|
||||||
socketubs
|
|
||||||
Sorin Sbarnea
|
|
||||||
Srinivas Nyayapati
|
|
||||||
Stavros Korokithakis
|
|
||||||
Stefan Scherfke
|
|
||||||
Stefano Rivera
|
|
||||||
Stephan Erb
|
|
||||||
Stephen Rosen
|
|
||||||
stepshal
|
|
||||||
Steve (Gadget) Barnes
|
|
||||||
Steve Barnes
|
|
||||||
Steve Dower
|
|
||||||
Steve Kowalik
|
|
||||||
Steven Myint
|
|
||||||
Steven Silvester
|
|
||||||
stonebig
|
|
||||||
studioj
|
|
||||||
Stéphane Bidoul
|
|
||||||
Stéphane Bidoul (ACSONE)
|
|
||||||
Stéphane Klein
|
|
||||||
Sumana Harihareswara
|
|
||||||
Surbhi Sharma
|
|
||||||
Sviatoslav Sydorenko
|
|
||||||
Swat009
|
|
||||||
Sylvain
|
|
||||||
Takayuki SHIMIZUKAWA
|
|
||||||
Taneli Hukkinen
|
|
||||||
tbeswick
|
|
||||||
Thiago
|
|
||||||
Thijs Triemstra
|
|
||||||
Thomas Fenzl
|
|
||||||
Thomas Grainger
|
|
||||||
Thomas Guettler
|
|
||||||
Thomas Johansson
|
|
||||||
Thomas Kluyver
|
|
||||||
Thomas Smith
|
|
||||||
Thomas VINCENT
|
|
||||||
Tim D. Smith
|
|
||||||
Tim Gates
|
|
||||||
Tim Harder
|
|
||||||
Tim Heap
|
|
||||||
tim smith
|
|
||||||
tinruufu
|
|
||||||
Tobias Hermann
|
|
||||||
Tom Forbes
|
|
||||||
Tom Freudenheim
|
|
||||||
Tom V
|
|
||||||
Tomas Hrnciar
|
|
||||||
Tomas Orsava
|
|
||||||
Tomer Chachamu
|
|
||||||
Tommi Enenkel | AnB
|
|
||||||
Tomáš Hrnčiar
|
|
||||||
Tony Beswick
|
|
||||||
Tony Narlock
|
|
||||||
Tony Zhaocheng Tan
|
|
||||||
TonyBeswick
|
|
||||||
toonarmycaptain
|
|
||||||
Toshio Kuratomi
|
|
||||||
toxinu
|
|
||||||
Travis Swicegood
|
|
||||||
Tushar Sadhwani
|
|
||||||
Tzu-ping Chung
|
|
||||||
Valentin Haenel
|
|
||||||
Victor Stinner
|
|
||||||
victorvpaulo
|
|
||||||
Vikram - Google
|
|
||||||
Viktor Szépe
|
|
||||||
Ville Skyttä
|
|
||||||
Vinay Sajip
|
|
||||||
Vincent Philippon
|
|
||||||
Vinicyus Macedo
|
|
||||||
Vipul Kumar
|
|
||||||
Vitaly Babiy
|
|
||||||
Vladimir Fokow
|
|
||||||
Vladimir Rutsky
|
|
||||||
W. Trevor King
|
|
||||||
Wil Tan
|
|
||||||
Wilfred Hughes
|
|
||||||
William Edwards
|
|
||||||
William ML Leslie
|
|
||||||
William T Olson
|
|
||||||
William Woodruff
|
|
||||||
Wilson Mo
|
|
||||||
wim glenn
|
|
||||||
Winson Luk
|
|
||||||
Wolfgang Maier
|
|
||||||
Wu Zhenyu
|
|
||||||
XAMES3
|
|
||||||
Xavier Fernandez
|
|
||||||
xoviat
|
|
||||||
xtreak
|
|
||||||
YAMAMOTO Takashi
|
|
||||||
Yen Chi Hsuan
|
|
||||||
Yeray Diaz Diaz
|
|
||||||
Yoval P
|
|
||||||
Yu Jian
|
|
||||||
Yuan Jing Vincent Yan
|
|
||||||
Yusuke Hayashi
|
|
||||||
Zearin
|
|
||||||
Zhiping Deng
|
|
||||||
ziebam
|
|
||||||
Zvezdan Petkovic
|
|
||||||
Łukasz Langa
|
|
||||||
Роман Донченко
|
|
||||||
Семён Марьясин
|
|
||||||
rekcäH nitraM
|
|
||||||
@@ -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: 24.0
|
|
||||||
Summary: The PyPA recommended tool for installing Python packages.
|
|
||||||
Author-email: The pip developers <distutils-sig@python.org>
|
|
||||||
License: MIT
|
|
||||||
Project-URL: Homepage, https://pip.pypa.io/
|
|
||||||
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
|
|
||||||
Description-Content-Type: text/x-rst
|
|
||||||
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.42.0)
|
|
||||||
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.12 = pip._internal.cli.main:main
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
pip
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
from typing import List, Optional
|
|
||||||
|
|
||||||
__version__ = "24.0"
|
|
||||||
|
|
||||||
|
|
||||||
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(
|
|
||||||
f"{val} is not a valid value for {key} option, "
|
|
||||||
"please specify a boolean value like yes/no, "
|
|
||||||
"true/false or 1/0 instead."
|
|
||||||
)
|
|
||||||
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(
|
|
||||||
f"{val} is not a valid value for {key} 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."
|
|
||||||
)
|
|
||||||
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.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user