Memory updates: corrections, email triage, heartbeat state
- Updated corrections.md with config validation principles - Email triage rules and logs - Infrastructure ownership documentation - Daily memory files through Feb 1 - Heartbeat state tracking
This commit is contained in:
commit
023030c035
|
|
@ -0,0 +1,9 @@
|
||||||
|
{
|
||||||
|
"version": 1,
|
||||||
|
"skills": {
|
||||||
|
"homeassistant": {
|
||||||
|
"version": "1.0.0",
|
||||||
|
"installedAt": 1769414031023
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,247 @@
|
||||||
|
<#
|
||||||
|
.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"
|
||||||
|
|
@ -0,0 +1,70 @@
|
||||||
|
# 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/johan/clawd/.venv)
|
||||||
|
else
|
||||||
|
# use the path as-is
|
||||||
|
export VIRTUAL_ENV=/home/johan/clawd/.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
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
# 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/johan/clawd/.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
|
||||||
|
|
@ -0,0 +1,69 @@
|
||||||
|
# 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/johan/clawd/.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
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/home/johan/clawd/.venv/bin/python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from curl_cffi.cli import main
|
||||||
|
if __name__ == '__main__':
|
||||||
|
sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
|
||||||
|
sys.exit(main())
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/home/johan/clawd/.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())
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/home/johan/clawd/.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())
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/home/johan/clawd/.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())
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
python3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
/usr/bin/python3
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
python3
|
||||||
BIN
.venv/lib/python3.12/site-packages/_cffi_backend.cpython-312-x86_64-linux-gnu.so
Executable file
BIN
.venv/lib/python3.12/site-packages/_cffi_backend.cpython-312-x86_64-linux-gnu.so
Executable file
Binary file not shown.
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,78 @@
|
||||||
|
Metadata-Version: 2.4
|
||||||
|
Name: certifi
|
||||||
|
Version: 2026.1.4
|
||||||
|
Summary: Python package for providing Mozilla's CA Bundle.
|
||||||
|
Home-page: https://github.com/certifi/python-certifi
|
||||||
|
Author: Kenneth Reitz
|
||||||
|
Author-email: me@kennethreitz.com
|
||||||
|
License: MPL-2.0
|
||||||
|
Project-URL: Source, https://github.com/certifi/python-certifi
|
||||||
|
Classifier: Development Status :: 5 - Production/Stable
|
||||||
|
Classifier: Intended Audience :: Developers
|
||||||
|
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
|
||||||
|
Classifier: Natural Language :: English
|
||||||
|
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 :: 3.13
|
||||||
|
Classifier: Programming Language :: Python :: 3.14
|
||||||
|
Requires-Python: >=3.7
|
||||||
|
License-File: LICENSE
|
||||||
|
Dynamic: author
|
||||||
|
Dynamic: author-email
|
||||||
|
Dynamic: classifier
|
||||||
|
Dynamic: description
|
||||||
|
Dynamic: home-page
|
||||||
|
Dynamic: license
|
||||||
|
Dynamic: license-file
|
||||||
|
Dynamic: project-url
|
||||||
|
Dynamic: requires-python
|
||||||
|
Dynamic: summary
|
||||||
|
|
||||||
|
Certifi: Python SSL Certificates
|
||||||
|
================================
|
||||||
|
|
||||||
|
Certifi provides Mozilla's carefully curated collection of Root Certificates for
|
||||||
|
validating the trustworthiness of SSL certificates while verifying the identity
|
||||||
|
of TLS hosts. It has been extracted from the `Requests`_ project.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
``certifi`` is available on PyPI. Simply install it with ``pip``::
|
||||||
|
|
||||||
|
$ pip install certifi
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
To reference the installed certificate authority (CA) bundle, you can use the
|
||||||
|
built-in function::
|
||||||
|
|
||||||
|
>>> import certifi
|
||||||
|
|
||||||
|
>>> certifi.where()
|
||||||
|
'/usr/local/lib/python3.7/site-packages/certifi/cacert.pem'
|
||||||
|
|
||||||
|
Or from the command line::
|
||||||
|
|
||||||
|
$ python -m certifi
|
||||||
|
/usr/local/lib/python3.7/site-packages/certifi/cacert.pem
|
||||||
|
|
||||||
|
Enjoy!
|
||||||
|
|
||||||
|
.. _`Requests`: https://requests.readthedocs.io/en/master/
|
||||||
|
|
||||||
|
Addition/Removal of Certificates
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
Certifi does not support any addition/removal or other modification of the
|
||||||
|
CA trust store content. This project is intended to provide a reliable and
|
||||||
|
highly portable root of trust to python deployments. Look to upstream projects
|
||||||
|
for methods to use alternate trust.
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
certifi-2026.1.4.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
certifi-2026.1.4.dist-info/METADATA,sha256=FSfJEfKuMo6bJlofUrtRpn4PFTYtbYyXpHN_A3ZFpIY,2473
|
||||||
|
certifi-2026.1.4.dist-info/RECORD,,
|
||||||
|
certifi-2026.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
||||||
|
certifi-2026.1.4.dist-info/licenses/LICENSE,sha256=6TcW2mucDVpKHfYP5pWzcPBpVgPSH2-D8FPkLPwQyvc,989
|
||||||
|
certifi-2026.1.4.dist-info/top_level.txt,sha256=KMu4vUCfsjLrkPbSNdgdekS-pVJzBAJFO__nI8NF6-U,8
|
||||||
|
certifi/__init__.py,sha256=969deMMS7Uchipr0oO4dbRBUvRi0uNYCn07VmG1aTrg,94
|
||||||
|
certifi/__main__.py,sha256=xBBoj905TUWBLRGANOcf7oi6e-3dMP4cEoG9OyMs11g,243
|
||||||
|
certifi/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
certifi/__pycache__/__main__.cpython-312.pyc,,
|
||||||
|
certifi/__pycache__/core.cpython-312.pyc,,
|
||||||
|
certifi/cacert.pem,sha256=Tzl1_zCrvzVEO0hgZK6Ly0Hf9wf_31dsdtKS-0WKoKk,270954
|
||||||
|
certifi/core.py,sha256=XFXycndG5pf37ayeF8N32HUuDafsyhkVMbO4BAPWHa0,3394
|
||||||
|
certifi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: setuptools (80.9.0)
|
||||||
|
Root-Is-Purelib: true
|
||||||
|
Tag: py3-none-any
|
||||||
|
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
This package contains a modified version of ca-bundle.crt:
|
||||||
|
|
||||||
|
ca-bundle.crt -- Bundle of CA Root Certificates
|
||||||
|
|
||||||
|
This is a bundle of X.509 certificates of public Certificate Authorities
|
||||||
|
(CA). These were automatically extracted from Mozilla's root certificates
|
||||||
|
file (certdata.txt). This file can be found in the mozilla source tree:
|
||||||
|
https://hg.mozilla.org/mozilla-central/file/tip/security/nss/lib/ckfw/builtins/certdata.txt
|
||||||
|
It contains the certificates in PEM format and therefore
|
||||||
|
can be directly used with curl / libcurl / php_curl, or with
|
||||||
|
an Apache+mod_ssl webserver for SSL client authentication.
|
||||||
|
Just configure this file as the SSLCACertificateFile.#
|
||||||
|
|
||||||
|
***** BEGIN LICENSE BLOCK *****
|
||||||
|
This Source Code Form is subject to the terms of the Mozilla Public License,
|
||||||
|
v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain
|
||||||
|
one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
***** END LICENSE BLOCK *****
|
||||||
|
@(#) $RCSfile: certdata.txt,v $ $Revision: 1.80 $ $Date: 2011/11/03 15:11:58 $
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
certifi
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
from .core import contents, where
|
||||||
|
|
||||||
|
__all__ = ["contents", "where"]
|
||||||
|
__version__ = "2026.01.04"
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
import argparse
|
||||||
|
|
||||||
|
from certifi import contents, where
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument("-c", "--contents", action="store_true")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
if args.contents:
|
||||||
|
print(contents())
|
||||||
|
else:
|
||||||
|
print(where())
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,83 @@
|
||||||
|
"""
|
||||||
|
certifi.py
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
This module returns the installation location of cacert.pem or its contents.
|
||||||
|
"""
|
||||||
|
import sys
|
||||||
|
import atexit
|
||||||
|
|
||||||
|
def exit_cacert_ctx() -> None:
|
||||||
|
_CACERT_CTX.__exit__(None, None, None) # type: ignore[union-attr]
|
||||||
|
|
||||||
|
|
||||||
|
if sys.version_info >= (3, 11):
|
||||||
|
|
||||||
|
from importlib.resources import as_file, files
|
||||||
|
|
||||||
|
_CACERT_CTX = None
|
||||||
|
_CACERT_PATH = None
|
||||||
|
|
||||||
|
def where() -> str:
|
||||||
|
# This is slightly terrible, but we want to delay extracting the file
|
||||||
|
# in cases where we're inside of a zipimport situation until someone
|
||||||
|
# actually calls where(), but we don't want to re-extract the file
|
||||||
|
# on every call of where(), so we'll do it once then store it in a
|
||||||
|
# global variable.
|
||||||
|
global _CACERT_CTX
|
||||||
|
global _CACERT_PATH
|
||||||
|
if _CACERT_PATH is None:
|
||||||
|
# This is slightly janky, the importlib.resources API wants you to
|
||||||
|
# manage the cleanup of this file, so it doesn't actually return a
|
||||||
|
# path, it returns a context manager that will give you the path
|
||||||
|
# when you enter it and will do any cleanup when you leave it. In
|
||||||
|
# the common case of not needing a temporary file, it will just
|
||||||
|
# return the file system location and the __exit__() is a no-op.
|
||||||
|
#
|
||||||
|
# We also have to hold onto the actual context manager, because
|
||||||
|
# it will do the cleanup whenever it gets garbage collected, so
|
||||||
|
# we will also store that at the global level as well.
|
||||||
|
_CACERT_CTX = as_file(files("certifi").joinpath("cacert.pem"))
|
||||||
|
_CACERT_PATH = str(_CACERT_CTX.__enter__())
|
||||||
|
atexit.register(exit_cacert_ctx)
|
||||||
|
|
||||||
|
return _CACERT_PATH
|
||||||
|
|
||||||
|
def contents() -> str:
|
||||||
|
return files("certifi").joinpath("cacert.pem").read_text(encoding="ascii")
|
||||||
|
|
||||||
|
else:
|
||||||
|
|
||||||
|
from importlib.resources import path as get_path, read_text
|
||||||
|
|
||||||
|
_CACERT_CTX = None
|
||||||
|
_CACERT_PATH = None
|
||||||
|
|
||||||
|
def where() -> str:
|
||||||
|
# This is slightly terrible, but we want to delay extracting the
|
||||||
|
# file in cases where we're inside of a zipimport situation until
|
||||||
|
# someone actually calls where(), but we don't want to re-extract
|
||||||
|
# the file on every call of where(), so we'll do it once then store
|
||||||
|
# it in a global variable.
|
||||||
|
global _CACERT_CTX
|
||||||
|
global _CACERT_PATH
|
||||||
|
if _CACERT_PATH is None:
|
||||||
|
# This is slightly janky, the importlib.resources API wants you
|
||||||
|
# to manage the cleanup of this file, so it doesn't actually
|
||||||
|
# return a path, it returns a context manager that will give
|
||||||
|
# you the path when you enter it and will do any cleanup when
|
||||||
|
# you leave it. In the common case of not needing a temporary
|
||||||
|
# file, it will just return the file system location and the
|
||||||
|
# __exit__() is a no-op.
|
||||||
|
#
|
||||||
|
# We also have to hold onto the actual context manager, because
|
||||||
|
# it will do the cleanup whenever it gets garbage collected, so
|
||||||
|
# we will also store that at the global level as well.
|
||||||
|
_CACERT_CTX = get_path("certifi", "cacert.pem")
|
||||||
|
_CACERT_PATH = str(_CACERT_CTX.__enter__())
|
||||||
|
atexit.register(exit_cacert_ctx)
|
||||||
|
|
||||||
|
return _CACERT_PATH
|
||||||
|
|
||||||
|
def contents() -> str:
|
||||||
|
return read_text("certifi", "cacert.pem", encoding="ascii")
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,68 @@
|
||||||
|
Metadata-Version: 2.4
|
||||||
|
Name: cffi
|
||||||
|
Version: 2.0.0
|
||||||
|
Summary: Foreign Function Interface for Python calling C code.
|
||||||
|
Author: Armin Rigo, Maciej Fijalkowski
|
||||||
|
Maintainer: Matt Davis, Matt Clay, Matti Picus
|
||||||
|
License-Expression: MIT
|
||||||
|
Project-URL: Documentation, https://cffi.readthedocs.io/
|
||||||
|
Project-URL: Changelog, https://cffi.readthedocs.io/en/latest/whatsnew.html
|
||||||
|
Project-URL: Downloads, https://github.com/python-cffi/cffi/releases
|
||||||
|
Project-URL: Contact, https://groups.google.com/forum/#!forum/python-cffi
|
||||||
|
Project-URL: Source Code, https://github.com/python-cffi/cffi
|
||||||
|
Project-URL: Issue Tracker, https://github.com/python-cffi/cffi/issues
|
||||||
|
Classifier: Programming Language :: Python
|
||||||
|
Classifier: Programming Language :: Python :: 3
|
||||||
|
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 :: 3.13
|
||||||
|
Classifier: Programming Language :: Python :: 3.14
|
||||||
|
Classifier: Programming Language :: Python :: Free Threading :: 2 - Beta
|
||||||
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||||||
|
Requires-Python: >=3.9
|
||||||
|
Description-Content-Type: text/markdown
|
||||||
|
License-File: LICENSE
|
||||||
|
License-File: AUTHORS
|
||||||
|
Requires-Dist: pycparser; implementation_name != "PyPy"
|
||||||
|
Dynamic: license-file
|
||||||
|
|
||||||
|
[](https://github.com/python-cffi/cffi/actions/workflows/ci.yaml?query=branch%3Amain++)
|
||||||
|
[](https://pypi.org/project/cffi)
|
||||||
|
[][Documentation]
|
||||||
|
|
||||||
|
|
||||||
|
CFFI
|
||||||
|
====
|
||||||
|
|
||||||
|
Foreign Function Interface for Python calling C code.
|
||||||
|
|
||||||
|
Please see the [Documentation] or uncompiled in the `doc/` subdirectory.
|
||||||
|
|
||||||
|
Download
|
||||||
|
--------
|
||||||
|
|
||||||
|
[Download page](https://github.com/python-cffi/cffi/releases)
|
||||||
|
|
||||||
|
Source Code
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Source code is publicly available on
|
||||||
|
[GitHub](https://github.com/python-cffi/cffi).
|
||||||
|
|
||||||
|
Contact
|
||||||
|
-------
|
||||||
|
|
||||||
|
[Mailing list](https://groups.google.com/forum/#!forum/python-cffi)
|
||||||
|
|
||||||
|
Testing/development tips
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
After `git clone` or `wget && tar`, we will get a directory called `cffi` or `cffi-x.x.x`. we call it `repo-directory`. To run tests under CPython, run the following in the `repo-directory`:
|
||||||
|
|
||||||
|
pip install pytest
|
||||||
|
pip install -e . # editable install of CFFI for local development
|
||||||
|
pytest src/c/ testing/
|
||||||
|
|
||||||
|
[Documentation]: http://cffi.readthedocs.org/
|
||||||
|
|
@ -0,0 +1,49 @@
|
||||||
|
_cffi_backend.cpython-312-x86_64-linux-gnu.so,sha256=AGLtw5fn9u4Cmwk3BbGlsXG7VZEvQekABMyEGuRZmcE,348808
|
||||||
|
cffi-2.0.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
cffi-2.0.0.dist-info/METADATA,sha256=uYzn40F68Im8EtXHNBLZs7FoPM-OxzyYbDWsjJvhujk,2559
|
||||||
|
cffi-2.0.0.dist-info/RECORD,,
|
||||||
|
cffi-2.0.0.dist-info/WHEEL,sha256=aSgG0F4rGPZtV0iTEIfy6dtHq6g67Lze3uLfk0vWn88,151
|
||||||
|
cffi-2.0.0.dist-info/entry_points.txt,sha256=y6jTxnyeuLnL-XJcDv8uML3n6wyYiGRg8MTp_QGJ9Ho,75
|
||||||
|
cffi-2.0.0.dist-info/licenses/AUTHORS,sha256=KmemC7-zN1nWfWRf8TG45ta8TK_CMtdR_Kw-2k0xTMg,208
|
||||||
|
cffi-2.0.0.dist-info/licenses/LICENSE,sha256=W6JN3FcGf5JJrdZEw6_EGl1tw34jQz73Wdld83Cwr2M,1123
|
||||||
|
cffi-2.0.0.dist-info/top_level.txt,sha256=rE7WR3rZfNKxWI9-jn6hsHCAl7MDkB-FmuQbxWjFehQ,19
|
||||||
|
cffi/__init__.py,sha256=-ksBQ7MfDzVvbBlV_ftYBWAmEqfA86ljIzMxzaZeAlI,511
|
||||||
|
cffi/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/_imp_emulation.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/_shimmed_dist_utils.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/api.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/backend_ctypes.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/cffi_opcode.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/commontypes.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/cparser.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/error.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/ffiplatform.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/lock.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/model.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/pkgconfig.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/recompiler.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/setuptools_ext.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/vengine_cpy.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/vengine_gen.cpython-312.pyc,,
|
||||||
|
cffi/__pycache__/verifier.cpython-312.pyc,,
|
||||||
|
cffi/_cffi_errors.h,sha256=zQXt7uR_m8gUW-fI2hJg0KoSkJFwXv8RGUkEDZ177dQ,3908
|
||||||
|
cffi/_cffi_include.h,sha256=Exhmgm9qzHWzWivjfTe0D7Xp4rPUkVxdNuwGhMTMzbw,15055
|
||||||
|
cffi/_embedding.h,sha256=Ai33FHblE7XSpHOCp8kPcWwN5_9BV14OvN0JVa6ITpw,18786
|
||||||
|
cffi/_imp_emulation.py,sha256=RxREG8zAbI2RPGBww90u_5fi8sWdahpdipOoPzkp7C0,2960
|
||||||
|
cffi/_shimmed_dist_utils.py,sha256=Bjj2wm8yZbvFvWEx5AEfmqaqZyZFhYfoyLLQHkXZuao,2230
|
||||||
|
cffi/api.py,sha256=alBv6hZQkjpmZplBphdaRn2lPO9-CORs_M7ixabvZWI,42169
|
||||||
|
cffi/backend_ctypes.py,sha256=h5ZIzLc6BFVXnGyc9xPqZWUS7qGy7yFSDqXe68Sa8z4,42454
|
||||||
|
cffi/cffi_opcode.py,sha256=JDV5l0R0_OadBX_uE7xPPTYtMdmpp8I9UYd6av7aiDU,5731
|
||||||
|
cffi/commontypes.py,sha256=7N6zPtCFlvxXMWhHV08psUjdYIK2XgsN3yo5dgua_v4,2805
|
||||||
|
cffi/cparser.py,sha256=QUTfmlL-aO-MYR8bFGlvAUHc36OQr7XYLe0WLkGFjRo,44790
|
||||||
|
cffi/error.py,sha256=v6xTiS4U0kvDcy4h_BDRo5v39ZQuj-IMRYLv5ETddZs,877
|
||||||
|
cffi/ffiplatform.py,sha256=avxFjdikYGJoEtmJO7ewVmwG_VEVl6EZ_WaNhZYCqv4,3584
|
||||||
|
cffi/lock.py,sha256=l9TTdwMIMpi6jDkJGnQgE9cvTIR7CAntIJr8EGHt3pY,747
|
||||||
|
cffi/model.py,sha256=W30UFQZE73jL5Mx5N81YT77us2W2iJjTm0XYfnwz1cg,21797
|
||||||
|
cffi/parse_c_type.h,sha256=OdwQfwM9ktq6vlCB43exFQmxDBtj2MBNdK8LYl15tjw,5976
|
||||||
|
cffi/pkgconfig.py,sha256=LP1w7vmWvmKwyqLaU1Z243FOWGNQMrgMUZrvgFuOlco,4374
|
||||||
|
cffi/recompiler.py,sha256=78J6lMEEOygXNmjN9-fOFFO3j7eW-iFxSrxfvQb54bY,65509
|
||||||
|
cffi/setuptools_ext.py,sha256=0rCwBJ1W7FHWtiMKfNXsSST88V8UXrui5oeXFlDNLG8,9411
|
||||||
|
cffi/vengine_cpy.py,sha256=oyQKD23kpE0aChUKA8Jg0e723foPiYzLYEdb-J0MiNs,43881
|
||||||
|
cffi/vengine_gen.py,sha256=DUlEIrDiVin1Pnhn1sfoamnS5NLqfJcOdhRoeSNeJRg,26939
|
||||||
|
cffi/verifier.py,sha256=oX8jpaohg2Qm3aHcznidAdvrVm5N4sQYG0a3Eo5mIl4,11182
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: setuptools (80.9.0)
|
||||||
|
Root-Is-Purelib: false
|
||||||
|
Tag: cp312-cp312-manylinux_2_17_x86_64
|
||||||
|
Tag: cp312-cp312-manylinux2014_x86_64
|
||||||
|
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
[distutils.setup_keywords]
|
||||||
|
cffi_modules = cffi.setuptools_ext:cffi_modules
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
This package has been mostly done by Armin Rigo with help from
|
||||||
|
Maciej Fijałkowski. The idea is heavily based (although not directly
|
||||||
|
copied) from LuaJIT ffi by Mike Pall.
|
||||||
|
|
||||||
|
|
||||||
|
Other contributors:
|
||||||
|
|
||||||
|
Google Inc.
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
|
||||||
|
Except when otherwise stated (look for LICENSE files in directories or
|
||||||
|
information at the beginning of each file) all software and
|
||||||
|
documentation is licensed as follows:
|
||||||
|
|
||||||
|
MIT No Attribution
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
_cffi_backend
|
||||||
|
cffi
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
__all__ = ['FFI', 'VerificationError', 'VerificationMissing', 'CDefError',
|
||||||
|
'FFIError']
|
||||||
|
|
||||||
|
from .api import FFI
|
||||||
|
from .error import CDefError, FFIError, VerificationError, VerificationMissing
|
||||||
|
from .error import PkgConfigError
|
||||||
|
|
||||||
|
__version__ = "2.0.0"
|
||||||
|
__version_info__ = (2, 0, 0)
|
||||||
|
|
||||||
|
# The verifier module file names are based on the CRC32 of a string that
|
||||||
|
# contains the following version number. It may be older than __version__
|
||||||
|
# if nothing is clearly incompatible.
|
||||||
|
__version_verifier_modules__ = "0.8.6"
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,149 @@
|
||||||
|
#ifndef CFFI_MESSAGEBOX
|
||||||
|
# ifdef _MSC_VER
|
||||||
|
# define CFFI_MESSAGEBOX 1
|
||||||
|
# else
|
||||||
|
# define CFFI_MESSAGEBOX 0
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if CFFI_MESSAGEBOX
|
||||||
|
/* Windows only: logic to take the Python-CFFI embedding logic
|
||||||
|
initialization errors and display them in a background thread
|
||||||
|
with MessageBox. The idea is that if the whole program closes
|
||||||
|
as a result of this problem, then likely it is already a console
|
||||||
|
program and you can read the stderr output in the console too.
|
||||||
|
If it is not a console program, then it will likely show its own
|
||||||
|
dialog to complain, or generally not abruptly close, and for this
|
||||||
|
case the background thread should stay alive.
|
||||||
|
*/
|
||||||
|
static void *volatile _cffi_bootstrap_text;
|
||||||
|
|
||||||
|
static PyObject *_cffi_start_error_capture(void)
|
||||||
|
{
|
||||||
|
PyObject *result = NULL;
|
||||||
|
PyObject *x, *m, *bi;
|
||||||
|
|
||||||
|
if (InterlockedCompareExchangePointer(&_cffi_bootstrap_text,
|
||||||
|
(void *)1, NULL) != NULL)
|
||||||
|
return (PyObject *)1;
|
||||||
|
|
||||||
|
m = PyImport_AddModule("_cffi_error_capture");
|
||||||
|
if (m == NULL)
|
||||||
|
goto error;
|
||||||
|
|
||||||
|
result = PyModule_GetDict(m);
|
||||||
|
if (result == NULL)
|
||||||
|
goto error;
|
||||||
|
|
||||||
|
#if PY_MAJOR_VERSION >= 3
|
||||||
|
bi = PyImport_ImportModule("builtins");
|
||||||
|
#else
|
||||||
|
bi = PyImport_ImportModule("__builtin__");
|
||||||
|
#endif
|
||||||
|
if (bi == NULL)
|
||||||
|
goto error;
|
||||||
|
PyDict_SetItemString(result, "__builtins__", bi);
|
||||||
|
Py_DECREF(bi);
|
||||||
|
|
||||||
|
x = PyRun_String(
|
||||||
|
"import sys\n"
|
||||||
|
"class FileLike:\n"
|
||||||
|
" def write(self, x):\n"
|
||||||
|
" try:\n"
|
||||||
|
" of.write(x)\n"
|
||||||
|
" except: pass\n"
|
||||||
|
" self.buf += x\n"
|
||||||
|
" def flush(self):\n"
|
||||||
|
" pass\n"
|
||||||
|
"fl = FileLike()\n"
|
||||||
|
"fl.buf = ''\n"
|
||||||
|
"of = sys.stderr\n"
|
||||||
|
"sys.stderr = fl\n"
|
||||||
|
"def done():\n"
|
||||||
|
" sys.stderr = of\n"
|
||||||
|
" return fl.buf\n", /* make sure the returned value stays alive */
|
||||||
|
Py_file_input,
|
||||||
|
result, result);
|
||||||
|
Py_XDECREF(x);
|
||||||
|
|
||||||
|
error:
|
||||||
|
if (PyErr_Occurred())
|
||||||
|
{
|
||||||
|
PyErr_WriteUnraisable(Py_None);
|
||||||
|
PyErr_Clear();
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
#pragma comment(lib, "user32.lib")
|
||||||
|
|
||||||
|
static DWORD WINAPI _cffi_bootstrap_dialog(LPVOID ignored)
|
||||||
|
{
|
||||||
|
Sleep(666); /* may be interrupted if the whole process is closing */
|
||||||
|
#if PY_MAJOR_VERSION >= 3
|
||||||
|
MessageBoxW(NULL, (wchar_t *)_cffi_bootstrap_text,
|
||||||
|
L"Python-CFFI error",
|
||||||
|
MB_OK | MB_ICONERROR);
|
||||||
|
#else
|
||||||
|
MessageBoxA(NULL, (char *)_cffi_bootstrap_text,
|
||||||
|
"Python-CFFI error",
|
||||||
|
MB_OK | MB_ICONERROR);
|
||||||
|
#endif
|
||||||
|
_cffi_bootstrap_text = NULL;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
static void _cffi_stop_error_capture(PyObject *ecap)
|
||||||
|
{
|
||||||
|
PyObject *s;
|
||||||
|
void *text;
|
||||||
|
|
||||||
|
if (ecap == (PyObject *)1)
|
||||||
|
return;
|
||||||
|
|
||||||
|
if (ecap == NULL)
|
||||||
|
goto error;
|
||||||
|
|
||||||
|
s = PyRun_String("done()", Py_eval_input, ecap, ecap);
|
||||||
|
if (s == NULL)
|
||||||
|
goto error;
|
||||||
|
|
||||||
|
/* Show a dialog box, but in a background thread, and
|
||||||
|
never show multiple dialog boxes at once. */
|
||||||
|
#if PY_MAJOR_VERSION >= 3
|
||||||
|
text = PyUnicode_AsWideCharString(s, NULL);
|
||||||
|
#else
|
||||||
|
text = PyString_AsString(s);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
_cffi_bootstrap_text = text;
|
||||||
|
|
||||||
|
if (text != NULL)
|
||||||
|
{
|
||||||
|
HANDLE h;
|
||||||
|
h = CreateThread(NULL, 0, _cffi_bootstrap_dialog,
|
||||||
|
NULL, 0, NULL);
|
||||||
|
if (h != NULL)
|
||||||
|
CloseHandle(h);
|
||||||
|
}
|
||||||
|
/* decref the string, but it should stay alive as 'fl.buf'
|
||||||
|
in the small module above. It will really be freed only if
|
||||||
|
we later get another similar error. So it's a leak of at
|
||||||
|
most one copy of the small module. That's fine for this
|
||||||
|
situation which is usually a "fatal error" anyway. */
|
||||||
|
Py_DECREF(s);
|
||||||
|
PyErr_Clear();
|
||||||
|
return;
|
||||||
|
|
||||||
|
error:
|
||||||
|
_cffi_bootstrap_text = NULL;
|
||||||
|
PyErr_Clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
#else
|
||||||
|
|
||||||
|
static PyObject *_cffi_start_error_capture(void) { return NULL; }
|
||||||
|
static void _cffi_stop_error_capture(PyObject *ecap) { }
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
@ -0,0 +1,389 @@
|
||||||
|
#define _CFFI_
|
||||||
|
|
||||||
|
/* We try to define Py_LIMITED_API before including Python.h.
|
||||||
|
|
||||||
|
Mess: we can only define it if Py_DEBUG, Py_TRACE_REFS and
|
||||||
|
Py_REF_DEBUG are not defined. This is a best-effort approximation:
|
||||||
|
we can learn about Py_DEBUG from pyconfig.h, but it is unclear if
|
||||||
|
the same works for the other two macros. Py_DEBUG implies them,
|
||||||
|
but not the other way around.
|
||||||
|
|
||||||
|
The implementation is messy (issue #350): on Windows, with _MSC_VER,
|
||||||
|
we have to define Py_LIMITED_API even before including pyconfig.h.
|
||||||
|
In that case, we guess what pyconfig.h will do to the macros above,
|
||||||
|
and check our guess after the #include.
|
||||||
|
|
||||||
|
Note that on Windows, with CPython 3.x, you need >= 3.5 and virtualenv
|
||||||
|
version >= 16.0.0. With older versions of either, you don't get a
|
||||||
|
copy of PYTHON3.DLL in the virtualenv. We can't check the version of
|
||||||
|
CPython *before* we even include pyconfig.h. ffi.set_source() puts
|
||||||
|
a ``#define _CFFI_NO_LIMITED_API'' at the start of this file if it is
|
||||||
|
running on Windows < 3.5, as an attempt at fixing it, but that's
|
||||||
|
arguably wrong because it may not be the target version of Python.
|
||||||
|
Still better than nothing I guess. As another workaround, you can
|
||||||
|
remove the definition of Py_LIMITED_API here.
|
||||||
|
|
||||||
|
See also 'py_limited_api' in cffi/setuptools_ext.py.
|
||||||
|
*/
|
||||||
|
#if !defined(_CFFI_USE_EMBEDDING) && !defined(Py_LIMITED_API)
|
||||||
|
# ifdef _MSC_VER
|
||||||
|
# if !defined(_DEBUG) && !defined(Py_DEBUG) && !defined(Py_TRACE_REFS) && !defined(Py_REF_DEBUG) && !defined(_CFFI_NO_LIMITED_API)
|
||||||
|
# define Py_LIMITED_API
|
||||||
|
# endif
|
||||||
|
# include <pyconfig.h>
|
||||||
|
/* sanity-check: Py_LIMITED_API will cause crashes if any of these
|
||||||
|
are also defined. Normally, the Python file PC/pyconfig.h does not
|
||||||
|
cause any of these to be defined, with the exception that _DEBUG
|
||||||
|
causes Py_DEBUG. Double-check that. */
|
||||||
|
# ifdef Py_LIMITED_API
|
||||||
|
# if defined(Py_DEBUG)
|
||||||
|
# error "pyconfig.h unexpectedly defines Py_DEBUG, but Py_LIMITED_API is set"
|
||||||
|
# endif
|
||||||
|
# if defined(Py_TRACE_REFS)
|
||||||
|
# error "pyconfig.h unexpectedly defines Py_TRACE_REFS, but Py_LIMITED_API is set"
|
||||||
|
# endif
|
||||||
|
# if defined(Py_REF_DEBUG)
|
||||||
|
# error "pyconfig.h unexpectedly defines Py_REF_DEBUG, but Py_LIMITED_API is set"
|
||||||
|
# endif
|
||||||
|
# endif
|
||||||
|
# else
|
||||||
|
# include <pyconfig.h>
|
||||||
|
# if !defined(Py_DEBUG) && !defined(Py_TRACE_REFS) && !defined(Py_REF_DEBUG) && !defined(_CFFI_NO_LIMITED_API)
|
||||||
|
# define Py_LIMITED_API
|
||||||
|
# endif
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <Python.h>
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
#include <stddef.h>
|
||||||
|
#include "parse_c_type.h"
|
||||||
|
|
||||||
|
/* this block of #ifs should be kept exactly identical between
|
||||||
|
c/_cffi_backend.c, cffi/vengine_cpy.py, cffi/vengine_gen.py
|
||||||
|
and cffi/_cffi_include.h */
|
||||||
|
#if defined(_MSC_VER)
|
||||||
|
# include <malloc.h> /* for alloca() */
|
||||||
|
# if _MSC_VER < 1600 /* MSVC < 2010 */
|
||||||
|
typedef __int8 int8_t;
|
||||||
|
typedef __int16 int16_t;
|
||||||
|
typedef __int32 int32_t;
|
||||||
|
typedef __int64 int64_t;
|
||||||
|
typedef unsigned __int8 uint8_t;
|
||||||
|
typedef unsigned __int16 uint16_t;
|
||||||
|
typedef unsigned __int32 uint32_t;
|
||||||
|
typedef unsigned __int64 uint64_t;
|
||||||
|
typedef __int8 int_least8_t;
|
||||||
|
typedef __int16 int_least16_t;
|
||||||
|
typedef __int32 int_least32_t;
|
||||||
|
typedef __int64 int_least64_t;
|
||||||
|
typedef unsigned __int8 uint_least8_t;
|
||||||
|
typedef unsigned __int16 uint_least16_t;
|
||||||
|
typedef unsigned __int32 uint_least32_t;
|
||||||
|
typedef unsigned __int64 uint_least64_t;
|
||||||
|
typedef __int8 int_fast8_t;
|
||||||
|
typedef __int16 int_fast16_t;
|
||||||
|
typedef __int32 int_fast32_t;
|
||||||
|
typedef __int64 int_fast64_t;
|
||||||
|
typedef unsigned __int8 uint_fast8_t;
|
||||||
|
typedef unsigned __int16 uint_fast16_t;
|
||||||
|
typedef unsigned __int32 uint_fast32_t;
|
||||||
|
typedef unsigned __int64 uint_fast64_t;
|
||||||
|
typedef __int64 intmax_t;
|
||||||
|
typedef unsigned __int64 uintmax_t;
|
||||||
|
# else
|
||||||
|
# include <stdint.h>
|
||||||
|
# endif
|
||||||
|
# if _MSC_VER < 1800 /* MSVC < 2013 */
|
||||||
|
# ifndef __cplusplus
|
||||||
|
typedef unsigned char _Bool;
|
||||||
|
# endif
|
||||||
|
# endif
|
||||||
|
# define _cffi_float_complex_t _Fcomplex /* include <complex.h> for it */
|
||||||
|
# define _cffi_double_complex_t _Dcomplex /* include <complex.h> for it */
|
||||||
|
#else
|
||||||
|
# include <stdint.h>
|
||||||
|
# if (defined (__SVR4) && defined (__sun)) || defined(_AIX) || defined(__hpux)
|
||||||
|
# include <alloca.h>
|
||||||
|
# endif
|
||||||
|
# define _cffi_float_complex_t float _Complex
|
||||||
|
# define _cffi_double_complex_t double _Complex
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef __GNUC__
|
||||||
|
# define _CFFI_UNUSED_FN __attribute__((unused))
|
||||||
|
#else
|
||||||
|
# define _CFFI_UNUSED_FN /* nothing */
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
# ifndef _Bool
|
||||||
|
typedef bool _Bool; /* semi-hackish: C++ has no _Bool; bool is builtin */
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/********** CPython-specific section **********/
|
||||||
|
#ifndef PYPY_VERSION
|
||||||
|
|
||||||
|
|
||||||
|
#if PY_MAJOR_VERSION >= 3
|
||||||
|
# define PyInt_FromLong PyLong_FromLong
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define _cffi_from_c_double PyFloat_FromDouble
|
||||||
|
#define _cffi_from_c_float PyFloat_FromDouble
|
||||||
|
#define _cffi_from_c_long PyInt_FromLong
|
||||||
|
#define _cffi_from_c_ulong PyLong_FromUnsignedLong
|
||||||
|
#define _cffi_from_c_longlong PyLong_FromLongLong
|
||||||
|
#define _cffi_from_c_ulonglong PyLong_FromUnsignedLongLong
|
||||||
|
#define _cffi_from_c__Bool PyBool_FromLong
|
||||||
|
|
||||||
|
#define _cffi_to_c_double PyFloat_AsDouble
|
||||||
|
#define _cffi_to_c_float PyFloat_AsDouble
|
||||||
|
|
||||||
|
#define _cffi_from_c_int(x, type) \
|
||||||
|
(((type)-1) > 0 ? /* unsigned */ \
|
||||||
|
(sizeof(type) < sizeof(long) ? \
|
||||||
|
PyInt_FromLong((long)x) : \
|
||||||
|
sizeof(type) == sizeof(long) ? \
|
||||||
|
PyLong_FromUnsignedLong((unsigned long)x) : \
|
||||||
|
PyLong_FromUnsignedLongLong((unsigned long long)x)) : \
|
||||||
|
(sizeof(type) <= sizeof(long) ? \
|
||||||
|
PyInt_FromLong((long)x) : \
|
||||||
|
PyLong_FromLongLong((long long)x)))
|
||||||
|
|
||||||
|
#define _cffi_to_c_int(o, type) \
|
||||||
|
((type)( \
|
||||||
|
sizeof(type) == 1 ? (((type)-1) > 0 ? (type)_cffi_to_c_u8(o) \
|
||||||
|
: (type)_cffi_to_c_i8(o)) : \
|
||||||
|
sizeof(type) == 2 ? (((type)-1) > 0 ? (type)_cffi_to_c_u16(o) \
|
||||||
|
: (type)_cffi_to_c_i16(o)) : \
|
||||||
|
sizeof(type) == 4 ? (((type)-1) > 0 ? (type)_cffi_to_c_u32(o) \
|
||||||
|
: (type)_cffi_to_c_i32(o)) : \
|
||||||
|
sizeof(type) == 8 ? (((type)-1) > 0 ? (type)_cffi_to_c_u64(o) \
|
||||||
|
: (type)_cffi_to_c_i64(o)) : \
|
||||||
|
(Py_FatalError("unsupported size for type " #type), (type)0)))
|
||||||
|
|
||||||
|
#define _cffi_to_c_i8 \
|
||||||
|
((int(*)(PyObject *))_cffi_exports[1])
|
||||||
|
#define _cffi_to_c_u8 \
|
||||||
|
((int(*)(PyObject *))_cffi_exports[2])
|
||||||
|
#define _cffi_to_c_i16 \
|
||||||
|
((int(*)(PyObject *))_cffi_exports[3])
|
||||||
|
#define _cffi_to_c_u16 \
|
||||||
|
((int(*)(PyObject *))_cffi_exports[4])
|
||||||
|
#define _cffi_to_c_i32 \
|
||||||
|
((int(*)(PyObject *))_cffi_exports[5])
|
||||||
|
#define _cffi_to_c_u32 \
|
||||||
|
((unsigned int(*)(PyObject *))_cffi_exports[6])
|
||||||
|
#define _cffi_to_c_i64 \
|
||||||
|
((long long(*)(PyObject *))_cffi_exports[7])
|
||||||
|
#define _cffi_to_c_u64 \
|
||||||
|
((unsigned long long(*)(PyObject *))_cffi_exports[8])
|
||||||
|
#define _cffi_to_c_char \
|
||||||
|
((int(*)(PyObject *))_cffi_exports[9])
|
||||||
|
#define _cffi_from_c_pointer \
|
||||||
|
((PyObject *(*)(char *, struct _cffi_ctypedescr *))_cffi_exports[10])
|
||||||
|
#define _cffi_to_c_pointer \
|
||||||
|
((char *(*)(PyObject *, struct _cffi_ctypedescr *))_cffi_exports[11])
|
||||||
|
#define _cffi_get_struct_layout \
|
||||||
|
not used any more
|
||||||
|
#define _cffi_restore_errno \
|
||||||
|
((void(*)(void))_cffi_exports[13])
|
||||||
|
#define _cffi_save_errno \
|
||||||
|
((void(*)(void))_cffi_exports[14])
|
||||||
|
#define _cffi_from_c_char \
|
||||||
|
((PyObject *(*)(char))_cffi_exports[15])
|
||||||
|
#define _cffi_from_c_deref \
|
||||||
|
((PyObject *(*)(char *, struct _cffi_ctypedescr *))_cffi_exports[16])
|
||||||
|
#define _cffi_to_c \
|
||||||
|
((int(*)(char *, struct _cffi_ctypedescr *, PyObject *))_cffi_exports[17])
|
||||||
|
#define _cffi_from_c_struct \
|
||||||
|
((PyObject *(*)(char *, struct _cffi_ctypedescr *))_cffi_exports[18])
|
||||||
|
#define _cffi_to_c_wchar_t \
|
||||||
|
((_cffi_wchar_t(*)(PyObject *))_cffi_exports[19])
|
||||||
|
#define _cffi_from_c_wchar_t \
|
||||||
|
((PyObject *(*)(_cffi_wchar_t))_cffi_exports[20])
|
||||||
|
#define _cffi_to_c_long_double \
|
||||||
|
((long double(*)(PyObject *))_cffi_exports[21])
|
||||||
|
#define _cffi_to_c__Bool \
|
||||||
|
((_Bool(*)(PyObject *))_cffi_exports[22])
|
||||||
|
#define _cffi_prepare_pointer_call_argument \
|
||||||
|
((Py_ssize_t(*)(struct _cffi_ctypedescr *, \
|
||||||
|
PyObject *, char **))_cffi_exports[23])
|
||||||
|
#define _cffi_convert_array_from_object \
|
||||||
|
((int(*)(char *, struct _cffi_ctypedescr *, PyObject *))_cffi_exports[24])
|
||||||
|
#define _CFFI_CPIDX 25
|
||||||
|
#define _cffi_call_python \
|
||||||
|
((void(*)(struct _cffi_externpy_s *, char *))_cffi_exports[_CFFI_CPIDX])
|
||||||
|
#define _cffi_to_c_wchar3216_t \
|
||||||
|
((int(*)(PyObject *))_cffi_exports[26])
|
||||||
|
#define _cffi_from_c_wchar3216_t \
|
||||||
|
((PyObject *(*)(int))_cffi_exports[27])
|
||||||
|
#define _CFFI_NUM_EXPORTS 28
|
||||||
|
|
||||||
|
struct _cffi_ctypedescr;
|
||||||
|
|
||||||
|
static void *_cffi_exports[_CFFI_NUM_EXPORTS];
|
||||||
|
|
||||||
|
#define _cffi_type(index) ( \
|
||||||
|
assert((((uintptr_t)_cffi_types[index]) & 1) == 0), \
|
||||||
|
(struct _cffi_ctypedescr *)_cffi_types[index])
|
||||||
|
|
||||||
|
static PyObject *_cffi_init(const char *module_name, Py_ssize_t version,
|
||||||
|
const struct _cffi_type_context_s *ctx)
|
||||||
|
{
|
||||||
|
PyObject *module, *o_arg, *new_module;
|
||||||
|
void *raw[] = {
|
||||||
|
(void *)module_name,
|
||||||
|
(void *)version,
|
||||||
|
(void *)_cffi_exports,
|
||||||
|
(void *)ctx,
|
||||||
|
};
|
||||||
|
|
||||||
|
module = PyImport_ImportModule("_cffi_backend");
|
||||||
|
if (module == NULL)
|
||||||
|
goto failure;
|
||||||
|
|
||||||
|
o_arg = PyLong_FromVoidPtr((void *)raw);
|
||||||
|
if (o_arg == NULL)
|
||||||
|
goto failure;
|
||||||
|
|
||||||
|
new_module = PyObject_CallMethod(
|
||||||
|
module, (char *)"_init_cffi_1_0_external_module", (char *)"O", o_arg);
|
||||||
|
|
||||||
|
Py_DECREF(o_arg);
|
||||||
|
Py_DECREF(module);
|
||||||
|
return new_module;
|
||||||
|
|
||||||
|
failure:
|
||||||
|
Py_XDECREF(module);
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#ifdef HAVE_WCHAR_H
|
||||||
|
typedef wchar_t _cffi_wchar_t;
|
||||||
|
#else
|
||||||
|
typedef uint16_t _cffi_wchar_t; /* same random pick as _cffi_backend.c */
|
||||||
|
#endif
|
||||||
|
|
||||||
|
_CFFI_UNUSED_FN static uint16_t _cffi_to_c_char16_t(PyObject *o)
|
||||||
|
{
|
||||||
|
if (sizeof(_cffi_wchar_t) == 2)
|
||||||
|
return (uint16_t)_cffi_to_c_wchar_t(o);
|
||||||
|
else
|
||||||
|
return (uint16_t)_cffi_to_c_wchar3216_t(o);
|
||||||
|
}
|
||||||
|
|
||||||
|
_CFFI_UNUSED_FN static PyObject *_cffi_from_c_char16_t(uint16_t x)
|
||||||
|
{
|
||||||
|
if (sizeof(_cffi_wchar_t) == 2)
|
||||||
|
return _cffi_from_c_wchar_t((_cffi_wchar_t)x);
|
||||||
|
else
|
||||||
|
return _cffi_from_c_wchar3216_t((int)x);
|
||||||
|
}
|
||||||
|
|
||||||
|
_CFFI_UNUSED_FN static int _cffi_to_c_char32_t(PyObject *o)
|
||||||
|
{
|
||||||
|
if (sizeof(_cffi_wchar_t) == 4)
|
||||||
|
return (int)_cffi_to_c_wchar_t(o);
|
||||||
|
else
|
||||||
|
return (int)_cffi_to_c_wchar3216_t(o);
|
||||||
|
}
|
||||||
|
|
||||||
|
_CFFI_UNUSED_FN static PyObject *_cffi_from_c_char32_t(unsigned int x)
|
||||||
|
{
|
||||||
|
if (sizeof(_cffi_wchar_t) == 4)
|
||||||
|
return _cffi_from_c_wchar_t((_cffi_wchar_t)x);
|
||||||
|
else
|
||||||
|
return _cffi_from_c_wchar3216_t((int)x);
|
||||||
|
}
|
||||||
|
|
||||||
|
union _cffi_union_alignment_u {
|
||||||
|
unsigned char m_char;
|
||||||
|
unsigned short m_short;
|
||||||
|
unsigned int m_int;
|
||||||
|
unsigned long m_long;
|
||||||
|
unsigned long long m_longlong;
|
||||||
|
float m_float;
|
||||||
|
double m_double;
|
||||||
|
long double m_longdouble;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_freeme_s {
|
||||||
|
struct _cffi_freeme_s *next;
|
||||||
|
union _cffi_union_alignment_u alignment;
|
||||||
|
};
|
||||||
|
|
||||||
|
_CFFI_UNUSED_FN static int
|
||||||
|
_cffi_convert_array_argument(struct _cffi_ctypedescr *ctptr, PyObject *arg,
|
||||||
|
char **output_data, Py_ssize_t datasize,
|
||||||
|
struct _cffi_freeme_s **freeme)
|
||||||
|
{
|
||||||
|
char *p;
|
||||||
|
if (datasize < 0)
|
||||||
|
return -1;
|
||||||
|
|
||||||
|
p = *output_data;
|
||||||
|
if (p == NULL) {
|
||||||
|
struct _cffi_freeme_s *fp = (struct _cffi_freeme_s *)PyObject_Malloc(
|
||||||
|
offsetof(struct _cffi_freeme_s, alignment) + (size_t)datasize);
|
||||||
|
if (fp == NULL)
|
||||||
|
return -1;
|
||||||
|
fp->next = *freeme;
|
||||||
|
*freeme = fp;
|
||||||
|
p = *output_data = (char *)&fp->alignment;
|
||||||
|
}
|
||||||
|
memset((void *)p, 0, (size_t)datasize);
|
||||||
|
return _cffi_convert_array_from_object(p, ctptr, arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
_CFFI_UNUSED_FN static void
|
||||||
|
_cffi_free_array_arguments(struct _cffi_freeme_s *freeme)
|
||||||
|
{
|
||||||
|
do {
|
||||||
|
void *p = (void *)freeme;
|
||||||
|
freeme = freeme->next;
|
||||||
|
PyObject_Free(p);
|
||||||
|
} while (freeme != NULL);
|
||||||
|
}
|
||||||
|
|
||||||
|
/********** end CPython-specific section **********/
|
||||||
|
#else
|
||||||
|
_CFFI_UNUSED_FN
|
||||||
|
static void (*_cffi_call_python_org)(struct _cffi_externpy_s *, char *);
|
||||||
|
# define _cffi_call_python _cffi_call_python_org
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#define _cffi_array_len(array) (sizeof(array) / sizeof((array)[0]))
|
||||||
|
|
||||||
|
#define _cffi_prim_int(size, sign) \
|
||||||
|
((size) == 1 ? ((sign) ? _CFFI_PRIM_INT8 : _CFFI_PRIM_UINT8) : \
|
||||||
|
(size) == 2 ? ((sign) ? _CFFI_PRIM_INT16 : _CFFI_PRIM_UINT16) : \
|
||||||
|
(size) == 4 ? ((sign) ? _CFFI_PRIM_INT32 : _CFFI_PRIM_UINT32) : \
|
||||||
|
(size) == 8 ? ((sign) ? _CFFI_PRIM_INT64 : _CFFI_PRIM_UINT64) : \
|
||||||
|
_CFFI__UNKNOWN_PRIM)
|
||||||
|
|
||||||
|
#define _cffi_prim_float(size) \
|
||||||
|
((size) == sizeof(float) ? _CFFI_PRIM_FLOAT : \
|
||||||
|
(size) == sizeof(double) ? _CFFI_PRIM_DOUBLE : \
|
||||||
|
(size) == sizeof(long double) ? _CFFI__UNKNOWN_LONG_DOUBLE : \
|
||||||
|
_CFFI__UNKNOWN_FLOAT_PRIM)
|
||||||
|
|
||||||
|
#define _cffi_check_int(got, got_nonpos, expected) \
|
||||||
|
((got_nonpos) == (expected <= 0) && \
|
||||||
|
(got) == (unsigned long long)expected)
|
||||||
|
|
||||||
|
#ifdef MS_WIN32
|
||||||
|
# define _cffi_stdcall __stdcall
|
||||||
|
#else
|
||||||
|
# define _cffi_stdcall /* nothing */
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
@ -0,0 +1,550 @@
|
||||||
|
|
||||||
|
/***** Support code for embedding *****/
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if defined(_WIN32)
|
||||||
|
# define CFFI_DLLEXPORT __declspec(dllexport)
|
||||||
|
#elif defined(__GNUC__)
|
||||||
|
# define CFFI_DLLEXPORT __attribute__((visibility("default")))
|
||||||
|
#else
|
||||||
|
# define CFFI_DLLEXPORT /* nothing */
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
/* There are two global variables of type _cffi_call_python_fnptr:
|
||||||
|
|
||||||
|
* _cffi_call_python, which we declare just below, is the one called
|
||||||
|
by ``extern "Python"`` implementations.
|
||||||
|
|
||||||
|
* _cffi_call_python_org, which on CPython is actually part of the
|
||||||
|
_cffi_exports[] array, is the function pointer copied from
|
||||||
|
_cffi_backend. If _cffi_start_python() fails, then this is set
|
||||||
|
to NULL; otherwise, it should never be NULL.
|
||||||
|
|
||||||
|
After initialization is complete, both are equal. However, the
|
||||||
|
first one remains equal to &_cffi_start_and_call_python until the
|
||||||
|
very end of initialization, when we are (or should be) sure that
|
||||||
|
concurrent threads also see a completely initialized world, and
|
||||||
|
only then is it changed.
|
||||||
|
*/
|
||||||
|
#undef _cffi_call_python
|
||||||
|
typedef void (*_cffi_call_python_fnptr)(struct _cffi_externpy_s *, char *);
|
||||||
|
static void _cffi_start_and_call_python(struct _cffi_externpy_s *, char *);
|
||||||
|
static _cffi_call_python_fnptr _cffi_call_python = &_cffi_start_and_call_python;
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef _MSC_VER
|
||||||
|
/* --- Assuming a GCC not infinitely old --- */
|
||||||
|
# define cffi_compare_and_swap(l,o,n) __sync_bool_compare_and_swap(l,o,n)
|
||||||
|
# define cffi_write_barrier() __sync_synchronize()
|
||||||
|
# if !defined(__amd64__) && !defined(__x86_64__) && \
|
||||||
|
!defined(__i386__) && !defined(__i386)
|
||||||
|
# define cffi_read_barrier() __sync_synchronize()
|
||||||
|
# else
|
||||||
|
# define cffi_read_barrier() (void)0
|
||||||
|
# endif
|
||||||
|
#else
|
||||||
|
/* --- Windows threads version --- */
|
||||||
|
# include <Windows.h>
|
||||||
|
# define cffi_compare_and_swap(l,o,n) \
|
||||||
|
(InterlockedCompareExchangePointer(l,n,o) == (o))
|
||||||
|
# define cffi_write_barrier() InterlockedCompareExchange(&_cffi_dummy,0,0)
|
||||||
|
# define cffi_read_barrier() (void)0
|
||||||
|
static volatile LONG _cffi_dummy;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef WITH_THREAD
|
||||||
|
# ifndef _MSC_VER
|
||||||
|
# include <pthread.h>
|
||||||
|
static pthread_mutex_t _cffi_embed_startup_lock;
|
||||||
|
# else
|
||||||
|
static CRITICAL_SECTION _cffi_embed_startup_lock;
|
||||||
|
# endif
|
||||||
|
static char _cffi_embed_startup_lock_ready = 0;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
static void _cffi_acquire_reentrant_mutex(void)
|
||||||
|
{
|
||||||
|
static void *volatile lock = NULL;
|
||||||
|
|
||||||
|
while (!cffi_compare_and_swap(&lock, NULL, (void *)1)) {
|
||||||
|
/* should ideally do a spin loop instruction here, but
|
||||||
|
hard to do it portably and doesn't really matter I
|
||||||
|
think: pthread_mutex_init() should be very fast, and
|
||||||
|
this is only run at start-up anyway. */
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef WITH_THREAD
|
||||||
|
if (!_cffi_embed_startup_lock_ready) {
|
||||||
|
# ifndef _MSC_VER
|
||||||
|
pthread_mutexattr_t attr;
|
||||||
|
pthread_mutexattr_init(&attr);
|
||||||
|
pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
|
||||||
|
pthread_mutex_init(&_cffi_embed_startup_lock, &attr);
|
||||||
|
# else
|
||||||
|
InitializeCriticalSection(&_cffi_embed_startup_lock);
|
||||||
|
# endif
|
||||||
|
_cffi_embed_startup_lock_ready = 1;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
while (!cffi_compare_and_swap(&lock, (void *)1, NULL))
|
||||||
|
;
|
||||||
|
|
||||||
|
#ifndef _MSC_VER
|
||||||
|
pthread_mutex_lock(&_cffi_embed_startup_lock);
|
||||||
|
#else
|
||||||
|
EnterCriticalSection(&_cffi_embed_startup_lock);
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
static void _cffi_release_reentrant_mutex(void)
|
||||||
|
{
|
||||||
|
#ifndef _MSC_VER
|
||||||
|
pthread_mutex_unlock(&_cffi_embed_startup_lock);
|
||||||
|
#else
|
||||||
|
LeaveCriticalSection(&_cffi_embed_startup_lock);
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/********** CPython-specific section **********/
|
||||||
|
#ifndef PYPY_VERSION
|
||||||
|
|
||||||
|
#include "_cffi_errors.h"
|
||||||
|
|
||||||
|
|
||||||
|
#define _cffi_call_python_org _cffi_exports[_CFFI_CPIDX]
|
||||||
|
|
||||||
|
PyMODINIT_FUNC _CFFI_PYTHON_STARTUP_FUNC(void); /* forward */
|
||||||
|
|
||||||
|
static void _cffi_py_initialize(void)
|
||||||
|
{
|
||||||
|
/* XXX use initsigs=0, which "skips initialization registration of
|
||||||
|
signal handlers, which might be useful when Python is
|
||||||
|
embedded" according to the Python docs. But review and think
|
||||||
|
if it should be a user-controllable setting.
|
||||||
|
|
||||||
|
XXX we should also give a way to write errors to a buffer
|
||||||
|
instead of to stderr.
|
||||||
|
|
||||||
|
XXX if importing 'site' fails, CPython (any version) calls
|
||||||
|
exit(). Should we try to work around this behavior here?
|
||||||
|
*/
|
||||||
|
Py_InitializeEx(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
static int _cffi_initialize_python(void)
|
||||||
|
{
|
||||||
|
/* This initializes Python, imports _cffi_backend, and then the
|
||||||
|
present .dll/.so is set up as a CPython C extension module.
|
||||||
|
*/
|
||||||
|
int result;
|
||||||
|
PyGILState_STATE state;
|
||||||
|
PyObject *pycode=NULL, *global_dict=NULL, *x;
|
||||||
|
PyObject *builtins;
|
||||||
|
|
||||||
|
state = PyGILState_Ensure();
|
||||||
|
|
||||||
|
/* Call the initxxx() function from the present module. It will
|
||||||
|
create and initialize us as a CPython extension module, instead
|
||||||
|
of letting the startup Python code do it---it might reimport
|
||||||
|
the same .dll/.so and get maybe confused on some platforms.
|
||||||
|
It might also have troubles locating the .dll/.so again for all
|
||||||
|
I know.
|
||||||
|
*/
|
||||||
|
(void)_CFFI_PYTHON_STARTUP_FUNC();
|
||||||
|
if (PyErr_Occurred())
|
||||||
|
goto error;
|
||||||
|
|
||||||
|
/* Now run the Python code provided to ffi.embedding_init_code().
|
||||||
|
*/
|
||||||
|
pycode = Py_CompileString(_CFFI_PYTHON_STARTUP_CODE,
|
||||||
|
"<init code for '" _CFFI_MODULE_NAME "'>",
|
||||||
|
Py_file_input);
|
||||||
|
if (pycode == NULL)
|
||||||
|
goto error;
|
||||||
|
global_dict = PyDict_New();
|
||||||
|
if (global_dict == NULL)
|
||||||
|
goto error;
|
||||||
|
builtins = PyEval_GetBuiltins();
|
||||||
|
if (builtins == NULL)
|
||||||
|
goto error;
|
||||||
|
if (PyDict_SetItemString(global_dict, "__builtins__", builtins) < 0)
|
||||||
|
goto error;
|
||||||
|
x = PyEval_EvalCode(
|
||||||
|
#if PY_MAJOR_VERSION < 3
|
||||||
|
(PyCodeObject *)
|
||||||
|
#endif
|
||||||
|
pycode, global_dict, global_dict);
|
||||||
|
if (x == NULL)
|
||||||
|
goto error;
|
||||||
|
Py_DECREF(x);
|
||||||
|
|
||||||
|
/* Done! Now if we've been called from
|
||||||
|
_cffi_start_and_call_python() in an ``extern "Python"``, we can
|
||||||
|
only hope that the Python code did correctly set up the
|
||||||
|
corresponding @ffi.def_extern() function. Otherwise, the
|
||||||
|
general logic of ``extern "Python"`` functions (inside the
|
||||||
|
_cffi_backend module) will find that the reference is still
|
||||||
|
missing and print an error.
|
||||||
|
*/
|
||||||
|
result = 0;
|
||||||
|
done:
|
||||||
|
Py_XDECREF(pycode);
|
||||||
|
Py_XDECREF(global_dict);
|
||||||
|
PyGILState_Release(state);
|
||||||
|
return result;
|
||||||
|
|
||||||
|
error:;
|
||||||
|
{
|
||||||
|
/* Print as much information as potentially useful.
|
||||||
|
Debugging load-time failures with embedding is not fun
|
||||||
|
*/
|
||||||
|
PyObject *ecap;
|
||||||
|
PyObject *exception, *v, *tb, *f, *modules, *mod;
|
||||||
|
PyErr_Fetch(&exception, &v, &tb);
|
||||||
|
ecap = _cffi_start_error_capture();
|
||||||
|
f = PySys_GetObject((char *)"stderr");
|
||||||
|
if (f != NULL && f != Py_None) {
|
||||||
|
PyFile_WriteString(
|
||||||
|
"Failed to initialize the Python-CFFI embedding logic:\n\n", f);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (exception != NULL) {
|
||||||
|
PyErr_NormalizeException(&exception, &v, &tb);
|
||||||
|
PyErr_Display(exception, v, tb);
|
||||||
|
}
|
||||||
|
Py_XDECREF(exception);
|
||||||
|
Py_XDECREF(v);
|
||||||
|
Py_XDECREF(tb);
|
||||||
|
|
||||||
|
if (f != NULL && f != Py_None) {
|
||||||
|
PyFile_WriteString("\nFrom: " _CFFI_MODULE_NAME
|
||||||
|
"\ncompiled with cffi version: 2.0.0"
|
||||||
|
"\n_cffi_backend module: ", f);
|
||||||
|
modules = PyImport_GetModuleDict();
|
||||||
|
mod = PyDict_GetItemString(modules, "_cffi_backend");
|
||||||
|
if (mod == NULL) {
|
||||||
|
PyFile_WriteString("not loaded", f);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
v = PyObject_GetAttrString(mod, "__file__");
|
||||||
|
PyFile_WriteObject(v, f, 0);
|
||||||
|
Py_XDECREF(v);
|
||||||
|
}
|
||||||
|
PyFile_WriteString("\nsys.path: ", f);
|
||||||
|
PyFile_WriteObject(PySys_GetObject((char *)"path"), f, 0);
|
||||||
|
PyFile_WriteString("\n\n", f);
|
||||||
|
}
|
||||||
|
_cffi_stop_error_capture(ecap);
|
||||||
|
}
|
||||||
|
result = -1;
|
||||||
|
goto done;
|
||||||
|
}
|
||||||
|
|
||||||
|
#if PY_VERSION_HEX < 0x03080000
|
||||||
|
PyAPI_DATA(char *) _PyParser_TokenNames[]; /* from CPython */
|
||||||
|
#endif
|
||||||
|
|
||||||
|
static int _cffi_carefully_make_gil(void)
|
||||||
|
{
|
||||||
|
/* This does the basic initialization of Python. It can be called
|
||||||
|
completely concurrently from unrelated threads. It assumes
|
||||||
|
that we don't hold the GIL before (if it exists), and we don't
|
||||||
|
hold it afterwards.
|
||||||
|
|
||||||
|
(What it really does used to be completely different in Python 2
|
||||||
|
and Python 3, with the Python 2 solution avoiding the spin-lock
|
||||||
|
around the Py_InitializeEx() call. However, after recent changes
|
||||||
|
to CPython 2.7 (issue #358) it no longer works. So we use the
|
||||||
|
Python 3 solution everywhere.)
|
||||||
|
|
||||||
|
This initializes Python by calling Py_InitializeEx().
|
||||||
|
Important: this must not be called concurrently at all.
|
||||||
|
So we use a global variable as a simple spin lock. This global
|
||||||
|
variable must be from 'libpythonX.Y.so', not from this
|
||||||
|
cffi-based extension module, because it must be shared from
|
||||||
|
different cffi-based extension modules.
|
||||||
|
|
||||||
|
In Python < 3.8, we choose
|
||||||
|
_PyParser_TokenNames[0] as a completely arbitrary pointer value
|
||||||
|
that is never written to. The default is to point to the
|
||||||
|
string "ENDMARKER". We change it temporarily to point to the
|
||||||
|
next character in that string. (Yes, I know it's REALLY
|
||||||
|
obscure.)
|
||||||
|
|
||||||
|
In Python >= 3.8, this string array is no longer writable, so
|
||||||
|
instead we pick PyCapsuleType.tp_version_tag. We can't change
|
||||||
|
Python < 3.8 because someone might use a mixture of cffi
|
||||||
|
embedded modules, some of which were compiled before this file
|
||||||
|
changed.
|
||||||
|
|
||||||
|
In Python >= 3.12, this stopped working because that particular
|
||||||
|
tp_version_tag gets modified during interpreter startup. It's
|
||||||
|
arguably a bad idea before 3.12 too, but again we can't change
|
||||||
|
that because someone might use a mixture of cffi embedded
|
||||||
|
modules, and no-one reported a bug so far. In Python >= 3.12
|
||||||
|
we go instead for PyCapsuleType.tp_as_buffer, which is supposed
|
||||||
|
to always be NULL. We write to it temporarily a pointer to
|
||||||
|
a struct full of NULLs, which is semantically the same.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifdef WITH_THREAD
|
||||||
|
# if PY_VERSION_HEX < 0x03080000
|
||||||
|
char *volatile *lock = (char *volatile *)_PyParser_TokenNames;
|
||||||
|
char *old_value, *locked_value;
|
||||||
|
|
||||||
|
while (1) { /* spin loop */
|
||||||
|
old_value = *lock;
|
||||||
|
locked_value = old_value + 1;
|
||||||
|
if (old_value[0] == 'E') {
|
||||||
|
assert(old_value[1] == 'N');
|
||||||
|
if (cffi_compare_and_swap(lock, old_value, locked_value))
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
assert(old_value[0] == 'N');
|
||||||
|
/* should ideally do a spin loop instruction here, but
|
||||||
|
hard to do it portably and doesn't really matter I
|
||||||
|
think: PyEval_InitThreads() should be very fast, and
|
||||||
|
this is only run at start-up anyway. */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
# else
|
||||||
|
# if PY_VERSION_HEX < 0x030C0000
|
||||||
|
int volatile *lock = (int volatile *)&PyCapsule_Type.tp_version_tag;
|
||||||
|
int old_value, locked_value = -42;
|
||||||
|
assert(!(PyCapsule_Type.tp_flags & Py_TPFLAGS_HAVE_VERSION_TAG));
|
||||||
|
# else
|
||||||
|
static struct ebp_s { PyBufferProcs buf; int mark; } empty_buffer_procs;
|
||||||
|
empty_buffer_procs.mark = -42;
|
||||||
|
PyBufferProcs *volatile *lock = (PyBufferProcs *volatile *)
|
||||||
|
&PyCapsule_Type.tp_as_buffer;
|
||||||
|
PyBufferProcs *old_value, *locked_value = &empty_buffer_procs.buf;
|
||||||
|
# endif
|
||||||
|
|
||||||
|
while (1) { /* spin loop */
|
||||||
|
old_value = *lock;
|
||||||
|
if (old_value == 0) {
|
||||||
|
if (cffi_compare_and_swap(lock, old_value, locked_value))
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
# if PY_VERSION_HEX < 0x030C0000
|
||||||
|
assert(old_value == locked_value);
|
||||||
|
# else
|
||||||
|
/* The pointer should point to a possibly different
|
||||||
|
empty_buffer_procs from another C extension module */
|
||||||
|
assert(((struct ebp_s *)old_value)->mark == -42);
|
||||||
|
# endif
|
||||||
|
/* should ideally do a spin loop instruction here, but
|
||||||
|
hard to do it portably and doesn't really matter I
|
||||||
|
think: PyEval_InitThreads() should be very fast, and
|
||||||
|
this is only run at start-up anyway. */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
# endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* call Py_InitializeEx() */
|
||||||
|
if (!Py_IsInitialized()) {
|
||||||
|
_cffi_py_initialize();
|
||||||
|
#if PY_VERSION_HEX < 0x03070000
|
||||||
|
PyEval_InitThreads();
|
||||||
|
#endif
|
||||||
|
PyEval_SaveThread(); /* release the GIL */
|
||||||
|
/* the returned tstate must be the one that has been stored into the
|
||||||
|
autoTLSkey by _PyGILState_Init() called from Py_Initialize(). */
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
#if PY_VERSION_HEX < 0x03070000
|
||||||
|
/* PyEval_InitThreads() is always a no-op from CPython 3.7 */
|
||||||
|
PyGILState_STATE state = PyGILState_Ensure();
|
||||||
|
PyEval_InitThreads();
|
||||||
|
PyGILState_Release(state);
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef WITH_THREAD
|
||||||
|
/* release the lock */
|
||||||
|
while (!cffi_compare_and_swap(lock, locked_value, old_value))
|
||||||
|
;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/********** end CPython-specific section **********/
|
||||||
|
|
||||||
|
|
||||||
|
#else
|
||||||
|
|
||||||
|
|
||||||
|
/********** PyPy-specific section **********/
|
||||||
|
|
||||||
|
PyMODINIT_FUNC _CFFI_PYTHON_STARTUP_FUNC(const void *[]); /* forward */
|
||||||
|
|
||||||
|
static struct _cffi_pypy_init_s {
|
||||||
|
const char *name;
|
||||||
|
void *func; /* function pointer */
|
||||||
|
const char *code;
|
||||||
|
} _cffi_pypy_init = {
|
||||||
|
_CFFI_MODULE_NAME,
|
||||||
|
_CFFI_PYTHON_STARTUP_FUNC,
|
||||||
|
_CFFI_PYTHON_STARTUP_CODE,
|
||||||
|
};
|
||||||
|
|
||||||
|
extern int pypy_carefully_make_gil(const char *);
|
||||||
|
extern int pypy_init_embedded_cffi_module(int, struct _cffi_pypy_init_s *);
|
||||||
|
|
||||||
|
static int _cffi_carefully_make_gil(void)
|
||||||
|
{
|
||||||
|
return pypy_carefully_make_gil(_CFFI_MODULE_NAME);
|
||||||
|
}
|
||||||
|
|
||||||
|
static int _cffi_initialize_python(void)
|
||||||
|
{
|
||||||
|
return pypy_init_embedded_cffi_module(0xB011, &_cffi_pypy_init);
|
||||||
|
}
|
||||||
|
|
||||||
|
/********** end PyPy-specific section **********/
|
||||||
|
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#ifdef __GNUC__
|
||||||
|
__attribute__((noinline))
|
||||||
|
#endif
|
||||||
|
static _cffi_call_python_fnptr _cffi_start_python(void)
|
||||||
|
{
|
||||||
|
/* Delicate logic to initialize Python. This function can be
|
||||||
|
called multiple times concurrently, e.g. when the process calls
|
||||||
|
its first ``extern "Python"`` functions in multiple threads at
|
||||||
|
once. It can also be called recursively, in which case we must
|
||||||
|
ignore it. We also have to consider what occurs if several
|
||||||
|
different cffi-based extensions reach this code in parallel
|
||||||
|
threads---it is a different copy of the code, then, and we
|
||||||
|
can't have any shared global variable unless it comes from
|
||||||
|
'libpythonX.Y.so'.
|
||||||
|
|
||||||
|
Idea:
|
||||||
|
|
||||||
|
* _cffi_carefully_make_gil(): "carefully" call
|
||||||
|
PyEval_InitThreads() (possibly with Py_InitializeEx() first).
|
||||||
|
|
||||||
|
* then we use a (local) custom lock to make sure that a call to this
|
||||||
|
cffi-based extension will wait if another call to the *same*
|
||||||
|
extension is running the initialization in another thread.
|
||||||
|
It is reentrant, so that a recursive call will not block, but
|
||||||
|
only one from a different thread.
|
||||||
|
|
||||||
|
* then we grab the GIL and (Python 2) we call Py_InitializeEx().
|
||||||
|
At this point, concurrent calls to Py_InitializeEx() are not
|
||||||
|
possible: we have the GIL.
|
||||||
|
|
||||||
|
* do the rest of the specific initialization, which may
|
||||||
|
temporarily release the GIL but not the custom lock.
|
||||||
|
Only release the custom lock when we are done.
|
||||||
|
*/
|
||||||
|
static char called = 0;
|
||||||
|
|
||||||
|
if (_cffi_carefully_make_gil() != 0)
|
||||||
|
return NULL;
|
||||||
|
|
||||||
|
_cffi_acquire_reentrant_mutex();
|
||||||
|
|
||||||
|
/* Here the GIL exists, but we don't have it. We're only protected
|
||||||
|
from concurrency by the reentrant mutex. */
|
||||||
|
|
||||||
|
/* This file only initializes the embedded module once, the first
|
||||||
|
time this is called, even if there are subinterpreters. */
|
||||||
|
if (!called) {
|
||||||
|
called = 1; /* invoke _cffi_initialize_python() only once,
|
||||||
|
but don't set '_cffi_call_python' right now,
|
||||||
|
otherwise concurrent threads won't call
|
||||||
|
this function at all (we need them to wait) */
|
||||||
|
if (_cffi_initialize_python() == 0) {
|
||||||
|
/* now initialization is finished. Switch to the fast-path. */
|
||||||
|
|
||||||
|
/* We would like nobody to see the new value of
|
||||||
|
'_cffi_call_python' without also seeing the rest of the
|
||||||
|
data initialized. However, this is not possible. But
|
||||||
|
the new value of '_cffi_call_python' is the function
|
||||||
|
'cffi_call_python()' from _cffi_backend. So: */
|
||||||
|
cffi_write_barrier();
|
||||||
|
/* ^^^ we put a write barrier here, and a corresponding
|
||||||
|
read barrier at the start of cffi_call_python(). This
|
||||||
|
ensures that after that read barrier, we see everything
|
||||||
|
done here before the write barrier.
|
||||||
|
*/
|
||||||
|
|
||||||
|
assert(_cffi_call_python_org != NULL);
|
||||||
|
_cffi_call_python = (_cffi_call_python_fnptr)_cffi_call_python_org;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
/* initialization failed. Reset this to NULL, even if it was
|
||||||
|
already set to some other value. Future calls to
|
||||||
|
_cffi_start_python() are still forced to occur, and will
|
||||||
|
always return NULL from now on. */
|
||||||
|
_cffi_call_python_org = NULL;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_cffi_release_reentrant_mutex();
|
||||||
|
|
||||||
|
return (_cffi_call_python_fnptr)_cffi_call_python_org;
|
||||||
|
}
|
||||||
|
|
||||||
|
static
|
||||||
|
void _cffi_start_and_call_python(struct _cffi_externpy_s *externpy, char *args)
|
||||||
|
{
|
||||||
|
_cffi_call_python_fnptr fnptr;
|
||||||
|
int current_err = errno;
|
||||||
|
#ifdef _MSC_VER
|
||||||
|
int current_lasterr = GetLastError();
|
||||||
|
#endif
|
||||||
|
fnptr = _cffi_start_python();
|
||||||
|
if (fnptr == NULL) {
|
||||||
|
fprintf(stderr, "function %s() called, but initialization code "
|
||||||
|
"failed. Returning 0.\n", externpy->name);
|
||||||
|
memset(args, 0, externpy->size_of_result);
|
||||||
|
}
|
||||||
|
#ifdef _MSC_VER
|
||||||
|
SetLastError(current_lasterr);
|
||||||
|
#endif
|
||||||
|
errno = current_err;
|
||||||
|
|
||||||
|
if (fnptr != NULL)
|
||||||
|
fnptr(externpy, args);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* The cffi_start_python() function makes sure Python is initialized
|
||||||
|
and our cffi module is set up. It can be called manually from the
|
||||||
|
user C code. The same effect is obtained automatically from any
|
||||||
|
dll-exported ``extern "Python"`` function. This function returns
|
||||||
|
-1 if initialization failed, 0 if all is OK. */
|
||||||
|
_CFFI_UNUSED_FN
|
||||||
|
static int cffi_start_python(void)
|
||||||
|
{
|
||||||
|
if (_cffi_call_python == &_cffi_start_and_call_python) {
|
||||||
|
if (_cffi_start_python() == NULL)
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
cffi_read_barrier();
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#undef cffi_compare_and_swap
|
||||||
|
#undef cffi_write_barrier
|
||||||
|
#undef cffi_read_barrier
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
@ -0,0 +1,83 @@
|
||||||
|
|
||||||
|
try:
|
||||||
|
# this works on Python < 3.12
|
||||||
|
from imp import *
|
||||||
|
|
||||||
|
except ImportError:
|
||||||
|
# this is a limited emulation for Python >= 3.12.
|
||||||
|
# Note that this is used only for tests or for the old ffi.verify().
|
||||||
|
# This is copied from the source code of Python 3.11.
|
||||||
|
|
||||||
|
from _imp import (acquire_lock, release_lock,
|
||||||
|
is_builtin, is_frozen)
|
||||||
|
|
||||||
|
from importlib._bootstrap import _load
|
||||||
|
|
||||||
|
from importlib import machinery
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import tokenize
|
||||||
|
|
||||||
|
SEARCH_ERROR = 0
|
||||||
|
PY_SOURCE = 1
|
||||||
|
PY_COMPILED = 2
|
||||||
|
C_EXTENSION = 3
|
||||||
|
PY_RESOURCE = 4
|
||||||
|
PKG_DIRECTORY = 5
|
||||||
|
C_BUILTIN = 6
|
||||||
|
PY_FROZEN = 7
|
||||||
|
PY_CODERESOURCE = 8
|
||||||
|
IMP_HOOK = 9
|
||||||
|
|
||||||
|
def get_suffixes():
|
||||||
|
extensions = [(s, 'rb', C_EXTENSION)
|
||||||
|
for s in machinery.EXTENSION_SUFFIXES]
|
||||||
|
source = [(s, 'r', PY_SOURCE) for s in machinery.SOURCE_SUFFIXES]
|
||||||
|
bytecode = [(s, 'rb', PY_COMPILED) for s in machinery.BYTECODE_SUFFIXES]
|
||||||
|
return extensions + source + bytecode
|
||||||
|
|
||||||
|
def find_module(name, path=None):
|
||||||
|
if not isinstance(name, str):
|
||||||
|
raise TypeError("'name' must be a str, not {}".format(type(name)))
|
||||||
|
elif not isinstance(path, (type(None), list)):
|
||||||
|
# Backwards-compatibility
|
||||||
|
raise RuntimeError("'path' must be None or a list, "
|
||||||
|
"not {}".format(type(path)))
|
||||||
|
|
||||||
|
if path is None:
|
||||||
|
if is_builtin(name):
|
||||||
|
return None, None, ('', '', C_BUILTIN)
|
||||||
|
elif is_frozen(name):
|
||||||
|
return None, None, ('', '', PY_FROZEN)
|
||||||
|
else:
|
||||||
|
path = sys.path
|
||||||
|
|
||||||
|
for entry in path:
|
||||||
|
package_directory = os.path.join(entry, name)
|
||||||
|
for suffix in ['.py', machinery.BYTECODE_SUFFIXES[0]]:
|
||||||
|
package_file_name = '__init__' + suffix
|
||||||
|
file_path = os.path.join(package_directory, package_file_name)
|
||||||
|
if os.path.isfile(file_path):
|
||||||
|
return None, package_directory, ('', '', PKG_DIRECTORY)
|
||||||
|
for suffix, mode, type_ in get_suffixes():
|
||||||
|
file_name = name + suffix
|
||||||
|
file_path = os.path.join(entry, file_name)
|
||||||
|
if os.path.isfile(file_path):
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
continue
|
||||||
|
break # Break out of outer loop when breaking out of inner loop.
|
||||||
|
else:
|
||||||
|
raise ImportError(name, name=name)
|
||||||
|
|
||||||
|
encoding = None
|
||||||
|
if 'b' not in mode:
|
||||||
|
with open(file_path, 'rb') as file:
|
||||||
|
encoding = tokenize.detect_encoding(file.readline)[0]
|
||||||
|
file = open(file_path, mode, encoding=encoding)
|
||||||
|
return file, file_path, (suffix, mode, type_)
|
||||||
|
|
||||||
|
def load_dynamic(name, path, file=None):
|
||||||
|
loader = machinery.ExtensionFileLoader(name, path)
|
||||||
|
spec = machinery.ModuleSpec(name=name, loader=loader, origin=path)
|
||||||
|
return _load(spec)
|
||||||
|
|
@ -0,0 +1,45 @@
|
||||||
|
"""
|
||||||
|
Temporary shim module to indirect the bits of distutils we need from setuptools/distutils while providing useful
|
||||||
|
error messages beyond `No module named 'distutils' on Python >= 3.12, or when setuptools' vendored distutils is broken.
|
||||||
|
|
||||||
|
This is a compromise to avoid a hard-dep on setuptools for Python >= 3.12, since many users don't need runtime compilation support from CFFI.
|
||||||
|
"""
|
||||||
|
import sys
|
||||||
|
|
||||||
|
try:
|
||||||
|
# import setuptools first; this is the most robust way to ensure its embedded distutils is available
|
||||||
|
# (the .pth shim should usually work, but this is even more robust)
|
||||||
|
import setuptools
|
||||||
|
except Exception as ex:
|
||||||
|
if sys.version_info >= (3, 12):
|
||||||
|
# Python 3.12 has no built-in distutils to fall back on, so any import problem is fatal
|
||||||
|
raise Exception("This CFFI feature requires setuptools on Python >= 3.12. The setuptools module is missing or non-functional.") from ex
|
||||||
|
|
||||||
|
# silently ignore on older Pythons (support fallback to stdlib distutils where available)
|
||||||
|
else:
|
||||||
|
del setuptools
|
||||||
|
|
||||||
|
try:
|
||||||
|
# bring in just the bits of distutils we need, whether they really came from setuptools or stdlib-embedded distutils
|
||||||
|
from distutils import log, sysconfig
|
||||||
|
from distutils.ccompiler import CCompiler
|
||||||
|
from distutils.command.build_ext import build_ext
|
||||||
|
from distutils.core import Distribution, Extension
|
||||||
|
from distutils.dir_util import mkpath
|
||||||
|
from distutils.errors import DistutilsSetupError, CompileError, LinkError
|
||||||
|
from distutils.log import set_threshold, set_verbosity
|
||||||
|
|
||||||
|
if sys.platform == 'win32':
|
||||||
|
try:
|
||||||
|
# FUTURE: msvc9compiler module was removed in setuptools 74; consider removing, as it's only used by an ancient patch in `recompiler`
|
||||||
|
from distutils.msvc9compiler import MSVCCompiler
|
||||||
|
except ImportError:
|
||||||
|
MSVCCompiler = None
|
||||||
|
except Exception as ex:
|
||||||
|
if sys.version_info >= (3, 12):
|
||||||
|
raise Exception("This CFFI feature requires setuptools on Python >= 3.12. Please install the setuptools package.") from ex
|
||||||
|
|
||||||
|
# anything older, just let the underlying distutils import error fly
|
||||||
|
raise Exception("This CFFI feature requires distutils. Please install the distutils or setuptools package.") from ex
|
||||||
|
|
||||||
|
del sys
|
||||||
|
|
@ -0,0 +1,967 @@
|
||||||
|
import sys, types
|
||||||
|
from .lock import allocate_lock
|
||||||
|
from .error import CDefError
|
||||||
|
from . import model
|
||||||
|
|
||||||
|
try:
|
||||||
|
callable
|
||||||
|
except NameError:
|
||||||
|
# Python 3.1
|
||||||
|
from collections import Callable
|
||||||
|
callable = lambda x: isinstance(x, Callable)
|
||||||
|
|
||||||
|
try:
|
||||||
|
basestring
|
||||||
|
except NameError:
|
||||||
|
# Python 3.x
|
||||||
|
basestring = str
|
||||||
|
|
||||||
|
_unspecified = object()
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class FFI(object):
|
||||||
|
r'''
|
||||||
|
The main top-level class that you instantiate once, or once per module.
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
|
||||||
|
ffi = FFI()
|
||||||
|
ffi.cdef("""
|
||||||
|
int printf(const char *, ...);
|
||||||
|
""")
|
||||||
|
|
||||||
|
C = ffi.dlopen(None) # standard library
|
||||||
|
-or-
|
||||||
|
C = ffi.verify() # use a C compiler: verify the decl above is right
|
||||||
|
|
||||||
|
C.printf("hello, %s!\n", ffi.new("char[]", "world"))
|
||||||
|
'''
|
||||||
|
|
||||||
|
def __init__(self, backend=None):
|
||||||
|
"""Create an FFI instance. The 'backend' argument is used to
|
||||||
|
select a non-default backend, mostly for tests.
|
||||||
|
"""
|
||||||
|
if backend is None:
|
||||||
|
# You need PyPy (>= 2.0 beta), or a CPython (>= 2.6) with
|
||||||
|
# _cffi_backend.so compiled.
|
||||||
|
import _cffi_backend as backend
|
||||||
|
from . import __version__
|
||||||
|
if backend.__version__ != __version__:
|
||||||
|
# bad version! Try to be as explicit as possible.
|
||||||
|
if hasattr(backend, '__file__'):
|
||||||
|
# CPython
|
||||||
|
raise Exception("Version mismatch: this is the 'cffi' package version %s, located in %r. When we import the top-level '_cffi_backend' extension module, we get version %s, located in %r. The two versions should be equal; check your installation." % (
|
||||||
|
__version__, __file__,
|
||||||
|
backend.__version__, backend.__file__))
|
||||||
|
else:
|
||||||
|
# PyPy
|
||||||
|
raise Exception("Version mismatch: this is the 'cffi' package version %s, located in %r. This interpreter comes with a built-in '_cffi_backend' module, which is version %s. The two versions should be equal; check your installation." % (
|
||||||
|
__version__, __file__, backend.__version__))
|
||||||
|
# (If you insist you can also try to pass the option
|
||||||
|
# 'backend=backend_ctypes.CTypesBackend()', but don't
|
||||||
|
# rely on it! It's probably not going to work well.)
|
||||||
|
|
||||||
|
from . import cparser
|
||||||
|
self._backend = backend
|
||||||
|
self._lock = allocate_lock()
|
||||||
|
self._parser = cparser.Parser()
|
||||||
|
self._cached_btypes = {}
|
||||||
|
self._parsed_types = types.ModuleType('parsed_types').__dict__
|
||||||
|
self._new_types = types.ModuleType('new_types').__dict__
|
||||||
|
self._function_caches = []
|
||||||
|
self._libraries = []
|
||||||
|
self._cdefsources = []
|
||||||
|
self._included_ffis = []
|
||||||
|
self._windows_unicode = None
|
||||||
|
self._init_once_cache = {}
|
||||||
|
self._cdef_version = None
|
||||||
|
self._embedding = None
|
||||||
|
self._typecache = model.get_typecache(backend)
|
||||||
|
if hasattr(backend, 'set_ffi'):
|
||||||
|
backend.set_ffi(self)
|
||||||
|
for name in list(backend.__dict__):
|
||||||
|
if name.startswith('RTLD_'):
|
||||||
|
setattr(self, name, getattr(backend, name))
|
||||||
|
#
|
||||||
|
with self._lock:
|
||||||
|
self.BVoidP = self._get_cached_btype(model.voidp_type)
|
||||||
|
self.BCharA = self._get_cached_btype(model.char_array_type)
|
||||||
|
if isinstance(backend, types.ModuleType):
|
||||||
|
# _cffi_backend: attach these constants to the class
|
||||||
|
if not hasattr(FFI, 'NULL'):
|
||||||
|
FFI.NULL = self.cast(self.BVoidP, 0)
|
||||||
|
FFI.CData, FFI.CType = backend._get_types()
|
||||||
|
else:
|
||||||
|
# ctypes backend: attach these constants to the instance
|
||||||
|
self.NULL = self.cast(self.BVoidP, 0)
|
||||||
|
self.CData, self.CType = backend._get_types()
|
||||||
|
self.buffer = backend.buffer
|
||||||
|
|
||||||
|
def cdef(self, csource, override=False, packed=False, pack=None):
|
||||||
|
"""Parse the given C source. This registers all declared functions,
|
||||||
|
types, and global variables. The functions and global variables can
|
||||||
|
then be accessed via either 'ffi.dlopen()' or 'ffi.verify()'.
|
||||||
|
The types can be used in 'ffi.new()' and other functions.
|
||||||
|
If 'packed' is specified as True, all structs declared inside this
|
||||||
|
cdef are packed, i.e. laid out without any field alignment at all.
|
||||||
|
Alternatively, 'pack' can be a small integer, and requests for
|
||||||
|
alignment greater than that are ignored (pack=1 is equivalent to
|
||||||
|
packed=True).
|
||||||
|
"""
|
||||||
|
self._cdef(csource, override=override, packed=packed, pack=pack)
|
||||||
|
|
||||||
|
def embedding_api(self, csource, packed=False, pack=None):
|
||||||
|
self._cdef(csource, packed=packed, pack=pack, dllexport=True)
|
||||||
|
if self._embedding is None:
|
||||||
|
self._embedding = ''
|
||||||
|
|
||||||
|
def _cdef(self, csource, override=False, **options):
|
||||||
|
if not isinstance(csource, str): # unicode, on Python 2
|
||||||
|
if not isinstance(csource, basestring):
|
||||||
|
raise TypeError("cdef() argument must be a string")
|
||||||
|
csource = csource.encode('ascii')
|
||||||
|
with self._lock:
|
||||||
|
self._cdef_version = object()
|
||||||
|
self._parser.parse(csource, override=override, **options)
|
||||||
|
self._cdefsources.append(csource)
|
||||||
|
if override:
|
||||||
|
for cache in self._function_caches:
|
||||||
|
cache.clear()
|
||||||
|
finishlist = self._parser._recomplete
|
||||||
|
if finishlist:
|
||||||
|
self._parser._recomplete = []
|
||||||
|
for tp in finishlist:
|
||||||
|
tp.finish_backend_type(self, finishlist)
|
||||||
|
|
||||||
|
def dlopen(self, name, flags=0):
|
||||||
|
"""Load and return a dynamic library identified by 'name'.
|
||||||
|
The standard C library can be loaded by passing None.
|
||||||
|
Note that functions and types declared by 'ffi.cdef()' are not
|
||||||
|
linked to a particular library, just like C headers; in the
|
||||||
|
library we only look for the actual (untyped) symbols.
|
||||||
|
"""
|
||||||
|
if not (isinstance(name, basestring) or
|
||||||
|
name is None or
|
||||||
|
isinstance(name, self.CData)):
|
||||||
|
raise TypeError("dlopen(name): name must be a file name, None, "
|
||||||
|
"or an already-opened 'void *' handle")
|
||||||
|
with self._lock:
|
||||||
|
lib, function_cache = _make_ffi_library(self, name, flags)
|
||||||
|
self._function_caches.append(function_cache)
|
||||||
|
self._libraries.append(lib)
|
||||||
|
return lib
|
||||||
|
|
||||||
|
def dlclose(self, lib):
|
||||||
|
"""Close a library obtained with ffi.dlopen(). After this call,
|
||||||
|
access to functions or variables from the library will fail
|
||||||
|
(possibly with a segmentation fault).
|
||||||
|
"""
|
||||||
|
type(lib).__cffi_close__(lib)
|
||||||
|
|
||||||
|
def _typeof_locked(self, cdecl):
|
||||||
|
# call me with the lock!
|
||||||
|
key = cdecl
|
||||||
|
if key in self._parsed_types:
|
||||||
|
return self._parsed_types[key]
|
||||||
|
#
|
||||||
|
if not isinstance(cdecl, str): # unicode, on Python 2
|
||||||
|
cdecl = cdecl.encode('ascii')
|
||||||
|
#
|
||||||
|
type = self._parser.parse_type(cdecl)
|
||||||
|
really_a_function_type = type.is_raw_function
|
||||||
|
if really_a_function_type:
|
||||||
|
type = type.as_function_pointer()
|
||||||
|
btype = self._get_cached_btype(type)
|
||||||
|
result = btype, really_a_function_type
|
||||||
|
self._parsed_types[key] = result
|
||||||
|
return result
|
||||||
|
|
||||||
|
def _typeof(self, cdecl, consider_function_as_funcptr=False):
|
||||||
|
# string -> ctype object
|
||||||
|
try:
|
||||||
|
result = self._parsed_types[cdecl]
|
||||||
|
except KeyError:
|
||||||
|
with self._lock:
|
||||||
|
result = self._typeof_locked(cdecl)
|
||||||
|
#
|
||||||
|
btype, really_a_function_type = result
|
||||||
|
if really_a_function_type and not consider_function_as_funcptr:
|
||||||
|
raise CDefError("the type %r is a function type, not a "
|
||||||
|
"pointer-to-function type" % (cdecl,))
|
||||||
|
return btype
|
||||||
|
|
||||||
|
def typeof(self, cdecl):
|
||||||
|
"""Parse the C type given as a string and return the
|
||||||
|
corresponding <ctype> object.
|
||||||
|
It can also be used on 'cdata' instance to get its C type.
|
||||||
|
"""
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
return self._typeof(cdecl)
|
||||||
|
if isinstance(cdecl, self.CData):
|
||||||
|
return self._backend.typeof(cdecl)
|
||||||
|
if isinstance(cdecl, types.BuiltinFunctionType):
|
||||||
|
res = _builtin_function_type(cdecl)
|
||||||
|
if res is not None:
|
||||||
|
return res
|
||||||
|
if (isinstance(cdecl, types.FunctionType)
|
||||||
|
and hasattr(cdecl, '_cffi_base_type')):
|
||||||
|
with self._lock:
|
||||||
|
return self._get_cached_btype(cdecl._cffi_base_type)
|
||||||
|
raise TypeError(type(cdecl))
|
||||||
|
|
||||||
|
def sizeof(self, cdecl):
|
||||||
|
"""Return the size in bytes of the argument. It can be a
|
||||||
|
string naming a C type, or a 'cdata' instance.
|
||||||
|
"""
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
BType = self._typeof(cdecl)
|
||||||
|
return self._backend.sizeof(BType)
|
||||||
|
else:
|
||||||
|
return self._backend.sizeof(cdecl)
|
||||||
|
|
||||||
|
def alignof(self, cdecl):
|
||||||
|
"""Return the natural alignment size in bytes of the C type
|
||||||
|
given as a string.
|
||||||
|
"""
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl)
|
||||||
|
return self._backend.alignof(cdecl)
|
||||||
|
|
||||||
|
def offsetof(self, cdecl, *fields_or_indexes):
|
||||||
|
"""Return the offset of the named field inside the given
|
||||||
|
structure or array, which must be given as a C type name.
|
||||||
|
You can give several field names in case of nested structures.
|
||||||
|
You can also give numeric values which correspond to array
|
||||||
|
items, in case of an array type.
|
||||||
|
"""
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl)
|
||||||
|
return self._typeoffsetof(cdecl, *fields_or_indexes)[1]
|
||||||
|
|
||||||
|
def new(self, cdecl, init=None):
|
||||||
|
"""Allocate an instance according to the specified C type and
|
||||||
|
return a pointer to it. The specified C type must be either a
|
||||||
|
pointer or an array: ``new('X *')`` allocates an X and returns
|
||||||
|
a pointer to it, whereas ``new('X[n]')`` allocates an array of
|
||||||
|
n X'es and returns an array referencing it (which works
|
||||||
|
mostly like a pointer, like in C). You can also use
|
||||||
|
``new('X[]', n)`` to allocate an array of a non-constant
|
||||||
|
length n.
|
||||||
|
|
||||||
|
The memory is initialized following the rules of declaring a
|
||||||
|
global variable in C: by default it is zero-initialized, but
|
||||||
|
an explicit initializer can be given which can be used to
|
||||||
|
fill all or part of the memory.
|
||||||
|
|
||||||
|
When the returned <cdata> object goes out of scope, the memory
|
||||||
|
is freed. In other words the returned <cdata> object has
|
||||||
|
ownership of the value of type 'cdecl' that it points to. This
|
||||||
|
means that the raw data can be used as long as this object is
|
||||||
|
kept alive, but must not be used for a longer time. Be careful
|
||||||
|
about that when copying the pointer to the memory somewhere
|
||||||
|
else, e.g. into another structure.
|
||||||
|
"""
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl)
|
||||||
|
return self._backend.newp(cdecl, init)
|
||||||
|
|
||||||
|
def new_allocator(self, alloc=None, free=None,
|
||||||
|
should_clear_after_alloc=True):
|
||||||
|
"""Return a new allocator, i.e. a function that behaves like ffi.new()
|
||||||
|
but uses the provided low-level 'alloc' and 'free' functions.
|
||||||
|
|
||||||
|
'alloc' is called with the size as argument. If it returns NULL, a
|
||||||
|
MemoryError is raised. 'free' is called with the result of 'alloc'
|
||||||
|
as argument. Both can be either Python function or directly C
|
||||||
|
functions. If 'free' is None, then no free function is called.
|
||||||
|
If both 'alloc' and 'free' are None, the default is used.
|
||||||
|
|
||||||
|
If 'should_clear_after_alloc' is set to False, then the memory
|
||||||
|
returned by 'alloc' is assumed to be already cleared (or you are
|
||||||
|
fine with garbage); otherwise CFFI will clear it.
|
||||||
|
"""
|
||||||
|
compiled_ffi = self._backend.FFI()
|
||||||
|
allocator = compiled_ffi.new_allocator(alloc, free,
|
||||||
|
should_clear_after_alloc)
|
||||||
|
def allocate(cdecl, init=None):
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl)
|
||||||
|
return allocator(cdecl, init)
|
||||||
|
return allocate
|
||||||
|
|
||||||
|
def cast(self, cdecl, source):
|
||||||
|
"""Similar to a C cast: returns an instance of the named C
|
||||||
|
type initialized with the given 'source'. The source is
|
||||||
|
casted between integers or pointers of any type.
|
||||||
|
"""
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl)
|
||||||
|
return self._backend.cast(cdecl, source)
|
||||||
|
|
||||||
|
def string(self, cdata, maxlen=-1):
|
||||||
|
"""Return a Python string (or unicode string) from the 'cdata'.
|
||||||
|
If 'cdata' is a pointer or array of characters or bytes, returns
|
||||||
|
the null-terminated string. The returned string extends until
|
||||||
|
the first null character, or at most 'maxlen' characters. If
|
||||||
|
'cdata' is an array then 'maxlen' defaults to its length.
|
||||||
|
|
||||||
|
If 'cdata' is a pointer or array of wchar_t, returns a unicode
|
||||||
|
string following the same rules.
|
||||||
|
|
||||||
|
If 'cdata' is a single character or byte or a wchar_t, returns
|
||||||
|
it as a string or unicode string.
|
||||||
|
|
||||||
|
If 'cdata' is an enum, returns the value of the enumerator as a
|
||||||
|
string, or 'NUMBER' if the value is out of range.
|
||||||
|
"""
|
||||||
|
return self._backend.string(cdata, maxlen)
|
||||||
|
|
||||||
|
def unpack(self, cdata, length):
|
||||||
|
"""Unpack an array of C data of the given length,
|
||||||
|
returning a Python string/unicode/list.
|
||||||
|
|
||||||
|
If 'cdata' is a pointer to 'char', returns a byte string.
|
||||||
|
It does not stop at the first null. This is equivalent to:
|
||||||
|
ffi.buffer(cdata, length)[:]
|
||||||
|
|
||||||
|
If 'cdata' is a pointer to 'wchar_t', returns a unicode string.
|
||||||
|
'length' is measured in wchar_t's; it is not the size in bytes.
|
||||||
|
|
||||||
|
If 'cdata' is a pointer to anything else, returns a list of
|
||||||
|
'length' items. This is a faster equivalent to:
|
||||||
|
[cdata[i] for i in range(length)]
|
||||||
|
"""
|
||||||
|
return self._backend.unpack(cdata, length)
|
||||||
|
|
||||||
|
#def buffer(self, cdata, size=-1):
|
||||||
|
# """Return a read-write buffer object that references the raw C data
|
||||||
|
# pointed to by the given 'cdata'. The 'cdata' must be a pointer or
|
||||||
|
# an array. Can be passed to functions expecting a buffer, or directly
|
||||||
|
# manipulated with:
|
||||||
|
#
|
||||||
|
# buf[:] get a copy of it in a regular string, or
|
||||||
|
# buf[idx] as a single character
|
||||||
|
# buf[:] = ...
|
||||||
|
# buf[idx] = ... change the content
|
||||||
|
# """
|
||||||
|
# note that 'buffer' is a type, set on this instance by __init__
|
||||||
|
|
||||||
|
def from_buffer(self, cdecl, python_buffer=_unspecified,
|
||||||
|
require_writable=False):
|
||||||
|
"""Return a cdata of the given type pointing to the data of the
|
||||||
|
given Python object, which must support the buffer interface.
|
||||||
|
Note that this is not meant to be used on the built-in types
|
||||||
|
str or unicode (you can build 'char[]' arrays explicitly)
|
||||||
|
but only on objects containing large quantities of raw data
|
||||||
|
in some other format, like 'array.array' or numpy arrays.
|
||||||
|
|
||||||
|
The first argument is optional and default to 'char[]'.
|
||||||
|
"""
|
||||||
|
if python_buffer is _unspecified:
|
||||||
|
cdecl, python_buffer = self.BCharA, cdecl
|
||||||
|
elif isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl)
|
||||||
|
return self._backend.from_buffer(cdecl, python_buffer,
|
||||||
|
require_writable)
|
||||||
|
|
||||||
|
def memmove(self, dest, src, n):
|
||||||
|
"""ffi.memmove(dest, src, n) copies n bytes of memory from src to dest.
|
||||||
|
|
||||||
|
Like the C function memmove(), the memory areas may overlap;
|
||||||
|
apart from that it behaves like the C function memcpy().
|
||||||
|
|
||||||
|
'src' can be any cdata ptr or array, or any Python buffer object.
|
||||||
|
'dest' can be any cdata ptr or array, or a writable Python buffer
|
||||||
|
object. The size to copy, 'n', is always measured in bytes.
|
||||||
|
|
||||||
|
Unlike other methods, this one supports all Python buffer including
|
||||||
|
byte strings and bytearrays---but it still does not support
|
||||||
|
non-contiguous buffers.
|
||||||
|
"""
|
||||||
|
return self._backend.memmove(dest, src, n)
|
||||||
|
|
||||||
|
def callback(self, cdecl, python_callable=None, error=None, onerror=None):
|
||||||
|
"""Return a callback object or a decorator making such a
|
||||||
|
callback object. 'cdecl' must name a C function pointer type.
|
||||||
|
The callback invokes the specified 'python_callable' (which may
|
||||||
|
be provided either directly or via a decorator). Important: the
|
||||||
|
callback object must be manually kept alive for as long as the
|
||||||
|
callback may be invoked from the C level.
|
||||||
|
"""
|
||||||
|
def callback_decorator_wrap(python_callable):
|
||||||
|
if not callable(python_callable):
|
||||||
|
raise TypeError("the 'python_callable' argument "
|
||||||
|
"is not callable")
|
||||||
|
return self._backend.callback(cdecl, python_callable,
|
||||||
|
error, onerror)
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl, consider_function_as_funcptr=True)
|
||||||
|
if python_callable is None:
|
||||||
|
return callback_decorator_wrap # decorator mode
|
||||||
|
else:
|
||||||
|
return callback_decorator_wrap(python_callable) # direct mode
|
||||||
|
|
||||||
|
def getctype(self, cdecl, replace_with=''):
|
||||||
|
"""Return a string giving the C type 'cdecl', which may be itself
|
||||||
|
a string or a <ctype> object. If 'replace_with' is given, it gives
|
||||||
|
extra text to append (or insert for more complicated C types), like
|
||||||
|
a variable name, or '*' to get actually the C type 'pointer-to-cdecl'.
|
||||||
|
"""
|
||||||
|
if isinstance(cdecl, basestring):
|
||||||
|
cdecl = self._typeof(cdecl)
|
||||||
|
replace_with = replace_with.strip()
|
||||||
|
if (replace_with.startswith('*')
|
||||||
|
and '&[' in self._backend.getcname(cdecl, '&')):
|
||||||
|
replace_with = '(%s)' % replace_with
|
||||||
|
elif replace_with and not replace_with[0] in '[(':
|
||||||
|
replace_with = ' ' + replace_with
|
||||||
|
return self._backend.getcname(cdecl, replace_with)
|
||||||
|
|
||||||
|
def gc(self, cdata, destructor, size=0):
|
||||||
|
"""Return a new cdata object that points to the same
|
||||||
|
data. Later, when this new cdata object is garbage-collected,
|
||||||
|
'destructor(old_cdata_object)' will be called.
|
||||||
|
|
||||||
|
The optional 'size' gives an estimate of the size, used to
|
||||||
|
trigger the garbage collection more eagerly. So far only used
|
||||||
|
on PyPy. It tells the GC that the returned object keeps alive
|
||||||
|
roughly 'size' bytes of external memory.
|
||||||
|
"""
|
||||||
|
return self._backend.gcp(cdata, destructor, size)
|
||||||
|
|
||||||
|
def _get_cached_btype(self, type):
|
||||||
|
assert self._lock.acquire(False) is False
|
||||||
|
# call me with the lock!
|
||||||
|
try:
|
||||||
|
BType = self._cached_btypes[type]
|
||||||
|
except KeyError:
|
||||||
|
finishlist = []
|
||||||
|
BType = type.get_cached_btype(self, finishlist)
|
||||||
|
for type in finishlist:
|
||||||
|
type.finish_backend_type(self, finishlist)
|
||||||
|
return BType
|
||||||
|
|
||||||
|
def verify(self, source='', tmpdir=None, **kwargs):
|
||||||
|
"""Verify that the current ffi signatures compile on this
|
||||||
|
machine, and return a dynamic library object. The dynamic
|
||||||
|
library can be used to call functions and access global
|
||||||
|
variables declared in this 'ffi'. The library is compiled
|
||||||
|
by the C compiler: it gives you C-level API compatibility
|
||||||
|
(including calling macros). This is unlike 'ffi.dlopen()',
|
||||||
|
which requires binary compatibility in the signatures.
|
||||||
|
"""
|
||||||
|
from .verifier import Verifier, _caller_dir_pycache
|
||||||
|
#
|
||||||
|
# If set_unicode(True) was called, insert the UNICODE and
|
||||||
|
# _UNICODE macro declarations
|
||||||
|
if self._windows_unicode:
|
||||||
|
self._apply_windows_unicode(kwargs)
|
||||||
|
#
|
||||||
|
# Set the tmpdir here, and not in Verifier.__init__: it picks
|
||||||
|
# up the caller's directory, which we want to be the caller of
|
||||||
|
# ffi.verify(), as opposed to the caller of Veritier().
|
||||||
|
tmpdir = tmpdir or _caller_dir_pycache()
|
||||||
|
#
|
||||||
|
# Make a Verifier() and use it to load the library.
|
||||||
|
self.verifier = Verifier(self, source, tmpdir, **kwargs)
|
||||||
|
lib = self.verifier.load_library()
|
||||||
|
#
|
||||||
|
# Save the loaded library for keep-alive purposes, even
|
||||||
|
# if the caller doesn't keep it alive itself (it should).
|
||||||
|
self._libraries.append(lib)
|
||||||
|
return lib
|
||||||
|
|
||||||
|
def _get_errno(self):
|
||||||
|
return self._backend.get_errno()
|
||||||
|
def _set_errno(self, errno):
|
||||||
|
self._backend.set_errno(errno)
|
||||||
|
errno = property(_get_errno, _set_errno, None,
|
||||||
|
"the value of 'errno' from/to the C calls")
|
||||||
|
|
||||||
|
def getwinerror(self, code=-1):
|
||||||
|
return self._backend.getwinerror(code)
|
||||||
|
|
||||||
|
def _pointer_to(self, ctype):
|
||||||
|
with self._lock:
|
||||||
|
return model.pointer_cache(self, ctype)
|
||||||
|
|
||||||
|
def addressof(self, cdata, *fields_or_indexes):
|
||||||
|
"""Return the address of a <cdata 'struct-or-union'>.
|
||||||
|
If 'fields_or_indexes' are given, returns the address of that
|
||||||
|
field or array item in the structure or array, recursively in
|
||||||
|
case of nested structures.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
ctype = self._backend.typeof(cdata)
|
||||||
|
except TypeError:
|
||||||
|
if '__addressof__' in type(cdata).__dict__:
|
||||||
|
return type(cdata).__addressof__(cdata, *fields_or_indexes)
|
||||||
|
raise
|
||||||
|
if fields_or_indexes:
|
||||||
|
ctype, offset = self._typeoffsetof(ctype, *fields_or_indexes)
|
||||||
|
else:
|
||||||
|
if ctype.kind == "pointer":
|
||||||
|
raise TypeError("addressof(pointer)")
|
||||||
|
offset = 0
|
||||||
|
ctypeptr = self._pointer_to(ctype)
|
||||||
|
return self._backend.rawaddressof(ctypeptr, cdata, offset)
|
||||||
|
|
||||||
|
def _typeoffsetof(self, ctype, field_or_index, *fields_or_indexes):
|
||||||
|
ctype, offset = self._backend.typeoffsetof(ctype, field_or_index)
|
||||||
|
for field1 in fields_or_indexes:
|
||||||
|
ctype, offset1 = self._backend.typeoffsetof(ctype, field1, 1)
|
||||||
|
offset += offset1
|
||||||
|
return ctype, offset
|
||||||
|
|
||||||
|
def include(self, ffi_to_include):
|
||||||
|
"""Includes the typedefs, structs, unions and enums defined
|
||||||
|
in another FFI instance. Usage is similar to a #include in C,
|
||||||
|
where a part of the program might include types defined in
|
||||||
|
another part for its own usage. Note that the include()
|
||||||
|
method has no effect on functions, constants and global
|
||||||
|
variables, which must anyway be accessed directly from the
|
||||||
|
lib object returned by the original FFI instance.
|
||||||
|
"""
|
||||||
|
if not isinstance(ffi_to_include, FFI):
|
||||||
|
raise TypeError("ffi.include() expects an argument that is also of"
|
||||||
|
" type cffi.FFI, not %r" % (
|
||||||
|
type(ffi_to_include).__name__,))
|
||||||
|
if ffi_to_include is self:
|
||||||
|
raise ValueError("self.include(self)")
|
||||||
|
with ffi_to_include._lock:
|
||||||
|
with self._lock:
|
||||||
|
self._parser.include(ffi_to_include._parser)
|
||||||
|
self._cdefsources.append('[')
|
||||||
|
self._cdefsources.extend(ffi_to_include._cdefsources)
|
||||||
|
self._cdefsources.append(']')
|
||||||
|
self._included_ffis.append(ffi_to_include)
|
||||||
|
|
||||||
|
def new_handle(self, x):
|
||||||
|
return self._backend.newp_handle(self.BVoidP, x)
|
||||||
|
|
||||||
|
def from_handle(self, x):
|
||||||
|
return self._backend.from_handle(x)
|
||||||
|
|
||||||
|
def release(self, x):
|
||||||
|
self._backend.release(x)
|
||||||
|
|
||||||
|
def set_unicode(self, enabled_flag):
|
||||||
|
"""Windows: if 'enabled_flag' is True, enable the UNICODE and
|
||||||
|
_UNICODE defines in C, and declare the types like TCHAR and LPTCSTR
|
||||||
|
to be (pointers to) wchar_t. If 'enabled_flag' is False,
|
||||||
|
declare these types to be (pointers to) plain 8-bit characters.
|
||||||
|
This is mostly for backward compatibility; you usually want True.
|
||||||
|
"""
|
||||||
|
if self._windows_unicode is not None:
|
||||||
|
raise ValueError("set_unicode() can only be called once")
|
||||||
|
enabled_flag = bool(enabled_flag)
|
||||||
|
if enabled_flag:
|
||||||
|
self.cdef("typedef wchar_t TBYTE;"
|
||||||
|
"typedef wchar_t TCHAR;"
|
||||||
|
"typedef const wchar_t *LPCTSTR;"
|
||||||
|
"typedef const wchar_t *PCTSTR;"
|
||||||
|
"typedef wchar_t *LPTSTR;"
|
||||||
|
"typedef wchar_t *PTSTR;"
|
||||||
|
"typedef TBYTE *PTBYTE;"
|
||||||
|
"typedef TCHAR *PTCHAR;")
|
||||||
|
else:
|
||||||
|
self.cdef("typedef char TBYTE;"
|
||||||
|
"typedef char TCHAR;"
|
||||||
|
"typedef const char *LPCTSTR;"
|
||||||
|
"typedef const char *PCTSTR;"
|
||||||
|
"typedef char *LPTSTR;"
|
||||||
|
"typedef char *PTSTR;"
|
||||||
|
"typedef TBYTE *PTBYTE;"
|
||||||
|
"typedef TCHAR *PTCHAR;")
|
||||||
|
self._windows_unicode = enabled_flag
|
||||||
|
|
||||||
|
def _apply_windows_unicode(self, kwds):
|
||||||
|
defmacros = kwds.get('define_macros', ())
|
||||||
|
if not isinstance(defmacros, (list, tuple)):
|
||||||
|
raise TypeError("'define_macros' must be a list or tuple")
|
||||||
|
defmacros = list(defmacros) + [('UNICODE', '1'),
|
||||||
|
('_UNICODE', '1')]
|
||||||
|
kwds['define_macros'] = defmacros
|
||||||
|
|
||||||
|
def _apply_embedding_fix(self, kwds):
|
||||||
|
# must include an argument like "-lpython2.7" for the compiler
|
||||||
|
def ensure(key, value):
|
||||||
|
lst = kwds.setdefault(key, [])
|
||||||
|
if value not in lst:
|
||||||
|
lst.append(value)
|
||||||
|
#
|
||||||
|
if '__pypy__' in sys.builtin_module_names:
|
||||||
|
import os
|
||||||
|
if sys.platform == "win32":
|
||||||
|
# we need 'libpypy-c.lib'. Current distributions of
|
||||||
|
# pypy (>= 4.1) contain it as 'libs/python27.lib'.
|
||||||
|
pythonlib = "python{0[0]}{0[1]}".format(sys.version_info)
|
||||||
|
if hasattr(sys, 'prefix'):
|
||||||
|
ensure('library_dirs', os.path.join(sys.prefix, 'libs'))
|
||||||
|
else:
|
||||||
|
# we need 'libpypy-c.{so,dylib}', which should be by
|
||||||
|
# default located in 'sys.prefix/bin' for installed
|
||||||
|
# systems.
|
||||||
|
if sys.version_info < (3,):
|
||||||
|
pythonlib = "pypy-c"
|
||||||
|
else:
|
||||||
|
pythonlib = "pypy3-c"
|
||||||
|
if hasattr(sys, 'prefix'):
|
||||||
|
ensure('library_dirs', os.path.join(sys.prefix, 'bin'))
|
||||||
|
# On uninstalled pypy's, the libpypy-c is typically found in
|
||||||
|
# .../pypy/goal/.
|
||||||
|
if hasattr(sys, 'prefix'):
|
||||||
|
ensure('library_dirs', os.path.join(sys.prefix, 'pypy', 'goal'))
|
||||||
|
else:
|
||||||
|
if sys.platform == "win32":
|
||||||
|
template = "python%d%d"
|
||||||
|
if hasattr(sys, 'gettotalrefcount'):
|
||||||
|
template += '_d'
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
import sysconfig
|
||||||
|
except ImportError: # 2.6
|
||||||
|
from cffi._shimmed_dist_utils import sysconfig
|
||||||
|
template = "python%d.%d"
|
||||||
|
if sysconfig.get_config_var('DEBUG_EXT'):
|
||||||
|
template += sysconfig.get_config_var('DEBUG_EXT')
|
||||||
|
pythonlib = (template %
|
||||||
|
(sys.hexversion >> 24, (sys.hexversion >> 16) & 0xff))
|
||||||
|
if hasattr(sys, 'abiflags'):
|
||||||
|
pythonlib += sys.abiflags
|
||||||
|
ensure('libraries', pythonlib)
|
||||||
|
if sys.platform == "win32":
|
||||||
|
ensure('extra_link_args', '/MANIFEST')
|
||||||
|
|
||||||
|
def set_source(self, module_name, source, source_extension='.c', **kwds):
|
||||||
|
import os
|
||||||
|
if hasattr(self, '_assigned_source'):
|
||||||
|
raise ValueError("set_source() cannot be called several times "
|
||||||
|
"per ffi object")
|
||||||
|
if not isinstance(module_name, basestring):
|
||||||
|
raise TypeError("'module_name' must be a string")
|
||||||
|
if os.sep in module_name or (os.altsep and os.altsep in module_name):
|
||||||
|
raise ValueError("'module_name' must not contain '/': use a dotted "
|
||||||
|
"name to make a 'package.module' location")
|
||||||
|
self._assigned_source = (str(module_name), source,
|
||||||
|
source_extension, kwds)
|
||||||
|
|
||||||
|
def set_source_pkgconfig(self, module_name, pkgconfig_libs, source,
|
||||||
|
source_extension='.c', **kwds):
|
||||||
|
from . import pkgconfig
|
||||||
|
if not isinstance(pkgconfig_libs, list):
|
||||||
|
raise TypeError("the pkgconfig_libs argument must be a list "
|
||||||
|
"of package names")
|
||||||
|
kwds2 = pkgconfig.flags_from_pkgconfig(pkgconfig_libs)
|
||||||
|
pkgconfig.merge_flags(kwds, kwds2)
|
||||||
|
self.set_source(module_name, source, source_extension, **kwds)
|
||||||
|
|
||||||
|
def distutils_extension(self, tmpdir='build', verbose=True):
|
||||||
|
from cffi._shimmed_dist_utils import mkpath
|
||||||
|
from .recompiler import recompile
|
||||||
|
#
|
||||||
|
if not hasattr(self, '_assigned_source'):
|
||||||
|
if hasattr(self, 'verifier'): # fallback, 'tmpdir' ignored
|
||||||
|
return self.verifier.get_extension()
|
||||||
|
raise ValueError("set_source() must be called before"
|
||||||
|
" distutils_extension()")
|
||||||
|
module_name, source, source_extension, kwds = self._assigned_source
|
||||||
|
if source is None:
|
||||||
|
raise TypeError("distutils_extension() is only for C extension "
|
||||||
|
"modules, not for dlopen()-style pure Python "
|
||||||
|
"modules")
|
||||||
|
mkpath(tmpdir)
|
||||||
|
ext, updated = recompile(self, module_name,
|
||||||
|
source, tmpdir=tmpdir, extradir=tmpdir,
|
||||||
|
source_extension=source_extension,
|
||||||
|
call_c_compiler=False, **kwds)
|
||||||
|
if verbose:
|
||||||
|
if updated:
|
||||||
|
sys.stderr.write("regenerated: %r\n" % (ext.sources[0],))
|
||||||
|
else:
|
||||||
|
sys.stderr.write("not modified: %r\n" % (ext.sources[0],))
|
||||||
|
return ext
|
||||||
|
|
||||||
|
def emit_c_code(self, filename):
|
||||||
|
from .recompiler import recompile
|
||||||
|
#
|
||||||
|
if not hasattr(self, '_assigned_source'):
|
||||||
|
raise ValueError("set_source() must be called before emit_c_code()")
|
||||||
|
module_name, source, source_extension, kwds = self._assigned_source
|
||||||
|
if source is None:
|
||||||
|
raise TypeError("emit_c_code() is only for C extension modules, "
|
||||||
|
"not for dlopen()-style pure Python modules")
|
||||||
|
recompile(self, module_name, source,
|
||||||
|
c_file=filename, call_c_compiler=False,
|
||||||
|
uses_ffiplatform=False, **kwds)
|
||||||
|
|
||||||
|
def emit_python_code(self, filename):
|
||||||
|
from .recompiler import recompile
|
||||||
|
#
|
||||||
|
if not hasattr(self, '_assigned_source'):
|
||||||
|
raise ValueError("set_source() must be called before emit_c_code()")
|
||||||
|
module_name, source, source_extension, kwds = self._assigned_source
|
||||||
|
if source is not None:
|
||||||
|
raise TypeError("emit_python_code() is only for dlopen()-style "
|
||||||
|
"pure Python modules, not for C extension modules")
|
||||||
|
recompile(self, module_name, source,
|
||||||
|
c_file=filename, call_c_compiler=False,
|
||||||
|
uses_ffiplatform=False, **kwds)
|
||||||
|
|
||||||
|
def compile(self, tmpdir='.', verbose=0, target=None, debug=None):
|
||||||
|
"""The 'target' argument gives the final file name of the
|
||||||
|
compiled DLL. Use '*' to force distutils' choice, suitable for
|
||||||
|
regular CPython C API modules. Use a file name ending in '.*'
|
||||||
|
to ask for the system's default extension for dynamic libraries
|
||||||
|
(.so/.dll/.dylib).
|
||||||
|
|
||||||
|
The default is '*' when building a non-embedded C API extension,
|
||||||
|
and (module_name + '.*') when building an embedded library.
|
||||||
|
"""
|
||||||
|
from .recompiler import recompile
|
||||||
|
#
|
||||||
|
if not hasattr(self, '_assigned_source'):
|
||||||
|
raise ValueError("set_source() must be called before compile()")
|
||||||
|
module_name, source, source_extension, kwds = self._assigned_source
|
||||||
|
return recompile(self, module_name, source, tmpdir=tmpdir,
|
||||||
|
target=target, source_extension=source_extension,
|
||||||
|
compiler_verbose=verbose, debug=debug, **kwds)
|
||||||
|
|
||||||
|
def init_once(self, func, tag):
|
||||||
|
# Read _init_once_cache[tag], which is either (False, lock) if
|
||||||
|
# we're calling the function now in some thread, or (True, result).
|
||||||
|
# Don't call setdefault() in most cases, to avoid allocating and
|
||||||
|
# immediately freeing a lock; but still use setdefaut() to avoid
|
||||||
|
# races.
|
||||||
|
try:
|
||||||
|
x = self._init_once_cache[tag]
|
||||||
|
except KeyError:
|
||||||
|
x = self._init_once_cache.setdefault(tag, (False, allocate_lock()))
|
||||||
|
# Common case: we got (True, result), so we return the result.
|
||||||
|
if x[0]:
|
||||||
|
return x[1]
|
||||||
|
# Else, it's a lock. Acquire it to serialize the following tests.
|
||||||
|
with x[1]:
|
||||||
|
# Read again from _init_once_cache the current status.
|
||||||
|
x = self._init_once_cache[tag]
|
||||||
|
if x[0]:
|
||||||
|
return x[1]
|
||||||
|
# Call the function and store the result back.
|
||||||
|
result = func()
|
||||||
|
self._init_once_cache[tag] = (True, result)
|
||||||
|
return result
|
||||||
|
|
||||||
|
def embedding_init_code(self, pysource):
|
||||||
|
if self._embedding:
|
||||||
|
raise ValueError("embedding_init_code() can only be called once")
|
||||||
|
# fix 'pysource' before it gets dumped into the C file:
|
||||||
|
# - remove empty lines at the beginning, so it starts at "line 1"
|
||||||
|
# - dedent, if all non-empty lines are indented
|
||||||
|
# - check for SyntaxErrors
|
||||||
|
import re
|
||||||
|
match = re.match(r'\s*\n', pysource)
|
||||||
|
if match:
|
||||||
|
pysource = pysource[match.end():]
|
||||||
|
lines = pysource.splitlines() or ['']
|
||||||
|
prefix = re.match(r'\s*', lines[0]).group()
|
||||||
|
for i in range(1, len(lines)):
|
||||||
|
line = lines[i]
|
||||||
|
if line.rstrip():
|
||||||
|
while not line.startswith(prefix):
|
||||||
|
prefix = prefix[:-1]
|
||||||
|
i = len(prefix)
|
||||||
|
lines = [line[i:]+'\n' for line in lines]
|
||||||
|
pysource = ''.join(lines)
|
||||||
|
#
|
||||||
|
compile(pysource, "cffi_init", "exec")
|
||||||
|
#
|
||||||
|
self._embedding = pysource
|
||||||
|
|
||||||
|
def def_extern(self, *args, **kwds):
|
||||||
|
raise ValueError("ffi.def_extern() is only available on API-mode FFI "
|
||||||
|
"objects")
|
||||||
|
|
||||||
|
def list_types(self):
|
||||||
|
"""Returns the user type names known to this FFI instance.
|
||||||
|
This returns a tuple containing three lists of names:
|
||||||
|
(typedef_names, names_of_structs, names_of_unions)
|
||||||
|
"""
|
||||||
|
typedefs = []
|
||||||
|
structs = []
|
||||||
|
unions = []
|
||||||
|
for key in self._parser._declarations:
|
||||||
|
if key.startswith('typedef '):
|
||||||
|
typedefs.append(key[8:])
|
||||||
|
elif key.startswith('struct '):
|
||||||
|
structs.append(key[7:])
|
||||||
|
elif key.startswith('union '):
|
||||||
|
unions.append(key[6:])
|
||||||
|
typedefs.sort()
|
||||||
|
structs.sort()
|
||||||
|
unions.sort()
|
||||||
|
return (typedefs, structs, unions)
|
||||||
|
|
||||||
|
|
||||||
|
def _load_backend_lib(backend, name, flags):
|
||||||
|
import os
|
||||||
|
if not isinstance(name, basestring):
|
||||||
|
if sys.platform != "win32" or name is not None:
|
||||||
|
return backend.load_library(name, flags)
|
||||||
|
name = "c" # Windows: load_library(None) fails, but this works
|
||||||
|
# on Python 2 (backward compatibility hack only)
|
||||||
|
first_error = None
|
||||||
|
if '.' in name or '/' in name or os.sep in name:
|
||||||
|
try:
|
||||||
|
return backend.load_library(name, flags)
|
||||||
|
except OSError as e:
|
||||||
|
first_error = e
|
||||||
|
import ctypes.util
|
||||||
|
path = ctypes.util.find_library(name)
|
||||||
|
if path is None:
|
||||||
|
if name == "c" and sys.platform == "win32" and sys.version_info >= (3,):
|
||||||
|
raise OSError("dlopen(None) cannot work on Windows for Python 3 "
|
||||||
|
"(see http://bugs.python.org/issue23606)")
|
||||||
|
msg = ("ctypes.util.find_library() did not manage "
|
||||||
|
"to locate a library called %r" % (name,))
|
||||||
|
if first_error is not None:
|
||||||
|
msg = "%s. Additionally, %s" % (first_error, msg)
|
||||||
|
raise OSError(msg)
|
||||||
|
return backend.load_library(path, flags)
|
||||||
|
|
||||||
|
def _make_ffi_library(ffi, libname, flags):
|
||||||
|
backend = ffi._backend
|
||||||
|
backendlib = _load_backend_lib(backend, libname, flags)
|
||||||
|
#
|
||||||
|
def accessor_function(name):
|
||||||
|
key = 'function ' + name
|
||||||
|
tp, _ = ffi._parser._declarations[key]
|
||||||
|
BType = ffi._get_cached_btype(tp)
|
||||||
|
value = backendlib.load_function(BType, name)
|
||||||
|
library.__dict__[name] = value
|
||||||
|
#
|
||||||
|
def accessor_variable(name):
|
||||||
|
key = 'variable ' + name
|
||||||
|
tp, _ = ffi._parser._declarations[key]
|
||||||
|
BType = ffi._get_cached_btype(tp)
|
||||||
|
read_variable = backendlib.read_variable
|
||||||
|
write_variable = backendlib.write_variable
|
||||||
|
setattr(FFILibrary, name, property(
|
||||||
|
lambda self: read_variable(BType, name),
|
||||||
|
lambda self, value: write_variable(BType, name, value)))
|
||||||
|
#
|
||||||
|
def addressof_var(name):
|
||||||
|
try:
|
||||||
|
return addr_variables[name]
|
||||||
|
except KeyError:
|
||||||
|
with ffi._lock:
|
||||||
|
if name not in addr_variables:
|
||||||
|
key = 'variable ' + name
|
||||||
|
tp, _ = ffi._parser._declarations[key]
|
||||||
|
BType = ffi._get_cached_btype(tp)
|
||||||
|
if BType.kind != 'array':
|
||||||
|
BType = model.pointer_cache(ffi, BType)
|
||||||
|
p = backendlib.load_function(BType, name)
|
||||||
|
addr_variables[name] = p
|
||||||
|
return addr_variables[name]
|
||||||
|
#
|
||||||
|
def accessor_constant(name):
|
||||||
|
raise NotImplementedError("non-integer constant '%s' cannot be "
|
||||||
|
"accessed from a dlopen() library" % (name,))
|
||||||
|
#
|
||||||
|
def accessor_int_constant(name):
|
||||||
|
library.__dict__[name] = ffi._parser._int_constants[name]
|
||||||
|
#
|
||||||
|
accessors = {}
|
||||||
|
accessors_version = [False]
|
||||||
|
addr_variables = {}
|
||||||
|
#
|
||||||
|
def update_accessors():
|
||||||
|
if accessors_version[0] is ffi._cdef_version:
|
||||||
|
return
|
||||||
|
#
|
||||||
|
for key, (tp, _) in ffi._parser._declarations.items():
|
||||||
|
if not isinstance(tp, model.EnumType):
|
||||||
|
tag, name = key.split(' ', 1)
|
||||||
|
if tag == 'function':
|
||||||
|
accessors[name] = accessor_function
|
||||||
|
elif tag == 'variable':
|
||||||
|
accessors[name] = accessor_variable
|
||||||
|
elif tag == 'constant':
|
||||||
|
accessors[name] = accessor_constant
|
||||||
|
else:
|
||||||
|
for i, enumname in enumerate(tp.enumerators):
|
||||||
|
def accessor_enum(name, tp=tp, i=i):
|
||||||
|
tp.check_not_partial()
|
||||||
|
library.__dict__[name] = tp.enumvalues[i]
|
||||||
|
accessors[enumname] = accessor_enum
|
||||||
|
for name in ffi._parser._int_constants:
|
||||||
|
accessors.setdefault(name, accessor_int_constant)
|
||||||
|
accessors_version[0] = ffi._cdef_version
|
||||||
|
#
|
||||||
|
def make_accessor(name):
|
||||||
|
with ffi._lock:
|
||||||
|
if name in library.__dict__ or name in FFILibrary.__dict__:
|
||||||
|
return # added by another thread while waiting for the lock
|
||||||
|
if name not in accessors:
|
||||||
|
update_accessors()
|
||||||
|
if name not in accessors:
|
||||||
|
raise AttributeError(name)
|
||||||
|
accessors[name](name)
|
||||||
|
#
|
||||||
|
class FFILibrary(object):
|
||||||
|
def __getattr__(self, name):
|
||||||
|
make_accessor(name)
|
||||||
|
return getattr(self, name)
|
||||||
|
def __setattr__(self, name, value):
|
||||||
|
try:
|
||||||
|
property = getattr(self.__class__, name)
|
||||||
|
except AttributeError:
|
||||||
|
make_accessor(name)
|
||||||
|
setattr(self, name, value)
|
||||||
|
else:
|
||||||
|
property.__set__(self, value)
|
||||||
|
def __dir__(self):
|
||||||
|
with ffi._lock:
|
||||||
|
update_accessors()
|
||||||
|
return accessors.keys()
|
||||||
|
def __addressof__(self, name):
|
||||||
|
if name in library.__dict__:
|
||||||
|
return library.__dict__[name]
|
||||||
|
if name in FFILibrary.__dict__:
|
||||||
|
return addressof_var(name)
|
||||||
|
make_accessor(name)
|
||||||
|
if name in library.__dict__:
|
||||||
|
return library.__dict__[name]
|
||||||
|
if name in FFILibrary.__dict__:
|
||||||
|
return addressof_var(name)
|
||||||
|
raise AttributeError("cffi library has no function or "
|
||||||
|
"global variable named '%s'" % (name,))
|
||||||
|
def __cffi_close__(self):
|
||||||
|
backendlib.close_lib()
|
||||||
|
self.__dict__.clear()
|
||||||
|
#
|
||||||
|
if isinstance(libname, basestring):
|
||||||
|
try:
|
||||||
|
if not isinstance(libname, str): # unicode, on Python 2
|
||||||
|
libname = libname.encode('utf-8')
|
||||||
|
FFILibrary.__name__ = 'FFILibrary_%s' % libname
|
||||||
|
except UnicodeError:
|
||||||
|
pass
|
||||||
|
library = FFILibrary()
|
||||||
|
return library, library.__dict__
|
||||||
|
|
||||||
|
def _builtin_function_type(func):
|
||||||
|
# a hack to make at least ffi.typeof(builtin_function) work,
|
||||||
|
# if the builtin function was obtained by 'vengine_cpy'.
|
||||||
|
import sys
|
||||||
|
try:
|
||||||
|
module = sys.modules[func.__module__]
|
||||||
|
ffi = module._cffi_original_ffi
|
||||||
|
types_of_builtin_funcs = module._cffi_types_of_builtin_funcs
|
||||||
|
tp = types_of_builtin_funcs[func]
|
||||||
|
except (KeyError, AttributeError, TypeError):
|
||||||
|
return None
|
||||||
|
else:
|
||||||
|
with ffi._lock:
|
||||||
|
return ffi._get_cached_btype(tp)
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,187 @@
|
||||||
|
from .error import VerificationError
|
||||||
|
|
||||||
|
class CffiOp(object):
|
||||||
|
def __init__(self, op, arg):
|
||||||
|
self.op = op
|
||||||
|
self.arg = arg
|
||||||
|
|
||||||
|
def as_c_expr(self):
|
||||||
|
if self.op is None:
|
||||||
|
assert isinstance(self.arg, str)
|
||||||
|
return '(_cffi_opcode_t)(%s)' % (self.arg,)
|
||||||
|
classname = CLASS_NAME[self.op]
|
||||||
|
return '_CFFI_OP(_CFFI_OP_%s, %s)' % (classname, self.arg)
|
||||||
|
|
||||||
|
def as_python_bytes(self):
|
||||||
|
if self.op is None and self.arg.isdigit():
|
||||||
|
value = int(self.arg) # non-negative: '-' not in self.arg
|
||||||
|
if value >= 2**31:
|
||||||
|
raise OverflowError("cannot emit %r: limited to 2**31-1"
|
||||||
|
% (self.arg,))
|
||||||
|
return format_four_bytes(value)
|
||||||
|
if isinstance(self.arg, str):
|
||||||
|
raise VerificationError("cannot emit to Python: %r" % (self.arg,))
|
||||||
|
return format_four_bytes((self.arg << 8) | self.op)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
classname = CLASS_NAME.get(self.op, self.op)
|
||||||
|
return '(%s %s)' % (classname, self.arg)
|
||||||
|
|
||||||
|
def format_four_bytes(num):
|
||||||
|
return '\\x%02X\\x%02X\\x%02X\\x%02X' % (
|
||||||
|
(num >> 24) & 0xFF,
|
||||||
|
(num >> 16) & 0xFF,
|
||||||
|
(num >> 8) & 0xFF,
|
||||||
|
(num ) & 0xFF)
|
||||||
|
|
||||||
|
OP_PRIMITIVE = 1
|
||||||
|
OP_POINTER = 3
|
||||||
|
OP_ARRAY = 5
|
||||||
|
OP_OPEN_ARRAY = 7
|
||||||
|
OP_STRUCT_UNION = 9
|
||||||
|
OP_ENUM = 11
|
||||||
|
OP_FUNCTION = 13
|
||||||
|
OP_FUNCTION_END = 15
|
||||||
|
OP_NOOP = 17
|
||||||
|
OP_BITFIELD = 19
|
||||||
|
OP_TYPENAME = 21
|
||||||
|
OP_CPYTHON_BLTN_V = 23 # varargs
|
||||||
|
OP_CPYTHON_BLTN_N = 25 # noargs
|
||||||
|
OP_CPYTHON_BLTN_O = 27 # O (i.e. a single arg)
|
||||||
|
OP_CONSTANT = 29
|
||||||
|
OP_CONSTANT_INT = 31
|
||||||
|
OP_GLOBAL_VAR = 33
|
||||||
|
OP_DLOPEN_FUNC = 35
|
||||||
|
OP_DLOPEN_CONST = 37
|
||||||
|
OP_GLOBAL_VAR_F = 39
|
||||||
|
OP_EXTERN_PYTHON = 41
|
||||||
|
|
||||||
|
PRIM_VOID = 0
|
||||||
|
PRIM_BOOL = 1
|
||||||
|
PRIM_CHAR = 2
|
||||||
|
PRIM_SCHAR = 3
|
||||||
|
PRIM_UCHAR = 4
|
||||||
|
PRIM_SHORT = 5
|
||||||
|
PRIM_USHORT = 6
|
||||||
|
PRIM_INT = 7
|
||||||
|
PRIM_UINT = 8
|
||||||
|
PRIM_LONG = 9
|
||||||
|
PRIM_ULONG = 10
|
||||||
|
PRIM_LONGLONG = 11
|
||||||
|
PRIM_ULONGLONG = 12
|
||||||
|
PRIM_FLOAT = 13
|
||||||
|
PRIM_DOUBLE = 14
|
||||||
|
PRIM_LONGDOUBLE = 15
|
||||||
|
|
||||||
|
PRIM_WCHAR = 16
|
||||||
|
PRIM_INT8 = 17
|
||||||
|
PRIM_UINT8 = 18
|
||||||
|
PRIM_INT16 = 19
|
||||||
|
PRIM_UINT16 = 20
|
||||||
|
PRIM_INT32 = 21
|
||||||
|
PRIM_UINT32 = 22
|
||||||
|
PRIM_INT64 = 23
|
||||||
|
PRIM_UINT64 = 24
|
||||||
|
PRIM_INTPTR = 25
|
||||||
|
PRIM_UINTPTR = 26
|
||||||
|
PRIM_PTRDIFF = 27
|
||||||
|
PRIM_SIZE = 28
|
||||||
|
PRIM_SSIZE = 29
|
||||||
|
PRIM_INT_LEAST8 = 30
|
||||||
|
PRIM_UINT_LEAST8 = 31
|
||||||
|
PRIM_INT_LEAST16 = 32
|
||||||
|
PRIM_UINT_LEAST16 = 33
|
||||||
|
PRIM_INT_LEAST32 = 34
|
||||||
|
PRIM_UINT_LEAST32 = 35
|
||||||
|
PRIM_INT_LEAST64 = 36
|
||||||
|
PRIM_UINT_LEAST64 = 37
|
||||||
|
PRIM_INT_FAST8 = 38
|
||||||
|
PRIM_UINT_FAST8 = 39
|
||||||
|
PRIM_INT_FAST16 = 40
|
||||||
|
PRIM_UINT_FAST16 = 41
|
||||||
|
PRIM_INT_FAST32 = 42
|
||||||
|
PRIM_UINT_FAST32 = 43
|
||||||
|
PRIM_INT_FAST64 = 44
|
||||||
|
PRIM_UINT_FAST64 = 45
|
||||||
|
PRIM_INTMAX = 46
|
||||||
|
PRIM_UINTMAX = 47
|
||||||
|
PRIM_FLOATCOMPLEX = 48
|
||||||
|
PRIM_DOUBLECOMPLEX = 49
|
||||||
|
PRIM_CHAR16 = 50
|
||||||
|
PRIM_CHAR32 = 51
|
||||||
|
|
||||||
|
_NUM_PRIM = 52
|
||||||
|
_UNKNOWN_PRIM = -1
|
||||||
|
_UNKNOWN_FLOAT_PRIM = -2
|
||||||
|
_UNKNOWN_LONG_DOUBLE = -3
|
||||||
|
|
||||||
|
_IO_FILE_STRUCT = -1
|
||||||
|
|
||||||
|
PRIMITIVE_TO_INDEX = {
|
||||||
|
'char': PRIM_CHAR,
|
||||||
|
'short': PRIM_SHORT,
|
||||||
|
'int': PRIM_INT,
|
||||||
|
'long': PRIM_LONG,
|
||||||
|
'long long': PRIM_LONGLONG,
|
||||||
|
'signed char': PRIM_SCHAR,
|
||||||
|
'unsigned char': PRIM_UCHAR,
|
||||||
|
'unsigned short': PRIM_USHORT,
|
||||||
|
'unsigned int': PRIM_UINT,
|
||||||
|
'unsigned long': PRIM_ULONG,
|
||||||
|
'unsigned long long': PRIM_ULONGLONG,
|
||||||
|
'float': PRIM_FLOAT,
|
||||||
|
'double': PRIM_DOUBLE,
|
||||||
|
'long double': PRIM_LONGDOUBLE,
|
||||||
|
'_cffi_float_complex_t': PRIM_FLOATCOMPLEX,
|
||||||
|
'_cffi_double_complex_t': PRIM_DOUBLECOMPLEX,
|
||||||
|
'_Bool': PRIM_BOOL,
|
||||||
|
'wchar_t': PRIM_WCHAR,
|
||||||
|
'char16_t': PRIM_CHAR16,
|
||||||
|
'char32_t': PRIM_CHAR32,
|
||||||
|
'int8_t': PRIM_INT8,
|
||||||
|
'uint8_t': PRIM_UINT8,
|
||||||
|
'int16_t': PRIM_INT16,
|
||||||
|
'uint16_t': PRIM_UINT16,
|
||||||
|
'int32_t': PRIM_INT32,
|
||||||
|
'uint32_t': PRIM_UINT32,
|
||||||
|
'int64_t': PRIM_INT64,
|
||||||
|
'uint64_t': PRIM_UINT64,
|
||||||
|
'intptr_t': PRIM_INTPTR,
|
||||||
|
'uintptr_t': PRIM_UINTPTR,
|
||||||
|
'ptrdiff_t': PRIM_PTRDIFF,
|
||||||
|
'size_t': PRIM_SIZE,
|
||||||
|
'ssize_t': PRIM_SSIZE,
|
||||||
|
'int_least8_t': PRIM_INT_LEAST8,
|
||||||
|
'uint_least8_t': PRIM_UINT_LEAST8,
|
||||||
|
'int_least16_t': PRIM_INT_LEAST16,
|
||||||
|
'uint_least16_t': PRIM_UINT_LEAST16,
|
||||||
|
'int_least32_t': PRIM_INT_LEAST32,
|
||||||
|
'uint_least32_t': PRIM_UINT_LEAST32,
|
||||||
|
'int_least64_t': PRIM_INT_LEAST64,
|
||||||
|
'uint_least64_t': PRIM_UINT_LEAST64,
|
||||||
|
'int_fast8_t': PRIM_INT_FAST8,
|
||||||
|
'uint_fast8_t': PRIM_UINT_FAST8,
|
||||||
|
'int_fast16_t': PRIM_INT_FAST16,
|
||||||
|
'uint_fast16_t': PRIM_UINT_FAST16,
|
||||||
|
'int_fast32_t': PRIM_INT_FAST32,
|
||||||
|
'uint_fast32_t': PRIM_UINT_FAST32,
|
||||||
|
'int_fast64_t': PRIM_INT_FAST64,
|
||||||
|
'uint_fast64_t': PRIM_UINT_FAST64,
|
||||||
|
'intmax_t': PRIM_INTMAX,
|
||||||
|
'uintmax_t': PRIM_UINTMAX,
|
||||||
|
}
|
||||||
|
|
||||||
|
F_UNION = 0x01
|
||||||
|
F_CHECK_FIELDS = 0x02
|
||||||
|
F_PACKED = 0x04
|
||||||
|
F_EXTERNAL = 0x08
|
||||||
|
F_OPAQUE = 0x10
|
||||||
|
|
||||||
|
G_FLAGS = dict([('_CFFI_' + _key, globals()[_key])
|
||||||
|
for _key in ['F_UNION', 'F_CHECK_FIELDS', 'F_PACKED',
|
||||||
|
'F_EXTERNAL', 'F_OPAQUE']])
|
||||||
|
|
||||||
|
CLASS_NAME = {}
|
||||||
|
for _name, _value in list(globals().items()):
|
||||||
|
if _name.startswith('OP_') and isinstance(_value, int):
|
||||||
|
CLASS_NAME[_value] = _name[3:]
|
||||||
|
|
@ -0,0 +1,82 @@
|
||||||
|
import sys
|
||||||
|
from . import model
|
||||||
|
from .error import FFIError
|
||||||
|
|
||||||
|
|
||||||
|
COMMON_TYPES = {}
|
||||||
|
|
||||||
|
try:
|
||||||
|
# fetch "bool" and all simple Windows types
|
||||||
|
from _cffi_backend import _get_common_types
|
||||||
|
_get_common_types(COMMON_TYPES)
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
COMMON_TYPES['FILE'] = model.unknown_type('FILE', '_IO_FILE')
|
||||||
|
COMMON_TYPES['bool'] = '_Bool' # in case we got ImportError above
|
||||||
|
COMMON_TYPES['float _Complex'] = '_cffi_float_complex_t'
|
||||||
|
COMMON_TYPES['double _Complex'] = '_cffi_double_complex_t'
|
||||||
|
|
||||||
|
for _type in model.PrimitiveType.ALL_PRIMITIVE_TYPES:
|
||||||
|
if _type.endswith('_t'):
|
||||||
|
COMMON_TYPES[_type] = _type
|
||||||
|
del _type
|
||||||
|
|
||||||
|
_CACHE = {}
|
||||||
|
|
||||||
|
def resolve_common_type(parser, commontype):
|
||||||
|
try:
|
||||||
|
return _CACHE[commontype]
|
||||||
|
except KeyError:
|
||||||
|
cdecl = COMMON_TYPES.get(commontype, commontype)
|
||||||
|
if not isinstance(cdecl, str):
|
||||||
|
result, quals = cdecl, 0 # cdecl is already a BaseType
|
||||||
|
elif cdecl in model.PrimitiveType.ALL_PRIMITIVE_TYPES:
|
||||||
|
result, quals = model.PrimitiveType(cdecl), 0
|
||||||
|
elif cdecl == 'set-unicode-needed':
|
||||||
|
raise FFIError("The Windows type %r is only available after "
|
||||||
|
"you call ffi.set_unicode()" % (commontype,))
|
||||||
|
else:
|
||||||
|
if commontype == cdecl:
|
||||||
|
raise FFIError(
|
||||||
|
"Unsupported type: %r. Please look at "
|
||||||
|
"http://cffi.readthedocs.io/en/latest/cdef.html#ffi-cdef-limitations "
|
||||||
|
"and file an issue if you think this type should really "
|
||||||
|
"be supported." % (commontype,))
|
||||||
|
result, quals = parser.parse_type_and_quals(cdecl) # recursive
|
||||||
|
|
||||||
|
assert isinstance(result, model.BaseTypeByIdentity)
|
||||||
|
_CACHE[commontype] = result, quals
|
||||||
|
return result, quals
|
||||||
|
|
||||||
|
|
||||||
|
# ____________________________________________________________
|
||||||
|
# extra types for Windows (most of them are in commontypes.c)
|
||||||
|
|
||||||
|
|
||||||
|
def win_common_types():
|
||||||
|
return {
|
||||||
|
"UNICODE_STRING": model.StructType(
|
||||||
|
"_UNICODE_STRING",
|
||||||
|
["Length",
|
||||||
|
"MaximumLength",
|
||||||
|
"Buffer"],
|
||||||
|
[model.PrimitiveType("unsigned short"),
|
||||||
|
model.PrimitiveType("unsigned short"),
|
||||||
|
model.PointerType(model.PrimitiveType("wchar_t"))],
|
||||||
|
[-1, -1, -1]),
|
||||||
|
"PUNICODE_STRING": "UNICODE_STRING *",
|
||||||
|
"PCUNICODE_STRING": "const UNICODE_STRING *",
|
||||||
|
|
||||||
|
"TBYTE": "set-unicode-needed",
|
||||||
|
"TCHAR": "set-unicode-needed",
|
||||||
|
"LPCTSTR": "set-unicode-needed",
|
||||||
|
"PCTSTR": "set-unicode-needed",
|
||||||
|
"LPTSTR": "set-unicode-needed",
|
||||||
|
"PTSTR": "set-unicode-needed",
|
||||||
|
"PTBYTE": "set-unicode-needed",
|
||||||
|
"PTCHAR": "set-unicode-needed",
|
||||||
|
}
|
||||||
|
|
||||||
|
if sys.platform == 'win32':
|
||||||
|
COMMON_TYPES.update(win_common_types())
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,31 @@
|
||||||
|
|
||||||
|
class FFIError(Exception):
|
||||||
|
__module__ = 'cffi'
|
||||||
|
|
||||||
|
class CDefError(Exception):
|
||||||
|
__module__ = 'cffi'
|
||||||
|
def __str__(self):
|
||||||
|
try:
|
||||||
|
current_decl = self.args[1]
|
||||||
|
filename = current_decl.coord.file
|
||||||
|
linenum = current_decl.coord.line
|
||||||
|
prefix = '%s:%d: ' % (filename, linenum)
|
||||||
|
except (AttributeError, TypeError, IndexError):
|
||||||
|
prefix = ''
|
||||||
|
return '%s%s' % (prefix, self.args[0])
|
||||||
|
|
||||||
|
class VerificationError(Exception):
|
||||||
|
""" An error raised when verification fails
|
||||||
|
"""
|
||||||
|
__module__ = 'cffi'
|
||||||
|
|
||||||
|
class VerificationMissing(Exception):
|
||||||
|
""" An error raised when incomplete structures are passed into
|
||||||
|
cdef, but no verification has been done
|
||||||
|
"""
|
||||||
|
__module__ = 'cffi'
|
||||||
|
|
||||||
|
class PkgConfigError(Exception):
|
||||||
|
""" An error raised for missing modules in pkg-config
|
||||||
|
"""
|
||||||
|
__module__ = 'cffi'
|
||||||
|
|
@ -0,0 +1,113 @@
|
||||||
|
import sys, os
|
||||||
|
from .error import VerificationError
|
||||||
|
|
||||||
|
|
||||||
|
LIST_OF_FILE_NAMES = ['sources', 'include_dirs', 'library_dirs',
|
||||||
|
'extra_objects', 'depends']
|
||||||
|
|
||||||
|
def get_extension(srcfilename, modname, sources=(), **kwds):
|
||||||
|
from cffi._shimmed_dist_utils import Extension
|
||||||
|
allsources = [srcfilename]
|
||||||
|
for src in sources:
|
||||||
|
allsources.append(os.path.normpath(src))
|
||||||
|
return Extension(name=modname, sources=allsources, **kwds)
|
||||||
|
|
||||||
|
def compile(tmpdir, ext, compiler_verbose=0, debug=None):
|
||||||
|
"""Compile a C extension module using distutils."""
|
||||||
|
|
||||||
|
saved_environ = os.environ.copy()
|
||||||
|
try:
|
||||||
|
outputfilename = _build(tmpdir, ext, compiler_verbose, debug)
|
||||||
|
outputfilename = os.path.abspath(outputfilename)
|
||||||
|
finally:
|
||||||
|
# workaround for a distutils bugs where some env vars can
|
||||||
|
# become longer and longer every time it is used
|
||||||
|
for key, value in saved_environ.items():
|
||||||
|
if os.environ.get(key) != value:
|
||||||
|
os.environ[key] = value
|
||||||
|
return outputfilename
|
||||||
|
|
||||||
|
def _build(tmpdir, ext, compiler_verbose=0, debug=None):
|
||||||
|
# XXX compact but horrible :-(
|
||||||
|
from cffi._shimmed_dist_utils import Distribution, CompileError, LinkError, set_threshold, set_verbosity
|
||||||
|
|
||||||
|
dist = Distribution({'ext_modules': [ext]})
|
||||||
|
dist.parse_config_files()
|
||||||
|
options = dist.get_option_dict('build_ext')
|
||||||
|
if debug is None:
|
||||||
|
debug = sys.flags.debug
|
||||||
|
options['debug'] = ('ffiplatform', debug)
|
||||||
|
options['force'] = ('ffiplatform', True)
|
||||||
|
options['build_lib'] = ('ffiplatform', tmpdir)
|
||||||
|
options['build_temp'] = ('ffiplatform', tmpdir)
|
||||||
|
#
|
||||||
|
try:
|
||||||
|
old_level = set_threshold(0) or 0
|
||||||
|
try:
|
||||||
|
set_verbosity(compiler_verbose)
|
||||||
|
dist.run_command('build_ext')
|
||||||
|
cmd_obj = dist.get_command_obj('build_ext')
|
||||||
|
[soname] = cmd_obj.get_outputs()
|
||||||
|
finally:
|
||||||
|
set_threshold(old_level)
|
||||||
|
except (CompileError, LinkError) as e:
|
||||||
|
raise VerificationError('%s: %s' % (e.__class__.__name__, e))
|
||||||
|
#
|
||||||
|
return soname
|
||||||
|
|
||||||
|
try:
|
||||||
|
from os.path import samefile
|
||||||
|
except ImportError:
|
||||||
|
def samefile(f1, f2):
|
||||||
|
return os.path.abspath(f1) == os.path.abspath(f2)
|
||||||
|
|
||||||
|
def maybe_relative_path(path):
|
||||||
|
if not os.path.isabs(path):
|
||||||
|
return path # already relative
|
||||||
|
dir = path
|
||||||
|
names = []
|
||||||
|
while True:
|
||||||
|
prevdir = dir
|
||||||
|
dir, name = os.path.split(prevdir)
|
||||||
|
if dir == prevdir or not dir:
|
||||||
|
return path # failed to make it relative
|
||||||
|
names.append(name)
|
||||||
|
try:
|
||||||
|
if samefile(dir, os.curdir):
|
||||||
|
names.reverse()
|
||||||
|
return os.path.join(*names)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# ____________________________________________________________
|
||||||
|
|
||||||
|
try:
|
||||||
|
int_or_long = (int, long)
|
||||||
|
import cStringIO
|
||||||
|
except NameError:
|
||||||
|
int_or_long = int # Python 3
|
||||||
|
import io as cStringIO
|
||||||
|
|
||||||
|
def _flatten(x, f):
|
||||||
|
if isinstance(x, str):
|
||||||
|
f.write('%ds%s' % (len(x), x))
|
||||||
|
elif isinstance(x, dict):
|
||||||
|
keys = sorted(x.keys())
|
||||||
|
f.write('%dd' % len(keys))
|
||||||
|
for key in keys:
|
||||||
|
_flatten(key, f)
|
||||||
|
_flatten(x[key], f)
|
||||||
|
elif isinstance(x, (list, tuple)):
|
||||||
|
f.write('%dl' % len(x))
|
||||||
|
for value in x:
|
||||||
|
_flatten(value, f)
|
||||||
|
elif isinstance(x, int_or_long):
|
||||||
|
f.write('%di' % (x,))
|
||||||
|
else:
|
||||||
|
raise TypeError(
|
||||||
|
"the keywords to verify() contains unsupported object %r" % (x,))
|
||||||
|
|
||||||
|
def flatten(x):
|
||||||
|
f = cStringIO.StringIO()
|
||||||
|
_flatten(x, f)
|
||||||
|
return f.getvalue()
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
import sys
|
||||||
|
|
||||||
|
if sys.version_info < (3,):
|
||||||
|
try:
|
||||||
|
from thread import allocate_lock
|
||||||
|
except ImportError:
|
||||||
|
from dummy_thread import allocate_lock
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
from _thread import allocate_lock
|
||||||
|
except ImportError:
|
||||||
|
from _dummy_thread import allocate_lock
|
||||||
|
|
||||||
|
|
||||||
|
##import sys
|
||||||
|
##l1 = allocate_lock
|
||||||
|
|
||||||
|
##class allocate_lock(object):
|
||||||
|
## def __init__(self):
|
||||||
|
## self._real = l1()
|
||||||
|
## def __enter__(self):
|
||||||
|
## for i in range(4, 0, -1):
|
||||||
|
## print sys._getframe(i).f_code
|
||||||
|
## print
|
||||||
|
## return self._real.__enter__()
|
||||||
|
## def __exit__(self, *args):
|
||||||
|
## return self._real.__exit__(*args)
|
||||||
|
## def acquire(self, f):
|
||||||
|
## assert f is False
|
||||||
|
## return self._real.acquire(f)
|
||||||
|
|
@ -0,0 +1,618 @@
|
||||||
|
import types
|
||||||
|
import weakref
|
||||||
|
|
||||||
|
from .lock import allocate_lock
|
||||||
|
from .error import CDefError, VerificationError, VerificationMissing
|
||||||
|
|
||||||
|
# type qualifiers
|
||||||
|
Q_CONST = 0x01
|
||||||
|
Q_RESTRICT = 0x02
|
||||||
|
Q_VOLATILE = 0x04
|
||||||
|
|
||||||
|
def qualify(quals, replace_with):
|
||||||
|
if quals & Q_CONST:
|
||||||
|
replace_with = ' const ' + replace_with.lstrip()
|
||||||
|
if quals & Q_VOLATILE:
|
||||||
|
replace_with = ' volatile ' + replace_with.lstrip()
|
||||||
|
if quals & Q_RESTRICT:
|
||||||
|
# It seems that __restrict is supported by gcc and msvc.
|
||||||
|
# If you hit some different compiler, add a #define in
|
||||||
|
# _cffi_include.h for it (and in its copies, documented there)
|
||||||
|
replace_with = ' __restrict ' + replace_with.lstrip()
|
||||||
|
return replace_with
|
||||||
|
|
||||||
|
|
||||||
|
class BaseTypeByIdentity(object):
|
||||||
|
is_array_type = False
|
||||||
|
is_raw_function = False
|
||||||
|
|
||||||
|
def get_c_name(self, replace_with='', context='a C file', quals=0):
|
||||||
|
result = self.c_name_with_marker
|
||||||
|
assert result.count('&') == 1
|
||||||
|
# some logic duplication with ffi.getctype()... :-(
|
||||||
|
replace_with = replace_with.strip()
|
||||||
|
if replace_with:
|
||||||
|
if replace_with.startswith('*') and '&[' in result:
|
||||||
|
replace_with = '(%s)' % replace_with
|
||||||
|
elif not replace_with[0] in '[(':
|
||||||
|
replace_with = ' ' + replace_with
|
||||||
|
replace_with = qualify(quals, replace_with)
|
||||||
|
result = result.replace('&', replace_with)
|
||||||
|
if '$' in result:
|
||||||
|
raise VerificationError(
|
||||||
|
"cannot generate '%s' in %s: unknown type name"
|
||||||
|
% (self._get_c_name(), context))
|
||||||
|
return result
|
||||||
|
|
||||||
|
def _get_c_name(self):
|
||||||
|
return self.c_name_with_marker.replace('&', '')
|
||||||
|
|
||||||
|
def has_c_name(self):
|
||||||
|
return '$' not in self._get_c_name()
|
||||||
|
|
||||||
|
def is_integer_type(self):
|
||||||
|
return False
|
||||||
|
|
||||||
|
def get_cached_btype(self, ffi, finishlist, can_delay=False):
|
||||||
|
try:
|
||||||
|
BType = ffi._cached_btypes[self]
|
||||||
|
except KeyError:
|
||||||
|
BType = self.build_backend_type(ffi, finishlist)
|
||||||
|
BType2 = ffi._cached_btypes.setdefault(self, BType)
|
||||||
|
assert BType2 is BType
|
||||||
|
return BType
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return '<%s>' % (self._get_c_name(),)
|
||||||
|
|
||||||
|
def _get_items(self):
|
||||||
|
return [(name, getattr(self, name)) for name in self._attrs_]
|
||||||
|
|
||||||
|
|
||||||
|
class BaseType(BaseTypeByIdentity):
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
return (self.__class__ == other.__class__ and
|
||||||
|
self._get_items() == other._get_items())
|
||||||
|
|
||||||
|
def __ne__(self, other):
|
||||||
|
return not self == other
|
||||||
|
|
||||||
|
def __hash__(self):
|
||||||
|
return hash((self.__class__, tuple(self._get_items())))
|
||||||
|
|
||||||
|
|
||||||
|
class VoidType(BaseType):
|
||||||
|
_attrs_ = ()
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.c_name_with_marker = 'void&'
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
return global_cache(self, ffi, 'new_void_type')
|
||||||
|
|
||||||
|
void_type = VoidType()
|
||||||
|
|
||||||
|
|
||||||
|
class BasePrimitiveType(BaseType):
|
||||||
|
def is_complex_type(self):
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
class PrimitiveType(BasePrimitiveType):
|
||||||
|
_attrs_ = ('name',)
|
||||||
|
|
||||||
|
ALL_PRIMITIVE_TYPES = {
|
||||||
|
'char': 'c',
|
||||||
|
'short': 'i',
|
||||||
|
'int': 'i',
|
||||||
|
'long': 'i',
|
||||||
|
'long long': 'i',
|
||||||
|
'signed char': 'i',
|
||||||
|
'unsigned char': 'i',
|
||||||
|
'unsigned short': 'i',
|
||||||
|
'unsigned int': 'i',
|
||||||
|
'unsigned long': 'i',
|
||||||
|
'unsigned long long': 'i',
|
||||||
|
'float': 'f',
|
||||||
|
'double': 'f',
|
||||||
|
'long double': 'f',
|
||||||
|
'_cffi_float_complex_t': 'j',
|
||||||
|
'_cffi_double_complex_t': 'j',
|
||||||
|
'_Bool': 'i',
|
||||||
|
# the following types are not primitive in the C sense
|
||||||
|
'wchar_t': 'c',
|
||||||
|
'char16_t': 'c',
|
||||||
|
'char32_t': 'c',
|
||||||
|
'int8_t': 'i',
|
||||||
|
'uint8_t': 'i',
|
||||||
|
'int16_t': 'i',
|
||||||
|
'uint16_t': 'i',
|
||||||
|
'int32_t': 'i',
|
||||||
|
'uint32_t': 'i',
|
||||||
|
'int64_t': 'i',
|
||||||
|
'uint64_t': 'i',
|
||||||
|
'int_least8_t': 'i',
|
||||||
|
'uint_least8_t': 'i',
|
||||||
|
'int_least16_t': 'i',
|
||||||
|
'uint_least16_t': 'i',
|
||||||
|
'int_least32_t': 'i',
|
||||||
|
'uint_least32_t': 'i',
|
||||||
|
'int_least64_t': 'i',
|
||||||
|
'uint_least64_t': 'i',
|
||||||
|
'int_fast8_t': 'i',
|
||||||
|
'uint_fast8_t': 'i',
|
||||||
|
'int_fast16_t': 'i',
|
||||||
|
'uint_fast16_t': 'i',
|
||||||
|
'int_fast32_t': 'i',
|
||||||
|
'uint_fast32_t': 'i',
|
||||||
|
'int_fast64_t': 'i',
|
||||||
|
'uint_fast64_t': 'i',
|
||||||
|
'intptr_t': 'i',
|
||||||
|
'uintptr_t': 'i',
|
||||||
|
'intmax_t': 'i',
|
||||||
|
'uintmax_t': 'i',
|
||||||
|
'ptrdiff_t': 'i',
|
||||||
|
'size_t': 'i',
|
||||||
|
'ssize_t': 'i',
|
||||||
|
}
|
||||||
|
|
||||||
|
def __init__(self, name):
|
||||||
|
assert name in self.ALL_PRIMITIVE_TYPES
|
||||||
|
self.name = name
|
||||||
|
self.c_name_with_marker = name + '&'
|
||||||
|
|
||||||
|
def is_char_type(self):
|
||||||
|
return self.ALL_PRIMITIVE_TYPES[self.name] == 'c'
|
||||||
|
def is_integer_type(self):
|
||||||
|
return self.ALL_PRIMITIVE_TYPES[self.name] == 'i'
|
||||||
|
def is_float_type(self):
|
||||||
|
return self.ALL_PRIMITIVE_TYPES[self.name] == 'f'
|
||||||
|
def is_complex_type(self):
|
||||||
|
return self.ALL_PRIMITIVE_TYPES[self.name] == 'j'
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
return global_cache(self, ffi, 'new_primitive_type', self.name)
|
||||||
|
|
||||||
|
|
||||||
|
class UnknownIntegerType(BasePrimitiveType):
|
||||||
|
_attrs_ = ('name',)
|
||||||
|
|
||||||
|
def __init__(self, name):
|
||||||
|
self.name = name
|
||||||
|
self.c_name_with_marker = name + '&'
|
||||||
|
|
||||||
|
def is_integer_type(self):
|
||||||
|
return True
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
raise NotImplementedError("integer type '%s' can only be used after "
|
||||||
|
"compilation" % self.name)
|
||||||
|
|
||||||
|
class UnknownFloatType(BasePrimitiveType):
|
||||||
|
_attrs_ = ('name', )
|
||||||
|
|
||||||
|
def __init__(self, name):
|
||||||
|
self.name = name
|
||||||
|
self.c_name_with_marker = name + '&'
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
raise NotImplementedError("float type '%s' can only be used after "
|
||||||
|
"compilation" % self.name)
|
||||||
|
|
||||||
|
|
||||||
|
class BaseFunctionType(BaseType):
|
||||||
|
_attrs_ = ('args', 'result', 'ellipsis', 'abi')
|
||||||
|
|
||||||
|
def __init__(self, args, result, ellipsis, abi=None):
|
||||||
|
self.args = args
|
||||||
|
self.result = result
|
||||||
|
self.ellipsis = ellipsis
|
||||||
|
self.abi = abi
|
||||||
|
#
|
||||||
|
reprargs = [arg._get_c_name() for arg in self.args]
|
||||||
|
if self.ellipsis:
|
||||||
|
reprargs.append('...')
|
||||||
|
reprargs = reprargs or ['void']
|
||||||
|
replace_with = self._base_pattern % (', '.join(reprargs),)
|
||||||
|
if abi is not None:
|
||||||
|
replace_with = replace_with[:1] + abi + ' ' + replace_with[1:]
|
||||||
|
self.c_name_with_marker = (
|
||||||
|
self.result.c_name_with_marker.replace('&', replace_with))
|
||||||
|
|
||||||
|
|
||||||
|
class RawFunctionType(BaseFunctionType):
|
||||||
|
# Corresponds to a C type like 'int(int)', which is the C type of
|
||||||
|
# a function, but not a pointer-to-function. The backend has no
|
||||||
|
# notion of such a type; it's used temporarily by parsing.
|
||||||
|
_base_pattern = '(&)(%s)'
|
||||||
|
is_raw_function = True
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
raise CDefError("cannot render the type %r: it is a function "
|
||||||
|
"type, not a pointer-to-function type" % (self,))
|
||||||
|
|
||||||
|
def as_function_pointer(self):
|
||||||
|
return FunctionPtrType(self.args, self.result, self.ellipsis, self.abi)
|
||||||
|
|
||||||
|
|
||||||
|
class FunctionPtrType(BaseFunctionType):
|
||||||
|
_base_pattern = '(*&)(%s)'
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
result = self.result.get_cached_btype(ffi, finishlist)
|
||||||
|
args = []
|
||||||
|
for tp in self.args:
|
||||||
|
args.append(tp.get_cached_btype(ffi, finishlist))
|
||||||
|
abi_args = ()
|
||||||
|
if self.abi == "__stdcall":
|
||||||
|
if not self.ellipsis: # __stdcall ignored for variadic funcs
|
||||||
|
try:
|
||||||
|
abi_args = (ffi._backend.FFI_STDCALL,)
|
||||||
|
except AttributeError:
|
||||||
|
pass
|
||||||
|
return global_cache(self, ffi, 'new_function_type',
|
||||||
|
tuple(args), result, self.ellipsis, *abi_args)
|
||||||
|
|
||||||
|
def as_raw_function(self):
|
||||||
|
return RawFunctionType(self.args, self.result, self.ellipsis, self.abi)
|
||||||
|
|
||||||
|
|
||||||
|
class PointerType(BaseType):
|
||||||
|
_attrs_ = ('totype', 'quals')
|
||||||
|
|
||||||
|
def __init__(self, totype, quals=0):
|
||||||
|
self.totype = totype
|
||||||
|
self.quals = quals
|
||||||
|
extra = " *&"
|
||||||
|
if totype.is_array_type:
|
||||||
|
extra = "(%s)" % (extra.lstrip(),)
|
||||||
|
extra = qualify(quals, extra)
|
||||||
|
self.c_name_with_marker = totype.c_name_with_marker.replace('&', extra)
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
BItem = self.totype.get_cached_btype(ffi, finishlist, can_delay=True)
|
||||||
|
return global_cache(self, ffi, 'new_pointer_type', BItem)
|
||||||
|
|
||||||
|
voidp_type = PointerType(void_type)
|
||||||
|
|
||||||
|
def ConstPointerType(totype):
|
||||||
|
return PointerType(totype, Q_CONST)
|
||||||
|
|
||||||
|
const_voidp_type = ConstPointerType(void_type)
|
||||||
|
|
||||||
|
|
||||||
|
class NamedPointerType(PointerType):
|
||||||
|
_attrs_ = ('totype', 'name')
|
||||||
|
|
||||||
|
def __init__(self, totype, name, quals=0):
|
||||||
|
PointerType.__init__(self, totype, quals)
|
||||||
|
self.name = name
|
||||||
|
self.c_name_with_marker = name + '&'
|
||||||
|
|
||||||
|
|
||||||
|
class ArrayType(BaseType):
|
||||||
|
_attrs_ = ('item', 'length')
|
||||||
|
is_array_type = True
|
||||||
|
|
||||||
|
def __init__(self, item, length):
|
||||||
|
self.item = item
|
||||||
|
self.length = length
|
||||||
|
#
|
||||||
|
if length is None:
|
||||||
|
brackets = '&[]'
|
||||||
|
elif length == '...':
|
||||||
|
brackets = '&[/*...*/]'
|
||||||
|
else:
|
||||||
|
brackets = '&[%s]' % length
|
||||||
|
self.c_name_with_marker = (
|
||||||
|
self.item.c_name_with_marker.replace('&', brackets))
|
||||||
|
|
||||||
|
def length_is_unknown(self):
|
||||||
|
return isinstance(self.length, str)
|
||||||
|
|
||||||
|
def resolve_length(self, newlength):
|
||||||
|
return ArrayType(self.item, newlength)
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
if self.length_is_unknown():
|
||||||
|
raise CDefError("cannot render the type %r: unknown length" %
|
||||||
|
(self,))
|
||||||
|
self.item.get_cached_btype(ffi, finishlist) # force the item BType
|
||||||
|
BPtrItem = PointerType(self.item).get_cached_btype(ffi, finishlist)
|
||||||
|
return global_cache(self, ffi, 'new_array_type', BPtrItem, self.length)
|
||||||
|
|
||||||
|
char_array_type = ArrayType(PrimitiveType('char'), None)
|
||||||
|
|
||||||
|
|
||||||
|
class StructOrUnionOrEnum(BaseTypeByIdentity):
|
||||||
|
_attrs_ = ('name',)
|
||||||
|
forcename = None
|
||||||
|
|
||||||
|
def build_c_name_with_marker(self):
|
||||||
|
name = self.forcename or '%s %s' % (self.kind, self.name)
|
||||||
|
self.c_name_with_marker = name + '&'
|
||||||
|
|
||||||
|
def force_the_name(self, forcename):
|
||||||
|
self.forcename = forcename
|
||||||
|
self.build_c_name_with_marker()
|
||||||
|
|
||||||
|
def get_official_name(self):
|
||||||
|
assert self.c_name_with_marker.endswith('&')
|
||||||
|
return self.c_name_with_marker[:-1]
|
||||||
|
|
||||||
|
|
||||||
|
class StructOrUnion(StructOrUnionOrEnum):
|
||||||
|
fixedlayout = None
|
||||||
|
completed = 0
|
||||||
|
partial = False
|
||||||
|
packed = 0
|
||||||
|
|
||||||
|
def __init__(self, name, fldnames, fldtypes, fldbitsize, fldquals=None):
|
||||||
|
self.name = name
|
||||||
|
self.fldnames = fldnames
|
||||||
|
self.fldtypes = fldtypes
|
||||||
|
self.fldbitsize = fldbitsize
|
||||||
|
self.fldquals = fldquals
|
||||||
|
self.build_c_name_with_marker()
|
||||||
|
|
||||||
|
def anonymous_struct_fields(self):
|
||||||
|
if self.fldtypes is not None:
|
||||||
|
for name, type in zip(self.fldnames, self.fldtypes):
|
||||||
|
if name == '' and isinstance(type, StructOrUnion):
|
||||||
|
yield type
|
||||||
|
|
||||||
|
def enumfields(self, expand_anonymous_struct_union=True):
|
||||||
|
fldquals = self.fldquals
|
||||||
|
if fldquals is None:
|
||||||
|
fldquals = (0,) * len(self.fldnames)
|
||||||
|
for name, type, bitsize, quals in zip(self.fldnames, self.fldtypes,
|
||||||
|
self.fldbitsize, fldquals):
|
||||||
|
if (name == '' and isinstance(type, StructOrUnion)
|
||||||
|
and expand_anonymous_struct_union):
|
||||||
|
# nested anonymous struct/union
|
||||||
|
for result in type.enumfields():
|
||||||
|
yield result
|
||||||
|
else:
|
||||||
|
yield (name, type, bitsize, quals)
|
||||||
|
|
||||||
|
def force_flatten(self):
|
||||||
|
# force the struct or union to have a declaration that lists
|
||||||
|
# directly all fields returned by enumfields(), flattening
|
||||||
|
# nested anonymous structs/unions.
|
||||||
|
names = []
|
||||||
|
types = []
|
||||||
|
bitsizes = []
|
||||||
|
fldquals = []
|
||||||
|
for name, type, bitsize, quals in self.enumfields():
|
||||||
|
names.append(name)
|
||||||
|
types.append(type)
|
||||||
|
bitsizes.append(bitsize)
|
||||||
|
fldquals.append(quals)
|
||||||
|
self.fldnames = tuple(names)
|
||||||
|
self.fldtypes = tuple(types)
|
||||||
|
self.fldbitsize = tuple(bitsizes)
|
||||||
|
self.fldquals = tuple(fldquals)
|
||||||
|
|
||||||
|
def get_cached_btype(self, ffi, finishlist, can_delay=False):
|
||||||
|
BType = StructOrUnionOrEnum.get_cached_btype(self, ffi, finishlist,
|
||||||
|
can_delay)
|
||||||
|
if not can_delay:
|
||||||
|
self.finish_backend_type(ffi, finishlist)
|
||||||
|
return BType
|
||||||
|
|
||||||
|
def finish_backend_type(self, ffi, finishlist):
|
||||||
|
if self.completed:
|
||||||
|
if self.completed != 2:
|
||||||
|
raise NotImplementedError("recursive structure declaration "
|
||||||
|
"for '%s'" % (self.name,))
|
||||||
|
return
|
||||||
|
BType = ffi._cached_btypes[self]
|
||||||
|
#
|
||||||
|
self.completed = 1
|
||||||
|
#
|
||||||
|
if self.fldtypes is None:
|
||||||
|
pass # not completing it: it's an opaque struct
|
||||||
|
#
|
||||||
|
elif self.fixedlayout is None:
|
||||||
|
fldtypes = [tp.get_cached_btype(ffi, finishlist)
|
||||||
|
for tp in self.fldtypes]
|
||||||
|
lst = list(zip(self.fldnames, fldtypes, self.fldbitsize))
|
||||||
|
extra_flags = ()
|
||||||
|
if self.packed:
|
||||||
|
if self.packed == 1:
|
||||||
|
extra_flags = (8,) # SF_PACKED
|
||||||
|
else:
|
||||||
|
extra_flags = (0, self.packed)
|
||||||
|
ffi._backend.complete_struct_or_union(BType, lst, self,
|
||||||
|
-1, -1, *extra_flags)
|
||||||
|
#
|
||||||
|
else:
|
||||||
|
fldtypes = []
|
||||||
|
fieldofs, fieldsize, totalsize, totalalignment = self.fixedlayout
|
||||||
|
for i in range(len(self.fldnames)):
|
||||||
|
fsize = fieldsize[i]
|
||||||
|
ftype = self.fldtypes[i]
|
||||||
|
#
|
||||||
|
if isinstance(ftype, ArrayType) and ftype.length_is_unknown():
|
||||||
|
# fix the length to match the total size
|
||||||
|
BItemType = ftype.item.get_cached_btype(ffi, finishlist)
|
||||||
|
nlen, nrest = divmod(fsize, ffi.sizeof(BItemType))
|
||||||
|
if nrest != 0:
|
||||||
|
self._verification_error(
|
||||||
|
"field '%s.%s' has a bogus size?" % (
|
||||||
|
self.name, self.fldnames[i] or '{}'))
|
||||||
|
ftype = ftype.resolve_length(nlen)
|
||||||
|
self.fldtypes = (self.fldtypes[:i] + (ftype,) +
|
||||||
|
self.fldtypes[i+1:])
|
||||||
|
#
|
||||||
|
BFieldType = ftype.get_cached_btype(ffi, finishlist)
|
||||||
|
if isinstance(ftype, ArrayType) and ftype.length is None:
|
||||||
|
assert fsize == 0
|
||||||
|
else:
|
||||||
|
bitemsize = ffi.sizeof(BFieldType)
|
||||||
|
if bitemsize != fsize:
|
||||||
|
self._verification_error(
|
||||||
|
"field '%s.%s' is declared as %d bytes, but is "
|
||||||
|
"really %d bytes" % (self.name,
|
||||||
|
self.fldnames[i] or '{}',
|
||||||
|
bitemsize, fsize))
|
||||||
|
fldtypes.append(BFieldType)
|
||||||
|
#
|
||||||
|
lst = list(zip(self.fldnames, fldtypes, self.fldbitsize, fieldofs))
|
||||||
|
ffi._backend.complete_struct_or_union(BType, lst, self,
|
||||||
|
totalsize, totalalignment)
|
||||||
|
self.completed = 2
|
||||||
|
|
||||||
|
def _verification_error(self, msg):
|
||||||
|
raise VerificationError(msg)
|
||||||
|
|
||||||
|
def check_not_partial(self):
|
||||||
|
if self.partial and self.fixedlayout is None:
|
||||||
|
raise VerificationMissing(self._get_c_name())
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
self.check_not_partial()
|
||||||
|
finishlist.append(self)
|
||||||
|
#
|
||||||
|
return global_cache(self, ffi, 'new_%s_type' % self.kind,
|
||||||
|
self.get_official_name(), key=self)
|
||||||
|
|
||||||
|
|
||||||
|
class StructType(StructOrUnion):
|
||||||
|
kind = 'struct'
|
||||||
|
|
||||||
|
|
||||||
|
class UnionType(StructOrUnion):
|
||||||
|
kind = 'union'
|
||||||
|
|
||||||
|
|
||||||
|
class EnumType(StructOrUnionOrEnum):
|
||||||
|
kind = 'enum'
|
||||||
|
partial = False
|
||||||
|
partial_resolved = False
|
||||||
|
|
||||||
|
def __init__(self, name, enumerators, enumvalues, baseinttype=None):
|
||||||
|
self.name = name
|
||||||
|
self.enumerators = enumerators
|
||||||
|
self.enumvalues = enumvalues
|
||||||
|
self.baseinttype = baseinttype
|
||||||
|
self.build_c_name_with_marker()
|
||||||
|
|
||||||
|
def force_the_name(self, forcename):
|
||||||
|
StructOrUnionOrEnum.force_the_name(self, forcename)
|
||||||
|
if self.forcename is None:
|
||||||
|
name = self.get_official_name()
|
||||||
|
self.forcename = '$' + name.replace(' ', '_')
|
||||||
|
|
||||||
|
def check_not_partial(self):
|
||||||
|
if self.partial and not self.partial_resolved:
|
||||||
|
raise VerificationMissing(self._get_c_name())
|
||||||
|
|
||||||
|
def build_backend_type(self, ffi, finishlist):
|
||||||
|
self.check_not_partial()
|
||||||
|
base_btype = self.build_baseinttype(ffi, finishlist)
|
||||||
|
return global_cache(self, ffi, 'new_enum_type',
|
||||||
|
self.get_official_name(),
|
||||||
|
self.enumerators, self.enumvalues,
|
||||||
|
base_btype, key=self)
|
||||||
|
|
||||||
|
def build_baseinttype(self, ffi, finishlist):
|
||||||
|
if self.baseinttype is not None:
|
||||||
|
return self.baseinttype.get_cached_btype(ffi, finishlist)
|
||||||
|
#
|
||||||
|
if self.enumvalues:
|
||||||
|
smallest_value = min(self.enumvalues)
|
||||||
|
largest_value = max(self.enumvalues)
|
||||||
|
else:
|
||||||
|
import warnings
|
||||||
|
try:
|
||||||
|
# XXX! The goal is to ensure that the warnings.warn()
|
||||||
|
# will not suppress the warning. We want to get it
|
||||||
|
# several times if we reach this point several times.
|
||||||
|
__warningregistry__.clear()
|
||||||
|
except NameError:
|
||||||
|
pass
|
||||||
|
warnings.warn("%r has no values explicitly defined; "
|
||||||
|
"guessing that it is equivalent to 'unsigned int'"
|
||||||
|
% self._get_c_name())
|
||||||
|
smallest_value = largest_value = 0
|
||||||
|
if smallest_value < 0: # needs a signed type
|
||||||
|
sign = 1
|
||||||
|
candidate1 = PrimitiveType("int")
|
||||||
|
candidate2 = PrimitiveType("long")
|
||||||
|
else:
|
||||||
|
sign = 0
|
||||||
|
candidate1 = PrimitiveType("unsigned int")
|
||||||
|
candidate2 = PrimitiveType("unsigned long")
|
||||||
|
btype1 = candidate1.get_cached_btype(ffi, finishlist)
|
||||||
|
btype2 = candidate2.get_cached_btype(ffi, finishlist)
|
||||||
|
size1 = ffi.sizeof(btype1)
|
||||||
|
size2 = ffi.sizeof(btype2)
|
||||||
|
if (smallest_value >= ((-1) << (8*size1-1)) and
|
||||||
|
largest_value < (1 << (8*size1-sign))):
|
||||||
|
return btype1
|
||||||
|
if (smallest_value >= ((-1) << (8*size2-1)) and
|
||||||
|
largest_value < (1 << (8*size2-sign))):
|
||||||
|
return btype2
|
||||||
|
raise CDefError("%s values don't all fit into either 'long' "
|
||||||
|
"or 'unsigned long'" % self._get_c_name())
|
||||||
|
|
||||||
|
def unknown_type(name, structname=None):
|
||||||
|
if structname is None:
|
||||||
|
structname = '$%s' % name
|
||||||
|
tp = StructType(structname, None, None, None)
|
||||||
|
tp.force_the_name(name)
|
||||||
|
tp.origin = "unknown_type"
|
||||||
|
return tp
|
||||||
|
|
||||||
|
def unknown_ptr_type(name, structname=None):
|
||||||
|
if structname is None:
|
||||||
|
structname = '$$%s' % name
|
||||||
|
tp = StructType(structname, None, None, None)
|
||||||
|
return NamedPointerType(tp, name)
|
||||||
|
|
||||||
|
|
||||||
|
global_lock = allocate_lock()
|
||||||
|
_typecache_cffi_backend = weakref.WeakValueDictionary()
|
||||||
|
|
||||||
|
def get_typecache(backend):
|
||||||
|
# returns _typecache_cffi_backend if backend is the _cffi_backend
|
||||||
|
# module, or type(backend).__typecache if backend is an instance of
|
||||||
|
# CTypesBackend (or some FakeBackend class during tests)
|
||||||
|
if isinstance(backend, types.ModuleType):
|
||||||
|
return _typecache_cffi_backend
|
||||||
|
with global_lock:
|
||||||
|
if not hasattr(type(backend), '__typecache'):
|
||||||
|
type(backend).__typecache = weakref.WeakValueDictionary()
|
||||||
|
return type(backend).__typecache
|
||||||
|
|
||||||
|
def global_cache(srctype, ffi, funcname, *args, **kwds):
|
||||||
|
key = kwds.pop('key', (funcname, args))
|
||||||
|
assert not kwds
|
||||||
|
try:
|
||||||
|
return ffi._typecache[key]
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
try:
|
||||||
|
res = getattr(ffi._backend, funcname)(*args)
|
||||||
|
except NotImplementedError as e:
|
||||||
|
raise NotImplementedError("%s: %r: %s" % (funcname, srctype, e))
|
||||||
|
# note that setdefault() on WeakValueDictionary is not atomic
|
||||||
|
# and contains a rare bug (http://bugs.python.org/issue19542);
|
||||||
|
# we have to use a lock and do it ourselves
|
||||||
|
cache = ffi._typecache
|
||||||
|
with global_lock:
|
||||||
|
res1 = cache.get(key)
|
||||||
|
if res1 is None:
|
||||||
|
cache[key] = res
|
||||||
|
return res
|
||||||
|
else:
|
||||||
|
return res1
|
||||||
|
|
||||||
|
def pointer_cache(ffi, BType):
|
||||||
|
return global_cache('?', ffi, 'new_pointer_type', BType)
|
||||||
|
|
||||||
|
def attach_exception_info(e, name):
|
||||||
|
if e.args and type(e.args[0]) is str:
|
||||||
|
e.args = ('%s: %s' % (name, e.args[0]),) + e.args[1:]
|
||||||
|
|
@ -0,0 +1,181 @@
|
||||||
|
|
||||||
|
/* This part is from file 'cffi/parse_c_type.h'. It is copied at the
|
||||||
|
beginning of C sources generated by CFFI's ffi.set_source(). */
|
||||||
|
|
||||||
|
typedef void *_cffi_opcode_t;
|
||||||
|
|
||||||
|
#define _CFFI_OP(opcode, arg) (_cffi_opcode_t)(opcode | (((uintptr_t)(arg)) << 8))
|
||||||
|
#define _CFFI_GETOP(cffi_opcode) ((unsigned char)(uintptr_t)cffi_opcode)
|
||||||
|
#define _CFFI_GETARG(cffi_opcode) (((intptr_t)cffi_opcode) >> 8)
|
||||||
|
|
||||||
|
#define _CFFI_OP_PRIMITIVE 1
|
||||||
|
#define _CFFI_OP_POINTER 3
|
||||||
|
#define _CFFI_OP_ARRAY 5
|
||||||
|
#define _CFFI_OP_OPEN_ARRAY 7
|
||||||
|
#define _CFFI_OP_STRUCT_UNION 9
|
||||||
|
#define _CFFI_OP_ENUM 11
|
||||||
|
#define _CFFI_OP_FUNCTION 13
|
||||||
|
#define _CFFI_OP_FUNCTION_END 15
|
||||||
|
#define _CFFI_OP_NOOP 17
|
||||||
|
#define _CFFI_OP_BITFIELD 19
|
||||||
|
#define _CFFI_OP_TYPENAME 21
|
||||||
|
#define _CFFI_OP_CPYTHON_BLTN_V 23 // varargs
|
||||||
|
#define _CFFI_OP_CPYTHON_BLTN_N 25 // noargs
|
||||||
|
#define _CFFI_OP_CPYTHON_BLTN_O 27 // O (i.e. a single arg)
|
||||||
|
#define _CFFI_OP_CONSTANT 29
|
||||||
|
#define _CFFI_OP_CONSTANT_INT 31
|
||||||
|
#define _CFFI_OP_GLOBAL_VAR 33
|
||||||
|
#define _CFFI_OP_DLOPEN_FUNC 35
|
||||||
|
#define _CFFI_OP_DLOPEN_CONST 37
|
||||||
|
#define _CFFI_OP_GLOBAL_VAR_F 39
|
||||||
|
#define _CFFI_OP_EXTERN_PYTHON 41
|
||||||
|
|
||||||
|
#define _CFFI_PRIM_VOID 0
|
||||||
|
#define _CFFI_PRIM_BOOL 1
|
||||||
|
#define _CFFI_PRIM_CHAR 2
|
||||||
|
#define _CFFI_PRIM_SCHAR 3
|
||||||
|
#define _CFFI_PRIM_UCHAR 4
|
||||||
|
#define _CFFI_PRIM_SHORT 5
|
||||||
|
#define _CFFI_PRIM_USHORT 6
|
||||||
|
#define _CFFI_PRIM_INT 7
|
||||||
|
#define _CFFI_PRIM_UINT 8
|
||||||
|
#define _CFFI_PRIM_LONG 9
|
||||||
|
#define _CFFI_PRIM_ULONG 10
|
||||||
|
#define _CFFI_PRIM_LONGLONG 11
|
||||||
|
#define _CFFI_PRIM_ULONGLONG 12
|
||||||
|
#define _CFFI_PRIM_FLOAT 13
|
||||||
|
#define _CFFI_PRIM_DOUBLE 14
|
||||||
|
#define _CFFI_PRIM_LONGDOUBLE 15
|
||||||
|
|
||||||
|
#define _CFFI_PRIM_WCHAR 16
|
||||||
|
#define _CFFI_PRIM_INT8 17
|
||||||
|
#define _CFFI_PRIM_UINT8 18
|
||||||
|
#define _CFFI_PRIM_INT16 19
|
||||||
|
#define _CFFI_PRIM_UINT16 20
|
||||||
|
#define _CFFI_PRIM_INT32 21
|
||||||
|
#define _CFFI_PRIM_UINT32 22
|
||||||
|
#define _CFFI_PRIM_INT64 23
|
||||||
|
#define _CFFI_PRIM_UINT64 24
|
||||||
|
#define _CFFI_PRIM_INTPTR 25
|
||||||
|
#define _CFFI_PRIM_UINTPTR 26
|
||||||
|
#define _CFFI_PRIM_PTRDIFF 27
|
||||||
|
#define _CFFI_PRIM_SIZE 28
|
||||||
|
#define _CFFI_PRIM_SSIZE 29
|
||||||
|
#define _CFFI_PRIM_INT_LEAST8 30
|
||||||
|
#define _CFFI_PRIM_UINT_LEAST8 31
|
||||||
|
#define _CFFI_PRIM_INT_LEAST16 32
|
||||||
|
#define _CFFI_PRIM_UINT_LEAST16 33
|
||||||
|
#define _CFFI_PRIM_INT_LEAST32 34
|
||||||
|
#define _CFFI_PRIM_UINT_LEAST32 35
|
||||||
|
#define _CFFI_PRIM_INT_LEAST64 36
|
||||||
|
#define _CFFI_PRIM_UINT_LEAST64 37
|
||||||
|
#define _CFFI_PRIM_INT_FAST8 38
|
||||||
|
#define _CFFI_PRIM_UINT_FAST8 39
|
||||||
|
#define _CFFI_PRIM_INT_FAST16 40
|
||||||
|
#define _CFFI_PRIM_UINT_FAST16 41
|
||||||
|
#define _CFFI_PRIM_INT_FAST32 42
|
||||||
|
#define _CFFI_PRIM_UINT_FAST32 43
|
||||||
|
#define _CFFI_PRIM_INT_FAST64 44
|
||||||
|
#define _CFFI_PRIM_UINT_FAST64 45
|
||||||
|
#define _CFFI_PRIM_INTMAX 46
|
||||||
|
#define _CFFI_PRIM_UINTMAX 47
|
||||||
|
#define _CFFI_PRIM_FLOATCOMPLEX 48
|
||||||
|
#define _CFFI_PRIM_DOUBLECOMPLEX 49
|
||||||
|
#define _CFFI_PRIM_CHAR16 50
|
||||||
|
#define _CFFI_PRIM_CHAR32 51
|
||||||
|
|
||||||
|
#define _CFFI__NUM_PRIM 52
|
||||||
|
#define _CFFI__UNKNOWN_PRIM (-1)
|
||||||
|
#define _CFFI__UNKNOWN_FLOAT_PRIM (-2)
|
||||||
|
#define _CFFI__UNKNOWN_LONG_DOUBLE (-3)
|
||||||
|
|
||||||
|
#define _CFFI__IO_FILE_STRUCT (-1)
|
||||||
|
|
||||||
|
|
||||||
|
struct _cffi_global_s {
|
||||||
|
const char *name;
|
||||||
|
void *address;
|
||||||
|
_cffi_opcode_t type_op;
|
||||||
|
void *size_or_direct_fn; // OP_GLOBAL_VAR: size, or 0 if unknown
|
||||||
|
// OP_CPYTHON_BLTN_*: addr of direct function
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_getconst_s {
|
||||||
|
unsigned long long value;
|
||||||
|
const struct _cffi_type_context_s *ctx;
|
||||||
|
int gindex;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_struct_union_s {
|
||||||
|
const char *name;
|
||||||
|
int type_index; // -> _cffi_types, on a OP_STRUCT_UNION
|
||||||
|
int flags; // _CFFI_F_* flags below
|
||||||
|
size_t size;
|
||||||
|
int alignment;
|
||||||
|
int first_field_index; // -> _cffi_fields array
|
||||||
|
int num_fields;
|
||||||
|
};
|
||||||
|
#define _CFFI_F_UNION 0x01 // is a union, not a struct
|
||||||
|
#define _CFFI_F_CHECK_FIELDS 0x02 // complain if fields are not in the
|
||||||
|
// "standard layout" or if some are missing
|
||||||
|
#define _CFFI_F_PACKED 0x04 // for CHECK_FIELDS, assume a packed struct
|
||||||
|
#define _CFFI_F_EXTERNAL 0x08 // in some other ffi.include()
|
||||||
|
#define _CFFI_F_OPAQUE 0x10 // opaque
|
||||||
|
|
||||||
|
struct _cffi_field_s {
|
||||||
|
const char *name;
|
||||||
|
size_t field_offset;
|
||||||
|
size_t field_size;
|
||||||
|
_cffi_opcode_t field_type_op;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_enum_s {
|
||||||
|
const char *name;
|
||||||
|
int type_index; // -> _cffi_types, on a OP_ENUM
|
||||||
|
int type_prim; // _CFFI_PRIM_xxx
|
||||||
|
const char *enumerators; // comma-delimited string
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_typename_s {
|
||||||
|
const char *name;
|
||||||
|
int type_index; /* if opaque, points to a possibly artificial
|
||||||
|
OP_STRUCT which is itself opaque */
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_type_context_s {
|
||||||
|
_cffi_opcode_t *types;
|
||||||
|
const struct _cffi_global_s *globals;
|
||||||
|
const struct _cffi_field_s *fields;
|
||||||
|
const struct _cffi_struct_union_s *struct_unions;
|
||||||
|
const struct _cffi_enum_s *enums;
|
||||||
|
const struct _cffi_typename_s *typenames;
|
||||||
|
int num_globals;
|
||||||
|
int num_struct_unions;
|
||||||
|
int num_enums;
|
||||||
|
int num_typenames;
|
||||||
|
const char *const *includes;
|
||||||
|
int num_types;
|
||||||
|
int flags; /* future extension */
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_parse_info_s {
|
||||||
|
const struct _cffi_type_context_s *ctx;
|
||||||
|
_cffi_opcode_t *output;
|
||||||
|
unsigned int output_size;
|
||||||
|
size_t error_location;
|
||||||
|
const char *error_message;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct _cffi_externpy_s {
|
||||||
|
const char *name;
|
||||||
|
size_t size_of_result;
|
||||||
|
void *reserved1, *reserved2;
|
||||||
|
};
|
||||||
|
|
||||||
|
#ifdef _CFFI_INTERNAL
|
||||||
|
static int parse_c_type(struct _cffi_parse_info_s *info, const char *input);
|
||||||
|
static int search_in_globals(const struct _cffi_type_context_s *ctx,
|
||||||
|
const char *search, size_t search_len);
|
||||||
|
static int search_in_struct_unions(const struct _cffi_type_context_s *ctx,
|
||||||
|
const char *search, size_t search_len);
|
||||||
|
#endif
|
||||||
|
|
@ -0,0 +1,121 @@
|
||||||
|
# pkg-config, https://www.freedesktop.org/wiki/Software/pkg-config/ integration for cffi
|
||||||
|
import sys, os, subprocess
|
||||||
|
|
||||||
|
from .error import PkgConfigError
|
||||||
|
|
||||||
|
|
||||||
|
def merge_flags(cfg1, cfg2):
|
||||||
|
"""Merge values from cffi config flags cfg2 to cf1
|
||||||
|
|
||||||
|
Example:
|
||||||
|
merge_flags({"libraries": ["one"]}, {"libraries": ["two"]})
|
||||||
|
{"libraries": ["one", "two"]}
|
||||||
|
"""
|
||||||
|
for key, value in cfg2.items():
|
||||||
|
if key not in cfg1:
|
||||||
|
cfg1[key] = value
|
||||||
|
else:
|
||||||
|
if not isinstance(cfg1[key], list):
|
||||||
|
raise TypeError("cfg1[%r] should be a list of strings" % (key,))
|
||||||
|
if not isinstance(value, list):
|
||||||
|
raise TypeError("cfg2[%r] should be a list of strings" % (key,))
|
||||||
|
cfg1[key].extend(value)
|
||||||
|
return cfg1
|
||||||
|
|
||||||
|
|
||||||
|
def call(libname, flag, encoding=sys.getfilesystemencoding()):
|
||||||
|
"""Calls pkg-config and returns the output if found
|
||||||
|
"""
|
||||||
|
a = ["pkg-config", "--print-errors"]
|
||||||
|
a.append(flag)
|
||||||
|
a.append(libname)
|
||||||
|
try:
|
||||||
|
pc = subprocess.Popen(a, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||||
|
except EnvironmentError as e:
|
||||||
|
raise PkgConfigError("cannot run pkg-config: %s" % (str(e).strip(),))
|
||||||
|
|
||||||
|
bout, berr = pc.communicate()
|
||||||
|
if pc.returncode != 0:
|
||||||
|
try:
|
||||||
|
berr = berr.decode(encoding)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
raise PkgConfigError(berr.strip())
|
||||||
|
|
||||||
|
if sys.version_info >= (3,) and not isinstance(bout, str): # Python 3.x
|
||||||
|
try:
|
||||||
|
bout = bout.decode(encoding)
|
||||||
|
except UnicodeDecodeError:
|
||||||
|
raise PkgConfigError("pkg-config %s %s returned bytes that cannot "
|
||||||
|
"be decoded with encoding %r:\n%r" %
|
||||||
|
(flag, libname, encoding, bout))
|
||||||
|
|
||||||
|
if os.altsep != '\\' and '\\' in bout:
|
||||||
|
raise PkgConfigError("pkg-config %s %s returned an unsupported "
|
||||||
|
"backslash-escaped output:\n%r" %
|
||||||
|
(flag, libname, bout))
|
||||||
|
return bout
|
||||||
|
|
||||||
|
|
||||||
|
def flags_from_pkgconfig(libs):
|
||||||
|
r"""Return compiler line flags for FFI.set_source based on pkg-config output
|
||||||
|
|
||||||
|
Usage
|
||||||
|
...
|
||||||
|
ffibuilder.set_source("_foo", pkgconfig = ["libfoo", "libbar >= 1.8.3"])
|
||||||
|
|
||||||
|
If pkg-config is installed on build machine, then arguments include_dirs,
|
||||||
|
library_dirs, libraries, define_macros, extra_compile_args and
|
||||||
|
extra_link_args are extended with an output of pkg-config for libfoo and
|
||||||
|
libbar.
|
||||||
|
|
||||||
|
Raises PkgConfigError in case the pkg-config call fails.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def get_include_dirs(string):
|
||||||
|
return [x[2:] for x in string.split() if x.startswith("-I")]
|
||||||
|
|
||||||
|
def get_library_dirs(string):
|
||||||
|
return [x[2:] for x in string.split() if x.startswith("-L")]
|
||||||
|
|
||||||
|
def get_libraries(string):
|
||||||
|
return [x[2:] for x in string.split() if x.startswith("-l")]
|
||||||
|
|
||||||
|
# convert -Dfoo=bar to list of tuples [("foo", "bar")] expected by distutils
|
||||||
|
def get_macros(string):
|
||||||
|
def _macro(x):
|
||||||
|
x = x[2:] # drop "-D"
|
||||||
|
if '=' in x:
|
||||||
|
return tuple(x.split("=", 1)) # "-Dfoo=bar" => ("foo", "bar")
|
||||||
|
else:
|
||||||
|
return (x, None) # "-Dfoo" => ("foo", None)
|
||||||
|
return [_macro(x) for x in string.split() if x.startswith("-D")]
|
||||||
|
|
||||||
|
def get_other_cflags(string):
|
||||||
|
return [x for x in string.split() if not x.startswith("-I") and
|
||||||
|
not x.startswith("-D")]
|
||||||
|
|
||||||
|
def get_other_libs(string):
|
||||||
|
return [x for x in string.split() if not x.startswith("-L") and
|
||||||
|
not x.startswith("-l")]
|
||||||
|
|
||||||
|
# return kwargs for given libname
|
||||||
|
def kwargs(libname):
|
||||||
|
fse = sys.getfilesystemencoding()
|
||||||
|
all_cflags = call(libname, "--cflags")
|
||||||
|
all_libs = call(libname, "--libs")
|
||||||
|
return {
|
||||||
|
"include_dirs": get_include_dirs(all_cflags),
|
||||||
|
"library_dirs": get_library_dirs(all_libs),
|
||||||
|
"libraries": get_libraries(all_libs),
|
||||||
|
"define_macros": get_macros(all_cflags),
|
||||||
|
"extra_compile_args": get_other_cflags(all_cflags),
|
||||||
|
"extra_link_args": get_other_libs(all_libs),
|
||||||
|
}
|
||||||
|
|
||||||
|
# merge all arguments together
|
||||||
|
ret = {}
|
||||||
|
for libname in libs:
|
||||||
|
lib_flags = kwargs(libname)
|
||||||
|
merge_flags(ret, lib_flags)
|
||||||
|
return ret
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,229 @@
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import sysconfig
|
||||||
|
|
||||||
|
try:
|
||||||
|
basestring
|
||||||
|
except NameError:
|
||||||
|
# Python 3.x
|
||||||
|
basestring = str
|
||||||
|
|
||||||
|
def error(msg):
|
||||||
|
from cffi._shimmed_dist_utils import DistutilsSetupError
|
||||||
|
raise DistutilsSetupError(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def execfile(filename, glob):
|
||||||
|
# We use execfile() (here rewritten for Python 3) instead of
|
||||||
|
# __import__() to load the build script. The problem with
|
||||||
|
# a normal import is that in some packages, the intermediate
|
||||||
|
# __init__.py files may already try to import the file that
|
||||||
|
# we are generating.
|
||||||
|
with open(filename) as f:
|
||||||
|
src = f.read()
|
||||||
|
src += '\n' # Python 2.6 compatibility
|
||||||
|
code = compile(src, filename, 'exec')
|
||||||
|
exec(code, glob, glob)
|
||||||
|
|
||||||
|
|
||||||
|
def add_cffi_module(dist, mod_spec):
|
||||||
|
from cffi.api import FFI
|
||||||
|
|
||||||
|
if not isinstance(mod_spec, basestring):
|
||||||
|
error("argument to 'cffi_modules=...' must be a str or a list of str,"
|
||||||
|
" not %r" % (type(mod_spec).__name__,))
|
||||||
|
mod_spec = str(mod_spec)
|
||||||
|
try:
|
||||||
|
build_file_name, ffi_var_name = mod_spec.split(':')
|
||||||
|
except ValueError:
|
||||||
|
error("%r must be of the form 'path/build.py:ffi_variable'" %
|
||||||
|
(mod_spec,))
|
||||||
|
if not os.path.exists(build_file_name):
|
||||||
|
ext = ''
|
||||||
|
rewritten = build_file_name.replace('.', '/') + '.py'
|
||||||
|
if os.path.exists(rewritten):
|
||||||
|
ext = ' (rewrite cffi_modules to [%r])' % (
|
||||||
|
rewritten + ':' + ffi_var_name,)
|
||||||
|
error("%r does not name an existing file%s" % (build_file_name, ext))
|
||||||
|
|
||||||
|
mod_vars = {'__name__': '__cffi__', '__file__': build_file_name}
|
||||||
|
execfile(build_file_name, mod_vars)
|
||||||
|
|
||||||
|
try:
|
||||||
|
ffi = mod_vars[ffi_var_name]
|
||||||
|
except KeyError:
|
||||||
|
error("%r: object %r not found in module" % (mod_spec,
|
||||||
|
ffi_var_name))
|
||||||
|
if not isinstance(ffi, FFI):
|
||||||
|
ffi = ffi() # maybe it's a function instead of directly an ffi
|
||||||
|
if not isinstance(ffi, FFI):
|
||||||
|
error("%r is not an FFI instance (got %r)" % (mod_spec,
|
||||||
|
type(ffi).__name__))
|
||||||
|
if not hasattr(ffi, '_assigned_source'):
|
||||||
|
error("%r: the set_source() method was not called" % (mod_spec,))
|
||||||
|
module_name, source, source_extension, kwds = ffi._assigned_source
|
||||||
|
if ffi._windows_unicode:
|
||||||
|
kwds = kwds.copy()
|
||||||
|
ffi._apply_windows_unicode(kwds)
|
||||||
|
|
||||||
|
if source is None:
|
||||||
|
_add_py_module(dist, ffi, module_name)
|
||||||
|
else:
|
||||||
|
_add_c_module(dist, ffi, module_name, source, source_extension, kwds)
|
||||||
|
|
||||||
|
def _set_py_limited_api(Extension, kwds):
|
||||||
|
"""
|
||||||
|
Add py_limited_api to kwds if setuptools >= 26 is in use.
|
||||||
|
Do not alter the setting if it already exists.
|
||||||
|
Setuptools takes care of ignoring the flag on Python 2 and PyPy.
|
||||||
|
|
||||||
|
CPython itself should ignore the flag in a debugging version
|
||||||
|
(by not listing .abi3.so in the extensions it supports), but
|
||||||
|
it doesn't so far, creating troubles. That's why we check
|
||||||
|
for "not hasattr(sys, 'gettotalrefcount')" (the 2.7 compatible equivalent
|
||||||
|
of 'd' not in sys.abiflags). (http://bugs.python.org/issue28401)
|
||||||
|
|
||||||
|
On Windows, with CPython <= 3.4, it's better not to use py_limited_api
|
||||||
|
because virtualenv *still* doesn't copy PYTHON3.DLL on these versions.
|
||||||
|
Recently (2020) we started shipping only >= 3.5 wheels, though. So
|
||||||
|
we'll give it another try and set py_limited_api on Windows >= 3.5.
|
||||||
|
"""
|
||||||
|
from cffi._shimmed_dist_utils import log
|
||||||
|
from cffi import recompiler
|
||||||
|
|
||||||
|
if ('py_limited_api' not in kwds and not hasattr(sys, 'gettotalrefcount')
|
||||||
|
and recompiler.USE_LIMITED_API):
|
||||||
|
import setuptools
|
||||||
|
try:
|
||||||
|
setuptools_major_version = int(setuptools.__version__.partition('.')[0])
|
||||||
|
if setuptools_major_version >= 26:
|
||||||
|
kwds['py_limited_api'] = True
|
||||||
|
except ValueError: # certain development versions of setuptools
|
||||||
|
# If we don't know the version number of setuptools, we
|
||||||
|
# try to set 'py_limited_api' anyway. At worst, we get a
|
||||||
|
# warning.
|
||||||
|
kwds['py_limited_api'] = True
|
||||||
|
|
||||||
|
if sysconfig.get_config_var("Py_GIL_DISABLED"):
|
||||||
|
if kwds.get('py_limited_api'):
|
||||||
|
log.info("Ignoring py_limited_api=True for free-threaded build.")
|
||||||
|
|
||||||
|
kwds['py_limited_api'] = False
|
||||||
|
|
||||||
|
if kwds.get('py_limited_api') is False:
|
||||||
|
# avoid setting Py_LIMITED_API if py_limited_api=False
|
||||||
|
# which _cffi_include.h does unless _CFFI_NO_LIMITED_API is defined
|
||||||
|
kwds.setdefault("define_macros", []).append(("_CFFI_NO_LIMITED_API", None))
|
||||||
|
return kwds
|
||||||
|
|
||||||
|
def _add_c_module(dist, ffi, module_name, source, source_extension, kwds):
|
||||||
|
# We are a setuptools extension. Need this build_ext for py_limited_api.
|
||||||
|
from setuptools.command.build_ext import build_ext
|
||||||
|
from cffi._shimmed_dist_utils import Extension, log, mkpath
|
||||||
|
from cffi import recompiler
|
||||||
|
|
||||||
|
allsources = ['$PLACEHOLDER']
|
||||||
|
allsources.extend(kwds.pop('sources', []))
|
||||||
|
kwds = _set_py_limited_api(Extension, kwds)
|
||||||
|
ext = Extension(name=module_name, sources=allsources, **kwds)
|
||||||
|
|
||||||
|
def make_mod(tmpdir, pre_run=None):
|
||||||
|
c_file = os.path.join(tmpdir, module_name + source_extension)
|
||||||
|
log.info("generating cffi module %r" % c_file)
|
||||||
|
mkpath(tmpdir)
|
||||||
|
# a setuptools-only, API-only hook: called with the "ext" and "ffi"
|
||||||
|
# arguments just before we turn the ffi into C code. To use it,
|
||||||
|
# subclass the 'distutils.command.build_ext.build_ext' class and
|
||||||
|
# add a method 'def pre_run(self, ext, ffi)'.
|
||||||
|
if pre_run is not None:
|
||||||
|
pre_run(ext, ffi)
|
||||||
|
updated = recompiler.make_c_source(ffi, module_name, source, c_file)
|
||||||
|
if not updated:
|
||||||
|
log.info("already up-to-date")
|
||||||
|
return c_file
|
||||||
|
|
||||||
|
if dist.ext_modules is None:
|
||||||
|
dist.ext_modules = []
|
||||||
|
dist.ext_modules.append(ext)
|
||||||
|
|
||||||
|
base_class = dist.cmdclass.get('build_ext', build_ext)
|
||||||
|
class build_ext_make_mod(base_class):
|
||||||
|
def run(self):
|
||||||
|
if ext.sources[0] == '$PLACEHOLDER':
|
||||||
|
pre_run = getattr(self, 'pre_run', None)
|
||||||
|
ext.sources[0] = make_mod(self.build_temp, pre_run)
|
||||||
|
base_class.run(self)
|
||||||
|
dist.cmdclass['build_ext'] = build_ext_make_mod
|
||||||
|
# NB. multiple runs here will create multiple 'build_ext_make_mod'
|
||||||
|
# classes. Even in this case the 'build_ext' command should be
|
||||||
|
# run once; but just in case, the logic above does nothing if
|
||||||
|
# called again.
|
||||||
|
|
||||||
|
|
||||||
|
def _add_py_module(dist, ffi, module_name):
|
||||||
|
from setuptools.command.build_py import build_py
|
||||||
|
from setuptools.command.build_ext import build_ext
|
||||||
|
from cffi._shimmed_dist_utils import log, mkpath
|
||||||
|
from cffi import recompiler
|
||||||
|
|
||||||
|
def generate_mod(py_file):
|
||||||
|
log.info("generating cffi module %r" % py_file)
|
||||||
|
mkpath(os.path.dirname(py_file))
|
||||||
|
updated = recompiler.make_py_source(ffi, module_name, py_file)
|
||||||
|
if not updated:
|
||||||
|
log.info("already up-to-date")
|
||||||
|
|
||||||
|
base_class = dist.cmdclass.get('build_py', build_py)
|
||||||
|
class build_py_make_mod(base_class):
|
||||||
|
def run(self):
|
||||||
|
base_class.run(self)
|
||||||
|
module_path = module_name.split('.')
|
||||||
|
module_path[-1] += '.py'
|
||||||
|
generate_mod(os.path.join(self.build_lib, *module_path))
|
||||||
|
def get_source_files(self):
|
||||||
|
# This is called from 'setup.py sdist' only. Exclude
|
||||||
|
# the generate .py module in this case.
|
||||||
|
saved_py_modules = self.py_modules
|
||||||
|
try:
|
||||||
|
if saved_py_modules:
|
||||||
|
self.py_modules = [m for m in saved_py_modules
|
||||||
|
if m != module_name]
|
||||||
|
return base_class.get_source_files(self)
|
||||||
|
finally:
|
||||||
|
self.py_modules = saved_py_modules
|
||||||
|
dist.cmdclass['build_py'] = build_py_make_mod
|
||||||
|
|
||||||
|
# distutils and setuptools have no notion I could find of a
|
||||||
|
# generated python module. If we don't add module_name to
|
||||||
|
# dist.py_modules, then things mostly work but there are some
|
||||||
|
# combination of options (--root and --record) that will miss
|
||||||
|
# the module. So we add it here, which gives a few apparently
|
||||||
|
# harmless warnings about not finding the file outside the
|
||||||
|
# build directory.
|
||||||
|
# Then we need to hack more in get_source_files(); see above.
|
||||||
|
if dist.py_modules is None:
|
||||||
|
dist.py_modules = []
|
||||||
|
dist.py_modules.append(module_name)
|
||||||
|
|
||||||
|
# the following is only for "build_ext -i"
|
||||||
|
base_class_2 = dist.cmdclass.get('build_ext', build_ext)
|
||||||
|
class build_ext_make_mod(base_class_2):
|
||||||
|
def run(self):
|
||||||
|
base_class_2.run(self)
|
||||||
|
if self.inplace:
|
||||||
|
# from get_ext_fullpath() in distutils/command/build_ext.py
|
||||||
|
module_path = module_name.split('.')
|
||||||
|
package = '.'.join(module_path[:-1])
|
||||||
|
build_py = self.get_finalized_command('build_py')
|
||||||
|
package_dir = build_py.get_package_dir(package)
|
||||||
|
file_name = module_path[-1] + '.py'
|
||||||
|
generate_mod(os.path.join(package_dir, file_name))
|
||||||
|
dist.cmdclass['build_ext'] = build_ext_make_mod
|
||||||
|
|
||||||
|
def cffi_modules(dist, attr, value):
|
||||||
|
assert attr == 'cffi_modules'
|
||||||
|
if isinstance(value, basestring):
|
||||||
|
value = [value]
|
||||||
|
|
||||||
|
for cffi_module in value:
|
||||||
|
add_cffi_module(dist, cffi_module)
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,679 @@
|
||||||
|
#
|
||||||
|
# DEPRECATED: implementation for ffi.verify()
|
||||||
|
#
|
||||||
|
import sys, os
|
||||||
|
import types
|
||||||
|
|
||||||
|
from . import model
|
||||||
|
from .error import VerificationError
|
||||||
|
|
||||||
|
|
||||||
|
class VGenericEngine(object):
|
||||||
|
_class_key = 'g'
|
||||||
|
_gen_python_module = False
|
||||||
|
|
||||||
|
def __init__(self, verifier):
|
||||||
|
self.verifier = verifier
|
||||||
|
self.ffi = verifier.ffi
|
||||||
|
self.export_symbols = []
|
||||||
|
self._struct_pending_verification = {}
|
||||||
|
|
||||||
|
def patch_extension_kwds(self, kwds):
|
||||||
|
# add 'export_symbols' to the dictionary. Note that we add the
|
||||||
|
# list before filling it. When we fill it, it will thus also show
|
||||||
|
# up in kwds['export_symbols'].
|
||||||
|
kwds.setdefault('export_symbols', self.export_symbols)
|
||||||
|
|
||||||
|
def find_module(self, module_name, path, so_suffixes):
|
||||||
|
for so_suffix in so_suffixes:
|
||||||
|
basename = module_name + so_suffix
|
||||||
|
if path is None:
|
||||||
|
path = sys.path
|
||||||
|
for dirname in path:
|
||||||
|
filename = os.path.join(dirname, basename)
|
||||||
|
if os.path.isfile(filename):
|
||||||
|
return filename
|
||||||
|
|
||||||
|
def collect_types(self):
|
||||||
|
pass # not needed in the generic engine
|
||||||
|
|
||||||
|
def _prnt(self, what=''):
|
||||||
|
self._f.write(what + '\n')
|
||||||
|
|
||||||
|
def write_source_to_f(self):
|
||||||
|
prnt = self._prnt
|
||||||
|
# first paste some standard set of lines that are mostly '#include'
|
||||||
|
prnt(cffimod_header)
|
||||||
|
# then paste the C source given by the user, verbatim.
|
||||||
|
prnt(self.verifier.preamble)
|
||||||
|
#
|
||||||
|
# call generate_gen_xxx_decl(), for every xxx found from
|
||||||
|
# ffi._parser._declarations. This generates all the functions.
|
||||||
|
self._generate('decl')
|
||||||
|
#
|
||||||
|
# on Windows, distutils insists on putting init_cffi_xyz in
|
||||||
|
# 'export_symbols', so instead of fighting it, just give up and
|
||||||
|
# give it one
|
||||||
|
if sys.platform == 'win32':
|
||||||
|
if sys.version_info >= (3,):
|
||||||
|
prefix = 'PyInit_'
|
||||||
|
else:
|
||||||
|
prefix = 'init'
|
||||||
|
modname = self.verifier.get_module_name()
|
||||||
|
prnt("void %s%s(void) { }\n" % (prefix, modname))
|
||||||
|
|
||||||
|
def load_library(self, flags=0):
|
||||||
|
# import it with the CFFI backend
|
||||||
|
backend = self.ffi._backend
|
||||||
|
# needs to make a path that contains '/', on Posix
|
||||||
|
filename = os.path.join(os.curdir, self.verifier.modulefilename)
|
||||||
|
module = backend.load_library(filename, flags)
|
||||||
|
#
|
||||||
|
# call loading_gen_struct() to get the struct layout inferred by
|
||||||
|
# the C compiler
|
||||||
|
self._load(module, 'loading')
|
||||||
|
|
||||||
|
# build the FFILibrary class and instance, this is a module subclass
|
||||||
|
# because modules are expected to have usually-constant-attributes and
|
||||||
|
# in PyPy this means the JIT is able to treat attributes as constant,
|
||||||
|
# which we want.
|
||||||
|
class FFILibrary(types.ModuleType):
|
||||||
|
_cffi_generic_module = module
|
||||||
|
_cffi_ffi = self.ffi
|
||||||
|
_cffi_dir = []
|
||||||
|
def __dir__(self):
|
||||||
|
return FFILibrary._cffi_dir
|
||||||
|
library = FFILibrary("")
|
||||||
|
#
|
||||||
|
# finally, call the loaded_gen_xxx() functions. This will set
|
||||||
|
# up the 'library' object.
|
||||||
|
self._load(module, 'loaded', library=library)
|
||||||
|
return library
|
||||||
|
|
||||||
|
def _get_declarations(self):
|
||||||
|
lst = [(key, tp) for (key, (tp, qual)) in
|
||||||
|
self.ffi._parser._declarations.items()]
|
||||||
|
lst.sort()
|
||||||
|
return lst
|
||||||
|
|
||||||
|
def _generate(self, step_name):
|
||||||
|
for name, tp in self._get_declarations():
|
||||||
|
kind, realname = name.split(' ', 1)
|
||||||
|
try:
|
||||||
|
method = getattr(self, '_generate_gen_%s_%s' % (kind,
|
||||||
|
step_name))
|
||||||
|
except AttributeError:
|
||||||
|
raise VerificationError(
|
||||||
|
"not implemented in verify(): %r" % name)
|
||||||
|
try:
|
||||||
|
method(tp, realname)
|
||||||
|
except Exception as e:
|
||||||
|
model.attach_exception_info(e, name)
|
||||||
|
raise
|
||||||
|
|
||||||
|
def _load(self, module, step_name, **kwds):
|
||||||
|
for name, tp in self._get_declarations():
|
||||||
|
kind, realname = name.split(' ', 1)
|
||||||
|
method = getattr(self, '_%s_gen_%s' % (step_name, kind))
|
||||||
|
try:
|
||||||
|
method(tp, realname, module, **kwds)
|
||||||
|
except Exception as e:
|
||||||
|
model.attach_exception_info(e, name)
|
||||||
|
raise
|
||||||
|
|
||||||
|
def _generate_nothing(self, tp, name):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def _loaded_noop(self, tp, name, module, **kwds):
|
||||||
|
pass
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# typedefs: generates no code so far
|
||||||
|
|
||||||
|
_generate_gen_typedef_decl = _generate_nothing
|
||||||
|
_loading_gen_typedef = _loaded_noop
|
||||||
|
_loaded_gen_typedef = _loaded_noop
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# function declarations
|
||||||
|
|
||||||
|
def _generate_gen_function_decl(self, tp, name):
|
||||||
|
assert isinstance(tp, model.FunctionPtrType)
|
||||||
|
if tp.ellipsis:
|
||||||
|
# cannot support vararg functions better than this: check for its
|
||||||
|
# exact type (including the fixed arguments), and build it as a
|
||||||
|
# constant function pointer (no _cffi_f_%s wrapper)
|
||||||
|
self._generate_gen_const(False, name, tp)
|
||||||
|
return
|
||||||
|
prnt = self._prnt
|
||||||
|
numargs = len(tp.args)
|
||||||
|
argnames = []
|
||||||
|
for i, type in enumerate(tp.args):
|
||||||
|
indirection = ''
|
||||||
|
if isinstance(type, model.StructOrUnion):
|
||||||
|
indirection = '*'
|
||||||
|
argnames.append('%sx%d' % (indirection, i))
|
||||||
|
context = 'argument of %s' % name
|
||||||
|
arglist = [type.get_c_name(' %s' % arg, context)
|
||||||
|
for type, arg in zip(tp.args, argnames)]
|
||||||
|
tpresult = tp.result
|
||||||
|
if isinstance(tpresult, model.StructOrUnion):
|
||||||
|
arglist.insert(0, tpresult.get_c_name(' *r', context))
|
||||||
|
tpresult = model.void_type
|
||||||
|
arglist = ', '.join(arglist) or 'void'
|
||||||
|
wrappername = '_cffi_f_%s' % name
|
||||||
|
self.export_symbols.append(wrappername)
|
||||||
|
if tp.abi:
|
||||||
|
abi = tp.abi + ' '
|
||||||
|
else:
|
||||||
|
abi = ''
|
||||||
|
funcdecl = ' %s%s(%s)' % (abi, wrappername, arglist)
|
||||||
|
context = 'result of %s' % name
|
||||||
|
prnt(tpresult.get_c_name(funcdecl, context))
|
||||||
|
prnt('{')
|
||||||
|
#
|
||||||
|
if isinstance(tp.result, model.StructOrUnion):
|
||||||
|
result_code = '*r = '
|
||||||
|
elif not isinstance(tp.result, model.VoidType):
|
||||||
|
result_code = 'return '
|
||||||
|
else:
|
||||||
|
result_code = ''
|
||||||
|
prnt(' %s%s(%s);' % (result_code, name, ', '.join(argnames)))
|
||||||
|
prnt('}')
|
||||||
|
prnt()
|
||||||
|
|
||||||
|
_loading_gen_function = _loaded_noop
|
||||||
|
|
||||||
|
def _loaded_gen_function(self, tp, name, module, library):
|
||||||
|
assert isinstance(tp, model.FunctionPtrType)
|
||||||
|
if tp.ellipsis:
|
||||||
|
newfunction = self._load_constant(False, tp, name, module)
|
||||||
|
else:
|
||||||
|
indirections = []
|
||||||
|
base_tp = tp
|
||||||
|
if (any(isinstance(typ, model.StructOrUnion) for typ in tp.args)
|
||||||
|
or isinstance(tp.result, model.StructOrUnion)):
|
||||||
|
indirect_args = []
|
||||||
|
for i, typ in enumerate(tp.args):
|
||||||
|
if isinstance(typ, model.StructOrUnion):
|
||||||
|
typ = model.PointerType(typ)
|
||||||
|
indirections.append((i, typ))
|
||||||
|
indirect_args.append(typ)
|
||||||
|
indirect_result = tp.result
|
||||||
|
if isinstance(indirect_result, model.StructOrUnion):
|
||||||
|
if indirect_result.fldtypes is None:
|
||||||
|
raise TypeError("'%s' is used as result type, "
|
||||||
|
"but is opaque" % (
|
||||||
|
indirect_result._get_c_name(),))
|
||||||
|
indirect_result = model.PointerType(indirect_result)
|
||||||
|
indirect_args.insert(0, indirect_result)
|
||||||
|
indirections.insert(0, ("result", indirect_result))
|
||||||
|
indirect_result = model.void_type
|
||||||
|
tp = model.FunctionPtrType(tuple(indirect_args),
|
||||||
|
indirect_result, tp.ellipsis)
|
||||||
|
BFunc = self.ffi._get_cached_btype(tp)
|
||||||
|
wrappername = '_cffi_f_%s' % name
|
||||||
|
newfunction = module.load_function(BFunc, wrappername)
|
||||||
|
for i, typ in indirections:
|
||||||
|
newfunction = self._make_struct_wrapper(newfunction, i, typ,
|
||||||
|
base_tp)
|
||||||
|
setattr(library, name, newfunction)
|
||||||
|
type(library)._cffi_dir.append(name)
|
||||||
|
|
||||||
|
def _make_struct_wrapper(self, oldfunc, i, tp, base_tp):
|
||||||
|
backend = self.ffi._backend
|
||||||
|
BType = self.ffi._get_cached_btype(tp)
|
||||||
|
if i == "result":
|
||||||
|
ffi = self.ffi
|
||||||
|
def newfunc(*args):
|
||||||
|
res = ffi.new(BType)
|
||||||
|
oldfunc(res, *args)
|
||||||
|
return res[0]
|
||||||
|
else:
|
||||||
|
def newfunc(*args):
|
||||||
|
args = args[:i] + (backend.newp(BType, args[i]),) + args[i+1:]
|
||||||
|
return oldfunc(*args)
|
||||||
|
newfunc._cffi_base_type = base_tp
|
||||||
|
return newfunc
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# named structs
|
||||||
|
|
||||||
|
def _generate_gen_struct_decl(self, tp, name):
|
||||||
|
assert name == tp.name
|
||||||
|
self._generate_struct_or_union_decl(tp, 'struct', name)
|
||||||
|
|
||||||
|
def _loading_gen_struct(self, tp, name, module):
|
||||||
|
self._loading_struct_or_union(tp, 'struct', name, module)
|
||||||
|
|
||||||
|
def _loaded_gen_struct(self, tp, name, module, **kwds):
|
||||||
|
self._loaded_struct_or_union(tp)
|
||||||
|
|
||||||
|
def _generate_gen_union_decl(self, tp, name):
|
||||||
|
assert name == tp.name
|
||||||
|
self._generate_struct_or_union_decl(tp, 'union', name)
|
||||||
|
|
||||||
|
def _loading_gen_union(self, tp, name, module):
|
||||||
|
self._loading_struct_or_union(tp, 'union', name, module)
|
||||||
|
|
||||||
|
def _loaded_gen_union(self, tp, name, module, **kwds):
|
||||||
|
self._loaded_struct_or_union(tp)
|
||||||
|
|
||||||
|
def _generate_struct_or_union_decl(self, tp, prefix, name):
|
||||||
|
if tp.fldnames is None:
|
||||||
|
return # nothing to do with opaque structs
|
||||||
|
checkfuncname = '_cffi_check_%s_%s' % (prefix, name)
|
||||||
|
layoutfuncname = '_cffi_layout_%s_%s' % (prefix, name)
|
||||||
|
cname = ('%s %s' % (prefix, name)).strip()
|
||||||
|
#
|
||||||
|
prnt = self._prnt
|
||||||
|
prnt('static void %s(%s *p)' % (checkfuncname, cname))
|
||||||
|
prnt('{')
|
||||||
|
prnt(' /* only to generate compile-time warnings or errors */')
|
||||||
|
prnt(' (void)p;')
|
||||||
|
for fname, ftype, fbitsize, fqual in tp.enumfields():
|
||||||
|
if (isinstance(ftype, model.PrimitiveType)
|
||||||
|
and ftype.is_integer_type()) or fbitsize >= 0:
|
||||||
|
# accept all integers, but complain on float or double
|
||||||
|
prnt(' (void)((p->%s) << 1);' % fname)
|
||||||
|
else:
|
||||||
|
# only accept exactly the type declared.
|
||||||
|
try:
|
||||||
|
prnt(' { %s = &p->%s; (void)tmp; }' % (
|
||||||
|
ftype.get_c_name('*tmp', 'field %r'%fname, quals=fqual),
|
||||||
|
fname))
|
||||||
|
except VerificationError as e:
|
||||||
|
prnt(' /* %s */' % str(e)) # cannot verify it, ignore
|
||||||
|
prnt('}')
|
||||||
|
self.export_symbols.append(layoutfuncname)
|
||||||
|
prnt('intptr_t %s(intptr_t i)' % (layoutfuncname,))
|
||||||
|
prnt('{')
|
||||||
|
prnt(' struct _cffi_aligncheck { char x; %s y; };' % cname)
|
||||||
|
prnt(' static intptr_t nums[] = {')
|
||||||
|
prnt(' sizeof(%s),' % cname)
|
||||||
|
prnt(' offsetof(struct _cffi_aligncheck, y),')
|
||||||
|
for fname, ftype, fbitsize, fqual in tp.enumfields():
|
||||||
|
if fbitsize >= 0:
|
||||||
|
continue # xxx ignore fbitsize for now
|
||||||
|
prnt(' offsetof(%s, %s),' % (cname, fname))
|
||||||
|
if isinstance(ftype, model.ArrayType) and ftype.length is None:
|
||||||
|
prnt(' 0, /* %s */' % ftype._get_c_name())
|
||||||
|
else:
|
||||||
|
prnt(' sizeof(((%s *)0)->%s),' % (cname, fname))
|
||||||
|
prnt(' -1')
|
||||||
|
prnt(' };')
|
||||||
|
prnt(' return nums[i];')
|
||||||
|
prnt(' /* the next line is not executed, but compiled */')
|
||||||
|
prnt(' %s(0);' % (checkfuncname,))
|
||||||
|
prnt('}')
|
||||||
|
prnt()
|
||||||
|
|
||||||
|
def _loading_struct_or_union(self, tp, prefix, name, module):
|
||||||
|
if tp.fldnames is None:
|
||||||
|
return # nothing to do with opaque structs
|
||||||
|
layoutfuncname = '_cffi_layout_%s_%s' % (prefix, name)
|
||||||
|
#
|
||||||
|
BFunc = self.ffi._typeof_locked("intptr_t(*)(intptr_t)")[0]
|
||||||
|
function = module.load_function(BFunc, layoutfuncname)
|
||||||
|
layout = []
|
||||||
|
num = 0
|
||||||
|
while True:
|
||||||
|
x = function(num)
|
||||||
|
if x < 0: break
|
||||||
|
layout.append(x)
|
||||||
|
num += 1
|
||||||
|
if isinstance(tp, model.StructOrUnion) and tp.partial:
|
||||||
|
# use the function()'s sizes and offsets to guide the
|
||||||
|
# layout of the struct
|
||||||
|
totalsize = layout[0]
|
||||||
|
totalalignment = layout[1]
|
||||||
|
fieldofs = layout[2::2]
|
||||||
|
fieldsize = layout[3::2]
|
||||||
|
tp.force_flatten()
|
||||||
|
assert len(fieldofs) == len(fieldsize) == len(tp.fldnames)
|
||||||
|
tp.fixedlayout = fieldofs, fieldsize, totalsize, totalalignment
|
||||||
|
else:
|
||||||
|
cname = ('%s %s' % (prefix, name)).strip()
|
||||||
|
self._struct_pending_verification[tp] = layout, cname
|
||||||
|
|
||||||
|
def _loaded_struct_or_union(self, tp):
|
||||||
|
if tp.fldnames is None:
|
||||||
|
return # nothing to do with opaque structs
|
||||||
|
self.ffi._get_cached_btype(tp) # force 'fixedlayout' to be considered
|
||||||
|
|
||||||
|
if tp in self._struct_pending_verification:
|
||||||
|
# check that the layout sizes and offsets match the real ones
|
||||||
|
def check(realvalue, expectedvalue, msg):
|
||||||
|
if realvalue != expectedvalue:
|
||||||
|
raise VerificationError(
|
||||||
|
"%s (we have %d, but C compiler says %d)"
|
||||||
|
% (msg, expectedvalue, realvalue))
|
||||||
|
ffi = self.ffi
|
||||||
|
BStruct = ffi._get_cached_btype(tp)
|
||||||
|
layout, cname = self._struct_pending_verification.pop(tp)
|
||||||
|
check(layout[0], ffi.sizeof(BStruct), "wrong total size")
|
||||||
|
check(layout[1], ffi.alignof(BStruct), "wrong total alignment")
|
||||||
|
i = 2
|
||||||
|
for fname, ftype, fbitsize, fqual in tp.enumfields():
|
||||||
|
if fbitsize >= 0:
|
||||||
|
continue # xxx ignore fbitsize for now
|
||||||
|
check(layout[i], ffi.offsetof(BStruct, fname),
|
||||||
|
"wrong offset for field %r" % (fname,))
|
||||||
|
if layout[i+1] != 0:
|
||||||
|
BField = ffi._get_cached_btype(ftype)
|
||||||
|
check(layout[i+1], ffi.sizeof(BField),
|
||||||
|
"wrong size for field %r" % (fname,))
|
||||||
|
i += 2
|
||||||
|
assert i == len(layout)
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# 'anonymous' declarations. These are produced for anonymous structs
|
||||||
|
# or unions; the 'name' is obtained by a typedef.
|
||||||
|
|
||||||
|
def _generate_gen_anonymous_decl(self, tp, name):
|
||||||
|
if isinstance(tp, model.EnumType):
|
||||||
|
self._generate_gen_enum_decl(tp, name, '')
|
||||||
|
else:
|
||||||
|
self._generate_struct_or_union_decl(tp, '', name)
|
||||||
|
|
||||||
|
def _loading_gen_anonymous(self, tp, name, module):
|
||||||
|
if isinstance(tp, model.EnumType):
|
||||||
|
self._loading_gen_enum(tp, name, module, '')
|
||||||
|
else:
|
||||||
|
self._loading_struct_or_union(tp, '', name, module)
|
||||||
|
|
||||||
|
def _loaded_gen_anonymous(self, tp, name, module, **kwds):
|
||||||
|
if isinstance(tp, model.EnumType):
|
||||||
|
self._loaded_gen_enum(tp, name, module, **kwds)
|
||||||
|
else:
|
||||||
|
self._loaded_struct_or_union(tp)
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# constants, likely declared with '#define'
|
||||||
|
|
||||||
|
def _generate_gen_const(self, is_int, name, tp=None, category='const',
|
||||||
|
check_value=None):
|
||||||
|
prnt = self._prnt
|
||||||
|
funcname = '_cffi_%s_%s' % (category, name)
|
||||||
|
self.export_symbols.append(funcname)
|
||||||
|
if check_value is not None:
|
||||||
|
assert is_int
|
||||||
|
assert category == 'const'
|
||||||
|
prnt('int %s(char *out_error)' % funcname)
|
||||||
|
prnt('{')
|
||||||
|
self._check_int_constant_value(name, check_value)
|
||||||
|
prnt(' return 0;')
|
||||||
|
prnt('}')
|
||||||
|
elif is_int:
|
||||||
|
assert category == 'const'
|
||||||
|
prnt('int %s(long long *out_value)' % funcname)
|
||||||
|
prnt('{')
|
||||||
|
prnt(' *out_value = (long long)(%s);' % (name,))
|
||||||
|
prnt(' return (%s) <= 0;' % (name,))
|
||||||
|
prnt('}')
|
||||||
|
else:
|
||||||
|
assert tp is not None
|
||||||
|
assert check_value is None
|
||||||
|
if category == 'var':
|
||||||
|
ampersand = '&'
|
||||||
|
else:
|
||||||
|
ampersand = ''
|
||||||
|
extra = ''
|
||||||
|
if category == 'const' and isinstance(tp, model.StructOrUnion):
|
||||||
|
extra = 'const *'
|
||||||
|
ampersand = '&'
|
||||||
|
prnt(tp.get_c_name(' %s%s(void)' % (extra, funcname), name))
|
||||||
|
prnt('{')
|
||||||
|
prnt(' return (%s%s);' % (ampersand, name))
|
||||||
|
prnt('}')
|
||||||
|
prnt()
|
||||||
|
|
||||||
|
def _generate_gen_constant_decl(self, tp, name):
|
||||||
|
is_int = isinstance(tp, model.PrimitiveType) and tp.is_integer_type()
|
||||||
|
self._generate_gen_const(is_int, name, tp)
|
||||||
|
|
||||||
|
_loading_gen_constant = _loaded_noop
|
||||||
|
|
||||||
|
def _load_constant(self, is_int, tp, name, module, check_value=None):
|
||||||
|
funcname = '_cffi_const_%s' % name
|
||||||
|
if check_value is not None:
|
||||||
|
assert is_int
|
||||||
|
self._load_known_int_constant(module, funcname)
|
||||||
|
value = check_value
|
||||||
|
elif is_int:
|
||||||
|
BType = self.ffi._typeof_locked("long long*")[0]
|
||||||
|
BFunc = self.ffi._typeof_locked("int(*)(long long*)")[0]
|
||||||
|
function = module.load_function(BFunc, funcname)
|
||||||
|
p = self.ffi.new(BType)
|
||||||
|
negative = function(p)
|
||||||
|
value = int(p[0])
|
||||||
|
if value < 0 and not negative:
|
||||||
|
BLongLong = self.ffi._typeof_locked("long long")[0]
|
||||||
|
value += (1 << (8*self.ffi.sizeof(BLongLong)))
|
||||||
|
else:
|
||||||
|
assert check_value is None
|
||||||
|
fntypeextra = '(*)(void)'
|
||||||
|
if isinstance(tp, model.StructOrUnion):
|
||||||
|
fntypeextra = '*' + fntypeextra
|
||||||
|
BFunc = self.ffi._typeof_locked(tp.get_c_name(fntypeextra, name))[0]
|
||||||
|
function = module.load_function(BFunc, funcname)
|
||||||
|
value = function()
|
||||||
|
if isinstance(tp, model.StructOrUnion):
|
||||||
|
value = value[0]
|
||||||
|
return value
|
||||||
|
|
||||||
|
def _loaded_gen_constant(self, tp, name, module, library):
|
||||||
|
is_int = isinstance(tp, model.PrimitiveType) and tp.is_integer_type()
|
||||||
|
value = self._load_constant(is_int, tp, name, module)
|
||||||
|
setattr(library, name, value)
|
||||||
|
type(library)._cffi_dir.append(name)
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# enums
|
||||||
|
|
||||||
|
def _check_int_constant_value(self, name, value):
|
||||||
|
prnt = self._prnt
|
||||||
|
if value <= 0:
|
||||||
|
prnt(' if ((%s) > 0 || (long)(%s) != %dL) {' % (
|
||||||
|
name, name, value))
|
||||||
|
else:
|
||||||
|
prnt(' if ((%s) <= 0 || (unsigned long)(%s) != %dUL) {' % (
|
||||||
|
name, name, value))
|
||||||
|
prnt(' char buf[64];')
|
||||||
|
prnt(' if ((%s) <= 0)' % name)
|
||||||
|
prnt(' sprintf(buf, "%%ld", (long)(%s));' % name)
|
||||||
|
prnt(' else')
|
||||||
|
prnt(' sprintf(buf, "%%lu", (unsigned long)(%s));' %
|
||||||
|
name)
|
||||||
|
prnt(' sprintf(out_error, "%s has the real value %s, not %s",')
|
||||||
|
prnt(' "%s", buf, "%d");' % (name[:100], value))
|
||||||
|
prnt(' return -1;')
|
||||||
|
prnt(' }')
|
||||||
|
|
||||||
|
def _load_known_int_constant(self, module, funcname):
|
||||||
|
BType = self.ffi._typeof_locked("char[]")[0]
|
||||||
|
BFunc = self.ffi._typeof_locked("int(*)(char*)")[0]
|
||||||
|
function = module.load_function(BFunc, funcname)
|
||||||
|
p = self.ffi.new(BType, 256)
|
||||||
|
if function(p) < 0:
|
||||||
|
error = self.ffi.string(p)
|
||||||
|
if sys.version_info >= (3,):
|
||||||
|
error = str(error, 'utf-8')
|
||||||
|
raise VerificationError(error)
|
||||||
|
|
||||||
|
def _enum_funcname(self, prefix, name):
|
||||||
|
# "$enum_$1" => "___D_enum____D_1"
|
||||||
|
name = name.replace('$', '___D_')
|
||||||
|
return '_cffi_e_%s_%s' % (prefix, name)
|
||||||
|
|
||||||
|
def _generate_gen_enum_decl(self, tp, name, prefix='enum'):
|
||||||
|
if tp.partial:
|
||||||
|
for enumerator in tp.enumerators:
|
||||||
|
self._generate_gen_const(True, enumerator)
|
||||||
|
return
|
||||||
|
#
|
||||||
|
funcname = self._enum_funcname(prefix, name)
|
||||||
|
self.export_symbols.append(funcname)
|
||||||
|
prnt = self._prnt
|
||||||
|
prnt('int %s(char *out_error)' % funcname)
|
||||||
|
prnt('{')
|
||||||
|
for enumerator, enumvalue in zip(tp.enumerators, tp.enumvalues):
|
||||||
|
self._check_int_constant_value(enumerator, enumvalue)
|
||||||
|
prnt(' return 0;')
|
||||||
|
prnt('}')
|
||||||
|
prnt()
|
||||||
|
|
||||||
|
def _loading_gen_enum(self, tp, name, module, prefix='enum'):
|
||||||
|
if tp.partial:
|
||||||
|
enumvalues = [self._load_constant(True, tp, enumerator, module)
|
||||||
|
for enumerator in tp.enumerators]
|
||||||
|
tp.enumvalues = tuple(enumvalues)
|
||||||
|
tp.partial_resolved = True
|
||||||
|
else:
|
||||||
|
funcname = self._enum_funcname(prefix, name)
|
||||||
|
self._load_known_int_constant(module, funcname)
|
||||||
|
|
||||||
|
def _loaded_gen_enum(self, tp, name, module, library):
|
||||||
|
for enumerator, enumvalue in zip(tp.enumerators, tp.enumvalues):
|
||||||
|
setattr(library, enumerator, enumvalue)
|
||||||
|
type(library)._cffi_dir.append(enumerator)
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# macros: for now only for integers
|
||||||
|
|
||||||
|
def _generate_gen_macro_decl(self, tp, name):
|
||||||
|
if tp == '...':
|
||||||
|
check_value = None
|
||||||
|
else:
|
||||||
|
check_value = tp # an integer
|
||||||
|
self._generate_gen_const(True, name, check_value=check_value)
|
||||||
|
|
||||||
|
_loading_gen_macro = _loaded_noop
|
||||||
|
|
||||||
|
def _loaded_gen_macro(self, tp, name, module, library):
|
||||||
|
if tp == '...':
|
||||||
|
check_value = None
|
||||||
|
else:
|
||||||
|
check_value = tp # an integer
|
||||||
|
value = self._load_constant(True, tp, name, module,
|
||||||
|
check_value=check_value)
|
||||||
|
setattr(library, name, value)
|
||||||
|
type(library)._cffi_dir.append(name)
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
# global variables
|
||||||
|
|
||||||
|
def _generate_gen_variable_decl(self, tp, name):
|
||||||
|
if isinstance(tp, model.ArrayType):
|
||||||
|
if tp.length_is_unknown():
|
||||||
|
prnt = self._prnt
|
||||||
|
funcname = '_cffi_sizeof_%s' % (name,)
|
||||||
|
self.export_symbols.append(funcname)
|
||||||
|
prnt("size_t %s(void)" % funcname)
|
||||||
|
prnt("{")
|
||||||
|
prnt(" return sizeof(%s);" % (name,))
|
||||||
|
prnt("}")
|
||||||
|
tp_ptr = model.PointerType(tp.item)
|
||||||
|
self._generate_gen_const(False, name, tp_ptr)
|
||||||
|
else:
|
||||||
|
tp_ptr = model.PointerType(tp)
|
||||||
|
self._generate_gen_const(False, name, tp_ptr, category='var')
|
||||||
|
|
||||||
|
_loading_gen_variable = _loaded_noop
|
||||||
|
|
||||||
|
def _loaded_gen_variable(self, tp, name, module, library):
|
||||||
|
if isinstance(tp, model.ArrayType): # int a[5] is "constant" in the
|
||||||
|
# sense that "a=..." is forbidden
|
||||||
|
if tp.length_is_unknown():
|
||||||
|
funcname = '_cffi_sizeof_%s' % (name,)
|
||||||
|
BFunc = self.ffi._typeof_locked('size_t(*)(void)')[0]
|
||||||
|
function = module.load_function(BFunc, funcname)
|
||||||
|
size = function()
|
||||||
|
BItemType = self.ffi._get_cached_btype(tp.item)
|
||||||
|
length, rest = divmod(size, self.ffi.sizeof(BItemType))
|
||||||
|
if rest != 0:
|
||||||
|
raise VerificationError(
|
||||||
|
"bad size: %r does not seem to be an array of %s" %
|
||||||
|
(name, tp.item))
|
||||||
|
tp = tp.resolve_length(length)
|
||||||
|
tp_ptr = model.PointerType(tp.item)
|
||||||
|
value = self._load_constant(False, tp_ptr, name, module)
|
||||||
|
# 'value' is a <cdata 'type *'> which we have to replace with
|
||||||
|
# a <cdata 'type[N]'> if the N is actually known
|
||||||
|
if tp.length is not None:
|
||||||
|
BArray = self.ffi._get_cached_btype(tp)
|
||||||
|
value = self.ffi.cast(BArray, value)
|
||||||
|
setattr(library, name, value)
|
||||||
|
type(library)._cffi_dir.append(name)
|
||||||
|
return
|
||||||
|
# remove ptr=<cdata 'int *'> from the library instance, and replace
|
||||||
|
# it by a property on the class, which reads/writes into ptr[0].
|
||||||
|
funcname = '_cffi_var_%s' % name
|
||||||
|
BFunc = self.ffi._typeof_locked(tp.get_c_name('*(*)(void)', name))[0]
|
||||||
|
function = module.load_function(BFunc, funcname)
|
||||||
|
ptr = function()
|
||||||
|
def getter(library):
|
||||||
|
return ptr[0]
|
||||||
|
def setter(library, value):
|
||||||
|
ptr[0] = value
|
||||||
|
setattr(type(library), name, property(getter, setter))
|
||||||
|
type(library)._cffi_dir.append(name)
|
||||||
|
|
||||||
|
cffimod_header = r'''
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdarg.h>
|
||||||
|
#include <errno.h>
|
||||||
|
#include <sys/types.h> /* XXX for ssize_t on some platforms */
|
||||||
|
|
||||||
|
/* this block of #ifs should be kept exactly identical between
|
||||||
|
c/_cffi_backend.c, cffi/vengine_cpy.py, cffi/vengine_gen.py
|
||||||
|
and cffi/_cffi_include.h */
|
||||||
|
#if defined(_MSC_VER)
|
||||||
|
# include <malloc.h> /* for alloca() */
|
||||||
|
# if _MSC_VER < 1600 /* MSVC < 2010 */
|
||||||
|
typedef __int8 int8_t;
|
||||||
|
typedef __int16 int16_t;
|
||||||
|
typedef __int32 int32_t;
|
||||||
|
typedef __int64 int64_t;
|
||||||
|
typedef unsigned __int8 uint8_t;
|
||||||
|
typedef unsigned __int16 uint16_t;
|
||||||
|
typedef unsigned __int32 uint32_t;
|
||||||
|
typedef unsigned __int64 uint64_t;
|
||||||
|
typedef __int8 int_least8_t;
|
||||||
|
typedef __int16 int_least16_t;
|
||||||
|
typedef __int32 int_least32_t;
|
||||||
|
typedef __int64 int_least64_t;
|
||||||
|
typedef unsigned __int8 uint_least8_t;
|
||||||
|
typedef unsigned __int16 uint_least16_t;
|
||||||
|
typedef unsigned __int32 uint_least32_t;
|
||||||
|
typedef unsigned __int64 uint_least64_t;
|
||||||
|
typedef __int8 int_fast8_t;
|
||||||
|
typedef __int16 int_fast16_t;
|
||||||
|
typedef __int32 int_fast32_t;
|
||||||
|
typedef __int64 int_fast64_t;
|
||||||
|
typedef unsigned __int8 uint_fast8_t;
|
||||||
|
typedef unsigned __int16 uint_fast16_t;
|
||||||
|
typedef unsigned __int32 uint_fast32_t;
|
||||||
|
typedef unsigned __int64 uint_fast64_t;
|
||||||
|
typedef __int64 intmax_t;
|
||||||
|
typedef unsigned __int64 uintmax_t;
|
||||||
|
# else
|
||||||
|
# include <stdint.h>
|
||||||
|
# endif
|
||||||
|
# if _MSC_VER < 1800 /* MSVC < 2013 */
|
||||||
|
# ifndef __cplusplus
|
||||||
|
typedef unsigned char _Bool;
|
||||||
|
# endif
|
||||||
|
# endif
|
||||||
|
# define _cffi_float_complex_t _Fcomplex /* include <complex.h> for it */
|
||||||
|
# define _cffi_double_complex_t _Dcomplex /* include <complex.h> for it */
|
||||||
|
#else
|
||||||
|
# include <stdint.h>
|
||||||
|
# if (defined (__SVR4) && defined (__sun)) || defined(_AIX) || defined(__hpux)
|
||||||
|
# include <alloca.h>
|
||||||
|
# endif
|
||||||
|
# define _cffi_float_complex_t float _Complex
|
||||||
|
# define _cffi_double_complex_t double _Complex
|
||||||
|
#endif
|
||||||
|
'''
|
||||||
|
|
@ -0,0 +1,306 @@
|
||||||
|
#
|
||||||
|
# DEPRECATED: implementation for ffi.verify()
|
||||||
|
#
|
||||||
|
import sys, os, binascii, shutil, io
|
||||||
|
from . import __version_verifier_modules__
|
||||||
|
from . import ffiplatform
|
||||||
|
from .error import VerificationError
|
||||||
|
|
||||||
|
if sys.version_info >= (3, 3):
|
||||||
|
import importlib.machinery
|
||||||
|
def _extension_suffixes():
|
||||||
|
return importlib.machinery.EXTENSION_SUFFIXES[:]
|
||||||
|
else:
|
||||||
|
import imp
|
||||||
|
def _extension_suffixes():
|
||||||
|
return [suffix for suffix, _, type in imp.get_suffixes()
|
||||||
|
if type == imp.C_EXTENSION]
|
||||||
|
|
||||||
|
|
||||||
|
if sys.version_info >= (3,):
|
||||||
|
NativeIO = io.StringIO
|
||||||
|
else:
|
||||||
|
class NativeIO(io.BytesIO):
|
||||||
|
def write(self, s):
|
||||||
|
if isinstance(s, unicode):
|
||||||
|
s = s.encode('ascii')
|
||||||
|
super(NativeIO, self).write(s)
|
||||||
|
|
||||||
|
|
||||||
|
class Verifier(object):
|
||||||
|
|
||||||
|
def __init__(self, ffi, preamble, tmpdir=None, modulename=None,
|
||||||
|
ext_package=None, tag='', force_generic_engine=False,
|
||||||
|
source_extension='.c', flags=None, relative_to=None, **kwds):
|
||||||
|
if ffi._parser._uses_new_feature:
|
||||||
|
raise VerificationError(
|
||||||
|
"feature not supported with ffi.verify(), but only "
|
||||||
|
"with ffi.set_source(): %s" % (ffi._parser._uses_new_feature,))
|
||||||
|
self.ffi = ffi
|
||||||
|
self.preamble = preamble
|
||||||
|
if not modulename:
|
||||||
|
flattened_kwds = ffiplatform.flatten(kwds)
|
||||||
|
vengine_class = _locate_engine_class(ffi, force_generic_engine)
|
||||||
|
self._vengine = vengine_class(self)
|
||||||
|
self._vengine.patch_extension_kwds(kwds)
|
||||||
|
self.flags = flags
|
||||||
|
self.kwds = self.make_relative_to(kwds, relative_to)
|
||||||
|
#
|
||||||
|
if modulename:
|
||||||
|
if tag:
|
||||||
|
raise TypeError("can't specify both 'modulename' and 'tag'")
|
||||||
|
else:
|
||||||
|
key = '\x00'.join(['%d.%d' % sys.version_info[:2],
|
||||||
|
__version_verifier_modules__,
|
||||||
|
preamble, flattened_kwds] +
|
||||||
|
ffi._cdefsources)
|
||||||
|
if sys.version_info >= (3,):
|
||||||
|
key = key.encode('utf-8')
|
||||||
|
k1 = hex(binascii.crc32(key[0::2]) & 0xffffffff)
|
||||||
|
k1 = k1.lstrip('0x').rstrip('L')
|
||||||
|
k2 = hex(binascii.crc32(key[1::2]) & 0xffffffff)
|
||||||
|
k2 = k2.lstrip('0').rstrip('L')
|
||||||
|
modulename = '_cffi_%s_%s%s%s' % (tag, self._vengine._class_key,
|
||||||
|
k1, k2)
|
||||||
|
suffix = _get_so_suffixes()[0]
|
||||||
|
self.tmpdir = tmpdir or _caller_dir_pycache()
|
||||||
|
self.sourcefilename = os.path.join(self.tmpdir, modulename + source_extension)
|
||||||
|
self.modulefilename = os.path.join(self.tmpdir, modulename + suffix)
|
||||||
|
self.ext_package = ext_package
|
||||||
|
self._has_source = False
|
||||||
|
self._has_module = False
|
||||||
|
|
||||||
|
def write_source(self, file=None):
|
||||||
|
"""Write the C source code. It is produced in 'self.sourcefilename',
|
||||||
|
which can be tweaked beforehand."""
|
||||||
|
with self.ffi._lock:
|
||||||
|
if self._has_source and file is None:
|
||||||
|
raise VerificationError(
|
||||||
|
"source code already written")
|
||||||
|
self._write_source(file)
|
||||||
|
|
||||||
|
def compile_module(self):
|
||||||
|
"""Write the C source code (if not done already) and compile it.
|
||||||
|
This produces a dynamic link library in 'self.modulefilename'."""
|
||||||
|
with self.ffi._lock:
|
||||||
|
if self._has_module:
|
||||||
|
raise VerificationError("module already compiled")
|
||||||
|
if not self._has_source:
|
||||||
|
self._write_source()
|
||||||
|
self._compile_module()
|
||||||
|
|
||||||
|
def load_library(self):
|
||||||
|
"""Get a C module from this Verifier instance.
|
||||||
|
Returns an instance of a FFILibrary class that behaves like the
|
||||||
|
objects returned by ffi.dlopen(), but that delegates all
|
||||||
|
operations to the C module. If necessary, the C code is written
|
||||||
|
and compiled first.
|
||||||
|
"""
|
||||||
|
with self.ffi._lock:
|
||||||
|
if not self._has_module:
|
||||||
|
self._locate_module()
|
||||||
|
if not self._has_module:
|
||||||
|
if not self._has_source:
|
||||||
|
self._write_source()
|
||||||
|
self._compile_module()
|
||||||
|
return self._load_library()
|
||||||
|
|
||||||
|
def get_module_name(self):
|
||||||
|
basename = os.path.basename(self.modulefilename)
|
||||||
|
# kill both the .so extension and the other .'s, as introduced
|
||||||
|
# by Python 3: 'basename.cpython-33m.so'
|
||||||
|
basename = basename.split('.', 1)[0]
|
||||||
|
# and the _d added in Python 2 debug builds --- but try to be
|
||||||
|
# conservative and not kill a legitimate _d
|
||||||
|
if basename.endswith('_d') and hasattr(sys, 'gettotalrefcount'):
|
||||||
|
basename = basename[:-2]
|
||||||
|
return basename
|
||||||
|
|
||||||
|
def get_extension(self):
|
||||||
|
if not self._has_source:
|
||||||
|
with self.ffi._lock:
|
||||||
|
if not self._has_source:
|
||||||
|
self._write_source()
|
||||||
|
sourcename = ffiplatform.maybe_relative_path(self.sourcefilename)
|
||||||
|
modname = self.get_module_name()
|
||||||
|
return ffiplatform.get_extension(sourcename, modname, **self.kwds)
|
||||||
|
|
||||||
|
def generates_python_module(self):
|
||||||
|
return self._vengine._gen_python_module
|
||||||
|
|
||||||
|
def make_relative_to(self, kwds, relative_to):
|
||||||
|
if relative_to and os.path.dirname(relative_to):
|
||||||
|
dirname = os.path.dirname(relative_to)
|
||||||
|
kwds = kwds.copy()
|
||||||
|
for key in ffiplatform.LIST_OF_FILE_NAMES:
|
||||||
|
if key in kwds:
|
||||||
|
lst = kwds[key]
|
||||||
|
if not isinstance(lst, (list, tuple)):
|
||||||
|
raise TypeError("keyword '%s' should be a list or tuple"
|
||||||
|
% (key,))
|
||||||
|
lst = [os.path.join(dirname, fn) for fn in lst]
|
||||||
|
kwds[key] = lst
|
||||||
|
return kwds
|
||||||
|
|
||||||
|
# ----------
|
||||||
|
|
||||||
|
def _locate_module(self):
|
||||||
|
if not os.path.isfile(self.modulefilename):
|
||||||
|
if self.ext_package:
|
||||||
|
try:
|
||||||
|
pkg = __import__(self.ext_package, None, None, ['__doc__'])
|
||||||
|
except ImportError:
|
||||||
|
return # cannot import the package itself, give up
|
||||||
|
# (e.g. it might be called differently before installation)
|
||||||
|
path = pkg.__path__
|
||||||
|
else:
|
||||||
|
path = None
|
||||||
|
filename = self._vengine.find_module(self.get_module_name(), path,
|
||||||
|
_get_so_suffixes())
|
||||||
|
if filename is None:
|
||||||
|
return
|
||||||
|
self.modulefilename = filename
|
||||||
|
self._vengine.collect_types()
|
||||||
|
self._has_module = True
|
||||||
|
|
||||||
|
def _write_source_to(self, file):
|
||||||
|
self._vengine._f = file
|
||||||
|
try:
|
||||||
|
self._vengine.write_source_to_f()
|
||||||
|
finally:
|
||||||
|
del self._vengine._f
|
||||||
|
|
||||||
|
def _write_source(self, file=None):
|
||||||
|
if file is not None:
|
||||||
|
self._write_source_to(file)
|
||||||
|
else:
|
||||||
|
# Write our source file to an in memory file.
|
||||||
|
f = NativeIO()
|
||||||
|
self._write_source_to(f)
|
||||||
|
source_data = f.getvalue()
|
||||||
|
|
||||||
|
# Determine if this matches the current file
|
||||||
|
if os.path.exists(self.sourcefilename):
|
||||||
|
with open(self.sourcefilename, "r") as fp:
|
||||||
|
needs_written = not (fp.read() == source_data)
|
||||||
|
else:
|
||||||
|
needs_written = True
|
||||||
|
|
||||||
|
# Actually write the file out if it doesn't match
|
||||||
|
if needs_written:
|
||||||
|
_ensure_dir(self.sourcefilename)
|
||||||
|
with open(self.sourcefilename, "w") as fp:
|
||||||
|
fp.write(source_data)
|
||||||
|
|
||||||
|
# Set this flag
|
||||||
|
self._has_source = True
|
||||||
|
|
||||||
|
def _compile_module(self):
|
||||||
|
# compile this C source
|
||||||
|
tmpdir = os.path.dirname(self.sourcefilename)
|
||||||
|
outputfilename = ffiplatform.compile(tmpdir, self.get_extension())
|
||||||
|
try:
|
||||||
|
same = ffiplatform.samefile(outputfilename, self.modulefilename)
|
||||||
|
except OSError:
|
||||||
|
same = False
|
||||||
|
if not same:
|
||||||
|
_ensure_dir(self.modulefilename)
|
||||||
|
shutil.move(outputfilename, self.modulefilename)
|
||||||
|
self._has_module = True
|
||||||
|
|
||||||
|
def _load_library(self):
|
||||||
|
assert self._has_module
|
||||||
|
if self.flags is not None:
|
||||||
|
return self._vengine.load_library(self.flags)
|
||||||
|
else:
|
||||||
|
return self._vengine.load_library()
|
||||||
|
|
||||||
|
# ____________________________________________________________
|
||||||
|
|
||||||
|
_FORCE_GENERIC_ENGINE = False # for tests
|
||||||
|
|
||||||
|
def _locate_engine_class(ffi, force_generic_engine):
|
||||||
|
if _FORCE_GENERIC_ENGINE:
|
||||||
|
force_generic_engine = True
|
||||||
|
if not force_generic_engine:
|
||||||
|
if '__pypy__' in sys.builtin_module_names:
|
||||||
|
force_generic_engine = True
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
import _cffi_backend
|
||||||
|
except ImportError:
|
||||||
|
_cffi_backend = '?'
|
||||||
|
if ffi._backend is not _cffi_backend:
|
||||||
|
force_generic_engine = True
|
||||||
|
if force_generic_engine:
|
||||||
|
from . import vengine_gen
|
||||||
|
return vengine_gen.VGenericEngine
|
||||||
|
else:
|
||||||
|
from . import vengine_cpy
|
||||||
|
return vengine_cpy.VCPythonEngine
|
||||||
|
|
||||||
|
# ____________________________________________________________
|
||||||
|
|
||||||
|
_TMPDIR = None
|
||||||
|
|
||||||
|
def _caller_dir_pycache():
|
||||||
|
if _TMPDIR:
|
||||||
|
return _TMPDIR
|
||||||
|
result = os.environ.get('CFFI_TMPDIR')
|
||||||
|
if result:
|
||||||
|
return result
|
||||||
|
filename = sys._getframe(2).f_code.co_filename
|
||||||
|
return os.path.abspath(os.path.join(os.path.dirname(filename),
|
||||||
|
'__pycache__'))
|
||||||
|
|
||||||
|
def set_tmpdir(dirname):
|
||||||
|
"""Set the temporary directory to use instead of __pycache__."""
|
||||||
|
global _TMPDIR
|
||||||
|
_TMPDIR = dirname
|
||||||
|
|
||||||
|
def cleanup_tmpdir(tmpdir=None, keep_so=False):
|
||||||
|
"""Clean up the temporary directory by removing all files in it
|
||||||
|
called `_cffi_*.{c,so}` as well as the `build` subdirectory."""
|
||||||
|
tmpdir = tmpdir or _caller_dir_pycache()
|
||||||
|
try:
|
||||||
|
filelist = os.listdir(tmpdir)
|
||||||
|
except OSError:
|
||||||
|
return
|
||||||
|
if keep_so:
|
||||||
|
suffix = '.c' # only remove .c files
|
||||||
|
else:
|
||||||
|
suffix = _get_so_suffixes()[0].lower()
|
||||||
|
for fn in filelist:
|
||||||
|
if fn.lower().startswith('_cffi_') and (
|
||||||
|
fn.lower().endswith(suffix) or fn.lower().endswith('.c')):
|
||||||
|
try:
|
||||||
|
os.unlink(os.path.join(tmpdir, fn))
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
clean_dir = [os.path.join(tmpdir, 'build')]
|
||||||
|
for dir in clean_dir:
|
||||||
|
try:
|
||||||
|
for fn in os.listdir(dir):
|
||||||
|
fn = os.path.join(dir, fn)
|
||||||
|
if os.path.isdir(fn):
|
||||||
|
clean_dir.append(fn)
|
||||||
|
else:
|
||||||
|
os.unlink(fn)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def _get_so_suffixes():
|
||||||
|
suffixes = _extension_suffixes()
|
||||||
|
if not suffixes:
|
||||||
|
# bah, no C_EXTENSION available. Occurs on pypy without cpyext
|
||||||
|
if sys.platform == 'win32':
|
||||||
|
suffixes = [".pyd"]
|
||||||
|
else:
|
||||||
|
suffixes = [".so"]
|
||||||
|
|
||||||
|
return suffixes
|
||||||
|
|
||||||
|
def _ensure_dir(filename):
|
||||||
|
dirname = os.path.dirname(filename)
|
||||||
|
if dirname and not os.path.isdir(dirname):
|
||||||
|
os.makedirs(dirname)
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,343 @@
|
||||||
|
Metadata-Version: 2.4
|
||||||
|
Name: curl_cffi
|
||||||
|
Version: 0.14.0
|
||||||
|
Summary: libcurl ffi bindings for Python, with impersonation support.
|
||||||
|
Author-email: lexiforest <infinitesheldon@gmail.com>
|
||||||
|
License: MIT License
|
||||||
|
Project-URL: repository, https://github.com/lexiforest/curl_cffi
|
||||||
|
Classifier: Development Status :: 4 - Beta
|
||||||
|
Classifier: Intended Audience :: Developers
|
||||||
|
Classifier: Programming Language :: Python :: 3
|
||||||
|
Classifier: Programming Language :: Python :: 3.10
|
||||||
|
Classifier: Programming Language :: Python :: 3.11
|
||||||
|
Classifier: Programming Language :: Python :: 3.12
|
||||||
|
Classifier: Programming Language :: Python :: 3.13
|
||||||
|
Classifier: Programming Language :: Python :: 3.14
|
||||||
|
Requires-Python: >=3.10
|
||||||
|
Description-Content-Type: text/markdown
|
||||||
|
License-File: LICENSE
|
||||||
|
Requires-Dist: cffi>=1.12.0
|
||||||
|
Requires-Dist: certifi>=2024.2.2
|
||||||
|
Provides-Extra: extra
|
||||||
|
Requires-Dist: readability-lxml>=0.8.1; extra == "extra"
|
||||||
|
Requires-Dist: markdownify>=1.1.0; extra == "extra"
|
||||||
|
Requires-Dist: lxml_html_clean; extra == "extra"
|
||||||
|
Provides-Extra: dev
|
||||||
|
Requires-Dist: charset_normalizer<4.0,>=3.3.2; extra == "dev"
|
||||||
|
Requires-Dist: coverage<7.0,>=6.4.1; extra == "dev"
|
||||||
|
Requires-Dist: cryptography<43.0,>=42.0.5; extra == "dev"
|
||||||
|
Requires-Dist: httpx==0.23.1; extra == "dev"
|
||||||
|
Requires-Dist: mypy<2.0,>=1.9.0; extra == "dev"
|
||||||
|
Requires-Dist: pytest<9.0,>=8.1.1; extra == "dev"
|
||||||
|
Requires-Dist: pytest-asyncio<1.0,>=0.23.6; extra == "dev"
|
||||||
|
Requires-Dist: pytest-trio<1.0,>=0.8.0; extra == "dev"
|
||||||
|
Requires-Dist: ruff<1.0,>=0.3.5; extra == "dev"
|
||||||
|
Requires-Dist: trio<1.0,>=0.25.0; extra == "dev"
|
||||||
|
Requires-Dist: trustme<2.0,>=1.1.0; extra == "dev"
|
||||||
|
Requires-Dist: uvicorn<1.0,>=0.29.0; extra == "dev"
|
||||||
|
Requires-Dist: websockets>=14.0; extra == "dev"
|
||||||
|
Requires-Dist: typing_extensions; extra == "dev"
|
||||||
|
Provides-Extra: build
|
||||||
|
Requires-Dist: cibuildwheel; extra == "build"
|
||||||
|
Requires-Dist: wheel; extra == "build"
|
||||||
|
Provides-Extra: test
|
||||||
|
Requires-Dist: charset_normalizer<4.0,>=3.3.2; extra == "test"
|
||||||
|
Requires-Dist: cryptography<43.0,>=42.0.5; extra == "test"
|
||||||
|
Requires-Dist: fastapi<1.0,>=0.110.0; extra == "test"
|
||||||
|
Requires-Dist: httpx==0.23.1; extra == "test"
|
||||||
|
Requires-Dist: proxy.py<3.0,>=2.4.3; extra == "test"
|
||||||
|
Requires-Dist: pytest<9.0,>=8.1.1; extra == "test"
|
||||||
|
Requires-Dist: pytest-asyncio<1.0,>=0.23.6; extra == "test"
|
||||||
|
Requires-Dist: pytest-trio<1.0,>=0.8.0; extra == "test"
|
||||||
|
Requires-Dist: python-multipart<1.0,>=0.0.9; extra == "test"
|
||||||
|
Requires-Dist: trio<1.0,>=0.25.0; extra == "test"
|
||||||
|
Requires-Dist: trustme<2.0,>=1.1.0; extra == "test"
|
||||||
|
Requires-Dist: uvicorn<1.0,>=0.29.0; extra == "test"
|
||||||
|
Requires-Dist: websockets>=14.0; extra == "test"
|
||||||
|
Requires-Dist: typing_extensions; extra == "test"
|
||||||
|
Dynamic: license-file
|
||||||
|
|
||||||
|
# curl_cffi
|
||||||
|
|
||||||
|
[](https://pepy.tech/projects/curl-cffi)
|
||||||
|

|
||||||
|
[](https://badge.fury.io/py/curl-cffi)
|
||||||
|
[](https://t.me/real_curl_cffi)
|
||||||
|
[](https://discord.gg/kJqMHHgdn2)
|
||||||
|
|
||||||
|
[Documentation](https://curl-cffi.readthedocs.io)
|
||||||
|
|
||||||
|
Python binding for [curl-impersonate fork](https://github.com/lexiforest/curl-impersonate)
|
||||||
|
via [cffi](https://cffi.readthedocs.io/en/latest/). For commercial support, visit [impersonate.pro](https://impersonate.pro).
|
||||||
|
|
||||||
|
`curl_cffi` is the most popular Python binding for `curl`. Unlike other pure
|
||||||
|
python http clients like `httpx` or `requests`, `curl_cffi` can impersonate
|
||||||
|
browsers' TLS/JA3 and HTTP/2 fingerprints. If you are blocked by some
|
||||||
|
website for no obvious reason, you can give `curl_cffi` a try.
|
||||||
|
|
||||||
|
Python 3.9 is the minimum supported version since v0.10.
|
||||||
|
|
||||||
|
## Recall.ai - API for meeting recordings
|
||||||
|
|
||||||
|
<a href="https://www.recall.ai/?utm_source=github&utm_medium=sponsorship&utm_campaign=lexiforest-curl_cffi" target="_blank"><img src="https://cdn.prod.website-files.com/620d732b1f1f7b244ac89f0e/66b294e51ee15f18dd2b171e_recall-logo.svg" alt="Recall.ai" height="47" width="149"></a>
|
||||||
|
|
||||||
|
If you’re looking for a meeting recording API, consider checking out [Recall.ai](https://www.recall.ai/?utm_source=github&utm_medium=sponsorship&utm_campaign=lexiforest-curl_cffi), an API that records Zoom, Google Meet, Microsoft Teams, in-person meetings, and more.
|
||||||
|
|
||||||
|
## Residential Proxies
|
||||||
|
|
||||||
|
<a href="https://www.thordata.com/?ls=github&lk=curl_cffi" target="_blank"><img src="https://raw.githubusercontent.com/lexiforest/curl_cffi/main/assets/thordata.png" alt="Thordata" height="126" width="240"></a>
|
||||||
|
|
||||||
|
Thordata: A reliable and cost-effective proxy service provider. One-click collection of public network data, providing enterprises and developers with stable, efficient, and compliant global proxy IP services. Register for a free trial of [residential proxies](https://www.thordata.com/products/residential-proxies/?ls=github&lk=curl_cffi) and receive 2000 free SERP API calls.
|
||||||
|
|
||||||
|
## Sponsors
|
||||||
|
|
||||||
|
Maintenance of this project is made possible by all the <a href="https://github.com/lexiforest/curl_cffi/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/lexiforest">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/lexiforest">click here</a>. 💖
|
||||||
|
|
||||||
|
------
|
||||||
|
|
||||||
|
### Bypass Cloudflare with API
|
||||||
|
|
||||||
|
<a href="https://yescaptcha.com/i/stfnIO" target="_blank"><img src="https://raw.githubusercontent.com/lexiforest/curl_cffi/main/assets/yescaptcha.png" alt="Yes Captcha!" height="47" width="149"></a>
|
||||||
|
|
||||||
|
Yescaptcha is a proxy service that bypasses Cloudflare and uses the API interface to
|
||||||
|
obtain verified cookies (e.g. `cf_clearance`). Click [here](https://yescaptcha.com/i/stfnIO)
|
||||||
|
to register: https://yescaptcha.com/i/stfnIO
|
||||||
|
|
||||||
|
------
|
||||||
|
|
||||||
|
<a href="https://hypersolutions.co/?utm_source=github&utm_medium=readme&utm_campaign=curl_cffi" target="_blank"><img src="https://raw.githubusercontent.com/lexiforest/curl_cffi/main/assets/hypersolutions.png" height="47" width="149"></a>
|
||||||
|
|
||||||
|
TLS fingerprinting alone isn't enough for modern bot protection. [Hyper Solutions](https://hypersolutions.co?utm_source=github&utm_medium=readme&utm_campaign=curl_cffi) provides the missing piece - API endpoints that generate valid antibot tokens for:
|
||||||
|
|
||||||
|
Akamai • DataDome • Kasada • Incapsula
|
||||||
|
|
||||||
|
No browser automation. Just simple API calls that return the exact cookies and headers these systems require.
|
||||||
|
|
||||||
|
🚀 [Get Your API Key](https://hypersolutions.co?utm_source=github&utm_medium=readme&utm_campaign=curl_cffi) | 📖 [Docs](https://docs.justhyped.dev) | 💬 [Discord](https://discord.gg/akamai)
|
||||||
|
|
||||||
|
------
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Supports JA3/TLS and http2 fingerprints impersonation, including recent browsers and custom fingerprints.
|
||||||
|
- Much faster than requests/httpx, on par with aiohttp/pycurl, see [benchmarks](https://github.com/lexiforest/curl_cffi/tree/main/benchmark).
|
||||||
|
- Mimics the requests API, no need to learn another one.
|
||||||
|
- Pre-compiled, so you don't have to compile on your machine.
|
||||||
|
- Supports `asyncio` with proxy rotation on each request.
|
||||||
|
- Supports http 2.0 & 3.0, which requests does not.
|
||||||
|
- Supports websocket.
|
||||||
|
- MIT licensed.
|
||||||
|
|
||||||
|
||requests|aiohttp|httpx|pycurl|curl_cffi|
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
|http/2|❌|❌|✅|✅|✅|
|
||||||
|
|http/3|❌|❌|❌|☑️<sup>1</sup>|✅<sup>2</sup>|
|
||||||
|
|sync|✅|❌|✅|✅|✅|
|
||||||
|
|async|❌|✅|✅|❌|✅|
|
||||||
|
|websocket|❌|✅|❌|❌|✅|
|
||||||
|
|fingerprints|❌|❌|❌|❌|✅|
|
||||||
|
|speed|🐇|🐇🐇|🐇|🐇🐇|🐇🐇|
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
1. For pycurl, you need an http/3 enabled libcurl to make it work, while curl_cffi packages libcurl-impersonate inside Python wheels.
|
||||||
|
2. Since v0.11.4.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
pip install curl_cffi --upgrade
|
||||||
|
|
||||||
|
This should work on Linux, macOS and Windows out of the box.
|
||||||
|
If it does not work on you platform, you may need to compile and install `curl-impersonate`
|
||||||
|
first and set some environment variables like `LD_LIBRARY_PATH`.
|
||||||
|
|
||||||
|
To install beta releases:
|
||||||
|
|
||||||
|
pip install curl_cffi --upgrade --pre
|
||||||
|
|
||||||
|
To install unstable version from GitHub:
|
||||||
|
|
||||||
|
git clone https://github.com/lexiforest/curl_cffi/
|
||||||
|
cd curl_cffi
|
||||||
|
make preprocess
|
||||||
|
pip install .
|
||||||
|
|
||||||
|
On macOS, you may need to install the following dependencies:
|
||||||
|
|
||||||
|
brew install zstd nghttp2
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
`curl_cffi` comes with a low-level `curl` API and a high-level `requests`-like API.
|
||||||
|
|
||||||
|
### requests-like
|
||||||
|
|
||||||
|
|
||||||
|
```python
|
||||||
|
import curl_cffi
|
||||||
|
|
||||||
|
# Notice the impersonate parameter
|
||||||
|
r = curl_cffi.get("https://tls.browserleaks.com/json", impersonate="chrome")
|
||||||
|
|
||||||
|
print(r.json())
|
||||||
|
# output: {..., "ja3n_hash": "aa56c057ad164ec4fdcb7a5a283be9fc", ...}
|
||||||
|
# the js3n fingerprint should be the same as target browser
|
||||||
|
|
||||||
|
# To keep using the latest browser version as `curl_cffi` updates,
|
||||||
|
# simply set impersonate="chrome" without specifying a version.
|
||||||
|
# Other similar values are: "safari" and "safari_ios"
|
||||||
|
r = curl_cffi.get("https://tls.browserleaks.com/json", impersonate="chrome")
|
||||||
|
|
||||||
|
# Randomly choose a browser version based on current market share in real world
|
||||||
|
# from: https://caniuse.com/usage-table
|
||||||
|
# NOTE: this is a pro feature.
|
||||||
|
r = curl_cffi.get("https://example.com", impersonate="realworld")
|
||||||
|
|
||||||
|
# To pin a specific version, use version numbers together.
|
||||||
|
r = curl_cffi.get("https://tls.browserleaks.com/json", impersonate="chrome124")
|
||||||
|
|
||||||
|
# To impersonate other than browsers, bring your own ja3/akamai strings
|
||||||
|
# See examples directory for details.
|
||||||
|
r = curl_cffi.get("https://tls.browserleaks.com/json", ja3=..., akamai=...)
|
||||||
|
|
||||||
|
# http/socks proxies are supported
|
||||||
|
proxies = {"https": "http://localhost:3128"}
|
||||||
|
r = curl_cffi.get("https://tls.browserleaks.com/json", impersonate="chrome", proxies=proxies)
|
||||||
|
|
||||||
|
proxies = {"https": "socks://localhost:3128"}
|
||||||
|
r = curl_cffi.get("https://tls.browserleaks.com/json", impersonate="chrome", proxies=proxies)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sessions
|
||||||
|
|
||||||
|
```python
|
||||||
|
s = curl_cffi.Session()
|
||||||
|
|
||||||
|
# httpbin is a http test website, this endpoint makes the server set cookies
|
||||||
|
s.get("https://httpbin.org/cookies/set/foo/bar")
|
||||||
|
print(s.cookies)
|
||||||
|
# <Cookies[<Cookie foo=bar for httpbin.org />]>
|
||||||
|
|
||||||
|
# retrieve cookies again to verify
|
||||||
|
r = s.get("https://httpbin.org/cookies")
|
||||||
|
print(r.json())
|
||||||
|
# {'cookies': {'foo': 'bar'}}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Supported impersonate browsers
|
||||||
|
|
||||||
|
`curl_cffi` supports the same browser versions as supported by my [fork](https://github.com/lexiforest/curl-impersonate) of [curl-impersonate](https://github.com/lwthiker/curl-impersonate):
|
||||||
|
|
||||||
|
Open source version of curl_cffi includes versions whose fingerprints differ from previous versions.
|
||||||
|
If you see a version, e.g. `chrome135`, were skipped, you can simply impersonate it with your own headers and the previous version.
|
||||||
|
|
||||||
|
If you don't want to look up the headers etc, by yourself, consider buying commercial support from [impersonate.pro](https://impersonate.pro),
|
||||||
|
we have comprehensive browser fingerprints database for almost all the browser versions on various platforms.
|
||||||
|
|
||||||
|
If you are trying to impersonate a target other than a browser, use `ja3=...` and `akamai=...`
|
||||||
|
to specify your own customized fingerprints. See the [docs on impersonation](https://curl-cffi.readthedocs.io/en/latest/impersonate/_index.html) for details.
|
||||||
|
|
||||||
|
|Browser|Open Source| Pro version|
|
||||||
|
|---|---|---|
|
||||||
|
|Chrome|chrome99, chrome100, chrome101, chrome104, chrome107, chrome110, chrome116<sup>[1]</sup>, chrome119<sup>[1]</sup>, chrome120<sup>[1]</sup>, chrome123<sup>[3]</sup>, chrome124<sup>[3]</sup>, chrome131<sup>[4]</sup>, chrome133a<sup>[5][6]</sup>, chrome136<sup>[6]</sup>|chrome132, chrome134, chrome135|
|
||||||
|
|Chrome Android| chrome99_android, chrome131_android <sup>[4]</sup>|chrome132_android, chrome133_android, chrome134_android, chrome135_android|
|
||||||
|
|Chrome iOS|N/A|coming soon|
|
||||||
|
|Safari <sup>[7]</sup>|safari153 <sup>[2]</sup>, safari155 <sup>[2]</sup>, safari170 <sup>[1]</sup>, safari180 <sup>[4]</sup>, safari184 <sup>[6]</sup>, safari260 <sup>[8]</sup>|coming soon|
|
||||||
|
|Safari iOS <sup>[7]</sup>| safari172_ios<sup>[1]</sup>, safari180_ios<sup>[4]</sup>, safari184_ios <sup>[6]</sup>, safari260_ios <sup>[8]</sup>|coming soon|
|
||||||
|
|Firefox|firefox133<sup>[5]</sup>, firefox135<sup>[7]</sup>|coming soon|
|
||||||
|
|Firefox Android|N/A|firefox135_android|
|
||||||
|
|Tor|tor145 <sup>[7]</sup>|coming soon|
|
||||||
|
|Edge|edge99, edge101|edge133, edge135|
|
||||||
|
|Opera|N/A|coming soon|
|
||||||
|
|Brave|N/A|coming soon|
|
||||||
|
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
1. Added in version `0.6.0`.
|
||||||
|
2. Fixed in version `0.6.0`, previous http2 fingerprints were [not correct](https://github.com/lwthiker/curl-impersonate/issues/215).
|
||||||
|
3. Added in version `0.7.0`.
|
||||||
|
4. Added in version `0.8.0`.
|
||||||
|
5. Added in version `0.9.0`.
|
||||||
|
6. The version postfix `-a`(e.g. `chrome133a`) means that this is an alternative version, i.e. the fingerprint has not been officially updated by browser, but has been observed because of A/B testing.
|
||||||
|
5. Added in version `0.10.0`.
|
||||||
|
6. Added in version `0.11.0`.
|
||||||
|
7. Since `0.11.0`, the format `safari184_ios` is preferred over `safari18_4_ios`, both are supported, but the latter is quite confusing and hard to parse.
|
||||||
|
8. Added in `0.12.0`.
|
||||||
|
|
||||||
|
### Asyncio
|
||||||
|
|
||||||
|
```python
|
||||||
|
from curl_cffi import AsyncSession
|
||||||
|
|
||||||
|
async with AsyncSession() as s:
|
||||||
|
r = await s.get("https://example.com")
|
||||||
|
```
|
||||||
|
|
||||||
|
More concurrency:
|
||||||
|
|
||||||
|
```python
|
||||||
|
import asyncio
|
||||||
|
from curl_cffi import AsyncSession
|
||||||
|
|
||||||
|
urls = [
|
||||||
|
"https://google.com/",
|
||||||
|
"https://facebook.com/",
|
||||||
|
"https://twitter.com/",
|
||||||
|
]
|
||||||
|
|
||||||
|
async with AsyncSession() as s:
|
||||||
|
tasks = []
|
||||||
|
for url in urls:
|
||||||
|
task = s.get(url)
|
||||||
|
tasks.append(task)
|
||||||
|
results = await asyncio.gather(*tasks)
|
||||||
|
```
|
||||||
|
|
||||||
|
For low-level APIs, Scrapy integration and other advanced topics, see the
|
||||||
|
[docs](https://curl-cffi.readthedocs.io) for more details.
|
||||||
|
|
||||||
|
|
||||||
|
### WebSockets
|
||||||
|
|
||||||
|
```python
|
||||||
|
from curl_cffi import WebSocket
|
||||||
|
|
||||||
|
def on_message(ws: WebSocket, message: str | bytes):
|
||||||
|
print(message)
|
||||||
|
|
||||||
|
ws = WebSocket(on_message=on_message)
|
||||||
|
ws.run_forever("wss://api.gemini.com/v1/marketdata/BTCUSD")
|
||||||
|
```
|
||||||
|
|
||||||
|
### Asyncio WebSockets
|
||||||
|
|
||||||
|
```python
|
||||||
|
import asyncio
|
||||||
|
from curl_cffi import AsyncSession
|
||||||
|
|
||||||
|
async with AsyncSession() as s:
|
||||||
|
ws = await s.ws_connect("wss://echo.websocket.org")
|
||||||
|
await asyncio.gather(*[ws.send_str("Hello, World!") for _ in range(10)])
|
||||||
|
await ws.flush()
|
||||||
|
async for message in ws:
|
||||||
|
print(message)
|
||||||
|
await ws.close()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Ecosystem
|
||||||
|
|
||||||
|
- Integrating with Scrapy: [divtiply/scrapy-curl-cffi](https://github.com/divtiply/scrapy-curl-cffi), [jxlil/scrapy-impersonate](https://github.com/jxlil/scrapy-impersonate) and [tieyongjie/scrapy-fingerprint](https://github.com/tieyongjie/scrapy-fingerprint).
|
||||||
|
- Integrating with [requests](https://github.com/el1s7/curl-adapter), [httpx](https://github.com/vgavro/httpx-curl-cffi) as adapter.
|
||||||
|
- Integrating with captcha resolvers: [YesCaptcha](https://yescaptcha.atlassian.net/wiki/spaces/YESCAPTCHA/overview). Please see the head area for promo code and link.
|
||||||
|
|
||||||
|
## Acknowledgement
|
||||||
|
|
||||||
|
- Originally forked from [multippt/python_curl_cffi](https://github.com/multippt/python_curl_cffi), which is under the MIT license.
|
||||||
|
- Headers/Cookies files are copied from [httpx](https://github.com/encode/httpx/blob/master/httpx/_models.py), which is under the BSD license.
|
||||||
|
- Asyncio support is inspired by Tornado's curl http client.
|
||||||
|
- The synchronous WebSocket API is inspired by [websocket_client](https://github.com/websocket-client/websocket-client).
|
||||||
|
- The asynchronous WebSocket API is inspired by [aiohttp](https://github.com/aio-libs/aiohttp).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
When submitting an PR, please use a different branch other than `main` and check the
|
||||||
|
"Allow edits by maintainers" box, so I can update your PR with lint or style fixes. Thanks!
|
||||||
|
|
@ -0,0 +1,47 @@
|
||||||
|
../../../bin/curl-cffi,sha256=8oLcB1URgkqm6yQqLENMHvdsVoMiTJh0M63MYpNwYbk,231
|
||||||
|
curl_cffi-0.14.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
curl_cffi-0.14.0.dist-info/METADATA,sha256=U65Tl3G1ydxoLtCSBaNsb15kEyFjBuKlh71_-EnHPkM,15518
|
||||||
|
curl_cffi-0.14.0.dist-info/RECORD,,
|
||||||
|
curl_cffi-0.14.0.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
curl_cffi-0.14.0.dist-info/WHEEL,sha256=h1aYCrgberf8zKRdTp9A0VCnBgQ-UWmk4eWr2Sp1e1M,148
|
||||||
|
curl_cffi-0.14.0.dist-info/entry_points.txt,sha256=HzTwoUpbiKIo5uJrqnxPk5OdxZ0PhT0dPTSqUP8Js70,49
|
||||||
|
curl_cffi-0.14.0.dist-info/licenses/LICENSE,sha256=PoiwKbULav021rGGQs5Mi27uTJA_HPq-9bgR9h4HBQs,1106
|
||||||
|
curl_cffi-0.14.0.dist-info/top_level.txt,sha256=b51YB50I_vu6XAbSERmqtgaYciYADCA_baVoZ_T5Lzs,10
|
||||||
|
curl_cffi/__init__.py,sha256=_3js_vIETSp3e-rMyy2wPflnodRa9PCeP4txZgizsV0,1689
|
||||||
|
curl_cffi/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
curl_cffi/__pycache__/__version__.cpython-312.pyc,,
|
||||||
|
curl_cffi/__pycache__/_asyncio_selector.cpython-312.pyc,,
|
||||||
|
curl_cffi/__pycache__/aio.cpython-312.pyc,,
|
||||||
|
curl_cffi/__pycache__/cli.cpython-312.pyc,,
|
||||||
|
curl_cffi/__pycache__/const.cpython-312.pyc,,
|
||||||
|
curl_cffi/__pycache__/curl.cpython-312.pyc,,
|
||||||
|
curl_cffi/__pycache__/utils.cpython-312.pyc,,
|
||||||
|
curl_cffi/__version__.py,sha256=V5JrAqGGOx4CN0E7qt-KOSZ1KbxGTS7yp5654MhTrss,229
|
||||||
|
curl_cffi/_asyncio_selector.py,sha256=dxKOC6B8mlRu3WYi0trSq0L-FsWV6l_pg9TP35OpDI4,13043
|
||||||
|
curl_cffi/_wrapper.abi3.so,sha256=Hbj3Rg7xjuY88_5ZDmbAgRLzdrpy4ZvQeL1hVaXMxXA,23747304
|
||||||
|
curl_cffi/aio.py,sha256=oTiffUFDNfxxSHmCVAsjX0CIOs4IuBQ6mhm4WuY5KZs,11925
|
||||||
|
curl_cffi/cli.py,sha256=hlvQdBw-QI3c0btcNBnzJMIBZMNHISc23AjkQfuN5VQ,821
|
||||||
|
curl_cffi/const.py,sha256=d5YuvTCTPLYfXwKDz5PuROwg-qxfJ7nFMKMiJtXUfP8,18026
|
||||||
|
curl_cffi/curl.py,sha256=zca9wnzpk9CPZMmcGtWu0Y57dBvlgVec0vPacdW1p6Q,24237
|
||||||
|
curl_cffi/py.typed,sha256=dcrsqJrcYfTX-ckLFJMTaj6mD8aDe2u0tkQG-ZYxnEg,26
|
||||||
|
curl_cffi/requests/__init__.py,sha256=UK77C7FgnKEcMrPzdHMw0XfDA8zyoirT4fAAPzwpB3E,5941
|
||||||
|
curl_cffi/requests/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/cookies.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/errors.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/exceptions.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/headers.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/impersonate.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/models.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/session.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/utils.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/__pycache__/websockets.cpython-312.pyc,,
|
||||||
|
curl_cffi/requests/cookies.py,sha256=QDEuhtsSjh6iNAKmp5TnGyyAe8wdDJCADCHY_GWCeCc,11867
|
||||||
|
curl_cffi/requests/errors.py,sha256=R6N5lmOTdRukThkNGUihDAQRu8HSh27M8E3zfUJJX74,250
|
||||||
|
curl_cffi/requests/exceptions.py,sha256=ViyLx3XHii_s7kjrO3GhVOVXhq2_UsYfAQl8MPwDnEM,6187
|
||||||
|
curl_cffi/requests/headers.py,sha256=A2w20i_JbmmIVQpq5BvWW9rLGm-zc8AgWIjSp5BN0vo,11496
|
||||||
|
curl_cffi/requests/impersonate.py,sha256=9BOWDnzXvgTZ_FoftegSiHG3RfoZ-nqWbM_5WCd__Kg,12919
|
||||||
|
curl_cffi/requests/models.py,sha256=GQSvoI9RaIQ9yurXcqundTrfuV2Vv92zkuDewJPRZac,10815
|
||||||
|
curl_cffi/requests/session.py,sha256=osYav8C9gbvrB-PvON_ToQis6kD7UYxnsSuEGd-Z4JA,47191
|
||||||
|
curl_cffi/requests/utils.py,sha256=wTlb--TZmljivqvViDHpZiFaVvhSKMJGJbS9zYRTEIE,24767
|
||||||
|
curl_cffi/requests/websockets.py,sha256=zhQyqUqZZTXiPjW-kOTmkdMGoJ70k9KcQVQfr2lmS60,53962
|
||||||
|
curl_cffi/utils.py,sha256=gRVzO-vhjf596V6kr_SjwHlwJfDIwTrPbRLJvvNlUNE,307
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: setuptools (80.9.0)
|
||||||
|
Root-Is-Purelib: false
|
||||||
|
Tag: cp39-abi3-manylinux_2_26_x86_64
|
||||||
|
Tag: cp39-abi3-manylinux_2_28_x86_64
|
||||||
|
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
[console_scripts]
|
||||||
|
curl-cffi = curl_cffi.cli:main
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
|
||||||
|
Copyright (c) 2018 multippt
|
||||||
|
Copyright (c) 2022 curl_cffi developers
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
curl_cffi
|
||||||
|
|
@ -0,0 +1,96 @@
|
||||||
|
__all__ = [
|
||||||
|
"Curl",
|
||||||
|
"AsyncCurl",
|
||||||
|
"CurlMime",
|
||||||
|
"CurlError",
|
||||||
|
"CurlInfo",
|
||||||
|
"CurlOpt",
|
||||||
|
"CurlMOpt",
|
||||||
|
"CurlECode",
|
||||||
|
"CurlHttpVersion",
|
||||||
|
"CurlSslVersion",
|
||||||
|
"CurlWsFlag",
|
||||||
|
"config_warnings",
|
||||||
|
"ffi",
|
||||||
|
"is_pro",
|
||||||
|
"lib",
|
||||||
|
"Session",
|
||||||
|
"AsyncSession",
|
||||||
|
"BrowserType",
|
||||||
|
"BrowserTypeLiteral",
|
||||||
|
"request",
|
||||||
|
"head",
|
||||||
|
"get",
|
||||||
|
"post",
|
||||||
|
"put",
|
||||||
|
"patch",
|
||||||
|
"delete",
|
||||||
|
"options",
|
||||||
|
"Cookies",
|
||||||
|
"Headers",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"AsyncWebSocket",
|
||||||
|
"WebSocket",
|
||||||
|
"WebSocketError",
|
||||||
|
"WebSocketClosed",
|
||||||
|
"WebSocketTimeout",
|
||||||
|
"WsCloseCode",
|
||||||
|
"ExtraFingerprints",
|
||||||
|
"CookieTypes",
|
||||||
|
"HeaderTypes",
|
||||||
|
"ProxySpec",
|
||||||
|
"exceptions",
|
||||||
|
]
|
||||||
|
|
||||||
|
import _cffi_backend # noqa: F401 # required by _wrapper
|
||||||
|
|
||||||
|
from .__version__ import __curl_version__, __description__, __title__, __version__ # noqa: F401
|
||||||
|
|
||||||
|
# This line includes _wrapper.so into the wheel
|
||||||
|
from ._wrapper import ffi, lib
|
||||||
|
from .aio import AsyncCurl
|
||||||
|
from .const import (
|
||||||
|
CurlECode,
|
||||||
|
CurlHttpVersion,
|
||||||
|
CurlInfo,
|
||||||
|
CurlMOpt,
|
||||||
|
CurlOpt,
|
||||||
|
CurlSslVersion,
|
||||||
|
CurlWsFlag,
|
||||||
|
)
|
||||||
|
from .curl import Curl, CurlError, CurlMime
|
||||||
|
|
||||||
|
from .requests import (
|
||||||
|
AsyncSession,
|
||||||
|
AsyncWebSocket,
|
||||||
|
BrowserType,
|
||||||
|
BrowserTypeLiteral,
|
||||||
|
Cookies,
|
||||||
|
CookieTypes,
|
||||||
|
ExtraFingerprints,
|
||||||
|
Headers,
|
||||||
|
HeaderTypes,
|
||||||
|
ProxySpec,
|
||||||
|
Request,
|
||||||
|
Response,
|
||||||
|
Session,
|
||||||
|
WebSocket,
|
||||||
|
WebSocketClosed,
|
||||||
|
WebSocketError,
|
||||||
|
WebSocketTimeout,
|
||||||
|
WsCloseCode,
|
||||||
|
delete,
|
||||||
|
exceptions,
|
||||||
|
get,
|
||||||
|
head,
|
||||||
|
options,
|
||||||
|
patch,
|
||||||
|
post,
|
||||||
|
put,
|
||||||
|
request,
|
||||||
|
)
|
||||||
|
|
||||||
|
from .utils import config_warnings, is_pro
|
||||||
|
|
||||||
|
config_warnings(on=False)
|
||||||
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.
|
|
@ -0,0 +1,8 @@
|
||||||
|
from importlib import metadata
|
||||||
|
|
||||||
|
from .curl import Curl
|
||||||
|
|
||||||
|
__title__ = "curl_cffi"
|
||||||
|
__description__ = metadata.metadata("curl_cffi")["Summary"]
|
||||||
|
__version__ = metadata.version("curl_cffi")
|
||||||
|
__curl_version__ = Curl().version().decode()
|
||||||
|
|
@ -0,0 +1,344 @@
|
||||||
|
"""Ensure asyncio selector methods (add_reader, etc.) are available
|
||||||
|
tornado 6.1 adds AddThreadSelectorEventLoop event loop,
|
||||||
|
running select in a thread and defining these methods on the running event loop.
|
||||||
|
This factors out the functionality of AddThreadSelectorEventLoop
|
||||||
|
into a standalone SelectorThread object which can be attached to any running event loop.
|
||||||
|
Vendored from tornado v6.4.0
|
||||||
|
Redistributed under license Apache-2.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import atexit
|
||||||
|
import errno
|
||||||
|
import functools
|
||||||
|
import select
|
||||||
|
import socket
|
||||||
|
import threading
|
||||||
|
import typing
|
||||||
|
from collections.abc import Callable
|
||||||
|
from contextlib import suppress
|
||||||
|
from typing import (
|
||||||
|
Any,
|
||||||
|
Optional,
|
||||||
|
Protocol,
|
||||||
|
TypeVar,
|
||||||
|
Union,
|
||||||
|
)
|
||||||
|
|
||||||
|
_T = TypeVar("_T")
|
||||||
|
|
||||||
|
|
||||||
|
class _HasFileno(Protocol):
|
||||||
|
def fileno(self) -> int:
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
_FileDescriptorLike = Union[int, _HasFileno]
|
||||||
|
|
||||||
|
|
||||||
|
# Collection of selector thread event loops to shut down on exit.
|
||||||
|
_selector_loops: set["SelectorThread"] = set()
|
||||||
|
|
||||||
|
|
||||||
|
def _atexit_callback() -> None:
|
||||||
|
for loop in _selector_loops:
|
||||||
|
with loop._select_cond:
|
||||||
|
loop._closing_selector = True
|
||||||
|
loop._select_cond.notify()
|
||||||
|
with suppress(BlockingIOError):
|
||||||
|
loop._waker_w.send(b"a")
|
||||||
|
if loop._thread is not None:
|
||||||
|
# If we don't join our (daemon) thread here, we may get a deadlock
|
||||||
|
# during interpreter shutdown. I don't really understand why. This
|
||||||
|
# deadlock happens every time in CI (both travis and appveyor) but
|
||||||
|
# I've never been able to reproduce locally.
|
||||||
|
loop._thread.join()
|
||||||
|
_selector_loops.clear()
|
||||||
|
|
||||||
|
|
||||||
|
atexit.register(_atexit_callback)
|
||||||
|
|
||||||
|
|
||||||
|
class SelectorThread:
|
||||||
|
"""Define ``add_reader`` methods to be called in a background select thread.
|
||||||
|
|
||||||
|
Instances of this class start a second thread to run a selector.
|
||||||
|
This thread is completely hidden from the user;
|
||||||
|
all callbacks are run on the wrapped event loop's thread.
|
||||||
|
|
||||||
|
Typically used via ``AddThreadSelectorEventLoop``,
|
||||||
|
but can be attached to a running asyncio loop.
|
||||||
|
"""
|
||||||
|
|
||||||
|
_closed = False
|
||||||
|
|
||||||
|
def __init__(self, real_loop: asyncio.AbstractEventLoop) -> None:
|
||||||
|
self._real_loop = real_loop
|
||||||
|
|
||||||
|
self._select_cond = threading.Condition()
|
||||||
|
self._select_args: Optional[
|
||||||
|
tuple[list[_FileDescriptorLike], list[_FileDescriptorLike]]
|
||||||
|
] = None
|
||||||
|
self._closing_selector = False
|
||||||
|
self._thread: Optional[threading.Thread] = None
|
||||||
|
self._thread_manager_handle = self._thread_manager()
|
||||||
|
|
||||||
|
async def thread_manager_anext() -> None:
|
||||||
|
# the anext builtin wasn't added until 3.10. We just need to iterate
|
||||||
|
# this generator one step.
|
||||||
|
await self._thread_manager_handle.__anext__()
|
||||||
|
|
||||||
|
# When the loop starts, start the thread. Not too soon because we can't
|
||||||
|
# clean up if we get to this point but the event loop is closed without
|
||||||
|
# starting.
|
||||||
|
self._real_loop.call_soon(
|
||||||
|
lambda: self._real_loop.create_task(thread_manager_anext())
|
||||||
|
)
|
||||||
|
|
||||||
|
self._readers: dict[_FileDescriptorLike, Callable] = {}
|
||||||
|
self._writers: dict[_FileDescriptorLike, Callable] = {}
|
||||||
|
|
||||||
|
# Writing to _waker_w will wake up the selector thread, which
|
||||||
|
# watches for _waker_r to be readable.
|
||||||
|
self._waker_r, self._waker_w = socket.socketpair()
|
||||||
|
self._waker_r.setblocking(False)
|
||||||
|
self._waker_w.setblocking(False)
|
||||||
|
_selector_loops.add(self)
|
||||||
|
self.add_reader(self._waker_r, self._consume_waker)
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
if self._closed:
|
||||||
|
return
|
||||||
|
with self._select_cond:
|
||||||
|
self._closing_selector = True
|
||||||
|
self._select_cond.notify()
|
||||||
|
self._wake_selector()
|
||||||
|
if self._thread is not None:
|
||||||
|
self._thread.join()
|
||||||
|
_selector_loops.discard(self)
|
||||||
|
self.remove_reader(self._waker_r)
|
||||||
|
self._waker_r.close()
|
||||||
|
self._waker_w.close()
|
||||||
|
self._closed = True
|
||||||
|
|
||||||
|
async def _thread_manager(self) -> typing.AsyncGenerator[None, None]:
|
||||||
|
# Create a thread to run the select system call. We manage this thread
|
||||||
|
# manually so we can trigger a clean shutdown from an atexit hook. Note
|
||||||
|
# that due to the order of operations at shutdown, only daemon threads
|
||||||
|
# can be shut down in this way (non-daemon threads would require the
|
||||||
|
# introduction of a new hook: https://bugs.python.org/issue41962)
|
||||||
|
self._thread = threading.Thread(
|
||||||
|
name="Tornado selector",
|
||||||
|
daemon=True,
|
||||||
|
target=self._run_select,
|
||||||
|
)
|
||||||
|
self._thread.start()
|
||||||
|
self._start_select()
|
||||||
|
try:
|
||||||
|
# The presense of this yield statement means that this coroutine
|
||||||
|
# is actually an asynchronous generator, which has a special
|
||||||
|
# shutdown protocol. We wait at this yield point until the
|
||||||
|
# event loop's shutdown_asyncgens method is called, at which point
|
||||||
|
# we will get a GeneratorExit exception and can shut down the
|
||||||
|
# selector thread.
|
||||||
|
yield
|
||||||
|
except GeneratorExit:
|
||||||
|
self.close()
|
||||||
|
raise
|
||||||
|
|
||||||
|
def _wake_selector(self) -> None:
|
||||||
|
if self._closed:
|
||||||
|
return
|
||||||
|
with suppress(BlockingIOError):
|
||||||
|
self._waker_w.send(b"a")
|
||||||
|
|
||||||
|
def _consume_waker(self) -> None:
|
||||||
|
with suppress(BlockingIOError):
|
||||||
|
self._waker_r.recv(1024)
|
||||||
|
|
||||||
|
def _start_select(self) -> None:
|
||||||
|
# Capture reader and writer sets here in the event loop
|
||||||
|
# thread to avoid any problems with concurrent
|
||||||
|
# modification while the select loop uses them.
|
||||||
|
with self._select_cond:
|
||||||
|
assert self._select_args is None
|
||||||
|
self._select_args = (list(self._readers.keys()), list(self._writers.keys()))
|
||||||
|
self._select_cond.notify()
|
||||||
|
|
||||||
|
def _run_select(self) -> None:
|
||||||
|
while True:
|
||||||
|
with self._select_cond:
|
||||||
|
while self._select_args is None and not self._closing_selector:
|
||||||
|
self._select_cond.wait()
|
||||||
|
if self._closing_selector:
|
||||||
|
return
|
||||||
|
assert self._select_args is not None
|
||||||
|
to_read, to_write = self._select_args
|
||||||
|
self._select_args = None
|
||||||
|
|
||||||
|
# We use the simpler interface of the select module instead of
|
||||||
|
# the more stateful interface in the selectors module because
|
||||||
|
# this class is only intended for use on windows, where
|
||||||
|
# select.select is the only option. The selector interface
|
||||||
|
# does not have well-documented thread-safety semantics that
|
||||||
|
# we can rely on so ensuring proper synchronization would be
|
||||||
|
# tricky.
|
||||||
|
try:
|
||||||
|
# On windows, selecting on a socket for write will not
|
||||||
|
# return the socket when there is an error (but selecting
|
||||||
|
# for reads works). Also select for errors when selecting
|
||||||
|
# for writes, and merge the results.
|
||||||
|
#
|
||||||
|
# This pattern is also used in
|
||||||
|
# https://github.com/python/cpython/blob/v3.8.0/Lib/selectors.py#L312-L317
|
||||||
|
rs, ws, xs = select.select(to_read, to_write, to_write)
|
||||||
|
ws = ws + xs
|
||||||
|
except OSError as e:
|
||||||
|
# After remove_reader or remove_writer is called, the file
|
||||||
|
# descriptor may subsequently be closed on the event loop
|
||||||
|
# thread. It's possible that this select thread hasn't
|
||||||
|
# gotten into the select system call by the time that
|
||||||
|
# happens in which case (at least on macOS), select may
|
||||||
|
# raise a "bad file descriptor" error. If we get that
|
||||||
|
# error, check and see if we're also being woken up by
|
||||||
|
# polling the waker alone. If we are, just return to the
|
||||||
|
# event loop and we'll get the updated set of file
|
||||||
|
# descriptors on the next iteration. Otherwise, raise the
|
||||||
|
# original error.
|
||||||
|
if e.errno == getattr(errno, "WSAENOTSOCK", errno.EBADF):
|
||||||
|
rs, _, _ = select.select([self._waker_r.fileno()], [], [], 0)
|
||||||
|
if rs:
|
||||||
|
ws = []
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
|
try:
|
||||||
|
self._real_loop.call_soon_threadsafe(self._handle_select, rs, ws)
|
||||||
|
except RuntimeError:
|
||||||
|
# "Event loop is closed". Swallow the exception for
|
||||||
|
# consistency with PollIOLoop (and logical consistency
|
||||||
|
# with the fact that we can't guarantee that an
|
||||||
|
# add_callback that completes without error will
|
||||||
|
# eventually execute).
|
||||||
|
pass
|
||||||
|
except AttributeError:
|
||||||
|
# ProactorEventLoop may raise this instead of RuntimeError
|
||||||
|
# if call_soon_threadsafe races with a call to close().
|
||||||
|
# Swallow it too for consistency.
|
||||||
|
pass
|
||||||
|
|
||||||
|
def _handle_select(
|
||||||
|
self, rs: list[_FileDescriptorLike], ws: list[_FileDescriptorLike]
|
||||||
|
) -> None:
|
||||||
|
for r in rs:
|
||||||
|
self._handle_event(r, self._readers)
|
||||||
|
for w in ws:
|
||||||
|
self._handle_event(w, self._writers)
|
||||||
|
self._start_select()
|
||||||
|
|
||||||
|
def _handle_event(
|
||||||
|
self,
|
||||||
|
fd: _FileDescriptorLike,
|
||||||
|
cb_map: dict[_FileDescriptorLike, Callable],
|
||||||
|
) -> None:
|
||||||
|
try:
|
||||||
|
callback = cb_map[fd]
|
||||||
|
except KeyError:
|
||||||
|
return
|
||||||
|
callback()
|
||||||
|
|
||||||
|
def add_reader(
|
||||||
|
self, fd: _FileDescriptorLike, callback: Callable[..., None], *args: Any
|
||||||
|
) -> None:
|
||||||
|
self._readers[fd] = functools.partial(callback, *args)
|
||||||
|
self._wake_selector()
|
||||||
|
|
||||||
|
def add_writer(
|
||||||
|
self, fd: _FileDescriptorLike, callback: Callable[..., None], *args: Any
|
||||||
|
) -> None:
|
||||||
|
self._writers[fd] = functools.partial(callback, *args)
|
||||||
|
self._wake_selector()
|
||||||
|
|
||||||
|
def remove_reader(self, fd: _FileDescriptorLike) -> bool:
|
||||||
|
try:
|
||||||
|
del self._readers[fd]
|
||||||
|
except KeyError:
|
||||||
|
return False
|
||||||
|
self._wake_selector()
|
||||||
|
return True
|
||||||
|
|
||||||
|
def remove_writer(self, fd: _FileDescriptorLike) -> bool:
|
||||||
|
try:
|
||||||
|
del self._writers[fd]
|
||||||
|
except KeyError:
|
||||||
|
return False
|
||||||
|
self._wake_selector()
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
class AddThreadSelectorEventLoop(asyncio.AbstractEventLoop):
|
||||||
|
"""Wrap an event loop to add implementations of the ``add_reader`` method family.
|
||||||
|
|
||||||
|
Instances of this class start a second thread to run a selector.
|
||||||
|
This thread is completely hidden from the user; all callbacks are
|
||||||
|
run on the wrapped event loop's thread.
|
||||||
|
|
||||||
|
This class is used automatically by Tornado; applications should not need
|
||||||
|
to refer to it directly.
|
||||||
|
|
||||||
|
It is safe to wrap any event loop with this class, although it only makes sense
|
||||||
|
for event loops that do not implement the ``add_reader`` family of methods
|
||||||
|
themselves (i.e. ``WindowsProactorEventLoop``)
|
||||||
|
|
||||||
|
Closing the ``AddThreadSelectorEventLoop`` also closes the wrapped event loop.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# This class is a __getattribute__-based proxy. All attributes other than those
|
||||||
|
# in this set are proxied through to the underlying loop.
|
||||||
|
MY_ATTRIBUTES = {
|
||||||
|
"_real_loop",
|
||||||
|
"_selector",
|
||||||
|
"add_reader",
|
||||||
|
"add_writer",
|
||||||
|
"close",
|
||||||
|
"remove_reader",
|
||||||
|
"remove_writer",
|
||||||
|
}
|
||||||
|
|
||||||
|
def __getattribute__(self, name: str) -> Any:
|
||||||
|
if name in AddThreadSelectorEventLoop.MY_ATTRIBUTES:
|
||||||
|
return super().__getattribute__(name)
|
||||||
|
return getattr(self._real_loop, name)
|
||||||
|
|
||||||
|
def __init__(self, real_loop: asyncio.AbstractEventLoop) -> None:
|
||||||
|
self._real_loop = real_loop
|
||||||
|
self._selector = SelectorThread(real_loop)
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
self._selector.close()
|
||||||
|
self._real_loop.close()
|
||||||
|
|
||||||
|
def add_reader( # type: ignore
|
||||||
|
self,
|
||||||
|
fd: "_FileDescriptorLike",
|
||||||
|
callback: Callable[..., None],
|
||||||
|
*args: Any,
|
||||||
|
) -> None:
|
||||||
|
return self._selector.add_reader(fd, callback, *args)
|
||||||
|
|
||||||
|
def add_writer( # type: ignore
|
||||||
|
self,
|
||||||
|
fd: "_FileDescriptorLike",
|
||||||
|
callback: Callable[..., None],
|
||||||
|
*args: Any, # type: ignore
|
||||||
|
) -> None:
|
||||||
|
return self._selector.add_writer(fd, callback, *args)
|
||||||
|
|
||||||
|
def remove_reader(self, fd: "_FileDescriptorLike") -> bool:
|
||||||
|
return self._selector.remove_reader(fd)
|
||||||
|
|
||||||
|
def remove_writer(self, fd: "_FileDescriptorLike") -> bool:
|
||||||
|
return self._selector.remove_writer(fd)
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,343 @@
|
||||||
|
import asyncio
|
||||||
|
import sys
|
||||||
|
import warnings
|
||||||
|
from contextlib import suppress
|
||||||
|
from typing import Any, Optional
|
||||||
|
from weakref import WeakKeyDictionary
|
||||||
|
|
||||||
|
from ._wrapper import ffi, lib
|
||||||
|
from .const import CurlECode, CurlMOpt
|
||||||
|
from .curl import DEFAULT_CACERT, Curl, CurlError
|
||||||
|
from .utils import CurlCffiWarning
|
||||||
|
|
||||||
|
__all__ = ["AsyncCurl"]
|
||||||
|
|
||||||
|
if sys.platform == "win32":
|
||||||
|
# registry of asyncio loop : selector thread
|
||||||
|
_selectors: WeakKeyDictionary = WeakKeyDictionary()
|
||||||
|
PROACTOR_WARNING = """
|
||||||
|
Proactor event loop does not implement add_reader family of methods required.
|
||||||
|
Registering an additional selector thread for add_reader support.
|
||||||
|
To avoid this warning use:
|
||||||
|
asyncio.set_event_loop_policy(WindowsSelectorEventLoopPolicy())
|
||||||
|
"""
|
||||||
|
|
||||||
|
def get_selector(
|
||||||
|
asyncio_loop: asyncio.AbstractEventLoop,
|
||||||
|
) -> asyncio.AbstractEventLoop:
|
||||||
|
"""Get selector-compatible loop
|
||||||
|
|
||||||
|
Returns an object with ``add_reader`` family of methods,
|
||||||
|
either the loop itself or a SelectorThread instance.
|
||||||
|
|
||||||
|
Workaround Windows proactor removal of *reader methods.
|
||||||
|
"""
|
||||||
|
|
||||||
|
if asyncio_loop in _selectors:
|
||||||
|
return _selectors[asyncio_loop]
|
||||||
|
|
||||||
|
if not isinstance(
|
||||||
|
asyncio_loop, getattr(asyncio, "ProactorEventLoop", type(None))
|
||||||
|
):
|
||||||
|
return asyncio_loop
|
||||||
|
|
||||||
|
warnings.warn(PROACTOR_WARNING, CurlCffiWarning, stacklevel=2)
|
||||||
|
|
||||||
|
from ._asyncio_selector import AddThreadSelectorEventLoop
|
||||||
|
|
||||||
|
selector_loop = _selectors[asyncio_loop] = AddThreadSelectorEventLoop(
|
||||||
|
asyncio_loop
|
||||||
|
) # type: ignore
|
||||||
|
|
||||||
|
# patch loop.close to also close the selector thread
|
||||||
|
loop_close = asyncio_loop.close
|
||||||
|
|
||||||
|
def _close_selector_and_loop():
|
||||||
|
# restore original before calling selector.close,
|
||||||
|
# which in turn calls eventloop.close!
|
||||||
|
asyncio_loop.close = loop_close
|
||||||
|
_selectors.pop(asyncio_loop, None)
|
||||||
|
selector_loop.close()
|
||||||
|
|
||||||
|
asyncio_loop.close = _close_selector_and_loop
|
||||||
|
return selector_loop
|
||||||
|
|
||||||
|
else:
|
||||||
|
|
||||||
|
def get_selector(loop: asyncio.AbstractEventLoop) -> asyncio.AbstractEventLoop:
|
||||||
|
return loop
|
||||||
|
|
||||||
|
|
||||||
|
CURL_POLL_NONE = 0
|
||||||
|
CURL_POLL_IN = 1
|
||||||
|
CURL_POLL_OUT = 2
|
||||||
|
CURL_POLL_INOUT = 3
|
||||||
|
CURL_POLL_REMOVE = 4
|
||||||
|
|
||||||
|
CURL_SOCKET_TIMEOUT = -1
|
||||||
|
CURL_SOCKET_BAD = -1
|
||||||
|
|
||||||
|
CURL_CSELECT_IN = 0x01
|
||||||
|
CURL_CSELECT_OUT = 0x02
|
||||||
|
CURL_CSELECT_ERR = 0x04
|
||||||
|
|
||||||
|
CURLMSG_DONE = 1
|
||||||
|
|
||||||
|
CURLPIPE_NOTHING = 0
|
||||||
|
CURLPIPE_HTTP1 = 1 # deprecated
|
||||||
|
CURLPIPE_MULTIPLEX = 2
|
||||||
|
|
||||||
|
|
||||||
|
"""
|
||||||
|
libcurl provides an event-based system for multiple handles with the following API:
|
||||||
|
|
||||||
|
- curl_multi_socket_action, for detecting events
|
||||||
|
- curl_multi_info_read, for reading the transfer status
|
||||||
|
|
||||||
|
There are 2 callbacks:
|
||||||
|
|
||||||
|
- socket_function, set by CURLMOPT_SOCKETFUNCTION, will be called for socket events.
|
||||||
|
- timer_function, set by CURLMOPT_TIMERFUNCTION, will be called when timeouts happen.
|
||||||
|
|
||||||
|
And it works like the following:
|
||||||
|
|
||||||
|
Set up handles, callbacks first.
|
||||||
|
|
||||||
|
When started, curl_multi_socket_action should be called to start everything.
|
||||||
|
|
||||||
|
If there are data in/out, libcurl calls the socket_function callback, and it sets up
|
||||||
|
`process_data` as asyncio loop reader/writer function. `process_data` will call
|
||||||
|
curl_multi_info_read to determine whether a certain `await perform` has finished.
|
||||||
|
|
||||||
|
When idle, libcurl will call the timer_function callback, which sets up a later call
|
||||||
|
for socket_action to detect events.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
@ffi.def_extern()
|
||||||
|
def timer_function(curlm, timeout_ms: int, clientp: Any) -> int:
|
||||||
|
"""
|
||||||
|
see: https://curl.se/libcurl/c/CURLMOPT_TIMERFUNCTION.html
|
||||||
|
"""
|
||||||
|
async_curl = ffi.from_handle(clientp)
|
||||||
|
|
||||||
|
# Cancel the timer anyway, if it's -1, yes, libcurl says it should be cancelled.
|
||||||
|
# If not, to add a new timer, we need to cancel the old timer.
|
||||||
|
if async_curl._timer:
|
||||||
|
async_curl._timer.cancel() # If already called, cancel does nothing.
|
||||||
|
async_curl._timer = None
|
||||||
|
|
||||||
|
# libcurl says to install a timer which calls socket_action on fire.
|
||||||
|
async_curl._timer = async_curl.loop.call_later(
|
||||||
|
timeout_ms / 1000,
|
||||||
|
async_curl.process_data,
|
||||||
|
CURL_SOCKET_TIMEOUT, # -1
|
||||||
|
CURL_POLL_NONE, # 0
|
||||||
|
)
|
||||||
|
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
@ffi.def_extern()
|
||||||
|
def socket_function(curl, sockfd: int, what: int, clientp: Any, data: Any) -> int:
|
||||||
|
"""This callback is called when libcurl decides it's time to interact with certain
|
||||||
|
sockets"""
|
||||||
|
|
||||||
|
async_curl = ffi.from_handle(clientp)
|
||||||
|
loop = async_curl.loop
|
||||||
|
|
||||||
|
# Always remove and re-add fds
|
||||||
|
if sockfd in async_curl._sockfds:
|
||||||
|
loop.remove_reader(sockfd)
|
||||||
|
loop.remove_writer(sockfd)
|
||||||
|
|
||||||
|
# Need to read from the socket
|
||||||
|
if what & CURL_POLL_IN:
|
||||||
|
loop.add_reader(sockfd, async_curl.process_data, sockfd, CURL_CSELECT_IN)
|
||||||
|
async_curl._sockfds.add(sockfd)
|
||||||
|
|
||||||
|
# Need to write to the socket
|
||||||
|
if what & CURL_POLL_OUT:
|
||||||
|
loop.add_writer(sockfd, async_curl.process_data, sockfd, CURL_CSELECT_OUT)
|
||||||
|
async_curl._sockfds.add(sockfd)
|
||||||
|
|
||||||
|
# Need to remove the socket
|
||||||
|
if what == CURL_POLL_REMOVE:
|
||||||
|
async_curl._sockfds.remove(sockfd)
|
||||||
|
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
class AsyncCurl:
|
||||||
|
"""Wrapper around curl_multi handle to provide asyncio support. It uses the libcurl
|
||||||
|
socket_action APIs."""
|
||||||
|
|
||||||
|
def __init__(self, cacert: str = "", loop=None):
|
||||||
|
"""
|
||||||
|
Parameters:
|
||||||
|
cacert: CA cert path to use, by default, certs from ``certifi`` are used.
|
||||||
|
loop: EventLoop to use.
|
||||||
|
"""
|
||||||
|
self._curlm = lib.curl_multi_init()
|
||||||
|
self._cacert = cacert or DEFAULT_CACERT
|
||||||
|
self._curl2future: dict[Curl, asyncio.Future] = {} # curl to future map
|
||||||
|
self._curl2curl: dict[ffi.CData, Curl] = {} # c curl to Curl
|
||||||
|
self._sockfds: set[int] = set() # sockfds
|
||||||
|
self.loop = get_selector(
|
||||||
|
loop if loop is not None else asyncio.get_running_loop()
|
||||||
|
)
|
||||||
|
self._timeout_checker = self.loop.create_task(self._force_timeout())
|
||||||
|
self._timer: Optional[asyncio.TimerHandle] = None
|
||||||
|
self._setup()
|
||||||
|
|
||||||
|
def _setup(self):
|
||||||
|
self.setopt(CurlMOpt.TIMERFUNCTION, lib.timer_function)
|
||||||
|
self.setopt(CurlMOpt.SOCKETFUNCTION, lib.socket_function)
|
||||||
|
self._self_handle = ffi.new_handle(self)
|
||||||
|
self.setopt(CurlMOpt.SOCKETDATA, self._self_handle)
|
||||||
|
self.setopt(CurlMOpt.TIMERDATA, self._self_handle)
|
||||||
|
# self.setopt(CurlMOpt.PIPELINING, CURLPIPE_NOTHING)
|
||||||
|
|
||||||
|
async def close(self):
|
||||||
|
"""Close and cleanup running timers, readers, writers and handles."""
|
||||||
|
|
||||||
|
# Close and wait for the force timeout checker to complete
|
||||||
|
self._timeout_checker.cancel()
|
||||||
|
with suppress(asyncio.CancelledError):
|
||||||
|
await self._timeout_checker
|
||||||
|
|
||||||
|
# Close all pending futures
|
||||||
|
for curl, future in self._curl2future.items():
|
||||||
|
lib.curl_multi_remove_handle(self._curlm, curl._curl)
|
||||||
|
if not future.done() and not future.cancelled():
|
||||||
|
future.set_result(None)
|
||||||
|
|
||||||
|
# Cleanup curl_multi handle
|
||||||
|
lib.curl_multi_cleanup(self._curlm)
|
||||||
|
self._curlm = None
|
||||||
|
|
||||||
|
# Remove add readers and writers
|
||||||
|
for sockfd in self._sockfds:
|
||||||
|
self.loop.remove_reader(sockfd)
|
||||||
|
self.loop.remove_writer(sockfd)
|
||||||
|
|
||||||
|
# Cancel all time functions
|
||||||
|
if self._timer:
|
||||||
|
self._timer.cancel()
|
||||||
|
|
||||||
|
async def _force_timeout(self):
|
||||||
|
"""This coroutine is used to safeguard from any missing signals from curl, and
|
||||||
|
put everything back on track"""
|
||||||
|
while True:
|
||||||
|
if not self._curlm:
|
||||||
|
break
|
||||||
|
self.socket_action(CURL_SOCKET_TIMEOUT, CURL_POLL_NONE)
|
||||||
|
await asyncio.sleep(0.1)
|
||||||
|
|
||||||
|
def add_handle(self, curl: Curl):
|
||||||
|
"""Add a curl handle to be managed by curl_multi. This is the equivalent of
|
||||||
|
`perform` in the async world."""
|
||||||
|
|
||||||
|
curl._ensure_cacert()
|
||||||
|
errcode = lib.curl_multi_add_handle(self._curlm, curl._curl)
|
||||||
|
self._check_error(errcode)
|
||||||
|
future = self.loop.create_future()
|
||||||
|
self._curl2future[curl] = future
|
||||||
|
self._curl2curl[curl._curl] = curl
|
||||||
|
return future
|
||||||
|
|
||||||
|
def socket_action(self, sockfd: int, ev_bitmask: int) -> int:
|
||||||
|
"""wrapper for curl_multi_socket_action,
|
||||||
|
returns the number of running curl handles."""
|
||||||
|
running_handle = ffi.new("int *")
|
||||||
|
errcode = lib.curl_multi_socket_action(
|
||||||
|
self._curlm, sockfd, ev_bitmask, running_handle
|
||||||
|
)
|
||||||
|
self._check_error(errcode)
|
||||||
|
return running_handle[0]
|
||||||
|
|
||||||
|
def process_data(self, sockfd: int, ev_bitmask: int):
|
||||||
|
"""Call curl_multi_info_read to read data for given socket."""
|
||||||
|
if not self._curlm:
|
||||||
|
warnings.warn(
|
||||||
|
"Curlm already closed! quitting from process_data",
|
||||||
|
CurlCffiWarning,
|
||||||
|
stacklevel=2,
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
self.socket_action(sockfd, ev_bitmask)
|
||||||
|
|
||||||
|
msg_in_queue = ffi.new("int *")
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
curl_msg = lib.curl_multi_info_read(self._curlm, msg_in_queue)
|
||||||
|
# NULL is returned as a signal that no more to be get at this point
|
||||||
|
if curl_msg == ffi.NULL:
|
||||||
|
break
|
||||||
|
if curl_msg.msg == CURLMSG_DONE:
|
||||||
|
curl = self._curl2curl[curl_msg.easy_handle]
|
||||||
|
retcode = curl_msg.data.result
|
||||||
|
if retcode == 0:
|
||||||
|
self.set_result(curl)
|
||||||
|
else:
|
||||||
|
self.set_exception(curl, curl._get_error(retcode, "perform"))
|
||||||
|
else:
|
||||||
|
print("NOT DONE") # Will not reach, for nothing else being defined.
|
||||||
|
except Exception:
|
||||||
|
warnings.warn(
|
||||||
|
"Unexpected curl multi state in process_data, "
|
||||||
|
"please open an issue on GitHub\n",
|
||||||
|
CurlCffiWarning,
|
||||||
|
stacklevel=2,
|
||||||
|
)
|
||||||
|
|
||||||
|
def _pop_future(self, curl: Curl):
|
||||||
|
errcode = lib.curl_multi_remove_handle(self._curlm, curl._curl)
|
||||||
|
self._check_error(errcode)
|
||||||
|
self._curl2curl.pop(curl._curl, None)
|
||||||
|
return self._curl2future.pop(curl, None)
|
||||||
|
|
||||||
|
def remove_handle(self, curl: Curl):
|
||||||
|
"""Cancel a future for given curl handle."""
|
||||||
|
future = self._pop_future(curl)
|
||||||
|
if future and not future.done() and not future.cancelled():
|
||||||
|
future.cancel()
|
||||||
|
|
||||||
|
def set_result(self, curl: Curl):
|
||||||
|
"""Mark a future as done for given curl handle."""
|
||||||
|
future = self._pop_future(curl)
|
||||||
|
if future and not future.done() and not future.cancelled():
|
||||||
|
future.set_result(None)
|
||||||
|
|
||||||
|
def set_exception(self, curl: Curl, exception):
|
||||||
|
"""Raise exception of a future for given curl handle."""
|
||||||
|
future = self._pop_future(curl)
|
||||||
|
if future and not future.done() and not future.cancelled():
|
||||||
|
future.set_exception(exception)
|
||||||
|
|
||||||
|
def _check_error(self, errcode: int, *args: Any):
|
||||||
|
if errcode == CurlECode.OK:
|
||||||
|
return
|
||||||
|
errmsg = lib.curl_multi_strerror(errcode)
|
||||||
|
action = " ".join([str(a) for a in args])
|
||||||
|
raise CurlError(
|
||||||
|
f"Failed in {action}, multi: ({errcode}) {errmsg}. "
|
||||||
|
"See https://curl.se/libcurl/c/libcurl-errors.html first for more "
|
||||||
|
"details. Please open an issue on GitHub to help debug this error.",
|
||||||
|
)
|
||||||
|
|
||||||
|
def setopt(self, option, value):
|
||||||
|
"""Wrapper around curl_multi_setopt."""
|
||||||
|
if option in (
|
||||||
|
CurlMOpt.PIPELINING,
|
||||||
|
CurlMOpt.MAXCONNECTS,
|
||||||
|
CurlMOpt.MAX_HOST_CONNECTIONS,
|
||||||
|
CurlMOpt.MAX_PIPELINE_LENGTH,
|
||||||
|
CurlMOpt.MAX_TOTAL_CONNECTIONS,
|
||||||
|
CurlMOpt.MAX_CONCURRENT_STREAMS,
|
||||||
|
):
|
||||||
|
c_value = ffi.new("long*", value)
|
||||||
|
else:
|
||||||
|
c_value = value
|
||||||
|
return lib.curl_multi_setopt(self._curlm, option, c_value)
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
import curl_cffi
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
prog="curl-cffi",
|
||||||
|
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||||||
|
description="A curl-like tool using curl-cffi with browser impersonation",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"-i",
|
||||||
|
"--impersonate",
|
||||||
|
default="chrome",
|
||||||
|
help="Browser to impersonate",
|
||||||
|
)
|
||||||
|
parser.add_argument("urls", nargs="+", help="URLs to fetch")
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
for url in args.urls:
|
||||||
|
try:
|
||||||
|
response = curl_cffi.requests.get(url, impersonate=args.impersonate)
|
||||||
|
print(response.text)
|
||||||
|
except Exception as e:
|
||||||
|
print(f"Error fetching {url}: {e}", file=sys.stderr)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
|
|
@ -0,0 +1,613 @@
|
||||||
|
# This file is automatically generated, do not modify it directly.
|
||||||
|
|
||||||
|
from enum import IntEnum
|
||||||
|
|
||||||
|
|
||||||
|
class CurlOpt(IntEnum):
|
||||||
|
"""``CULROPT_`` constancs extracted from libcurl,
|
||||||
|
see: https://curl.se/libcurl/c/curl_easy_setopt.html"""
|
||||||
|
|
||||||
|
WRITEDATA = 10000 + 1
|
||||||
|
URL = 10000 + 2
|
||||||
|
PORT = 0 + 3
|
||||||
|
PROXY = 10000 + 4
|
||||||
|
USERPWD = 10000 + 5
|
||||||
|
PROXYUSERPWD = 10000 + 6
|
||||||
|
RANGE = 10000 + 7
|
||||||
|
READDATA = 10000 + 9
|
||||||
|
ERRORBUFFER = 10000 + 10
|
||||||
|
WRITEFUNCTION = 20000 + 11
|
||||||
|
READFUNCTION = 20000 + 12
|
||||||
|
TIMEOUT = 0 + 13
|
||||||
|
INFILESIZE = 0 + 14
|
||||||
|
POSTFIELDS = 10000 + 15
|
||||||
|
REFERER = 10000 + 16
|
||||||
|
FTPPORT = 10000 + 17
|
||||||
|
USERAGENT = 10000 + 18
|
||||||
|
LOW_SPEED_LIMIT = 0 + 19
|
||||||
|
LOW_SPEED_TIME = 0 + 20
|
||||||
|
RESUME_FROM = 0 + 21
|
||||||
|
COOKIE = 10000 + 22
|
||||||
|
HTTPHEADER = 10000 + 23
|
||||||
|
HTTPPOST = 10000 + 24
|
||||||
|
SSLCERT = 10000 + 25
|
||||||
|
KEYPASSWD = 10000 + 26
|
||||||
|
CRLF = 0 + 27
|
||||||
|
QUOTE = 10000 + 28
|
||||||
|
HEADERDATA = 10000 + 29
|
||||||
|
COOKIEFILE = 10000 + 31
|
||||||
|
SSLVERSION = 0 + 32
|
||||||
|
TIMECONDITION = 0 + 33
|
||||||
|
TIMEVALUE = 0 + 34
|
||||||
|
CUSTOMREQUEST = 10000 + 36
|
||||||
|
STDERR = 10000 + 37
|
||||||
|
POSTQUOTE = 10000 + 39
|
||||||
|
VERBOSE = 0 + 41
|
||||||
|
HEADER = 0 + 42
|
||||||
|
NOPROGRESS = 0 + 43
|
||||||
|
NOBODY = 0 + 44
|
||||||
|
FAILONERROR = 0 + 45
|
||||||
|
UPLOAD = 0 + 46
|
||||||
|
POST = 0 + 47
|
||||||
|
DIRLISTONLY = 0 + 48
|
||||||
|
APPEND = 0 + 50
|
||||||
|
NETRC = 0 + 51
|
||||||
|
FOLLOWLOCATION = 0 + 52
|
||||||
|
TRANSFERTEXT = 0 + 53
|
||||||
|
PUT = 0 + 54
|
||||||
|
PROGRESSFUNCTION = 20000 + 56
|
||||||
|
XFERINFODATA = 10000 + 57
|
||||||
|
AUTOREFERER = 0 + 58
|
||||||
|
PROXYPORT = 0 + 59
|
||||||
|
POSTFIELDSIZE = 0 + 60
|
||||||
|
HTTPPROXYTUNNEL = 0 + 61
|
||||||
|
INTERFACE = 10000 + 62
|
||||||
|
KRBLEVEL = 10000 + 63
|
||||||
|
SSL_VERIFYPEER = 0 + 64
|
||||||
|
CAINFO = 10000 + 65
|
||||||
|
MAXREDIRS = 0 + 68
|
||||||
|
FILETIME = 0 + 69
|
||||||
|
TELNETOPTIONS = 10000 + 70
|
||||||
|
MAXCONNECTS = 0 + 71
|
||||||
|
FRESH_CONNECT = 0 + 74
|
||||||
|
FORBID_REUSE = 0 + 75
|
||||||
|
RANDOM_FILE = 10000 + 76
|
||||||
|
EGDSOCKET = 10000 + 77
|
||||||
|
CONNECTTIMEOUT = 0 + 78
|
||||||
|
HEADERFUNCTION = 20000 + 79
|
||||||
|
HTTPGET = 0 + 80
|
||||||
|
SSL_VERIFYHOST = 0 + 81
|
||||||
|
COOKIEJAR = 10000 + 82
|
||||||
|
SSL_CIPHER_LIST = 10000 + 83
|
||||||
|
HTTP_VERSION = 0 + 84
|
||||||
|
FTP_USE_EPSV = 0 + 85
|
||||||
|
SSLCERTTYPE = 10000 + 86
|
||||||
|
SSLKEY = 10000 + 87
|
||||||
|
SSLKEYTYPE = 10000 + 88
|
||||||
|
SSLENGINE = 10000 + 89
|
||||||
|
SSLENGINE_DEFAULT = 0 + 90
|
||||||
|
DNS_USE_GLOBAL_CACHE = 0 + 91
|
||||||
|
DNS_CACHE_TIMEOUT = 0 + 92
|
||||||
|
PREQUOTE = 10000 + 93
|
||||||
|
DEBUGFUNCTION = 20000 + 94
|
||||||
|
DEBUGDATA = 10000 + 95
|
||||||
|
COOKIESESSION = 0 + 96
|
||||||
|
CAPATH = 10000 + 97
|
||||||
|
BUFFERSIZE = 0 + 98
|
||||||
|
NOSIGNAL = 0 + 99
|
||||||
|
SHARE = 10000 + 100
|
||||||
|
PROXYTYPE = 0 + 101
|
||||||
|
ACCEPT_ENCODING = 10000 + 102
|
||||||
|
PRIVATE = 10000 + 103
|
||||||
|
HTTP200ALIASES = 10000 + 104
|
||||||
|
UNRESTRICTED_AUTH = 0 + 105
|
||||||
|
FTP_USE_EPRT = 0 + 106
|
||||||
|
HTTPAUTH = 0 + 107
|
||||||
|
SSL_CTX_FUNCTION = 20000 + 108
|
||||||
|
SSL_CTX_DATA = 10000 + 109
|
||||||
|
FTP_CREATE_MISSING_DIRS = 0 + 110
|
||||||
|
PROXYAUTH = 0 + 111
|
||||||
|
SERVER_RESPONSE_TIMEOUT = 0 + 112
|
||||||
|
IPRESOLVE = 0 + 113
|
||||||
|
MAXFILESIZE = 0 + 114
|
||||||
|
INFILESIZE_LARGE = 30000 + 115
|
||||||
|
RESUME_FROM_LARGE = 30000 + 116
|
||||||
|
MAXFILESIZE_LARGE = 30000 + 117
|
||||||
|
NETRC_FILE = 10000 + 118
|
||||||
|
USE_SSL = 0 + 119
|
||||||
|
POSTFIELDSIZE_LARGE = 30000 + 120
|
||||||
|
TCP_NODELAY = 0 + 121
|
||||||
|
FTPSSLAUTH = 0 + 129
|
||||||
|
IOCTLFUNCTION = 20000 + 130
|
||||||
|
IOCTLDATA = 10000 + 131
|
||||||
|
FTP_ACCOUNT = 10000 + 134
|
||||||
|
COOKIELIST = 10000 + 135
|
||||||
|
IGNORE_CONTENT_LENGTH = 0 + 136
|
||||||
|
FTP_SKIP_PASV_IP = 0 + 137
|
||||||
|
FTP_FILEMETHOD = 0 + 138
|
||||||
|
LOCALPORT = 0 + 139
|
||||||
|
LOCALPORTRANGE = 0 + 140
|
||||||
|
CONNECT_ONLY = 0 + 141
|
||||||
|
CONV_FROM_NETWORK_FUNCTION = 20000 + 142
|
||||||
|
CONV_TO_NETWORK_FUNCTION = 20000 + 143
|
||||||
|
CONV_FROM_UTF8_FUNCTION = 20000 + 144
|
||||||
|
MAX_SEND_SPEED_LARGE = 30000 + 145
|
||||||
|
MAX_RECV_SPEED_LARGE = 30000 + 146
|
||||||
|
FTP_ALTERNATIVE_TO_USER = 10000 + 147
|
||||||
|
SOCKOPTFUNCTION = 20000 + 148
|
||||||
|
SOCKOPTDATA = 10000 + 149
|
||||||
|
SSL_SESSIONID_CACHE = 0 + 150
|
||||||
|
SSH_AUTH_TYPES = 0 + 151
|
||||||
|
SSH_PUBLIC_KEYFILE = 10000 + 152
|
||||||
|
SSH_PRIVATE_KEYFILE = 10000 + 153
|
||||||
|
FTP_SSL_CCC = 0 + 154
|
||||||
|
TIMEOUT_MS = 0 + 155
|
||||||
|
CONNECTTIMEOUT_MS = 0 + 156
|
||||||
|
HTTP_TRANSFER_DECODING = 0 + 157
|
||||||
|
HTTP_CONTENT_DECODING = 0 + 158
|
||||||
|
NEW_FILE_PERMS = 0 + 159
|
||||||
|
NEW_DIRECTORY_PERMS = 0 + 160
|
||||||
|
POSTREDIR = 0 + 161
|
||||||
|
SSH_HOST_PUBLIC_KEY_MD5 = 10000 + 162
|
||||||
|
OPENSOCKETFUNCTION = 20000 + 163
|
||||||
|
OPENSOCKETDATA = 10000 + 164
|
||||||
|
COPYPOSTFIELDS = 10000 + 165
|
||||||
|
PROXY_TRANSFER_MODE = 0 + 166
|
||||||
|
SEEKFUNCTION = 20000 + 167
|
||||||
|
SEEKDATA = 10000 + 168
|
||||||
|
CRLFILE = 10000 + 169
|
||||||
|
ISSUERCERT = 10000 + 170
|
||||||
|
ADDRESS_SCOPE = 0 + 171
|
||||||
|
CERTINFO = 0 + 172
|
||||||
|
USERNAME = 10000 + 173
|
||||||
|
PASSWORD = 10000 + 174
|
||||||
|
PROXYUSERNAME = 10000 + 175
|
||||||
|
PROXYPASSWORD = 10000 + 176
|
||||||
|
NOPROXY = 10000 + 177
|
||||||
|
TFTP_BLKSIZE = 0 + 178
|
||||||
|
SOCKS5_GSSAPI_SERVICE = 10000 + 179
|
||||||
|
SOCKS5_GSSAPI_NEC = 0 + 180
|
||||||
|
PROTOCOLS = 0 + 181
|
||||||
|
REDIR_PROTOCOLS = 0 + 182
|
||||||
|
SSH_KNOWNHOSTS = 10000 + 183
|
||||||
|
SSH_KEYFUNCTION = 20000 + 184
|
||||||
|
SSH_KEYDATA = 10000 + 185
|
||||||
|
MAIL_FROM = 10000 + 186
|
||||||
|
MAIL_RCPT = 10000 + 187
|
||||||
|
FTP_USE_PRET = 0 + 188
|
||||||
|
RTSP_REQUEST = 0 + 189
|
||||||
|
RTSP_SESSION_ID = 10000 + 190
|
||||||
|
RTSP_STREAM_URI = 10000 + 191
|
||||||
|
RTSP_TRANSPORT = 10000 + 192
|
||||||
|
RTSP_CLIENT_CSEQ = 0 + 193
|
||||||
|
RTSP_SERVER_CSEQ = 0 + 194
|
||||||
|
INTERLEAVEDATA = 10000 + 195
|
||||||
|
INTERLEAVEFUNCTION = 20000 + 196
|
||||||
|
WILDCARDMATCH = 0 + 197
|
||||||
|
CHUNK_BGN_FUNCTION = 20000 + 198
|
||||||
|
CHUNK_END_FUNCTION = 20000 + 199
|
||||||
|
FNMATCH_FUNCTION = 20000 + 200
|
||||||
|
CHUNK_DATA = 10000 + 201
|
||||||
|
FNMATCH_DATA = 10000 + 202
|
||||||
|
RESOLVE = 10000 + 203
|
||||||
|
TLSAUTH_USERNAME = 10000 + 204
|
||||||
|
TLSAUTH_PASSWORD = 10000 + 205
|
||||||
|
TLSAUTH_TYPE = 10000 + 206
|
||||||
|
TRANSFER_ENCODING = 0 + 207
|
||||||
|
CLOSESOCKETFUNCTION = 20000 + 208
|
||||||
|
CLOSESOCKETDATA = 10000 + 209
|
||||||
|
GSSAPI_DELEGATION = 0 + 210
|
||||||
|
DNS_SERVERS = 10000 + 211
|
||||||
|
ACCEPTTIMEOUT_MS = 0 + 212
|
||||||
|
TCP_KEEPALIVE = 0 + 213
|
||||||
|
TCP_KEEPIDLE = 0 + 214
|
||||||
|
TCP_KEEPINTVL = 0 + 215
|
||||||
|
SSL_OPTIONS = 0 + 216
|
||||||
|
MAIL_AUTH = 10000 + 217
|
||||||
|
SASL_IR = 0 + 218
|
||||||
|
XFERINFOFUNCTION = 20000 + 219
|
||||||
|
XOAUTH2_BEARER = 10000 + 220
|
||||||
|
DNS_INTERFACE = 10000 + 221
|
||||||
|
DNS_LOCAL_IP4 = 10000 + 222
|
||||||
|
DNS_LOCAL_IP6 = 10000 + 223
|
||||||
|
LOGIN_OPTIONS = 10000 + 224
|
||||||
|
SSL_ENABLE_NPN = 0 + 225
|
||||||
|
SSL_ENABLE_ALPN = 0 + 226
|
||||||
|
EXPECT_100_TIMEOUT_MS = 0 + 227
|
||||||
|
PROXYHEADER = 10000 + 228
|
||||||
|
HEADEROPT = 0 + 229
|
||||||
|
PINNEDPUBLICKEY = 10000 + 230
|
||||||
|
UNIX_SOCKET_PATH = 10000 + 231
|
||||||
|
SSL_VERIFYSTATUS = 0 + 232
|
||||||
|
SSL_FALSESTART = 0 + 233
|
||||||
|
PATH_AS_IS = 0 + 234
|
||||||
|
PROXY_SERVICE_NAME = 10000 + 235
|
||||||
|
SERVICE_NAME = 10000 + 236
|
||||||
|
PIPEWAIT = 0 + 237
|
||||||
|
DEFAULT_PROTOCOL = 10000 + 238
|
||||||
|
STREAM_WEIGHT = 0 + 239
|
||||||
|
STREAM_DEPENDS = 10000 + 240
|
||||||
|
STREAM_DEPENDS_E = 10000 + 241
|
||||||
|
TFTP_NO_OPTIONS = 0 + 242
|
||||||
|
CONNECT_TO = 10000 + 243
|
||||||
|
TCP_FASTOPEN = 0 + 244
|
||||||
|
KEEP_SENDING_ON_ERROR = 0 + 245
|
||||||
|
PROXY_CAINFO = 10000 + 246
|
||||||
|
PROXY_CAPATH = 10000 + 247
|
||||||
|
PROXY_SSL_VERIFYPEER = 0 + 248
|
||||||
|
PROXY_SSL_VERIFYHOST = 0 + 249
|
||||||
|
PROXY_SSLVERSION = 0 + 250
|
||||||
|
PROXY_TLSAUTH_USERNAME = 10000 + 251
|
||||||
|
PROXY_TLSAUTH_PASSWORD = 10000 + 252
|
||||||
|
PROXY_TLSAUTH_TYPE = 10000 + 253
|
||||||
|
PROXY_SSLCERT = 10000 + 254
|
||||||
|
PROXY_SSLCERTTYPE = 10000 + 255
|
||||||
|
PROXY_SSLKEY = 10000 + 256
|
||||||
|
PROXY_SSLKEYTYPE = 10000 + 257
|
||||||
|
PROXY_KEYPASSWD = 10000 + 258
|
||||||
|
PROXY_SSL_CIPHER_LIST = 10000 + 259
|
||||||
|
PROXY_CRLFILE = 10000 + 260
|
||||||
|
PROXY_SSL_OPTIONS = 0 + 261
|
||||||
|
PRE_PROXY = 10000 + 262
|
||||||
|
PROXY_PINNEDPUBLICKEY = 10000 + 263
|
||||||
|
ABSTRACT_UNIX_SOCKET = 10000 + 264
|
||||||
|
SUPPRESS_CONNECT_HEADERS = 0 + 265
|
||||||
|
REQUEST_TARGET = 10000 + 266
|
||||||
|
SOCKS5_AUTH = 0 + 267
|
||||||
|
SSH_COMPRESSION = 0 + 268
|
||||||
|
MIMEPOST = 10000 + 269
|
||||||
|
TIMEVALUE_LARGE = 30000 + 270
|
||||||
|
HAPPY_EYEBALLS_TIMEOUT_MS = 0 + 271
|
||||||
|
RESOLVER_START_FUNCTION = 20000 + 272
|
||||||
|
RESOLVER_START_DATA = 10000 + 273
|
||||||
|
HAPROXYPROTOCOL = 0 + 274
|
||||||
|
DNS_SHUFFLE_ADDRESSES = 0 + 275
|
||||||
|
TLS13_CIPHERS = 10000 + 276
|
||||||
|
PROXY_TLS13_CIPHERS = 10000 + 277
|
||||||
|
DISALLOW_USERNAME_IN_URL = 0 + 278
|
||||||
|
DOH_URL = 10000 + 279
|
||||||
|
UPLOAD_BUFFERSIZE = 0 + 280
|
||||||
|
UPKEEP_INTERVAL_MS = 0 + 281
|
||||||
|
CURLU = 10000 + 282
|
||||||
|
TRAILERFUNCTION = 20000 + 283
|
||||||
|
TRAILERDATA = 10000 + 284
|
||||||
|
HTTP09_ALLOWED = 0 + 285
|
||||||
|
ALTSVC_CTRL = 0 + 286
|
||||||
|
ALTSVC = 10000 + 287
|
||||||
|
MAXAGE_CONN = 0 + 288
|
||||||
|
SASL_AUTHZID = 10000 + 289
|
||||||
|
MAIL_RCPT_ALLOWFAILS = 0 + 290
|
||||||
|
SSLCERT_BLOB = 40000 + 291
|
||||||
|
SSLKEY_BLOB = 40000 + 292
|
||||||
|
PROXY_SSLCERT_BLOB = 40000 + 293
|
||||||
|
PROXY_SSLKEY_BLOB = 40000 + 294
|
||||||
|
ISSUERCERT_BLOB = 40000 + 295
|
||||||
|
PROXY_ISSUERCERT = 10000 + 296
|
||||||
|
PROXY_ISSUERCERT_BLOB = 40000 + 297
|
||||||
|
SSL_EC_CURVES = 10000 + 298
|
||||||
|
HSTS_CTRL = 0 + 299
|
||||||
|
HSTS = 10000 + 300
|
||||||
|
HSTSREADFUNCTION = 20000 + 301
|
||||||
|
HSTSREADDATA = 10000 + 302
|
||||||
|
HSTSWRITEFUNCTION = 20000 + 303
|
||||||
|
HSTSWRITEDATA = 10000 + 304
|
||||||
|
AWS_SIGV4 = 10000 + 305
|
||||||
|
DOH_SSL_VERIFYPEER = 0 + 306
|
||||||
|
DOH_SSL_VERIFYHOST = 0 + 307
|
||||||
|
DOH_SSL_VERIFYSTATUS = 0 + 308
|
||||||
|
CAINFO_BLOB = 40000 + 309
|
||||||
|
PROXY_CAINFO_BLOB = 40000 + 310
|
||||||
|
SSH_HOST_PUBLIC_KEY_SHA256 = 10000 + 311
|
||||||
|
PREREQFUNCTION = 20000 + 312
|
||||||
|
PREREQDATA = 10000 + 313
|
||||||
|
MAXLIFETIME_CONN = 0 + 314
|
||||||
|
MIME_OPTIONS = 0 + 315
|
||||||
|
SSH_HOSTKEYFUNCTION = 20000 + 316
|
||||||
|
SSH_HOSTKEYDATA = 10000 + 317
|
||||||
|
PROTOCOLS_STR = 10000 + 318
|
||||||
|
REDIR_PROTOCOLS_STR = 10000 + 319
|
||||||
|
WS_OPTIONS = 0 + 320
|
||||||
|
CA_CACHE_TIMEOUT = 0 + 321
|
||||||
|
QUICK_EXIT = 0 + 322
|
||||||
|
HAPROXY_CLIENT_IP = 10000 + 323
|
||||||
|
SERVER_RESPONSE_TIMEOUT_MS = 0 + 324
|
||||||
|
ECH = 10000 + 325
|
||||||
|
TCP_KEEPCNT = 0 + 326
|
||||||
|
UPLOAD_FLAGS = 0 + 327
|
||||||
|
SSL_SIGNATURE_ALGORITHMS = 10000 + 328
|
||||||
|
HTTPBASEHEADER = 10000 + 1000
|
||||||
|
SSL_SIG_HASH_ALGS = 10000 + 1001
|
||||||
|
SSL_ENABLE_ALPS = 0 + 1002
|
||||||
|
SSL_CERT_COMPRESSION = 10000 + 1003
|
||||||
|
SSL_ENABLE_TICKET = 0 + 1004
|
||||||
|
HTTP2_PSEUDO_HEADERS_ORDER = 10000 + 1005
|
||||||
|
HTTP2_SETTINGS = 10000 + 1006
|
||||||
|
SSL_PERMUTE_EXTENSIONS = 0 + 1007
|
||||||
|
HTTP2_WINDOW_UPDATE = 0 + 1008
|
||||||
|
HTTP2_STREAMS = 10000 + 1010
|
||||||
|
TLS_GREASE = 0 + 1011
|
||||||
|
TLS_EXTENSION_ORDER = 10000 + 1012
|
||||||
|
STREAM_EXCLUSIVE = 0 + 1013
|
||||||
|
TLS_KEY_USAGE_NO_CHECK = 0 + 1014
|
||||||
|
TLS_SIGNED_CERT_TIMESTAMPS = 0 + 1015
|
||||||
|
TLS_STATUS_REQUEST = 0 + 1016
|
||||||
|
TLS_DELEGATED_CREDENTIALS = 10000 + 1017
|
||||||
|
TLS_RECORD_SIZE_LIMIT = 0 + 1018
|
||||||
|
TLS_KEY_SHARES_LIMIT = 0 + 1019
|
||||||
|
TLS_USE_NEW_ALPS_CODEPOINT = 0 + 1020
|
||||||
|
HTTP2_NO_PRIORITY = 0 + 1021
|
||||||
|
PROXY_CREDENTIAL_NO_REUSE = 0 + 1022
|
||||||
|
|
||||||
|
if locals().get("WRITEDATA"):
|
||||||
|
FILE = locals().get("WRITEDATA")
|
||||||
|
if locals().get("READDATA"):
|
||||||
|
INFILE = locals().get("READDATA")
|
||||||
|
if locals().get("HEADERDATA"):
|
||||||
|
WRITEHEADER = locals().get("HEADERDATA")
|
||||||
|
|
||||||
|
|
||||||
|
class CurlInfo(IntEnum):
|
||||||
|
"""``CURLINFO_`` constancs extracted from libcurl,
|
||||||
|
see: https://curl.se/libcurl/c/curl_easy_getinfo.html"""
|
||||||
|
|
||||||
|
TEXT = 0
|
||||||
|
EFFECTIVE_URL = 0x100000 + 1
|
||||||
|
RESPONSE_CODE = 0x200000 + 2
|
||||||
|
TOTAL_TIME = 0x300000 + 3
|
||||||
|
NAMELOOKUP_TIME = 0x300000 + 4
|
||||||
|
CONNECT_TIME = 0x300000 + 5
|
||||||
|
PRETRANSFER_TIME = 0x300000 + 6
|
||||||
|
SIZE_UPLOAD_T = 0x600000 + 7
|
||||||
|
SIZE_DOWNLOAD_T = 0x600000 + 8
|
||||||
|
SPEED_DOWNLOAD_T = 0x600000 + 9
|
||||||
|
SPEED_UPLOAD_T = 0x600000 + 10
|
||||||
|
HEADER_SIZE = 0x200000 + 11
|
||||||
|
REQUEST_SIZE = 0x200000 + 12
|
||||||
|
SSL_VERIFYRESULT = 0x200000 + 13
|
||||||
|
FILETIME = 0x200000 + 14
|
||||||
|
FILETIME_T = 0x600000 + 14
|
||||||
|
CONTENT_LENGTH_DOWNLOAD_T = 0x600000 + 15
|
||||||
|
CONTENT_LENGTH_UPLOAD_T = 0x600000 + 16
|
||||||
|
STARTTRANSFER_TIME = 0x300000 + 17
|
||||||
|
CONTENT_TYPE = 0x100000 + 18
|
||||||
|
REDIRECT_TIME = 0x300000 + 19
|
||||||
|
REDIRECT_COUNT = 0x200000 + 20
|
||||||
|
PRIVATE = 0x100000 + 21
|
||||||
|
HTTP_CONNECTCODE = 0x200000 + 22
|
||||||
|
HTTPAUTH_AVAIL = 0x200000 + 23
|
||||||
|
PROXYAUTH_AVAIL = 0x200000 + 24
|
||||||
|
OS_ERRNO = 0x200000 + 25
|
||||||
|
NUM_CONNECTS = 0x200000 + 26
|
||||||
|
SSL_ENGINES = 0x400000 + 27
|
||||||
|
COOKIELIST = 0x400000 + 28
|
||||||
|
FTP_ENTRY_PATH = 0x100000 + 30
|
||||||
|
REDIRECT_URL = 0x100000 + 31
|
||||||
|
PRIMARY_IP = 0x100000 + 32
|
||||||
|
APPCONNECT_TIME = 0x300000 + 33
|
||||||
|
CERTINFO = 0x400000 + 34
|
||||||
|
CONDITION_UNMET = 0x200000 + 35
|
||||||
|
RTSP_SESSION_ID = 0x100000 + 36
|
||||||
|
RTSP_CLIENT_CSEQ = 0x200000 + 37
|
||||||
|
RTSP_SERVER_CSEQ = 0x200000 + 38
|
||||||
|
RTSP_CSEQ_RECV = 0x200000 + 39
|
||||||
|
PRIMARY_PORT = 0x200000 + 40
|
||||||
|
LOCAL_IP = 0x100000 + 41
|
||||||
|
LOCAL_PORT = 0x200000 + 42
|
||||||
|
ACTIVESOCKET = 0x500000 + 44
|
||||||
|
TLS_SSL_PTR = 0x400000 + 45
|
||||||
|
HTTP_VERSION = 0x200000 + 46
|
||||||
|
PROXY_SSL_VERIFYRESULT = 0x200000 + 47
|
||||||
|
SCHEME = 0x100000 + 49
|
||||||
|
TOTAL_TIME_T = 0x600000 + 50
|
||||||
|
NAMELOOKUP_TIME_T = 0x600000 + 51
|
||||||
|
CONNECT_TIME_T = 0x600000 + 52
|
||||||
|
PRETRANSFER_TIME_T = 0x600000 + 53
|
||||||
|
STARTTRANSFER_TIME_T = 0x600000 + 54
|
||||||
|
REDIRECT_TIME_T = 0x600000 + 55
|
||||||
|
APPCONNECT_TIME_T = 0x600000 + 56
|
||||||
|
RETRY_AFTER = 0x600000 + 57
|
||||||
|
EFFECTIVE_METHOD = 0x100000 + 58
|
||||||
|
PROXY_ERROR = 0x200000 + 59
|
||||||
|
REFERER = 0x100000 + 60
|
||||||
|
CAINFO = 0x100000 + 61
|
||||||
|
CAPATH = 0x100000 + 62
|
||||||
|
XFER_ID = 0x600000 + 63
|
||||||
|
CONN_ID = 0x600000 + 64
|
||||||
|
QUEUE_TIME_T = 0x600000 + 65
|
||||||
|
USED_PROXY = 0x200000 + 66
|
||||||
|
POSTTRANSFER_TIME_T = 0x600000 + 67
|
||||||
|
EARLYDATA_SENT_T = 0x600000 + 68
|
||||||
|
HTTPAUTH_USED = 0x200000 + 69
|
||||||
|
PROXYAUTH_USED = 0x200000 + 70
|
||||||
|
LASTONE = 70
|
||||||
|
|
||||||
|
if locals().get("RESPONSE_CODE"):
|
||||||
|
HTTP_CODE = locals().get("RESPONSE_CODE")
|
||||||
|
|
||||||
|
|
||||||
|
class CurlMOpt(IntEnum):
|
||||||
|
"""``CURLMOPT_`` constancs extracted from libcurl,
|
||||||
|
see: https://curl.se/libcurl/c/curl_multi_setopt.html"""
|
||||||
|
|
||||||
|
SOCKETFUNCTION = 20000 + 1
|
||||||
|
SOCKETDATA = 10000 + 2
|
||||||
|
PIPELINING = 0 + 3
|
||||||
|
TIMERFUNCTION = 20000 + 4
|
||||||
|
TIMERDATA = 10000 + 5
|
||||||
|
MAXCONNECTS = 0 + 6
|
||||||
|
MAX_HOST_CONNECTIONS = 0 + 7
|
||||||
|
MAX_PIPELINE_LENGTH = 0 + 8
|
||||||
|
CONTENT_LENGTH_PENALTY_SIZE = 30000 + 9
|
||||||
|
CHUNK_LENGTH_PENALTY_SIZE = 30000 + 10
|
||||||
|
PIPELINING_SITE_BL = 10000 + 11
|
||||||
|
PIPELINING_SERVER_BL = 10000 + 12
|
||||||
|
MAX_TOTAL_CONNECTIONS = 0 + 13
|
||||||
|
PUSHFUNCTION = 20000 + 14
|
||||||
|
PUSHDATA = 10000 + 15
|
||||||
|
MAX_CONCURRENT_STREAMS = 0 + 16
|
||||||
|
|
||||||
|
|
||||||
|
class CurlECode(IntEnum):
|
||||||
|
"""``CURLECODE_`` constancs extracted from libcurl,
|
||||||
|
see: https://curl.se/libcurl/c/libcurl-errors.html"""
|
||||||
|
|
||||||
|
OK = 0
|
||||||
|
UNSUPPORTED_PROTOCOL = 1
|
||||||
|
FAILED_INIT = 2
|
||||||
|
URL_MALFORMAT = 3
|
||||||
|
NOT_BUILT_IN = 4
|
||||||
|
COULDNT_RESOLVE_PROXY = 5
|
||||||
|
COULDNT_RESOLVE_HOST = 6
|
||||||
|
COULDNT_CONNECT = 7
|
||||||
|
WEIRD_SERVER_REPLY = 8
|
||||||
|
REMOTE_ACCESS_DENIED = 9
|
||||||
|
FTP_ACCEPT_FAILED = 10
|
||||||
|
FTP_WEIRD_PASS_REPLY = 11
|
||||||
|
FTP_ACCEPT_TIMEOUT = 12
|
||||||
|
FTP_WEIRD_PASV_REPLY = 13
|
||||||
|
FTP_WEIRD_227_FORMAT = 14
|
||||||
|
FTP_CANT_GET_HOST = 15
|
||||||
|
HTTP2 = 16
|
||||||
|
FTP_COULDNT_SET_TYPE = 17
|
||||||
|
PARTIAL_FILE = 18
|
||||||
|
FTP_COULDNT_RETR_FILE = 19
|
||||||
|
OBSOLETE20 = 20
|
||||||
|
QUOTE_ERROR = 21
|
||||||
|
HTTP_RETURNED_ERROR = 22
|
||||||
|
WRITE_ERROR = 23
|
||||||
|
OBSOLETE24 = 24
|
||||||
|
UPLOAD_FAILED = 25
|
||||||
|
READ_ERROR = 26
|
||||||
|
OUT_OF_MEMORY = 27
|
||||||
|
OPERATION_TIMEDOUT = 28
|
||||||
|
OBSOLETE29 = 29
|
||||||
|
FTP_PORT_FAILED = 30
|
||||||
|
FTP_COULDNT_USE_REST = 31
|
||||||
|
OBSOLETE32 = 32
|
||||||
|
RANGE_ERROR = 33
|
||||||
|
OBSOLETE34 = 34
|
||||||
|
SSL_CONNECT_ERROR = 35
|
||||||
|
BAD_DOWNLOAD_RESUME = 36
|
||||||
|
FILE_COULDNT_READ_FILE = 37
|
||||||
|
LDAP_CANNOT_BIND = 38
|
||||||
|
LDAP_SEARCH_FAILED = 39
|
||||||
|
OBSOLETE40 = 40
|
||||||
|
OBSOLETE41 = 41
|
||||||
|
ABORTED_BY_CALLBACK = 42
|
||||||
|
BAD_FUNCTION_ARGUMENT = 43
|
||||||
|
OBSOLETE44 = 44
|
||||||
|
INTERFACE_FAILED = 45
|
||||||
|
OBSOLETE46 = 46
|
||||||
|
TOO_MANY_REDIRECTS = 47
|
||||||
|
UNKNOWN_OPTION = 48
|
||||||
|
SETOPT_OPTION_SYNTAX = 49
|
||||||
|
OBSOLETE50 = 50
|
||||||
|
OBSOLETE51 = 51
|
||||||
|
GOT_NOTHING = 52
|
||||||
|
SSL_ENGINE_NOTFOUND = 53
|
||||||
|
SSL_ENGINE_SETFAILED = 54
|
||||||
|
SEND_ERROR = 55
|
||||||
|
RECV_ERROR = 56
|
||||||
|
OBSOLETE57 = 57
|
||||||
|
SSL_CERTPROBLEM = 58
|
||||||
|
SSL_CIPHER = 59
|
||||||
|
PEER_FAILED_VERIFICATION = 60
|
||||||
|
BAD_CONTENT_ENCODING = 61
|
||||||
|
OBSOLETE62 = 62
|
||||||
|
FILESIZE_EXCEEDED = 63
|
||||||
|
USE_SSL_FAILED = 64
|
||||||
|
SEND_FAIL_REWIND = 65
|
||||||
|
SSL_ENGINE_INITFAILED = 66
|
||||||
|
LOGIN_DENIED = 67
|
||||||
|
TFTP_NOTFOUND = 68
|
||||||
|
TFTP_PERM = 69
|
||||||
|
REMOTE_DISK_FULL = 70
|
||||||
|
TFTP_ILLEGAL = 71
|
||||||
|
TFTP_UNKNOWNID = 72
|
||||||
|
REMOTE_FILE_EXISTS = 73
|
||||||
|
TFTP_NOSUCHUSER = 74
|
||||||
|
OBSOLETE75 = 75
|
||||||
|
OBSOLETE76 = 76
|
||||||
|
SSL_CACERT_BADFILE = 77
|
||||||
|
REMOTE_FILE_NOT_FOUND = 78
|
||||||
|
SSH = 79
|
||||||
|
SSL_SHUTDOWN_FAILED = 80
|
||||||
|
AGAIN = 81
|
||||||
|
SSL_CRL_BADFILE = 82
|
||||||
|
SSL_ISSUER_ERROR = 83
|
||||||
|
FTP_PRET_FAILED = 84
|
||||||
|
RTSP_CSEQ_ERROR = 85
|
||||||
|
RTSP_SESSION_ERROR = 86
|
||||||
|
FTP_BAD_FILE_LIST = 87
|
||||||
|
CHUNK_FAILED = 88
|
||||||
|
NO_CONNECTION_AVAILABLE = 89
|
||||||
|
SSL_PINNEDPUBKEYNOTMATCH = 90
|
||||||
|
SSL_INVALIDCERTSTATUS = 91
|
||||||
|
HTTP2_STREAM = 92
|
||||||
|
RECURSIVE_API_CALL = 93
|
||||||
|
AUTH_ERROR = 94
|
||||||
|
HTTP3 = 95
|
||||||
|
QUIC_CONNECT_ERROR = 96
|
||||||
|
PROXY = 97
|
||||||
|
SSL_CLIENTCERT = 98
|
||||||
|
UNRECOVERABLE_POLL = 99
|
||||||
|
TOO_LARGE = 100
|
||||||
|
ECH_REQUIRED = 101
|
||||||
|
RESERVED115115 = 102
|
||||||
|
RESERVED116116 = 103
|
||||||
|
RESERVED117117 = 104
|
||||||
|
RESERVED118118 = 105
|
||||||
|
RESERVED119119 = 106
|
||||||
|
RESERVED120120 = 107
|
||||||
|
RESERVED121121 = 108
|
||||||
|
RESERVED122122 = 109
|
||||||
|
RESERVED123123 = 110
|
||||||
|
RESERVED124124 = 111
|
||||||
|
RESERVED125125 = 112
|
||||||
|
RESERVED126126 = 113
|
||||||
|
|
||||||
|
|
||||||
|
class CurlHttpVersion(IntEnum):
|
||||||
|
"""``CURL_HTTP_VERSION`` constants from libcurl, see comments for details."""
|
||||||
|
|
||||||
|
NONE = 0
|
||||||
|
V1_0 = 1 # please use HTTP 1.0 in the request */
|
||||||
|
V1_1 = 2 # please use HTTP 1.1 in the request */
|
||||||
|
V2_0 = 3 # please use HTTP 2 in the request */
|
||||||
|
V2TLS = 4 # use version 2 for HTTPS, version 1.1 for HTTP */
|
||||||
|
V2_PRIOR_KNOWLEDGE = 5 # please use HTTP 2 without HTTP/1.1 Upgrade */
|
||||||
|
V3 = 30 # Makes use of explicit HTTP/3 with fallback.
|
||||||
|
V3ONLY = 31 # No fallback
|
||||||
|
|
||||||
|
|
||||||
|
class CurlWsFlag(IntEnum):
|
||||||
|
"""``CURL_WS_FLAG`` constants from libcurl, see comments for details."""
|
||||||
|
|
||||||
|
TEXT = 1 << 0
|
||||||
|
BINARY = 1 << 1
|
||||||
|
CONT = 1 << 2
|
||||||
|
CLOSE = 1 << 3
|
||||||
|
PING = 1 << 4
|
||||||
|
OFFSET = 1 << 5
|
||||||
|
|
||||||
|
|
||||||
|
class CurlSslVersion(IntEnum):
|
||||||
|
"""``CURL_SSLVERSION`` constants from libcurl, see comments for details."""
|
||||||
|
|
||||||
|
DEFAULT = 0
|
||||||
|
TLSv1 = 1
|
||||||
|
SSLv2 = 2
|
||||||
|
SSLv3 = 3
|
||||||
|
TLSv1_0 = 4
|
||||||
|
TLSv1_1 = 5
|
||||||
|
TLSv1_2 = 6
|
||||||
|
TLSv1_3 = 7
|
||||||
|
MAX_DEFAULT = 1 << 16
|
||||||
|
|
||||||
|
|
||||||
|
class CurlIpResolve(IntEnum):
|
||||||
|
"""``CURL_IPRESOLVE`` constants from libcurl, see comments for details."""
|
||||||
|
|
||||||
|
WHATEVER = 0 # default, uses addresses to all IP versions that your system allows
|
||||||
|
V4 = 1 # uses only IPv4 addresses/connections
|
||||||
|
V6 = 2 # uses only IPv6 addresses/connections
|
||||||
|
|
@ -0,0 +1,691 @@
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import re
|
||||||
|
import locale
|
||||||
|
import struct
|
||||||
|
import sys
|
||||||
|
import warnings
|
||||||
|
from http.cookies import SimpleCookie
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING, Any, Literal, Optional, Union, cast
|
||||||
|
|
||||||
|
import certifi
|
||||||
|
|
||||||
|
from ._wrapper import ffi, lib
|
||||||
|
from .const import CurlECode, CurlHttpVersion, CurlInfo, CurlOpt, CurlWsFlag
|
||||||
|
from .utils import CurlCffiWarning
|
||||||
|
|
||||||
|
DEFAULT_CACERT = certifi.where()
|
||||||
|
REASON_PHRASE_RE = re.compile(rb"HTTP/\d\.\d [0-9]{3} (.*)")
|
||||||
|
STATUS_LINE_RE = re.compile(rb"HTTP/(\d\.\d) ([0-9]{3}) (.*)")
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
|
||||||
|
class CurlWsFrame:
|
||||||
|
age: int
|
||||||
|
flags: int
|
||||||
|
offset: int
|
||||||
|
bytesleft: int
|
||||||
|
len: int
|
||||||
|
|
||||||
|
|
||||||
|
class CurlError(Exception):
|
||||||
|
"""Base exception for curl_cffi package"""
|
||||||
|
|
||||||
|
def __init__(self, msg, code: Union[CurlECode, Literal[0]] = 0, *args, **kwargs):
|
||||||
|
super().__init__(msg, *args, **kwargs)
|
||||||
|
self.code: Union[CurlECode, Literal[0]] = code
|
||||||
|
|
||||||
|
|
||||||
|
CURLINFO_TEXT = 0
|
||||||
|
CURLINFO_HEADER_IN = 1
|
||||||
|
CURLINFO_HEADER_OUT = 2
|
||||||
|
CURLINFO_DATA_IN = 3
|
||||||
|
CURLINFO_DATA_OUT = 4
|
||||||
|
CURLINFO_SSL_DATA_IN = 5
|
||||||
|
CURLINFO_SSL_DATA_OUT = 6
|
||||||
|
|
||||||
|
CURL_WRITEFUNC_PAUSE = 0x10000001
|
||||||
|
CURL_WRITEFUNC_ERROR = 0xFFFFFFFF
|
||||||
|
|
||||||
|
|
||||||
|
@ffi.def_extern()
|
||||||
|
def debug_function(curl, type_: int, data, size: int, clientp) -> int:
|
||||||
|
"""ffi callback for curl debug info"""
|
||||||
|
callback = ffi.from_handle(clientp)
|
||||||
|
text = ffi.buffer(data, size)[:]
|
||||||
|
callback(type_, text)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def bytes_to_hex(b: bytes, uppercase: bool = False) -> str:
|
||||||
|
"""
|
||||||
|
Convert a bytes object to a space-separated hex string, e.g. "0a ff 3c".
|
||||||
|
If uppercase=True, letters will be A–F instead of a–f.
|
||||||
|
"""
|
||||||
|
fmt = "{:02X}" if uppercase else "{:02x}"
|
||||||
|
return " ".join(fmt.format(byte) for byte in b)
|
||||||
|
|
||||||
|
|
||||||
|
def debug_function_default(type_: int, data: bytes) -> None:
|
||||||
|
PREFIXES = {
|
||||||
|
CURLINFO_TEXT: "*",
|
||||||
|
CURLINFO_HEADER_IN: "<",
|
||||||
|
CURLINFO_HEADER_OUT: ">",
|
||||||
|
CURLINFO_DATA_IN: "< DATA",
|
||||||
|
CURLINFO_DATA_OUT: "> DATA",
|
||||||
|
CURLINFO_SSL_DATA_IN: "< SSL",
|
||||||
|
CURLINFO_SSL_DATA_OUT: "> SSL",
|
||||||
|
}
|
||||||
|
MAX_SHOW_BYTES = 40
|
||||||
|
prefix = PREFIXES.get(type_, "*")
|
||||||
|
|
||||||
|
# always show ssl data in binary format
|
||||||
|
if type_ in (CURLINFO_SSL_DATA_IN, CURLINFO_SSL_DATA_OUT):
|
||||||
|
hex_str = bytes_to_hex(data[:MAX_SHOW_BYTES])
|
||||||
|
postfix = "" if len(data) <= MAX_SHOW_BYTES else "..."
|
||||||
|
sys.stderr.write(f"{prefix} [{len(data)} bytes]: {hex_str}{postfix}\n")
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
text = data.decode("utf-8")
|
||||||
|
sys.stderr.write(f"{prefix} {text}")
|
||||||
|
if type_ not in (CURLINFO_TEXT, CURLINFO_HEADER_IN, CURLINFO_HEADER_OUT):
|
||||||
|
sys.stderr.write("\n")
|
||||||
|
except UnicodeDecodeError:
|
||||||
|
# Fallback to hex representation of first MAX_SHOW_BYTES bytes
|
||||||
|
hex_str = bytes_to_hex(data[:MAX_SHOW_BYTES])
|
||||||
|
postfix = "" if len(data) <= MAX_SHOW_BYTES else "..."
|
||||||
|
sys.stderr.write(f"{prefix} [{len(data)} bytes]: {hex_str}{postfix}\n")
|
||||||
|
|
||||||
|
|
||||||
|
@ffi.def_extern()
|
||||||
|
def buffer_callback(ptr, size, nmemb, userdata):
|
||||||
|
"""ffi callback for curl write function, directly writes to a buffer"""
|
||||||
|
# assert size == 1
|
||||||
|
buffer = ffi.from_handle(userdata)
|
||||||
|
buffer.write(ffi.buffer(ptr, nmemb)[:])
|
||||||
|
return nmemb * size
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_int(s):
|
||||||
|
if not s:
|
||||||
|
return 0
|
||||||
|
return int(s)
|
||||||
|
|
||||||
|
|
||||||
|
@ffi.def_extern()
|
||||||
|
def write_callback(ptr, size, nmemb, userdata):
|
||||||
|
"""ffi callback for curl write function, calls the callback python function"""
|
||||||
|
# although similar enough to the function above, kept here for performance reasons
|
||||||
|
callback = ffi.from_handle(userdata)
|
||||||
|
wrote = callback(ffi.buffer(ptr, nmemb)[:])
|
||||||
|
wrote = ensure_int(wrote)
|
||||||
|
if wrote == CURL_WRITEFUNC_PAUSE or wrote == CURL_WRITEFUNC_ERROR: # noqa: SIM109
|
||||||
|
return wrote
|
||||||
|
# should make this an exception in future versions
|
||||||
|
if wrote != nmemb * size:
|
||||||
|
warnings.warn("Wrote bytes != received bytes.", CurlCffiWarning, stacklevel=2)
|
||||||
|
return nmemb * size
|
||||||
|
|
||||||
|
|
||||||
|
# Credits: @alexio777 on https://github.com/lexiforest/curl_cffi/issues/4
|
||||||
|
def slist_to_list(head) -> list[bytes]:
|
||||||
|
"""Converts curl slist to a python list."""
|
||||||
|
result = []
|
||||||
|
ptr = head
|
||||||
|
while ptr:
|
||||||
|
result.append(ffi.string(ptr.data))
|
||||||
|
ptr = ptr.next
|
||||||
|
lib.curl_slist_free_all(head)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
class Curl:
|
||||||
|
"""
|
||||||
|
Wrapper for ``curl_easy_*`` functions of libcurl.
|
||||||
|
"""
|
||||||
|
|
||||||
|
_WS_RECV_BUFFER_SIZE = 128 * 1024 # 128 kB
|
||||||
|
|
||||||
|
def __init__(self, cacert: str = "", debug: bool = False, handle=None) -> None:
|
||||||
|
"""
|
||||||
|
Parameters:
|
||||||
|
cacert: CA cert path to use, by default, certs from ``certifi`` are used.
|
||||||
|
debug: whether to show curl debug messages.
|
||||||
|
handle: a curl handle instance from ``curl_easy_init``.
|
||||||
|
"""
|
||||||
|
self._curl = handle if handle else lib.curl_easy_init()
|
||||||
|
self._headers = ffi.NULL
|
||||||
|
self._proxy_headers = ffi.NULL
|
||||||
|
self._resolve = ffi.NULL
|
||||||
|
self._cacert = cacert or DEFAULT_CACERT
|
||||||
|
self._is_cert_set = False
|
||||||
|
self._write_handle: Any = None
|
||||||
|
self._header_handle: Any = None
|
||||||
|
self._debug_handle: Any = None
|
||||||
|
self._body_handle: Any = None
|
||||||
|
# TODO: use CURL_ERROR_SIZE
|
||||||
|
self._error_buffer = ffi.new("char[]", 256)
|
||||||
|
self._debug = debug
|
||||||
|
self._set_error_buffer()
|
||||||
|
|
||||||
|
# Pre-allocated CFFI objects for WebSocket performance
|
||||||
|
self._ws_recv_buffer = ffi.new("char[]", self._WS_RECV_BUFFER_SIZE)
|
||||||
|
self._ws_recv_n_recv = ffi.new("size_t *")
|
||||||
|
self._ws_recv_p_frame = ffi.new("struct curl_ws_frame **")
|
||||||
|
self._ws_send_n_sent = ffi.new("size_t *")
|
||||||
|
|
||||||
|
def _set_error_buffer(self) -> None:
|
||||||
|
ret = lib._curl_easy_setopt(self._curl, CurlOpt.ERRORBUFFER, self._error_buffer)
|
||||||
|
if ret != 0:
|
||||||
|
warnings.warn("Failed to set error buffer", CurlCffiWarning, stacklevel=2)
|
||||||
|
if self._debug:
|
||||||
|
self.debug()
|
||||||
|
|
||||||
|
def debug(self) -> None:
|
||||||
|
"""Set debug to True"""
|
||||||
|
self.setopt(CurlOpt.VERBOSE, 1)
|
||||||
|
self.setopt(CurlOpt.DEBUGFUNCTION, True)
|
||||||
|
|
||||||
|
def __del__(self) -> None:
|
||||||
|
self.close()
|
||||||
|
|
||||||
|
def _check_error(self, errcode: int, *args: Any) -> None:
|
||||||
|
if errcode == 0:
|
||||||
|
return
|
||||||
|
|
||||||
|
error = self._get_error(errcode, *args)
|
||||||
|
if error is not None:
|
||||||
|
raise error
|
||||||
|
|
||||||
|
def _get_error(self, errcode: int, *args: Any):
|
||||||
|
if errcode != 0:
|
||||||
|
errmsg = ffi.string(self._error_buffer).decode(errors="backslashreplace")
|
||||||
|
action = " ".join([str(a) for a in args])
|
||||||
|
return CurlError(
|
||||||
|
f"Failed to {action}, curl: ({errcode}) {errmsg}. "
|
||||||
|
"See https://curl.se/libcurl/c/libcurl-errors.html first for more "
|
||||||
|
"details.",
|
||||||
|
code=cast(CurlECode, errcode),
|
||||||
|
)
|
||||||
|
|
||||||
|
def setopt(self, option: CurlOpt, value: Any) -> int:
|
||||||
|
"""Wrapper for ``curl_easy_setopt``.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
option: option to set, using constants from CurlOpt enum
|
||||||
|
value: value to set, strings will be handled automatically
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
0 if no error, see ``CurlECode``.
|
||||||
|
"""
|
||||||
|
if self._curl is None:
|
||||||
|
return 0 # silently ignore if curl handle is None
|
||||||
|
input_option = {
|
||||||
|
# this should be int in curl, but cffi requires pointer for void*
|
||||||
|
# it will be convert back in the glue c code.
|
||||||
|
0: "long*",
|
||||||
|
10000: "char*",
|
||||||
|
20000: "void*",
|
||||||
|
30000: "int64_t*", # offset type
|
||||||
|
40000: "void*", # blob type
|
||||||
|
}
|
||||||
|
# print("option", option, "value", value)
|
||||||
|
|
||||||
|
# Convert value
|
||||||
|
value_type = input_option.get((option // 10000) * 10000)
|
||||||
|
if value_type == "long*" or value_type == "int64_t*":
|
||||||
|
c_value = ffi.new(value_type, value)
|
||||||
|
elif option == CurlOpt.WRITEDATA:
|
||||||
|
c_value = ffi.new_handle(value)
|
||||||
|
self._write_handle = c_value
|
||||||
|
lib._curl_easy_setopt(
|
||||||
|
self._curl, CurlOpt.WRITEFUNCTION, lib.buffer_callback
|
||||||
|
)
|
||||||
|
elif option == CurlOpt.HEADERDATA:
|
||||||
|
c_value = ffi.new_handle(value)
|
||||||
|
self._header_handle = c_value
|
||||||
|
lib._curl_easy_setopt(
|
||||||
|
self._curl, CurlOpt.HEADERFUNCTION, lib.buffer_callback
|
||||||
|
)
|
||||||
|
elif option == CurlOpt.WRITEFUNCTION:
|
||||||
|
c_value = ffi.new_handle(value)
|
||||||
|
self._write_handle = c_value
|
||||||
|
lib._curl_easy_setopt(self._curl, CurlOpt.WRITEFUNCTION, lib.write_callback)
|
||||||
|
option = CurlOpt.WRITEDATA
|
||||||
|
elif option == CurlOpt.HEADERFUNCTION:
|
||||||
|
c_value = ffi.new_handle(value)
|
||||||
|
self._header_handle = c_value
|
||||||
|
lib._curl_easy_setopt(
|
||||||
|
self._curl, CurlOpt.HEADERFUNCTION, lib.write_callback
|
||||||
|
)
|
||||||
|
option = CurlOpt.HEADERDATA
|
||||||
|
elif option == CurlOpt.DEBUGFUNCTION:
|
||||||
|
if value is True:
|
||||||
|
value = debug_function_default
|
||||||
|
c_value = ffi.new_handle(value)
|
||||||
|
self._debug_handle = c_value
|
||||||
|
lib._curl_easy_setopt(self._curl, CurlOpt.DEBUGFUNCTION, lib.debug_function)
|
||||||
|
option = CurlOpt.DEBUGDATA
|
||||||
|
elif value_type == "char*":
|
||||||
|
if isinstance(value, str):
|
||||||
|
# Windows/libcurl expects ANSI code page for file paths (char*).
|
||||||
|
# Non-ASCII paths encoded as UTF-8 can trigger ErrCode 77.
|
||||||
|
# Encode file-path-like options using the system encoding on Windows.
|
||||||
|
filepath_opts = {
|
||||||
|
CurlOpt.CAINFO,
|
||||||
|
CurlOpt.CAPATH,
|
||||||
|
CurlOpt.PROXY_CAINFO,
|
||||||
|
CurlOpt.PROXY_CAPATH,
|
||||||
|
CurlOpt.SSLCERT,
|
||||||
|
CurlOpt.SSLKEY,
|
||||||
|
CurlOpt.CRLFILE,
|
||||||
|
CurlOpt.ISSUERCERT,
|
||||||
|
CurlOpt.SSH_PUBLIC_KEYFILE,
|
||||||
|
CurlOpt.SSH_PRIVATE_KEYFILE,
|
||||||
|
CurlOpt.COOKIEFILE,
|
||||||
|
CurlOpt.COOKIEJAR,
|
||||||
|
CurlOpt.NETRC_FILE,
|
||||||
|
CurlOpt.UNIX_SOCKET_PATH,
|
||||||
|
}
|
||||||
|
if sys.platform.startswith("win") and option in filepath_opts:
|
||||||
|
# Use the process ANSI code page to match what CRT fopen expects.
|
||||||
|
enc = locale.getpreferredencoding(False)
|
||||||
|
c_value = value.encode(enc, errors="strict")
|
||||||
|
else:
|
||||||
|
c_value = value.encode()
|
||||||
|
else:
|
||||||
|
c_value = value
|
||||||
|
# Must keep a reference, otherwise may be GCed.
|
||||||
|
if option == CurlOpt.POSTFIELDS:
|
||||||
|
self._body_handle = c_value
|
||||||
|
else:
|
||||||
|
raise NotImplementedError(f"Option unsupported: {option}")
|
||||||
|
|
||||||
|
if option == CurlOpt.HTTPHEADER:
|
||||||
|
for header in value:
|
||||||
|
self._headers = lib.curl_slist_append(self._headers, header)
|
||||||
|
ret = lib._curl_easy_setopt(self._curl, option, self._headers)
|
||||||
|
elif option == CurlOpt.PROXYHEADER:
|
||||||
|
for proxy_header in value:
|
||||||
|
self._proxy_headers = lib.curl_slist_append(
|
||||||
|
self._proxy_headers, proxy_header
|
||||||
|
)
|
||||||
|
ret = lib._curl_easy_setopt(self._curl, option, self._proxy_headers)
|
||||||
|
elif option == CurlOpt.RESOLVE:
|
||||||
|
for resolve in value:
|
||||||
|
if isinstance(resolve, str):
|
||||||
|
resolve = resolve.encode()
|
||||||
|
self._resolve = lib.curl_slist_append(self._resolve, resolve)
|
||||||
|
ret = lib._curl_easy_setopt(self._curl, option, self._resolve)
|
||||||
|
else:
|
||||||
|
ret = lib._curl_easy_setopt(self._curl, option, c_value)
|
||||||
|
self._check_error(ret, "setopt", option, value)
|
||||||
|
|
||||||
|
if option == CurlOpt.CAINFO:
|
||||||
|
self._is_cert_set = True
|
||||||
|
|
||||||
|
return ret
|
||||||
|
|
||||||
|
def getinfo(self, option: CurlInfo) -> Union[bytes, int, float, list]:
|
||||||
|
"""Wrapper for ``curl_easy_getinfo``. Gets information in response after
|
||||||
|
curl.perform.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
option: option to get info of, using constants from ``CurlInfo`` enum
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
value retrieved from last perform.
|
||||||
|
"""
|
||||||
|
ret_option = {
|
||||||
|
0x100000: "char**",
|
||||||
|
0x200000: "long*",
|
||||||
|
0x300000: "double*",
|
||||||
|
0x400000: "struct curl_slist **",
|
||||||
|
0x500000: "long*",
|
||||||
|
0x600000: "int64_t*",
|
||||||
|
}
|
||||||
|
ret_cast_option = {
|
||||||
|
0x100000: ffi.string,
|
||||||
|
0x200000: int,
|
||||||
|
0x300000: float,
|
||||||
|
0x400000: list,
|
||||||
|
0x500000: int,
|
||||||
|
0x600000: int,
|
||||||
|
}
|
||||||
|
|
||||||
|
option_type = option & 0xF00000
|
||||||
|
|
||||||
|
if self._curl is None:
|
||||||
|
if option_type == 0x100000:
|
||||||
|
return b""
|
||||||
|
return ret_cast_option[option_type]()
|
||||||
|
|
||||||
|
c_value = ffi.new(ret_option[option_type])
|
||||||
|
ret = lib.curl_easy_getinfo(self._curl, option, c_value)
|
||||||
|
self._check_error(ret, "getinfo", option)
|
||||||
|
# cookielist and ssl_engines starts with 0x400000, see also: const.py
|
||||||
|
if option_type == 0x400000:
|
||||||
|
return slist_to_list(c_value[0])
|
||||||
|
if c_value[0] == ffi.NULL:
|
||||||
|
return b""
|
||||||
|
|
||||||
|
return ret_cast_option[option_type](c_value[0])
|
||||||
|
|
||||||
|
def version(self) -> bytes:
|
||||||
|
"""Get the underlying libcurl version."""
|
||||||
|
return ffi.string(lib.curl_version())
|
||||||
|
|
||||||
|
def impersonate(self, target: str, default_headers: bool = True) -> int:
|
||||||
|
"""Set the browser type to impersonate.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
target: browser to impersonate.
|
||||||
|
default_headers: whether to add default headers, like User-Agent.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
0 if no error.
|
||||||
|
"""
|
||||||
|
if self._curl is None:
|
||||||
|
return 0 # silently ignore if curl handle is None
|
||||||
|
return lib.curl_easy_impersonate(
|
||||||
|
self._curl, target.encode(), int(default_headers)
|
||||||
|
)
|
||||||
|
|
||||||
|
def _ensure_cacert(self) -> None:
|
||||||
|
if not self._is_cert_set:
|
||||||
|
ret = self.setopt(CurlOpt.CAINFO, self._cacert)
|
||||||
|
self._check_error(ret, "set cacert")
|
||||||
|
ret = self.setopt(CurlOpt.PROXY_CAINFO, self._cacert)
|
||||||
|
self._check_error(ret, "set proxy cacert")
|
||||||
|
|
||||||
|
def perform(self, clear_headers: bool = True, clear_resolve: bool = True) -> None:
|
||||||
|
"""Wrapper for ``curl_easy_perform``, performs a curl request.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
clear_headers: clear header slist used in this perform
|
||||||
|
clear_resolve: clear resolve slist used in this perform
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
CurlError: if the perform was not successful.
|
||||||
|
"""
|
||||||
|
if self._curl is None:
|
||||||
|
raise CurlError("Cannot perform request on closed handle.")
|
||||||
|
|
||||||
|
# make sure we set a cacert store
|
||||||
|
self._ensure_cacert()
|
||||||
|
|
||||||
|
# here we go
|
||||||
|
ret = lib.curl_easy_perform(self._curl)
|
||||||
|
|
||||||
|
try:
|
||||||
|
self._check_error(ret, "perform")
|
||||||
|
finally:
|
||||||
|
# cleaning
|
||||||
|
self.clean_handles_and_buffers(clear_headers, clear_resolve)
|
||||||
|
|
||||||
|
def upkeep(self) -> int:
|
||||||
|
if self._curl is None:
|
||||||
|
return 0 # silently ignore if curl handle is None
|
||||||
|
return lib.curl_easy_upkeep(self._curl)
|
||||||
|
|
||||||
|
def clean_handles_and_buffers(
|
||||||
|
self, clear_headers: bool = True, clear_resolve: bool = True
|
||||||
|
) -> None:
|
||||||
|
"""Clean up handles and buffers after ``perform`` and ``close``,
|
||||||
|
called at the end of ``perform`` and ``close``."""
|
||||||
|
self._write_handle = None
|
||||||
|
self._header_handle = None
|
||||||
|
self._debug_handle = None
|
||||||
|
self._body_handle = None
|
||||||
|
|
||||||
|
if clear_resolve:
|
||||||
|
if self._resolve != ffi.NULL:
|
||||||
|
lib.curl_slist_free_all(self._resolve)
|
||||||
|
self._resolve = ffi.NULL
|
||||||
|
|
||||||
|
if clear_headers:
|
||||||
|
if self._headers != ffi.NULL:
|
||||||
|
lib.curl_slist_free_all(self._headers)
|
||||||
|
self._headers = ffi.NULL
|
||||||
|
|
||||||
|
if self._proxy_headers != ffi.NULL:
|
||||||
|
lib.curl_slist_free_all(self._proxy_headers)
|
||||||
|
self._proxy_headers = ffi.NULL
|
||||||
|
|
||||||
|
def duphandle(self) -> Curl:
|
||||||
|
"""Wrapper for ``curl_easy_duphandle``.
|
||||||
|
|
||||||
|
This is not a full copy of entire curl object in python. For example, headers
|
||||||
|
handle is not copied, you have to set them again."""
|
||||||
|
if self._curl is None:
|
||||||
|
raise CurlError("Cannot duplicate closed handle.")
|
||||||
|
new_handle = lib.curl_easy_duphandle(self._curl)
|
||||||
|
c = Curl(cacert=self._cacert, debug=self._debug, handle=new_handle)
|
||||||
|
return c
|
||||||
|
|
||||||
|
def reset(self) -> None:
|
||||||
|
"""Reset all curl options, wrapper for ``curl_easy_reset``."""
|
||||||
|
self._is_cert_set = False
|
||||||
|
if self._curl is not None:
|
||||||
|
lib.curl_easy_reset(self._curl)
|
||||||
|
self._set_error_buffer()
|
||||||
|
self._resolve = ffi.NULL
|
||||||
|
|
||||||
|
def parse_cookie_headers(self, headers: list[bytes]) -> SimpleCookie:
|
||||||
|
"""Extract ``cookies.SimpleCookie`` from header lines.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
headers: list of headers in bytes.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
A parsed cookies.SimpleCookie instance.
|
||||||
|
"""
|
||||||
|
cookie: SimpleCookie = SimpleCookie()
|
||||||
|
for header in headers:
|
||||||
|
if header.lower().startswith(b"set-cookie: "):
|
||||||
|
cookie.load(header[12:].decode()) # len("set-cookie: ") == 12
|
||||||
|
return cookie
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_reason_phrase(status_line: bytes) -> bytes:
|
||||||
|
"""Extract reason phrase, like ``OK``, ``Not Found`` from response status
|
||||||
|
line."""
|
||||||
|
m = REASON_PHRASE_RE.match(status_line)
|
||||||
|
return m.group(1) if m else b""
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def parse_status_line(status_line: bytes) -> tuple[CurlHttpVersion, int, bytes]:
|
||||||
|
"""Parse status line.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
http_version, status_code, and reason phrase
|
||||||
|
"""
|
||||||
|
m = STATUS_LINE_RE.match(status_line)
|
||||||
|
if not m:
|
||||||
|
return CurlHttpVersion.V1_0, 0, b""
|
||||||
|
if m.group(1) == "2.0":
|
||||||
|
http_version = CurlHttpVersion.V2_0
|
||||||
|
elif m.group(1) == "1.1":
|
||||||
|
http_version = CurlHttpVersion.V1_1
|
||||||
|
elif m.group(1) == "1.0":
|
||||||
|
http_version = CurlHttpVersion.V1_0
|
||||||
|
else:
|
||||||
|
http_version = CurlHttpVersion.NONE
|
||||||
|
status_code = int(m.group(2))
|
||||||
|
reason = m.group(3)
|
||||||
|
|
||||||
|
return http_version, status_code, reason
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
"""Close and cleanup curl handle, wrapper for ``curl_easy_cleanup``."""
|
||||||
|
self.clean_handles_and_buffers()
|
||||||
|
|
||||||
|
if self._curl:
|
||||||
|
lib.curl_easy_cleanup(self._curl)
|
||||||
|
self._curl = None
|
||||||
|
ffi.release(self._error_buffer)
|
||||||
|
|
||||||
|
if self._ws_recv_buffer is not None:
|
||||||
|
ffi.release(self._ws_recv_buffer)
|
||||||
|
self._ws_recv_buffer = None
|
||||||
|
|
||||||
|
def ws_recv(self) -> tuple[bytes, CurlWsFrame]:
|
||||||
|
"""Receive a frame from a websocket connection.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
a tuple of frame content and curl frame meta struct.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
CurlError: if failed.
|
||||||
|
"""
|
||||||
|
if self._curl is None:
|
||||||
|
raise CurlError("Cannot receive websocket data on closed handle.")
|
||||||
|
ret = lib.curl_ws_recv(
|
||||||
|
self._curl,
|
||||||
|
self._ws_recv_buffer,
|
||||||
|
self._WS_RECV_BUFFER_SIZE,
|
||||||
|
self._ws_recv_n_recv,
|
||||||
|
self._ws_recv_p_frame,
|
||||||
|
)
|
||||||
|
self._check_error(ret, "WS_RECV")
|
||||||
|
|
||||||
|
# Frame meta explained: https://curl.se/libcurl/c/curl_ws_meta.html
|
||||||
|
frame = self._ws_recv_p_frame[0]
|
||||||
|
return ffi.buffer(self._ws_recv_buffer)[: self._ws_recv_n_recv[0]], frame
|
||||||
|
|
||||||
|
def ws_send(self, payload: bytes, flags: CurlWsFlag = CurlWsFlag.BINARY) -> int:
|
||||||
|
"""Send data to a websocket connection.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
payload: content to send.
|
||||||
|
flags: websocket flag to set for the frame, default: binary.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
0 if no error.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
CurlError: if failed.
|
||||||
|
"""
|
||||||
|
if self._curl is None:
|
||||||
|
raise CurlError("Cannot send websocket data on closed handle.")
|
||||||
|
|
||||||
|
buffer = ffi.from_buffer(payload)
|
||||||
|
ret = lib.curl_ws_send(
|
||||||
|
self._curl, buffer, len(payload), self._ws_send_n_sent, 0, flags
|
||||||
|
)
|
||||||
|
self._check_error(ret, "WS_SEND")
|
||||||
|
return self._ws_send_n_sent[0]
|
||||||
|
|
||||||
|
def ws_close(self, code: int = 1000, message: bytes = b"") -> int:
|
||||||
|
"""Close a websocket connection. Shorthand for :meth:`ws_send`
|
||||||
|
with close code and message. Note that to completely close the connection,
|
||||||
|
you must close the curl handle after this call with :meth:`close`.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
code: close code.
|
||||||
|
message: close message.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
0 if no error.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
CurlError: if failed.
|
||||||
|
"""
|
||||||
|
payload = struct.pack("!H", code) + message
|
||||||
|
return self.ws_send(payload, flags=CurlWsFlag.CLOSE)
|
||||||
|
|
||||||
|
|
||||||
|
class CurlMime:
|
||||||
|
"""Wrapper for the ``curl_mime_`` API."""
|
||||||
|
|
||||||
|
def __init__(self, curl: Optional[Curl] = None):
|
||||||
|
"""
|
||||||
|
Args:
|
||||||
|
curl: Curl instance to use.
|
||||||
|
"""
|
||||||
|
self._curl = curl if curl else Curl()
|
||||||
|
self._form = lib.curl_mime_init(self._curl._curl)
|
||||||
|
|
||||||
|
def addpart(
|
||||||
|
self,
|
||||||
|
name: str,
|
||||||
|
*,
|
||||||
|
content_type: Optional[str] = None,
|
||||||
|
filename: Optional[str] = None,
|
||||||
|
local_path: Optional[Union[str, bytes, Path]] = None,
|
||||||
|
data: Optional[bytes] = None,
|
||||||
|
) -> None:
|
||||||
|
"""Add a mime part for a mutlipart html form.
|
||||||
|
|
||||||
|
Note: You can only use either local_path or data, not both.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name: name of the field.
|
||||||
|
content_type: content_type for the field. for example: ``image/png``.
|
||||||
|
filename: filename for the server.
|
||||||
|
local_path: file to upload on local disk.
|
||||||
|
data: file content to upload.
|
||||||
|
"""
|
||||||
|
part = lib.curl_mime_addpart(self._form)
|
||||||
|
|
||||||
|
ret = lib.curl_mime_name(part, name.encode())
|
||||||
|
if ret != 0:
|
||||||
|
raise CurlError("Add field failed.")
|
||||||
|
|
||||||
|
# mime type
|
||||||
|
if content_type is not None:
|
||||||
|
ret = lib.curl_mime_type(part, content_type.encode())
|
||||||
|
if ret != 0:
|
||||||
|
raise CurlError("Add field failed.")
|
||||||
|
|
||||||
|
# remote file name
|
||||||
|
if filename is not None:
|
||||||
|
ret = lib.curl_mime_filename(part, filename.encode())
|
||||||
|
if ret != 0:
|
||||||
|
raise CurlError("Add field failed.")
|
||||||
|
|
||||||
|
if local_path and data:
|
||||||
|
raise CurlError("Can not use local_path and data at the same time.")
|
||||||
|
|
||||||
|
# this is a filename
|
||||||
|
if local_path is not None:
|
||||||
|
if isinstance(local_path, Path):
|
||||||
|
local_path_str = str(local_path)
|
||||||
|
elif isinstance(local_path, bytes):
|
||||||
|
local_path_str = local_path.decode()
|
||||||
|
else:
|
||||||
|
local_path_str = local_path
|
||||||
|
|
||||||
|
if not Path(local_path_str).exists():
|
||||||
|
raise FileNotFoundError(f"File not found at {local_path_str}")
|
||||||
|
ret = lib.curl_mime_filedata(part, local_path_str.encode())
|
||||||
|
if ret != 0:
|
||||||
|
raise CurlError("Add field failed.")
|
||||||
|
|
||||||
|
if data is not None:
|
||||||
|
if not isinstance(data, bytes):
|
||||||
|
data = str(data).encode()
|
||||||
|
ret = lib.curl_mime_data(part, data, len(data))
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_list(cls, files: list[dict]):
|
||||||
|
"""Create a multipart instance from a list of dict, for keys, see ``addpart``"""
|
||||||
|
form = cls()
|
||||||
|
for file in files:
|
||||||
|
form.addpart(**file)
|
||||||
|
return form
|
||||||
|
|
||||||
|
def attach(self, curl: Optional[Curl] = None) -> None:
|
||||||
|
"""Attach the mime instance to a curl instance."""
|
||||||
|
c = curl if curl else self._curl
|
||||||
|
c.setopt(CurlOpt.MIMEPOST, self._form)
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
"""Close the mime instance and underlying files. This method must be called
|
||||||
|
after ``perform`` or ``request``."""
|
||||||
|
lib.curl_mime_free(self._form)
|
||||||
|
self._form = ffi.NULL
|
||||||
|
|
||||||
|
def __del__(self) -> None:
|
||||||
|
self.close()
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
# Marker file for PEP 561.
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue