F7cloud Talk Recording: install-скрипт, vendor (Firefox ESR, GeckoDriver), systemd, конфиг-шаблон
This commit is contained in:
commit
18d01581be
85
README.md
Normal file
85
README.md
Normal file
|
|
@ -0,0 +1,85 @@
|
||||||
|
# F7cloud Talk Recording — сборка для развёртывания
|
||||||
|
|
||||||
|
В репозитории собраны **все компоненты для работы сервиса, кроме Python**. Firefox ESR и GeckoDriver скопированы с машины сборки в `vendor/` и при развёртывании на другом сервере просто копируются из репо в `/opt/firefox-esr` и `/usr/local/bin/geckodriver`. Python, xvfb и ffmpeg на целевой машине ставятся через apt в install.
|
||||||
|
|
||||||
|
## Структура
|
||||||
|
|
||||||
|
```
|
||||||
|
f7-recording/
|
||||||
|
├── README.md
|
||||||
|
├── install # скрипт установки (запуск: sudo ./install)
|
||||||
|
├── scripts/
|
||||||
|
│ └── download-vendor.sh # скачать Firefox ESR и GeckoDriver в vendor/ (обновление репо)
|
||||||
|
├── vendor/ # Firefox ESR и GeckoDriver (скопированы с машины сборки)
|
||||||
|
│ ├── README.md
|
||||||
|
│ ├── firefox-esr/ # каталог Firefox ESR — при деплое копируется в /opt/firefox-esr
|
||||||
|
│ └── geckodriver/geckodriver # бинарь GeckoDriver — при деплое копируется в /usr/local/bin
|
||||||
|
├── systemd/
|
||||||
|
│ └── f7cloud-talk-recording.service
|
||||||
|
├── etc/
|
||||||
|
│ └── f7cloud-talk-recording/
|
||||||
|
│ └── server.conf.template
|
||||||
|
└── opt/
|
||||||
|
├── f7cloud-talk-recording-src/ # исходники пакета (editable install)
|
||||||
|
└── f7cloud-talk-recording/
|
||||||
|
├── requirements.txt
|
||||||
|
└── venv/ # на цели venv создаётся заново
|
||||||
|
```
|
||||||
|
|
||||||
|
## Развёртывание одной командой
|
||||||
|
|
||||||
|
На целевой машине (Debian/Ubuntu) скопируйте эту папку и выполните:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo ./install
|
||||||
|
```
|
||||||
|
|
||||||
|
Скрипт установит через apt только Python 3.12, xvfb и ffmpeg; Firefox ESR и GeckoDriver скопирует из `vendor/` в `/opt/firefox-esr` и `/usr/local/bin`; создаст пользователя и каталоги, разложит файлы, соберёт venv и включит systemd-сервис. Конфиг создаётся из шаблона; если не заданы переменные окружения (см. ниже), в конфиг попадут плейсхолдеры — их нужно заменить вручную в `/etc/f7cloud-talk-recording/server.conf` и затем запустить сервис.
|
||||||
|
|
||||||
|
### Секреты и адреса (HPB и Nextcloud)
|
||||||
|
|
||||||
|
Задайте переменные окружения **до** запуска `install`, чтобы конфиг заполнился автоматически:
|
||||||
|
|
||||||
|
| Переменная | Описание |
|
||||||
|
|------------|----------|
|
||||||
|
| `F7CLOUD_NEXTCLOUD_URL` | URL сервера Nextcloud (например `https://forbion.f7cloud.ru`) |
|
||||||
|
| `F7CLOUD_SECRET` | Общий секрет (backend + nextcloud) |
|
||||||
|
| `F7CLOUD_TALK_URL` | URL signaling (HPB), например `https://hpb-prod.f7cloud.ru/standalone-signaling` |
|
||||||
|
| `F7CLOUD_TALK_INTERNALSECRET` | internalsecret для доступа к signaling-серверу |
|
||||||
|
|
||||||
|
Пример:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export F7CLOUD_NEXTCLOUD_URL="https://forbion.f7cloud.ru"
|
||||||
|
export F7CLOUD_SECRET="ваш_секрет_hex"
|
||||||
|
export F7CLOUD_TALK_URL="https://hpb-prod.f7cloud.ru/standalone-signaling"
|
||||||
|
export F7CLOUD_TALK_INTERNALSECRET="ваш_internalsecret_hex"
|
||||||
|
sudo -E ./install
|
||||||
|
```
|
||||||
|
|
||||||
|
Если переменные не заданы, после деплоя отредактируйте `/etc/f7cloud-talk-recording/server.conf` (замените строки `F7CLOUD_*` на нужные значения) и выполните:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
systemctl start f7cloud-talk-recording.service
|
||||||
|
```
|
||||||
|
|
||||||
|
## Что делает install
|
||||||
|
|
||||||
|
1. Ставит через apt только: **Python 3.12**, python3.12-venv, xvfb, ffmpeg (остальное — из репо).
|
||||||
|
2. Копирует **Firefox ESR** и **GeckoDriver** из `vendor/` в `/opt/firefox-esr` и `/usr/local/bin` (в репо они уже есть, скопированы с машины сборки).
|
||||||
|
3. Создаёт пользователя и группу `f7cloud-talk-recording`, каталоги `/var/lib/f7cloud-talk-recording` и `/var/lib/f7cloud-recordings`.
|
||||||
|
4. Копирует systemd unit в `/etc/systemd/system/`.
|
||||||
|
5. Создаёт конфиг из `server.conf.template` в `/etc/f7cloud-talk-recording/server.conf`.
|
||||||
|
6. Копирует исходники в `/opt/f7cloud-talk-recording-src/`, создаёт venv в `/opt/f7cloud-talk-recording/venv` и ставит зависимости.
|
||||||
|
7. Включает сервис; при заданных секретах — сразу запускает его.
|
||||||
|
|
||||||
|
Firefox ESR и GeckoDriver уже включены в репо (скопированы с этой машины в `vendor/`). При клонировании репо на другой сервер и запуске install они копируются на место без доступа в интернет. Обновить или заново положить их в репо — см. `vendor/README.md`.
|
||||||
|
|
||||||
|
### Ручное развёртывание (без install)
|
||||||
|
|
||||||
|
Если нужно развернуть вручную: установите Python 3.12, xvfb, ffmpeg; установите Firefox ESR и GeckoDriver из `vendor/` или скачайте (см. `vendor/README.md`); создайте пользователя и каталоги (как в install); скопируйте `systemd/`, `etc/`, `opt/` в целевые пути; создайте venv; заполните конфиг из шаблона; выполните `systemctl daemon-reload`, `systemctl enable f7cloud-talk-recording.service`, `systemctl start f7cloud-talk-recording.service`.
|
||||||
|
|
||||||
|
## Проверка
|
||||||
|
|
||||||
|
- Логи: `journalctl -u f7cloud-talk-recording.service -f`
|
||||||
|
- Конфиг: `/etc/f7cloud-talk-recording/server.conf` (пути браузера, ffmpeg, каталог записей при необходимости поправьте).
|
||||||
50
etc/f7cloud-talk-recording/server.conf.template
Normal file
50
etc/f7cloud-talk-recording/server.conf.template
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
# Шаблон конфига. При развёртывании подставьте свои значения
|
||||||
|
# (через переменные окружения F7CLOUD_* или вручную после копирования).
|
||||||
|
# Секция [nextcloud] — бэкенд приложения (имя менять не нужно).
|
||||||
|
|
||||||
|
[logs]
|
||||||
|
level = 20
|
||||||
|
|
||||||
|
[https]
|
||||||
|
listen = 127.0.0.1:8000
|
||||||
|
|
||||||
|
|
||||||
|
[app]
|
||||||
|
trustedproxies = 127.0.0.1
|
||||||
|
|
||||||
|
[backend]
|
||||||
|
allowall = false
|
||||||
|
backends = nextcloud
|
||||||
|
skipverify = false
|
||||||
|
maxmessagesize = 10240
|
||||||
|
videowidth = 1920
|
||||||
|
videoheight = 1080
|
||||||
|
directory = /var/lib/f7cloud-recordings
|
||||||
|
secret = F7CLOUD_SECRET
|
||||||
|
|
||||||
|
[nextcloud]
|
||||||
|
url = F7CLOUD_NEXTCLOUD_URL
|
||||||
|
secret = F7CLOUD_SECRET
|
||||||
|
|
||||||
|
[signaling]
|
||||||
|
signalings = talk
|
||||||
|
|
||||||
|
[talk]
|
||||||
|
# URL signaling-сервера (HPB)
|
||||||
|
url = F7CLOUD_TALK_URL
|
||||||
|
internalsecret = F7CLOUD_TALK_INTERNALSECRET
|
||||||
|
|
||||||
|
[ffmpeg]
|
||||||
|
common = ffmpeg -loglevel level+warning -n
|
||||||
|
outputaudio = -c:a libopus -b:a 128k
|
||||||
|
outputvideo = -c:v libvpx -deadline:v realtime -crf 10 -b:v 2M -threads 4
|
||||||
|
extensionaudio = .ogg
|
||||||
|
extensionvideo = .webm
|
||||||
|
|
||||||
|
[recording]
|
||||||
|
browser = firefox
|
||||||
|
browserPath = /usr/local/bin/firefox-esr
|
||||||
|
driverPath = /usr/local/bin/geckodriver
|
||||||
|
|
||||||
|
[stats]
|
||||||
|
allowed_ips = 127.0.0.1
|
||||||
117
install
Executable file
117
install
Executable file
|
|
@ -0,0 +1,117 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# Развёртывание F7cloud Talk Recording на целевой машине (Debian/Ubuntu).
|
||||||
|
# Запуск: sudo ./install
|
||||||
|
# Секреты и адреса задайте через переменные окружения перед запуском:
|
||||||
|
# F7CLOUD_NEXTCLOUD_URL — URL сервера Nextcloud (например https://forbion.f7cloud.ru)
|
||||||
|
# F7CLOUD_SECRET — общий секрет (backend + nextcloud)
|
||||||
|
# F7CLOUD_TALK_URL — URL signaling (HPB), например https://hpb-prod.f7cloud.ru/standalone-signaling
|
||||||
|
# F7CLOUD_TALK_INTERNALSECRET — internalsecret для доступа к signaling
|
||||||
|
# Пример: export F7CLOUD_NEXTCLOUD_URL=... F7CLOUD_SECRET=... F7CLOUD_TALK_URL=... F7CLOUD_TALK_INTERNALSECRET=... ; sudo -E ./install
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
if [ "$(id -u)" -ne 0 ]; then
|
||||||
|
echo "Запустите скрипт с правами root: sudo $0"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
REPO_ROOT="$(cd "$(dirname "$0")" && pwd)"
|
||||||
|
|
||||||
|
echo "=== 1. Зависимости (только Python 3.12, xvfb, ffmpeg — остальное в репо) ==="
|
||||||
|
apt-get update -qq
|
||||||
|
apt-get install -y python3.12 python3.12-venv xvfb ffmpeg
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "=== 2. Firefox ESR и GeckoDriver (копирование из репо) ==="
|
||||||
|
if [ ! -x "$REPO_ROOT/vendor/firefox-esr/firefox" ]; then
|
||||||
|
echo "Ошибка: в репо не найден vendor/firefox-esr/firefox. Положите сюда установленный Firefox ESR (скопируйте с машины сборки из /opt/firefox-esr)." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ ! -x "$REPO_ROOT/vendor/geckodriver/geckodriver" ]; then
|
||||||
|
echo "Ошибка: в репо не найден vendor/geckodriver/geckodriver. Положите сюда бинарь geckodriver (скопируйте с машины сборки из /usr/local/bin/geckodriver)." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
rm -rf /opt/firefox-esr
|
||||||
|
cp -r "$REPO_ROOT/vendor/firefox-esr" /opt/
|
||||||
|
ln -sf /opt/firefox-esr/firefox /usr/local/bin/firefox-esr
|
||||||
|
echo "Firefox ESR скопирован из vendor/ в /opt/firefox-esr."
|
||||||
|
|
||||||
|
cp "$REPO_ROOT/vendor/geckodriver/geckodriver" /usr/local/bin/geckodriver
|
||||||
|
chmod +x /usr/local/bin/geckodriver
|
||||||
|
echo "GeckoDriver скопирован из vendor/ в /usr/local/bin/geckodriver."
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "=== 3. Пользователь и каталоги ==="
|
||||||
|
if ! getent group f7cloud-talk-recording >/dev/null 2>&1; then
|
||||||
|
groupadd --system -g 989 f7cloud-talk-recording
|
||||||
|
fi
|
||||||
|
if ! id f7cloud-talk-recording >/dev/null 2>&1; then
|
||||||
|
useradd --system -u 999 -g f7cloud-talk-recording -d /var/lib/f7cloud-talk-recording -s /usr/sbin/nologin f7cloud-talk-recording
|
||||||
|
fi
|
||||||
|
mkdir -p /var/lib/f7cloud-talk-recording /var/lib/f7cloud-recordings
|
||||||
|
chown -R f7cloud-talk-recording:f7cloud-talk-recording /var/lib/f7cloud-talk-recording /var/lib/f7cloud-recordings
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "=== 4. Копирование systemd unit ==="
|
||||||
|
cp "$REPO_ROOT/systemd/f7cloud-talk-recording.service" /etc/systemd/system/
|
||||||
|
chmod 644 /etc/systemd/system/f7cloud-talk-recording.service
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "=== 5. Конфиг приложения ==="
|
||||||
|
mkdir -p /etc/f7cloud-talk-recording
|
||||||
|
TEMPLATE="$REPO_ROOT/etc/f7cloud-talk-recording/server.conf.template"
|
||||||
|
if [ -f "$TEMPLATE" ]; then
|
||||||
|
if [ -n "$F7CLOUD_NEXTCLOUD_URL" ] && [ -n "$F7CLOUD_SECRET" ] && [ -n "$F7CLOUD_TALK_URL" ] && [ -n "$F7CLOUD_TALK_INTERNALSECRET" ]; then
|
||||||
|
sed -e "s|F7CLOUD_NEXTCLOUD_URL|$F7CLOUD_NEXTCLOUD_URL|g" \
|
||||||
|
-e "s|F7CLOUD_SECRET|$F7CLOUD_SECRET|g" \
|
||||||
|
-e "s|F7CLOUD_TALK_URL|$F7CLOUD_TALK_URL|g" \
|
||||||
|
-e "s|F7CLOUD_TALK_INTERNALSECRET|$F7CLOUD_TALK_INTERNALSECRET|g" \
|
||||||
|
"$TEMPLATE" > /etc/f7cloud-talk-recording/server.conf
|
||||||
|
echo "Конфиг создан из шаблона (значения из переменных окружения)."
|
||||||
|
else
|
||||||
|
cp "$TEMPLATE" /etc/f7cloud-talk-recording/server.conf
|
||||||
|
echo "Конфиг скопирован как шаблон. Заполните вручную секреты и URL в /etc/f7cloud-talk-recording/server.conf"
|
||||||
|
echo " (F7CLOUD_NEXTCLOUD_URL, F7CLOUD_SECRET, F7CLOUD_TALK_URL, F7CLOUD_TALK_INTERNALSECRET)"
|
||||||
|
fi
|
||||||
|
chown root:root /etc/f7cloud-talk-recording/server.conf
|
||||||
|
chmod 640 /etc/f7cloud-talk-recording/server.conf
|
||||||
|
else
|
||||||
|
echo "Не найден шаблон $TEMPLATE" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "=== 6. Исходники и venv в /opt ==="
|
||||||
|
mkdir -p /opt/f7cloud-talk-recording
|
||||||
|
if [ -d "$REPO_ROOT/opt/f7cloud-talk-recording-src" ]; then
|
||||||
|
cp -r "$REPO_ROOT/opt/f7cloud-talk-recording-src" /opt/
|
||||||
|
else
|
||||||
|
echo "Не найдена папка opt/f7cloud-talk-recording-src" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ -f "$REPO_ROOT/opt/f7cloud-talk-recording/requirements.txt" ]; then
|
||||||
|
cp "$REPO_ROOT/opt/f7cloud-talk-recording/requirements.txt" /opt/f7cloud-talk-recording/
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Создание виртуального окружения..."
|
||||||
|
/usr/bin/python3.12 -m venv /opt/f7cloud-talk-recording/venv
|
||||||
|
/opt/f7cloud-talk-recording/venv/bin/pip install -q -r /opt/f7cloud-talk-recording/requirements.txt
|
||||||
|
/opt/f7cloud-talk-recording/venv/bin/pip install -q -e /opt/f7cloud-talk-recording-src
|
||||||
|
|
||||||
|
chown -R f7cloud-talk-recording:f7cloud-talk-recording /opt/f7cloud-talk-recording /opt/f7cloud-talk-recording-src
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "=== 7. Systemd ==="
|
||||||
|
systemctl daemon-reload
|
||||||
|
systemctl enable f7cloud-talk-recording.service
|
||||||
|
|
||||||
|
if [ -n "$F7CLOUD_NEXTCLOUD_URL" ] && [ -n "$F7CLOUD_SECRET" ] && [ -n "$F7CLOUD_TALK_URL" ] && [ -n "$F7CLOUD_TALK_INTERNALSECRET" ]; then
|
||||||
|
systemctl start f7cloud-talk-recording.service
|
||||||
|
echo "Сервис f7cloud-talk-recording запущен."
|
||||||
|
else
|
||||||
|
echo "После заполнения секретов в /etc/f7cloud-talk-recording/server.conf выполните:"
|
||||||
|
echo " systemctl start f7cloud-talk-recording.service"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "Готово. Логи: journalctl -u f7cloud-talk-recording.service -f"
|
||||||
1
opt/f7cloud-talk-recording-src
Submodule
1
opt/f7cloud-talk-recording-src
Submodule
|
|
@ -0,0 +1 @@
|
||||||
|
Subproject commit e9d533c4855135c9ab3e0eb5c0a2351f564f5c97
|
||||||
31
opt/f7cloud-talk-recording/requirements.txt
Normal file
31
opt/f7cloud-talk-recording/requirements.txt
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
attrs==25.4.0
|
||||||
|
blinker==1.9.0
|
||||||
|
certifi==2025.11.12
|
||||||
|
charset-normalizer==3.4.4
|
||||||
|
click==8.3.1
|
||||||
|
Flask==3.1.2
|
||||||
|
h11==0.16.0
|
||||||
|
idna==3.11
|
||||||
|
itsdangerous==2.2.0
|
||||||
|
Jinja2==3.1.6
|
||||||
|
MarkupSafe==3.0.3
|
||||||
|
# nextcloud-talk-recording ставится локально: pip install -e ./opt/nextcloud-talk-recording-src
|
||||||
|
outcome==1.3.0.post0
|
||||||
|
prometheus_client==0.23.1
|
||||||
|
psutil==7.1.3
|
||||||
|
pulsectl==24.12.0
|
||||||
|
PySocks==1.7.1
|
||||||
|
PyVirtualDisplay==3.0
|
||||||
|
requests==2.32.5
|
||||||
|
requests-toolbelt==1.0.0
|
||||||
|
selenium==4.39.0
|
||||||
|
sniffio==1.3.1
|
||||||
|
sortedcontainers==2.4.0
|
||||||
|
trio==0.32.0
|
||||||
|
trio-websocket==0.12.2
|
||||||
|
typing_extensions==4.15.0
|
||||||
|
urllib3==2.6.2
|
||||||
|
websocket-client==1.9.0
|
||||||
|
Werkzeug==3.1.4
|
||||||
|
wheel==0.45.1
|
||||||
|
wsproto==1.3.2
|
||||||
247
opt/f7cloud-talk-recording/venv/bin/Activate.ps1
Normal file
247
opt/f7cloud-talk-recording/venv/bin/Activate.ps1
Normal file
|
|
@ -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"
|
||||||
70
opt/f7cloud-talk-recording/venv/bin/activate
Normal file
70
opt/f7cloud-talk-recording/venv/bin/activate
Normal file
|
|
@ -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 /opt/nextcloud-talk-recording/venv)
|
||||||
|
else
|
||||||
|
# use the path as-is
|
||||||
|
export VIRTUAL_ENV=/opt/nextcloud-talk-recording/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
|
||||||
27
opt/f7cloud-talk-recording/venv/bin/activate.csh
Normal file
27
opt/f7cloud-talk-recording/venv/bin/activate.csh
Normal file
|
|
@ -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 /opt/nextcloud-talk-recording/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
|
||||||
69
opt/f7cloud-talk-recording/venv/bin/activate.fish
Normal file
69
opt/f7cloud-talk-recording/venv/bin/activate.fish
Normal file
|
|
@ -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 /opt/nextcloud-talk-recording/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
|
||||||
7
opt/f7cloud-talk-recording/venv/bin/flask
Executable file
7
opt/f7cloud-talk-recording/venv/bin/flask
Executable file
|
|
@ -0,0 +1,7 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/venv/bin/python3
|
||||||
|
import sys
|
||||||
|
from flask.cli import main
|
||||||
|
if __name__ == '__main__':
|
||||||
|
if sys.argv[0].endswith('.exe'):
|
||||||
|
sys.argv[0] = sys.argv[0][:-4]
|
||||||
|
sys.exit(main())
|
||||||
7
opt/f7cloud-talk-recording/venv/bin/nextcloud-talk-recording
Executable file
7
opt/f7cloud-talk-recording/venv/bin/nextcloud-talk-recording
Executable file
|
|
@ -0,0 +1,7 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/venv/bin/python3
|
||||||
|
import sys
|
||||||
|
from nextcloud.talk.recording.__main__ import main
|
||||||
|
if __name__ == '__main__':
|
||||||
|
if sys.argv[0].endswith('.exe'):
|
||||||
|
sys.argv[0] = sys.argv[0][:-4]
|
||||||
|
sys.exit(main())
|
||||||
7
opt/f7cloud-talk-recording/venv/bin/nextcloud-talk-recording-benchmark
Executable file
7
opt/f7cloud-talk-recording/venv/bin/nextcloud-talk-recording-benchmark
Executable file
|
|
@ -0,0 +1,7 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/venv/bin/python3
|
||||||
|
import sys
|
||||||
|
from nextcloud.talk.recording.Benchmark import main
|
||||||
|
if __name__ == '__main__':
|
||||||
|
if sys.argv[0].endswith('.exe'):
|
||||||
|
sys.argv[0] = sys.argv[0][:-4]
|
||||||
|
sys.exit(main())
|
||||||
7
opt/f7cloud-talk-recording/venv/bin/normalizer
Executable file
7
opt/f7cloud-talk-recording/venv/bin/normalizer
Executable file
|
|
@ -0,0 +1,7 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/venv/bin/python3
|
||||||
|
import sys
|
||||||
|
from charset_normalizer.cli import cli_detect
|
||||||
|
if __name__ == '__main__':
|
||||||
|
if sys.argv[0].endswith('.exe'):
|
||||||
|
sys.argv[0] = sys.argv[0][:-4]
|
||||||
|
sys.exit(cli_detect())
|
||||||
8
opt/f7cloud-talk-recording/venv/bin/pip
Executable file
8
opt/f7cloud-talk-recording/venv/bin/pip
Executable file
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/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())
|
||||||
8
opt/f7cloud-talk-recording/venv/bin/pip3
Executable file
8
opt/f7cloud-talk-recording/venv/bin/pip3
Executable file
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/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())
|
||||||
8
opt/f7cloud-talk-recording/venv/bin/pip3.12
Executable file
8
opt/f7cloud-talk-recording/venv/bin/pip3.12
Executable file
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/venv/bin/python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from pip._internal.cli.main import main
|
||||||
|
if __name__ == '__main__':
|
||||||
|
sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
|
||||||
|
sys.exit(main())
|
||||||
1
opt/f7cloud-talk-recording/venv/bin/python
Symbolic link
1
opt/f7cloud-talk-recording/venv/bin/python
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
python3
|
||||||
1
opt/f7cloud-talk-recording/venv/bin/python3
Symbolic link
1
opt/f7cloud-talk-recording/venv/bin/python3
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
/usr/bin/python3
|
||||||
1
opt/f7cloud-talk-recording/venv/bin/python3.12
Symbolic link
1
opt/f7cloud-talk-recording/venv/bin/python3.12
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
python3
|
||||||
8
opt/f7cloud-talk-recording/venv/bin/wheel
Executable file
8
opt/f7cloud-talk-recording/venv/bin/wheel
Executable file
|
|
@ -0,0 +1,8 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/venv/bin/python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from wheel.cli import main
|
||||||
|
if __name__ == '__main__':
|
||||||
|
sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
|
||||||
|
sys.exit(main())
|
||||||
7
opt/f7cloud-talk-recording/venv/bin/wsdump
Executable file
7
opt/f7cloud-talk-recording/venv/bin/wsdump
Executable file
|
|
@ -0,0 +1,7 @@
|
||||||
|
#!/opt/nextcloud-talk-recording/venv/bin/python3
|
||||||
|
import sys
|
||||||
|
from websocket._wsdump import main
|
||||||
|
if __name__ == '__main__':
|
||||||
|
if sys.argv[0].endswith('.exe'):
|
||||||
|
sys.argv[0] = sys.argv[0][:-4]
|
||||||
|
sys.exit(main())
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
Copyright 2006 Dan-Haim. All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification,
|
||||||
|
are permitted provided that the following conditions are met:
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation
|
||||||
|
and/or other materials provided with the distribution.
|
||||||
|
3. Neither the name of Dan Haim nor the names of his contributors may be used
|
||||||
|
to endorse or promote products derived from this software without specific
|
||||||
|
prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY DAN HAIM "AS IS" AND ANY EXPRESS OR IMPLIED
|
||||||
|
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
|
||||||
|
EVENT SHALL DAN HAIM OR HIS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||||
|
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA
|
||||||
|
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||||
|
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||||
|
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMANGE.
|
||||||
|
|
@ -0,0 +1,321 @@
|
||||||
|
Metadata-Version: 2.1
|
||||||
|
Name: PySocks
|
||||||
|
Version: 1.7.1
|
||||||
|
Summary: A Python SOCKS client module. See https://github.com/Anorov/PySocks for more information.
|
||||||
|
Home-page: https://github.com/Anorov/PySocks
|
||||||
|
Author: Anorov
|
||||||
|
Author-email: anorov.vorona@gmail.com
|
||||||
|
License: BSD
|
||||||
|
Keywords: socks,proxy
|
||||||
|
Platform: UNKNOWN
|
||||||
|
Classifier: Programming Language :: Python :: 2
|
||||||
|
Classifier: Programming Language :: Python :: 2.7
|
||||||
|
Classifier: Programming Language :: Python :: 3
|
||||||
|
Classifier: Programming Language :: Python :: 3.4
|
||||||
|
Classifier: Programming Language :: Python :: 3.5
|
||||||
|
Classifier: Programming Language :: Python :: 3.6
|
||||||
|
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
|
||||||
|
Description-Content-Type: text/markdown
|
||||||
|
|
||||||
|
PySocks
|
||||||
|
=======
|
||||||
|
|
||||||
|
PySocks lets you send traffic through SOCKS and HTTP proxy servers. It is a modern fork of [SocksiPy](http://socksipy.sourceforge.net/) with bug fixes and extra features.
|
||||||
|
|
||||||
|
Acts as a drop-in replacement to the socket module. Seamlessly configure SOCKS proxies for any socket object by calling `socket_object.set_proxy()`.
|
||||||
|
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Features
|
||||||
|
========
|
||||||
|
|
||||||
|
* SOCKS proxy client for Python 2.7 and 3.4+
|
||||||
|
* TCP supported
|
||||||
|
* UDP mostly supported (issues may occur in some edge cases)
|
||||||
|
* HTTP proxy client included but not supported or recommended (you should use urllib2's or requests' own HTTP proxy interface)
|
||||||
|
* urllib2 handler included. `pip install` / `setup.py install` will automatically install the `sockshandler` module.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
pip install PySocks
|
||||||
|
|
||||||
|
Or download the tarball / `git clone` and...
|
||||||
|
|
||||||
|
python setup.py install
|
||||||
|
|
||||||
|
These will install both the `socks` and `sockshandler` modules.
|
||||||
|
|
||||||
|
Alternatively, include just `socks.py` in your project.
|
||||||
|
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
*Warning:* PySocks/SocksiPy only supports HTTP proxies that use CONNECT tunneling. Certain HTTP proxies may not work with this library. If you wish to use HTTP (not SOCKS) proxies, it is recommended that you rely on your HTTP client's native proxy support (`proxies` dict for `requests`, or `urllib2.ProxyHandler` for `urllib2`) instead.
|
||||||
|
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
Usage
|
||||||
|
=====
|
||||||
|
|
||||||
|
## socks.socksocket ##
|
||||||
|
|
||||||
|
import socks
|
||||||
|
|
||||||
|
s = socks.socksocket() # Same API as socket.socket in the standard lib
|
||||||
|
|
||||||
|
s.set_proxy(socks.SOCKS5, "localhost") # SOCKS4 and SOCKS5 use port 1080 by default
|
||||||
|
# Or
|
||||||
|
s.set_proxy(socks.SOCKS4, "localhost", 4444)
|
||||||
|
# Or
|
||||||
|
s.set_proxy(socks.HTTP, "5.5.5.5", 8888)
|
||||||
|
|
||||||
|
# Can be treated identical to a regular socket object
|
||||||
|
s.connect(("www.somesite.com", 80))
|
||||||
|
s.sendall("GET / HTTP/1.1 ...")
|
||||||
|
print s.recv(4096)
|
||||||
|
|
||||||
|
## Monkeypatching ##
|
||||||
|
|
||||||
|
To monkeypatch the entire standard library with a single default proxy:
|
||||||
|
|
||||||
|
import urllib2
|
||||||
|
import socket
|
||||||
|
import socks
|
||||||
|
|
||||||
|
socks.set_default_proxy(socks.SOCKS5, "localhost")
|
||||||
|
socket.socket = socks.socksocket
|
||||||
|
|
||||||
|
urllib2.urlopen("http://www.somesite.com/") # All requests will pass through the SOCKS proxy
|
||||||
|
|
||||||
|
Note that monkeypatching may not work for all standard modules or for all third party modules, and generally isn't recommended. Monkeypatching is usually an anti-pattern in Python.
|
||||||
|
|
||||||
|
## urllib2 Handler ##
|
||||||
|
|
||||||
|
Example use case with the `sockshandler` urllib2 handler. Note that you must import both `socks` and `sockshandler`, as the handler is its own module separate from PySocks. The module is included in the PyPI package.
|
||||||
|
|
||||||
|
import urllib2
|
||||||
|
import socks
|
||||||
|
from sockshandler import SocksiPyHandler
|
||||||
|
|
||||||
|
opener = urllib2.build_opener(SocksiPyHandler(socks.SOCKS5, "127.0.0.1", 9050))
|
||||||
|
print opener.open("http://www.somesite.com/") # All requests made by the opener will pass through the SOCKS proxy
|
||||||
|
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
Original SocksiPy README attached below, amended to reflect API changes.
|
||||||
|
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
SocksiPy
|
||||||
|
|
||||||
|
A Python SOCKS module.
|
||||||
|
|
||||||
|
(C) 2006 Dan-Haim. All rights reserved.
|
||||||
|
|
||||||
|
See LICENSE file for details.
|
||||||
|
|
||||||
|
|
||||||
|
*WHAT IS A SOCKS PROXY?*
|
||||||
|
|
||||||
|
A SOCKS proxy is a proxy server at the TCP level. In other words, it acts as
|
||||||
|
a tunnel, relaying all traffic going through it without modifying it.
|
||||||
|
SOCKS proxies can be used to relay traffic using any network protocol that
|
||||||
|
uses TCP.
|
||||||
|
|
||||||
|
*WHAT IS SOCKSIPY?*
|
||||||
|
|
||||||
|
This Python module allows you to create TCP connections through a SOCKS
|
||||||
|
proxy without any special effort.
|
||||||
|
It also supports relaying UDP packets with a SOCKS5 proxy.
|
||||||
|
|
||||||
|
*PROXY COMPATIBILITY*
|
||||||
|
|
||||||
|
SocksiPy is compatible with three different types of proxies:
|
||||||
|
|
||||||
|
1. SOCKS Version 4 (SOCKS4), including the SOCKS4a extension.
|
||||||
|
2. SOCKS Version 5 (SOCKS5).
|
||||||
|
3. HTTP Proxies which support tunneling using the CONNECT method.
|
||||||
|
|
||||||
|
*SYSTEM REQUIREMENTS*
|
||||||
|
|
||||||
|
Being written in Python, SocksiPy can run on any platform that has a Python
|
||||||
|
interpreter and TCP/IP support.
|
||||||
|
This module has been tested with Python 2.3 and should work with greater versions
|
||||||
|
just as well.
|
||||||
|
|
||||||
|
|
||||||
|
INSTALLATION
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Simply copy the file "socks.py" to your Python's `lib/site-packages` directory,
|
||||||
|
and you're ready to go. [Editor's note: it is better to use `python setup.py install` for PySocks]
|
||||||
|
|
||||||
|
|
||||||
|
USAGE
|
||||||
|
------
|
||||||
|
|
||||||
|
First load the socks module with the command:
|
||||||
|
|
||||||
|
>>> import socks
|
||||||
|
>>>
|
||||||
|
|
||||||
|
The socks module provides a class called `socksocket`, which is the base to all of the module's functionality.
|
||||||
|
|
||||||
|
The `socksocket` object has the same initialization parameters as the normal socket
|
||||||
|
object to ensure maximal compatibility, however it should be noted that `socksocket` will only function with family being `AF_INET` and
|
||||||
|
type being either `SOCK_STREAM` or `SOCK_DGRAM`.
|
||||||
|
Generally, it is best to initialize the `socksocket` object with no parameters
|
||||||
|
|
||||||
|
>>> s = socks.socksocket()
|
||||||
|
>>>
|
||||||
|
|
||||||
|
The `socksocket` object has an interface which is very similiar to socket's (in fact
|
||||||
|
the `socksocket` class is derived from socket) with a few extra methods.
|
||||||
|
To select the proxy server you would like to use, use the `set_proxy` method, whose
|
||||||
|
syntax is:
|
||||||
|
|
||||||
|
set_proxy(proxy_type, addr[, port[, rdns[, username[, password]]]])
|
||||||
|
|
||||||
|
Explanation of the parameters:
|
||||||
|
|
||||||
|
`proxy_type` - The type of the proxy server. This can be one of three possible
|
||||||
|
choices: `PROXY_TYPE_SOCKS4`, `PROXY_TYPE_SOCKS5` and `PROXY_TYPE_HTTP` for SOCKS4,
|
||||||
|
SOCKS5 and HTTP servers respectively. `SOCKS4`, `SOCKS5`, and `HTTP` are all aliases, respectively.
|
||||||
|
|
||||||
|
`addr` - The IP address or DNS name of the proxy server.
|
||||||
|
|
||||||
|
`port` - The port of the proxy server. Defaults to 1080 for socks and 8080 for http.
|
||||||
|
|
||||||
|
`rdns` - This is a boolean flag than modifies the behavior regarding DNS resolving.
|
||||||
|
If it is set to True, DNS resolving will be preformed remotely, on the server.
|
||||||
|
If it is set to False, DNS resolving will be preformed locally. Please note that
|
||||||
|
setting this to True with SOCKS4 servers actually use an extension to the protocol,
|
||||||
|
called SOCKS4a, which may not be supported on all servers (SOCKS5 and http servers
|
||||||
|
always support DNS). The default is True.
|
||||||
|
|
||||||
|
`username` - For SOCKS5 servers, this allows simple username / password authentication
|
||||||
|
with the server. For SOCKS4 servers, this parameter will be sent as the userid.
|
||||||
|
This parameter is ignored if an HTTP server is being used. If it is not provided,
|
||||||
|
authentication will not be used (servers may accept unauthenticated requests).
|
||||||
|
|
||||||
|
`password` - This parameter is valid only for SOCKS5 servers and specifies the
|
||||||
|
respective password for the username provided.
|
||||||
|
|
||||||
|
Example of usage:
|
||||||
|
|
||||||
|
>>> s.set_proxy(socks.SOCKS5, "socks.example.com") # uses default port 1080
|
||||||
|
>>> s.set_proxy(socks.SOCKS4, "socks.test.com", 1081)
|
||||||
|
|
||||||
|
After the set_proxy method has been called, simply call the connect method with the
|
||||||
|
traditional parameters to establish a connection through the proxy:
|
||||||
|
|
||||||
|
>>> s.connect(("www.sourceforge.net", 80))
|
||||||
|
>>>
|
||||||
|
|
||||||
|
Connection will take a bit longer to allow negotiation with the proxy server.
|
||||||
|
Please note that calling connect without calling `set_proxy` earlier will connect
|
||||||
|
without a proxy (just like a regular socket).
|
||||||
|
|
||||||
|
Errors: Any errors in the connection process will trigger exceptions. The exception
|
||||||
|
may either be generated by the underlying socket layer or may be custom module
|
||||||
|
exceptions, whose details follow:
|
||||||
|
|
||||||
|
class `ProxyError` - This is a base exception class. It is not raised directly but
|
||||||
|
rather all other exception classes raised by this module are derived from it.
|
||||||
|
This allows an easy way to catch all proxy-related errors. It descends from `IOError`.
|
||||||
|
|
||||||
|
All `ProxyError` exceptions have an attribute `socket_err`, which will contain either a
|
||||||
|
caught `socket.error` exception, or `None` if there wasn't any.
|
||||||
|
|
||||||
|
class `GeneralProxyError` - When thrown, it indicates a problem which does not fall
|
||||||
|
into another category.
|
||||||
|
|
||||||
|
* `Sent invalid data` - This error means that unexpected data has been received from
|
||||||
|
the server. The most common reason is that the server specified as the proxy is
|
||||||
|
not really a SOCKS4/SOCKS5/HTTP proxy, or maybe the proxy type specified is wrong.
|
||||||
|
|
||||||
|
* `Connection closed unexpectedly` - The proxy server unexpectedly closed the connection.
|
||||||
|
This may indicate that the proxy server is experiencing network or software problems.
|
||||||
|
|
||||||
|
* `Bad proxy type` - This will be raised if the type of the proxy supplied to the
|
||||||
|
set_proxy function was not one of `SOCKS4`/`SOCKS5`/`HTTP`.
|
||||||
|
|
||||||
|
* `Bad input` - This will be raised if the `connect()` method is called with bad input
|
||||||
|
parameters.
|
||||||
|
|
||||||
|
class `SOCKS5AuthError` - This indicates that the connection through a SOCKS5 server
|
||||||
|
failed due to an authentication problem.
|
||||||
|
|
||||||
|
* `Authentication is required` - This will happen if you use a SOCKS5 server which
|
||||||
|
requires authentication without providing a username / password at all.
|
||||||
|
|
||||||
|
* `All offered authentication methods were rejected` - This will happen if the proxy
|
||||||
|
requires a special authentication method which is not supported by this module.
|
||||||
|
|
||||||
|
* `Unknown username or invalid password` - Self descriptive.
|
||||||
|
|
||||||
|
class `SOCKS5Error` - This will be raised for SOCKS5 errors which are not related to
|
||||||
|
authentication.
|
||||||
|
The parameter is a tuple containing a code, as given by the server,
|
||||||
|
and a description of the
|
||||||
|
error. The possible errors, according to the RFC, are:
|
||||||
|
|
||||||
|
* `0x01` - General SOCKS server failure - If for any reason the proxy server is unable to
|
||||||
|
fulfill your request (internal server error).
|
||||||
|
* `0x02` - connection not allowed by ruleset - If the address you're trying to connect to
|
||||||
|
is blacklisted on the server or requires authentication.
|
||||||
|
* `0x03` - Network unreachable - The target could not be contacted. A router on the network
|
||||||
|
had replied with a destination net unreachable error.
|
||||||
|
* `0x04` - Host unreachable - The target could not be contacted. A router on the network
|
||||||
|
had replied with a destination host unreachable error.
|
||||||
|
* `0x05` - Connection refused - The target server has actively refused the connection
|
||||||
|
(the requested port is closed).
|
||||||
|
* `0x06` - TTL expired - The TTL value of the SYN packet from the proxy to the target server
|
||||||
|
has expired. This usually means that there are network problems causing the packet
|
||||||
|
to be caught in a router-to-router "ping-pong".
|
||||||
|
* `0x07` - Command not supported - For instance if the server does not support UDP.
|
||||||
|
* `0x08` - Address type not supported - The client has provided an invalid address type.
|
||||||
|
When using this module, this error should not occur.
|
||||||
|
|
||||||
|
class `SOCKS4Error` - This will be raised for SOCKS4 errors. The parameter is a tuple
|
||||||
|
containing a code and a description of the error, as given by the server. The
|
||||||
|
possible error, according to the specification are:
|
||||||
|
|
||||||
|
* `0x5B` - Request rejected or failed - Will be raised in the event of an failure for any
|
||||||
|
reason other then the two mentioned next.
|
||||||
|
* `0x5C` - request rejected because SOCKS server cannot connect to identd on the client -
|
||||||
|
The Socks server had tried an ident lookup on your computer and has failed. In this
|
||||||
|
case you should run an identd server and/or configure your firewall to allow incoming
|
||||||
|
connections to local port 113 from the remote server.
|
||||||
|
* `0x5D` - request rejected because the client program and identd report different user-ids -
|
||||||
|
The Socks server had performed an ident lookup on your computer and has received a
|
||||||
|
different userid than the one you have provided. Change your userid (through the
|
||||||
|
username parameter of the set_proxy method) to match and try again.
|
||||||
|
|
||||||
|
class `HTTPError` - This will be raised for HTTP errors. The message will contain
|
||||||
|
the HTTP status code and provided error message.
|
||||||
|
|
||||||
|
After establishing the connection, the object behaves like a standard socket.
|
||||||
|
|
||||||
|
Methods like `makefile()` and `settimeout()` should behave just like regular sockets.
|
||||||
|
Call the `close()` method to close the connection.
|
||||||
|
|
||||||
|
In addition to the `socksocket` class, an additional function worth mentioning is the
|
||||||
|
`set_default_proxy` function. The parameters are the same as the `set_proxy` method.
|
||||||
|
This function will set default proxy settings for newly created `socksocket` objects,
|
||||||
|
in which the proxy settings haven't been changed via the `set_proxy` method.
|
||||||
|
This is quite useful if you wish to force 3rd party modules to use a SOCKS proxy,
|
||||||
|
by overriding the socket object.
|
||||||
|
For example:
|
||||||
|
|
||||||
|
>>> socks.set_default_proxy(socks.SOCKS5, "socks.example.com")
|
||||||
|
>>> socket.socket = socks.socksocket
|
||||||
|
>>> urllib.urlopen("http://www.sourceforge.net/")
|
||||||
|
|
||||||
|
|
||||||
|
PROBLEMS
|
||||||
|
---------
|
||||||
|
|
||||||
|
Please open a GitHub issue at https://github.com/Anorov/PySocks
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
PySocks-1.7.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
PySocks-1.7.1.dist-info/LICENSE,sha256=cCfiFOAU63i3rcwc7aWspxOnn8T2oMUsnaWz5wfm_-k,1401
|
||||||
|
PySocks-1.7.1.dist-info/METADATA,sha256=zbQMizjPOOP4DhEiEX24XXjNrYuIxF9UGUpN0uFDB6Y,13235
|
||||||
|
PySocks-1.7.1.dist-info/RECORD,,
|
||||||
|
PySocks-1.7.1.dist-info/WHEEL,sha256=t_MpApv386-8PVts2R6wsTifdIn0vbUDTVv61IbqFC8,92
|
||||||
|
PySocks-1.7.1.dist-info/top_level.txt,sha256=TKSOIfCFBoK9EY8FBYbYqC3PWd3--G15ph9n8-QHPDk,19
|
||||||
|
__pycache__/socks.cpython-312.pyc,,
|
||||||
|
__pycache__/sockshandler.cpython-312.pyc,,
|
||||||
|
socks.py,sha256=xOYn27t9IGrbTBzWsUUuPa0YBuplgiUykzkOB5V5iFY,31086
|
||||||
|
sockshandler.py,sha256=2SYGj-pwt1kjgLoZAmyeaEXCeZDWRmfVS_QG6kErGtY,3966
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: bdist_wheel (0.33.3)
|
||||||
|
Root-Is-Purelib: true
|
||||||
|
Tag: py3-none-any
|
||||||
|
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
socks
|
||||||
|
sockshandler
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
Copyright (c) 2011, ponty
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification,
|
||||||
|
are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
* Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation
|
||||||
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||||
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||||
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||||
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||||
|
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
Metadata-Version: 2.1
|
||||||
|
Name: PyVirtualDisplay
|
||||||
|
Version: 3.0
|
||||||
|
Summary: python wrapper for Xvfb, Xephyr and Xvnc
|
||||||
|
Home-page: https://github.com/ponty/pyvirtualdisplay
|
||||||
|
Author: ponty
|
||||||
|
License: BSD
|
||||||
|
Keywords: Xvfb Xephyr X wrapper
|
||||||
|
Platform: UNKNOWN
|
||||||
|
Classifier: License :: OSI Approved :: BSD License
|
||||||
|
Classifier: Natural Language :: English
|
||||||
|
Classifier: Operating System :: OS Independent
|
||||||
|
Classifier: Programming Language :: Python
|
||||||
|
Classifier: Programming Language :: Python :: 3
|
||||||
|
Classifier: Programming Language :: Python :: 3 :: Only
|
||||||
|
Classifier: Programming Language :: Python :: 3.6
|
||||||
|
Classifier: Programming Language :: Python :: 3.7
|
||||||
|
Classifier: Programming Language :: Python :: 3.8
|
||||||
|
Classifier: Programming Language :: Python :: 3.9
|
||||||
|
Classifier: Programming Language :: Python :: 3.10
|
||||||
|
Description-Content-Type: text/x-rst
|
||||||
|
|
||||||
|
pyvirtualdisplay is a python wrapper for Xvfb, Xephyr and Xvnc
|
||||||
|
|
||||||
|
Documentation: https://github.com/ponty/pyvirtualdisplay/tree/3.0
|
||||||
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
PyVirtualDisplay-3.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
PyVirtualDisplay-3.0.dist-info/LICENSE.txt,sha256=7AkJp5-qod-60Rc0BKew3KegiKBgPCClFAoqEYT9lU4,1309
|
||||||
|
PyVirtualDisplay-3.0.dist-info/METADATA,sha256=H0933jQs91_KPjq3f3OeforMsSdQitz-rVvUr4gLtdQ,943
|
||||||
|
PyVirtualDisplay-3.0.dist-info/RECORD,,
|
||||||
|
PyVirtualDisplay-3.0.dist-info/WHEEL,sha256=g4nMs7d-Xl9-xC9XovUrsDHGXt-FT0E17Yqo92DEfvY,92
|
||||||
|
PyVirtualDisplay-3.0.dist-info/top_level.txt,sha256=ssxAK7_apJcPpf6NG2ehxrlGCW1erkaxNk2EessFdms,17
|
||||||
|
pyvirtualdisplay/__init__.py,sha256=YP24pzfEmmJPYjwfNA8iuGk2tUqgPluM1Lc8jrXAMcE,241
|
||||||
|
pyvirtualdisplay/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/about.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/abstractdisplay.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/display.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/smartdisplay.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/util.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/xauth.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/xephyr.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/xvfb.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/__pycache__/xvnc.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/about.py,sha256=5f-dL23SITdqJpbFqY-avnmNzxAVz6xJh--gbw_osMA,20
|
||||||
|
pyvirtualdisplay/abstractdisplay.py,sha256=lTWlSJ8njddjviC5iwcZODmZDwtGZALTvBIZIfNwowc,12583
|
||||||
|
pyvirtualdisplay/display.py,sha256=a34ZUoF_41Zetb_1w111PvAzZnEY-LCle7K4Qhu0BPg,3257
|
||||||
|
pyvirtualdisplay/examples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
pyvirtualdisplay/examples/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/examples/__pycache__/headless.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/examples/__pycache__/lowres.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/examples/__pycache__/nested.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/examples/__pycache__/screenshot.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/examples/__pycache__/threadsafe.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/examples/__pycache__/vncserver.cpython-312.pyc,,
|
||||||
|
pyvirtualdisplay/examples/headless.py,sha256=cPwC9ZCSs8MVdsDt7HYYQFa513Z-msW5RS62McQMe8E,245
|
||||||
|
pyvirtualdisplay/examples/lowres.py,sha256=wKI93kUdoThA0hWDR_79fe1Q_Ef4YtmaUlK4APd7Upk,266
|
||||||
|
pyvirtualdisplay/examples/nested.py,sha256=eBr3XmxbHTrBvUbT5Z2Cl4XnLUa6VRVnjpyLakSHYMQ,736
|
||||||
|
pyvirtualdisplay/examples/screenshot.py,sha256=e8u38Rh8AaUxamjxup813Ds-AVOlnZwRoO-MBbe7Xmo,589
|
||||||
|
pyvirtualdisplay/examples/threadsafe.py,sha256=SIYdwsUw0R2F2tHlgpbuawqOeQgpJOivHwqoYQq-S4g,772
|
||||||
|
pyvirtualdisplay/examples/vncserver.py,sha256=oVNoGHqJcrzG6Pp1e9hfTv0iMIILSxz4Bs1XLWrTGRg,284
|
||||||
|
pyvirtualdisplay/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
pyvirtualdisplay/smartdisplay.py,sha256=GgPvahgDHoKHZjhygQ8YUwGQch89vbjzrRS2Giag0Ns,2663
|
||||||
|
pyvirtualdisplay/util.py,sha256=IOnwJgA_pPxivE5qAE8TLxdq5wS8EVn0PmhoJiYbfJc,486
|
||||||
|
pyvirtualdisplay/xauth.py,sha256=_4d3LuM16GLSTerJ25_ZobNMz7dtH8dOcEzEFxfoFNc,1167
|
||||||
|
pyvirtualdisplay/xephyr.py,sha256=m1yPhPHa-E2gMdS1rY0jVJbZ7lFgSVLxZ9wihk6ugrg,1635
|
||||||
|
pyvirtualdisplay/xvfb.py,sha256=7NNDbKFfjqVP8LzjT-PummIrJdPQ4d3_y8blJXJHy6M,1941
|
||||||
|
pyvirtualdisplay/xvnc.py,sha256=fxr8Z38LZIHrPGP2JOV3j5XSbJWxlzj0hKgBsbdWvYc,1917
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: bdist_wheel (0.34.2)
|
||||||
|
Root-Is-Purelib: true
|
||||||
|
Tag: py3-none-any
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pyvirtualdisplay
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
/opt/nextcloud-talk-recording-src/src
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,104 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""
|
||||||
|
Classes Without Boilerplate
|
||||||
|
"""
|
||||||
|
|
||||||
|
from functools import partial
|
||||||
|
from typing import Callable, Literal, Protocol
|
||||||
|
|
||||||
|
from . import converters, exceptions, filters, setters, validators
|
||||||
|
from ._cmp import cmp_using
|
||||||
|
from ._config import get_run_validators, set_run_validators
|
||||||
|
from ._funcs import asdict, assoc, astuple, has, resolve_types
|
||||||
|
from ._make import (
|
||||||
|
NOTHING,
|
||||||
|
Attribute,
|
||||||
|
Converter,
|
||||||
|
Factory,
|
||||||
|
_Nothing,
|
||||||
|
attrib,
|
||||||
|
attrs,
|
||||||
|
evolve,
|
||||||
|
fields,
|
||||||
|
fields_dict,
|
||||||
|
make_class,
|
||||||
|
validate,
|
||||||
|
)
|
||||||
|
from ._next_gen import define, field, frozen, mutable
|
||||||
|
from ._version_info import VersionInfo
|
||||||
|
|
||||||
|
|
||||||
|
s = attributes = attrs
|
||||||
|
ib = attr = attrib
|
||||||
|
dataclass = partial(attrs, auto_attribs=True) # happy Easter ;)
|
||||||
|
|
||||||
|
|
||||||
|
class AttrsInstance(Protocol):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
NothingType = Literal[_Nothing.NOTHING]
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"NOTHING",
|
||||||
|
"Attribute",
|
||||||
|
"AttrsInstance",
|
||||||
|
"Converter",
|
||||||
|
"Factory",
|
||||||
|
"NothingType",
|
||||||
|
"asdict",
|
||||||
|
"assoc",
|
||||||
|
"astuple",
|
||||||
|
"attr",
|
||||||
|
"attrib",
|
||||||
|
"attributes",
|
||||||
|
"attrs",
|
||||||
|
"cmp_using",
|
||||||
|
"converters",
|
||||||
|
"define",
|
||||||
|
"evolve",
|
||||||
|
"exceptions",
|
||||||
|
"field",
|
||||||
|
"fields",
|
||||||
|
"fields_dict",
|
||||||
|
"filters",
|
||||||
|
"frozen",
|
||||||
|
"get_run_validators",
|
||||||
|
"has",
|
||||||
|
"ib",
|
||||||
|
"make_class",
|
||||||
|
"mutable",
|
||||||
|
"resolve_types",
|
||||||
|
"s",
|
||||||
|
"set_run_validators",
|
||||||
|
"setters",
|
||||||
|
"validate",
|
||||||
|
"validators",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _make_getattr(mod_name: str) -> Callable:
|
||||||
|
"""
|
||||||
|
Create a metadata proxy for packaging information that uses *mod_name* in
|
||||||
|
its warnings and errors.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __getattr__(name: str) -> str:
|
||||||
|
if name not in ("__version__", "__version_info__"):
|
||||||
|
msg = f"module {mod_name} has no attribute {name}"
|
||||||
|
raise AttributeError(msg)
|
||||||
|
|
||||||
|
from importlib.metadata import metadata
|
||||||
|
|
||||||
|
meta = metadata("attrs")
|
||||||
|
|
||||||
|
if name == "__version_info__":
|
||||||
|
return VersionInfo._from_version_string(meta["version"])
|
||||||
|
|
||||||
|
return meta["version"]
|
||||||
|
|
||||||
|
return __getattr__
|
||||||
|
|
||||||
|
|
||||||
|
__getattr__ = _make_getattr(__name__)
|
||||||
|
|
@ -0,0 +1,389 @@
|
||||||
|
import enum
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from typing import (
|
||||||
|
Any,
|
||||||
|
Callable,
|
||||||
|
Generic,
|
||||||
|
Literal,
|
||||||
|
Mapping,
|
||||||
|
Protocol,
|
||||||
|
Sequence,
|
||||||
|
TypeVar,
|
||||||
|
overload,
|
||||||
|
)
|
||||||
|
|
||||||
|
# `import X as X` is required to make these public
|
||||||
|
from . import converters as converters
|
||||||
|
from . import exceptions as exceptions
|
||||||
|
from . import filters as filters
|
||||||
|
from . import setters as setters
|
||||||
|
from . import validators as validators
|
||||||
|
from ._cmp import cmp_using as cmp_using
|
||||||
|
from ._typing_compat import AttrsInstance_
|
||||||
|
from ._version_info import VersionInfo
|
||||||
|
from attrs import (
|
||||||
|
define as define,
|
||||||
|
field as field,
|
||||||
|
mutable as mutable,
|
||||||
|
frozen as frozen,
|
||||||
|
_EqOrderType,
|
||||||
|
_ValidatorType,
|
||||||
|
_ConverterType,
|
||||||
|
_ReprArgType,
|
||||||
|
_OnSetAttrType,
|
||||||
|
_OnSetAttrArgType,
|
||||||
|
_FieldTransformer,
|
||||||
|
_ValidatorArgType,
|
||||||
|
)
|
||||||
|
|
||||||
|
if sys.version_info >= (3, 10):
|
||||||
|
from typing import TypeGuard, TypeAlias
|
||||||
|
else:
|
||||||
|
from typing_extensions import TypeGuard, TypeAlias
|
||||||
|
|
||||||
|
if sys.version_info >= (3, 11):
|
||||||
|
from typing import dataclass_transform
|
||||||
|
else:
|
||||||
|
from typing_extensions import dataclass_transform
|
||||||
|
|
||||||
|
__version__: str
|
||||||
|
__version_info__: VersionInfo
|
||||||
|
__title__: str
|
||||||
|
__description__: str
|
||||||
|
__url__: str
|
||||||
|
__uri__: str
|
||||||
|
__author__: str
|
||||||
|
__email__: str
|
||||||
|
__license__: str
|
||||||
|
__copyright__: str
|
||||||
|
|
||||||
|
_T = TypeVar("_T")
|
||||||
|
_C = TypeVar("_C", bound=type)
|
||||||
|
|
||||||
|
_FilterType = Callable[["Attribute[_T]", _T], bool]
|
||||||
|
|
||||||
|
# We subclass this here to keep the protocol's qualified name clean.
|
||||||
|
class AttrsInstance(AttrsInstance_, Protocol):
|
||||||
|
pass
|
||||||
|
|
||||||
|
_A = TypeVar("_A", bound=type[AttrsInstance])
|
||||||
|
|
||||||
|
class _Nothing(enum.Enum):
|
||||||
|
NOTHING = enum.auto()
|
||||||
|
|
||||||
|
NOTHING = _Nothing.NOTHING
|
||||||
|
NothingType: TypeAlias = Literal[_Nothing.NOTHING]
|
||||||
|
|
||||||
|
# NOTE: Factory lies about its return type to make this possible:
|
||||||
|
# `x: List[int] # = Factory(list)`
|
||||||
|
# Work around mypy issue #4554 in the common case by using an overload.
|
||||||
|
|
||||||
|
@overload
|
||||||
|
def Factory(factory: Callable[[], _T]) -> _T: ...
|
||||||
|
@overload
|
||||||
|
def Factory(
|
||||||
|
factory: Callable[[Any], _T],
|
||||||
|
takes_self: Literal[True],
|
||||||
|
) -> _T: ...
|
||||||
|
@overload
|
||||||
|
def Factory(
|
||||||
|
factory: Callable[[], _T],
|
||||||
|
takes_self: Literal[False],
|
||||||
|
) -> _T: ...
|
||||||
|
|
||||||
|
In = TypeVar("In")
|
||||||
|
Out = TypeVar("Out")
|
||||||
|
|
||||||
|
class Converter(Generic[In, Out]):
|
||||||
|
@overload
|
||||||
|
def __init__(self, converter: Callable[[In], Out]) -> None: ...
|
||||||
|
@overload
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
converter: Callable[[In, AttrsInstance, Attribute], Out],
|
||||||
|
*,
|
||||||
|
takes_self: Literal[True],
|
||||||
|
takes_field: Literal[True],
|
||||||
|
) -> None: ...
|
||||||
|
@overload
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
converter: Callable[[In, Attribute], Out],
|
||||||
|
*,
|
||||||
|
takes_field: Literal[True],
|
||||||
|
) -> None: ...
|
||||||
|
@overload
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
converter: Callable[[In, AttrsInstance], Out],
|
||||||
|
*,
|
||||||
|
takes_self: Literal[True],
|
||||||
|
) -> None: ...
|
||||||
|
|
||||||
|
class Attribute(Generic[_T]):
|
||||||
|
name: str
|
||||||
|
default: _T | None
|
||||||
|
validator: _ValidatorType[_T] | None
|
||||||
|
repr: _ReprArgType
|
||||||
|
cmp: _EqOrderType
|
||||||
|
eq: _EqOrderType
|
||||||
|
order: _EqOrderType
|
||||||
|
hash: bool | None
|
||||||
|
init: bool
|
||||||
|
converter: Converter | None
|
||||||
|
metadata: dict[Any, Any]
|
||||||
|
type: type[_T] | None
|
||||||
|
kw_only: bool
|
||||||
|
on_setattr: _OnSetAttrType
|
||||||
|
alias: str | None
|
||||||
|
|
||||||
|
def evolve(self, **changes: Any) -> "Attribute[Any]": ...
|
||||||
|
|
||||||
|
# NOTE: We had several choices for the annotation to use for type arg:
|
||||||
|
# 1) Type[_T]
|
||||||
|
# - Pros: Handles simple cases correctly
|
||||||
|
# - Cons: Might produce less informative errors in the case of conflicting
|
||||||
|
# TypeVars e.g. `attr.ib(default='bad', type=int)`
|
||||||
|
# 2) Callable[..., _T]
|
||||||
|
# - Pros: Better error messages than #1 for conflicting TypeVars
|
||||||
|
# - Cons: Terrible error messages for validator checks.
|
||||||
|
# e.g. attr.ib(type=int, validator=validate_str)
|
||||||
|
# -> error: Cannot infer function type argument
|
||||||
|
# 3) type (and do all of the work in the mypy plugin)
|
||||||
|
# - Pros: Simple here, and we could customize the plugin with our own errors.
|
||||||
|
# - Cons: Would need to write mypy plugin code to handle all the cases.
|
||||||
|
# We chose option #1.
|
||||||
|
|
||||||
|
# `attr` lies about its return type to make the following possible:
|
||||||
|
# attr() -> Any
|
||||||
|
# attr(8) -> int
|
||||||
|
# attr(validator=<some callable>) -> Whatever the callable expects.
|
||||||
|
# This makes this type of assignments possible:
|
||||||
|
# x: int = attr(8)
|
||||||
|
#
|
||||||
|
# This form catches explicit None or no default but with no other arguments
|
||||||
|
# returns Any.
|
||||||
|
@overload
|
||||||
|
def attrib(
|
||||||
|
default: None = ...,
|
||||||
|
validator: None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
cmp: _EqOrderType | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
type: None = ...,
|
||||||
|
converter: None = ...,
|
||||||
|
factory: None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
) -> Any: ...
|
||||||
|
|
||||||
|
# This form catches an explicit None or no default and infers the type from the
|
||||||
|
# other arguments.
|
||||||
|
@overload
|
||||||
|
def attrib(
|
||||||
|
default: None = ...,
|
||||||
|
validator: _ValidatorArgType[_T] | None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
cmp: _EqOrderType | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
type: type[_T] | None = ...,
|
||||||
|
converter: _ConverterType
|
||||||
|
| list[_ConverterType]
|
||||||
|
| tuple[_ConverterType]
|
||||||
|
| None = ...,
|
||||||
|
factory: Callable[[], _T] | None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
) -> _T: ...
|
||||||
|
|
||||||
|
# This form catches an explicit default argument.
|
||||||
|
@overload
|
||||||
|
def attrib(
|
||||||
|
default: _T,
|
||||||
|
validator: _ValidatorArgType[_T] | None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
cmp: _EqOrderType | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
type: type[_T] | None = ...,
|
||||||
|
converter: _ConverterType
|
||||||
|
| list[_ConverterType]
|
||||||
|
| tuple[_ConverterType]
|
||||||
|
| None = ...,
|
||||||
|
factory: Callable[[], _T] | None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
) -> _T: ...
|
||||||
|
|
||||||
|
# This form covers type=non-Type: e.g. forward references (str), Any
|
||||||
|
@overload
|
||||||
|
def attrib(
|
||||||
|
default: _T | None = ...,
|
||||||
|
validator: _ValidatorArgType[_T] | None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
cmp: _EqOrderType | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
type: object = ...,
|
||||||
|
converter: _ConverterType
|
||||||
|
| list[_ConverterType]
|
||||||
|
| tuple[_ConverterType]
|
||||||
|
| None = ...,
|
||||||
|
factory: Callable[[], _T] | None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
) -> Any: ...
|
||||||
|
@overload
|
||||||
|
@dataclass_transform(order_default=True, field_specifiers=(attrib, field))
|
||||||
|
def attrs(
|
||||||
|
maybe_cls: _C,
|
||||||
|
these: dict[str, Any] | None = ...,
|
||||||
|
repr_ns: str | None = ...,
|
||||||
|
repr: bool = ...,
|
||||||
|
cmp: _EqOrderType | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
slots: bool = ...,
|
||||||
|
frozen: bool = ...,
|
||||||
|
weakref_slot: bool = ...,
|
||||||
|
str: bool = ...,
|
||||||
|
auto_attribs: bool = ...,
|
||||||
|
kw_only: bool = ...,
|
||||||
|
cache_hash: bool = ...,
|
||||||
|
auto_exc: bool = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
auto_detect: bool = ...,
|
||||||
|
collect_by_mro: bool = ...,
|
||||||
|
getstate_setstate: bool | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
field_transformer: _FieldTransformer | None = ...,
|
||||||
|
match_args: bool = ...,
|
||||||
|
unsafe_hash: bool | None = ...,
|
||||||
|
) -> _C: ...
|
||||||
|
@overload
|
||||||
|
@dataclass_transform(order_default=True, field_specifiers=(attrib, field))
|
||||||
|
def attrs(
|
||||||
|
maybe_cls: None = ...,
|
||||||
|
these: dict[str, Any] | None = ...,
|
||||||
|
repr_ns: str | None = ...,
|
||||||
|
repr: bool = ...,
|
||||||
|
cmp: _EqOrderType | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
slots: bool = ...,
|
||||||
|
frozen: bool = ...,
|
||||||
|
weakref_slot: bool = ...,
|
||||||
|
str: bool = ...,
|
||||||
|
auto_attribs: bool = ...,
|
||||||
|
kw_only: bool = ...,
|
||||||
|
cache_hash: bool = ...,
|
||||||
|
auto_exc: bool = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
auto_detect: bool = ...,
|
||||||
|
collect_by_mro: bool = ...,
|
||||||
|
getstate_setstate: bool | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
field_transformer: _FieldTransformer | None = ...,
|
||||||
|
match_args: bool = ...,
|
||||||
|
unsafe_hash: bool | None = ...,
|
||||||
|
) -> Callable[[_C], _C]: ...
|
||||||
|
def fields(cls: type[AttrsInstance]) -> Any: ...
|
||||||
|
def fields_dict(cls: type[AttrsInstance]) -> dict[str, Attribute[Any]]: ...
|
||||||
|
def validate(inst: AttrsInstance) -> None: ...
|
||||||
|
def resolve_types(
|
||||||
|
cls: _A,
|
||||||
|
globalns: dict[str, Any] | None = ...,
|
||||||
|
localns: dict[str, Any] | None = ...,
|
||||||
|
attribs: list[Attribute[Any]] | None = ...,
|
||||||
|
include_extras: bool = ...,
|
||||||
|
) -> _A: ...
|
||||||
|
|
||||||
|
# TODO: add support for returning a proper attrs class from the mypy plugin
|
||||||
|
# we use Any instead of _CountingAttr so that e.g. `make_class('Foo',
|
||||||
|
# [attr.ib()])` is valid
|
||||||
|
def make_class(
|
||||||
|
name: str,
|
||||||
|
attrs: list[str] | tuple[str, ...] | dict[str, Any],
|
||||||
|
bases: tuple[type, ...] = ...,
|
||||||
|
class_body: dict[str, Any] | None = ...,
|
||||||
|
repr_ns: str | None = ...,
|
||||||
|
repr: bool = ...,
|
||||||
|
cmp: _EqOrderType | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
slots: bool = ...,
|
||||||
|
frozen: bool = ...,
|
||||||
|
weakref_slot: bool = ...,
|
||||||
|
str: bool = ...,
|
||||||
|
auto_attribs: bool = ...,
|
||||||
|
kw_only: bool = ...,
|
||||||
|
cache_hash: bool = ...,
|
||||||
|
auto_exc: bool = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
collect_by_mro: bool = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
field_transformer: _FieldTransformer | None = ...,
|
||||||
|
) -> type: ...
|
||||||
|
|
||||||
|
# _funcs --
|
||||||
|
|
||||||
|
# TODO: add support for returning TypedDict from the mypy plugin
|
||||||
|
# FIXME: asdict/astuple do not honor their factory args. Waiting on one of
|
||||||
|
# these:
|
||||||
|
# https://github.com/python/mypy/issues/4236
|
||||||
|
# https://github.com/python/typing/issues/253
|
||||||
|
# XXX: remember to fix attrs.asdict/astuple too!
|
||||||
|
def asdict(
|
||||||
|
inst: AttrsInstance,
|
||||||
|
recurse: bool = ...,
|
||||||
|
filter: _FilterType[Any] | None = ...,
|
||||||
|
dict_factory: type[Mapping[Any, Any]] = ...,
|
||||||
|
retain_collection_types: bool = ...,
|
||||||
|
value_serializer: Callable[[type, Attribute[Any], Any], Any] | None = ...,
|
||||||
|
tuple_keys: bool | None = ...,
|
||||||
|
) -> dict[str, Any]: ...
|
||||||
|
|
||||||
|
# TODO: add support for returning NamedTuple from the mypy plugin
|
||||||
|
def astuple(
|
||||||
|
inst: AttrsInstance,
|
||||||
|
recurse: bool = ...,
|
||||||
|
filter: _FilterType[Any] | None = ...,
|
||||||
|
tuple_factory: type[Sequence[Any]] = ...,
|
||||||
|
retain_collection_types: bool = ...,
|
||||||
|
) -> tuple[Any, ...]: ...
|
||||||
|
def has(cls: type) -> TypeGuard[type[AttrsInstance]]: ...
|
||||||
|
def assoc(inst: _T, **changes: Any) -> _T: ...
|
||||||
|
def evolve(inst: _T, **changes: Any) -> _T: ...
|
||||||
|
|
||||||
|
# _config --
|
||||||
|
|
||||||
|
def set_run_validators(run: bool) -> None: ...
|
||||||
|
def get_run_validators() -> bool: ...
|
||||||
|
|
||||||
|
# aliases --
|
||||||
|
|
||||||
|
s = attributes = attrs
|
||||||
|
ib = attr = attrib
|
||||||
|
dataclass = attrs # Technically, partial(attrs, auto_attribs=True) ;)
|
||||||
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,160 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
|
||||||
|
import functools
|
||||||
|
import types
|
||||||
|
|
||||||
|
from ._make import __ne__
|
||||||
|
|
||||||
|
|
||||||
|
_operation_names = {"eq": "==", "lt": "<", "le": "<=", "gt": ">", "ge": ">="}
|
||||||
|
|
||||||
|
|
||||||
|
def cmp_using(
|
||||||
|
eq=None,
|
||||||
|
lt=None,
|
||||||
|
le=None,
|
||||||
|
gt=None,
|
||||||
|
ge=None,
|
||||||
|
require_same_type=True,
|
||||||
|
class_name="Comparable",
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
Create a class that can be passed into `attrs.field`'s ``eq``, ``order``,
|
||||||
|
and ``cmp`` arguments to customize field comparison.
|
||||||
|
|
||||||
|
The resulting class will have a full set of ordering methods if at least
|
||||||
|
one of ``{lt, le, gt, ge}`` and ``eq`` are provided.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
eq (typing.Callable | None):
|
||||||
|
Callable used to evaluate equality of two objects.
|
||||||
|
|
||||||
|
lt (typing.Callable | None):
|
||||||
|
Callable used to evaluate whether one object is less than another
|
||||||
|
object.
|
||||||
|
|
||||||
|
le (typing.Callable | None):
|
||||||
|
Callable used to evaluate whether one object is less than or equal
|
||||||
|
to another object.
|
||||||
|
|
||||||
|
gt (typing.Callable | None):
|
||||||
|
Callable used to evaluate whether one object is greater than
|
||||||
|
another object.
|
||||||
|
|
||||||
|
ge (typing.Callable | None):
|
||||||
|
Callable used to evaluate whether one object is greater than or
|
||||||
|
equal to another object.
|
||||||
|
|
||||||
|
require_same_type (bool):
|
||||||
|
When `True`, equality and ordering methods will return
|
||||||
|
`NotImplemented` if objects are not of the same type.
|
||||||
|
|
||||||
|
class_name (str | None): Name of class. Defaults to "Comparable".
|
||||||
|
|
||||||
|
See `comparison` for more details.
|
||||||
|
|
||||||
|
.. versionadded:: 21.1.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
body = {
|
||||||
|
"__slots__": ["value"],
|
||||||
|
"__init__": _make_init(),
|
||||||
|
"_requirements": [],
|
||||||
|
"_is_comparable_to": _is_comparable_to,
|
||||||
|
}
|
||||||
|
|
||||||
|
# Add operations.
|
||||||
|
num_order_functions = 0
|
||||||
|
has_eq_function = False
|
||||||
|
|
||||||
|
if eq is not None:
|
||||||
|
has_eq_function = True
|
||||||
|
body["__eq__"] = _make_operator("eq", eq)
|
||||||
|
body["__ne__"] = __ne__
|
||||||
|
|
||||||
|
if lt is not None:
|
||||||
|
num_order_functions += 1
|
||||||
|
body["__lt__"] = _make_operator("lt", lt)
|
||||||
|
|
||||||
|
if le is not None:
|
||||||
|
num_order_functions += 1
|
||||||
|
body["__le__"] = _make_operator("le", le)
|
||||||
|
|
||||||
|
if gt is not None:
|
||||||
|
num_order_functions += 1
|
||||||
|
body["__gt__"] = _make_operator("gt", gt)
|
||||||
|
|
||||||
|
if ge is not None:
|
||||||
|
num_order_functions += 1
|
||||||
|
body["__ge__"] = _make_operator("ge", ge)
|
||||||
|
|
||||||
|
type_ = types.new_class(
|
||||||
|
class_name, (object,), {}, lambda ns: ns.update(body)
|
||||||
|
)
|
||||||
|
|
||||||
|
# Add same type requirement.
|
||||||
|
if require_same_type:
|
||||||
|
type_._requirements.append(_check_same_type)
|
||||||
|
|
||||||
|
# Add total ordering if at least one operation was defined.
|
||||||
|
if 0 < num_order_functions < 4:
|
||||||
|
if not has_eq_function:
|
||||||
|
# functools.total_ordering requires __eq__ to be defined,
|
||||||
|
# so raise early error here to keep a nice stack.
|
||||||
|
msg = "eq must be define is order to complete ordering from lt, le, gt, ge."
|
||||||
|
raise ValueError(msg)
|
||||||
|
type_ = functools.total_ordering(type_)
|
||||||
|
|
||||||
|
return type_
|
||||||
|
|
||||||
|
|
||||||
|
def _make_init():
|
||||||
|
"""
|
||||||
|
Create __init__ method.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, value):
|
||||||
|
"""
|
||||||
|
Initialize object with *value*.
|
||||||
|
"""
|
||||||
|
self.value = value
|
||||||
|
|
||||||
|
return __init__
|
||||||
|
|
||||||
|
|
||||||
|
def _make_operator(name, func):
|
||||||
|
"""
|
||||||
|
Create operator method.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def method(self, other):
|
||||||
|
if not self._is_comparable_to(other):
|
||||||
|
return NotImplemented
|
||||||
|
|
||||||
|
result = func(self.value, other.value)
|
||||||
|
if result is NotImplemented:
|
||||||
|
return NotImplemented
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
method.__name__ = f"__{name}__"
|
||||||
|
method.__doc__ = (
|
||||||
|
f"Return a {_operation_names[name]} b. Computed by attrs."
|
||||||
|
)
|
||||||
|
|
||||||
|
return method
|
||||||
|
|
||||||
|
|
||||||
|
def _is_comparable_to(self, other):
|
||||||
|
"""
|
||||||
|
Check whether `other` is comparable to `self`.
|
||||||
|
"""
|
||||||
|
return all(func(self, other) for func in self._requirements)
|
||||||
|
|
||||||
|
|
||||||
|
def _check_same_type(self, other):
|
||||||
|
"""
|
||||||
|
Return True if *self* and *other* are of the same type, False otherwise.
|
||||||
|
"""
|
||||||
|
return other.value.__class__ is self.value.__class__
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
from typing import Any, Callable
|
||||||
|
|
||||||
|
_CompareWithType = Callable[[Any, Any], bool]
|
||||||
|
|
||||||
|
def cmp_using(
|
||||||
|
eq: _CompareWithType | None = ...,
|
||||||
|
lt: _CompareWithType | None = ...,
|
||||||
|
le: _CompareWithType | None = ...,
|
||||||
|
gt: _CompareWithType | None = ...,
|
||||||
|
ge: _CompareWithType | None = ...,
|
||||||
|
require_same_type: bool = ...,
|
||||||
|
class_name: str = ...,
|
||||||
|
) -> type: ...
|
||||||
|
|
@ -0,0 +1,99 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
import inspect
|
||||||
|
import platform
|
||||||
|
import sys
|
||||||
|
import threading
|
||||||
|
|
||||||
|
from collections.abc import Mapping, Sequence # noqa: F401
|
||||||
|
from typing import _GenericAlias
|
||||||
|
|
||||||
|
|
||||||
|
PYPY = platform.python_implementation() == "PyPy"
|
||||||
|
PY_3_10_PLUS = sys.version_info[:2] >= (3, 10)
|
||||||
|
PY_3_11_PLUS = sys.version_info[:2] >= (3, 11)
|
||||||
|
PY_3_12_PLUS = sys.version_info[:2] >= (3, 12)
|
||||||
|
PY_3_13_PLUS = sys.version_info[:2] >= (3, 13)
|
||||||
|
PY_3_14_PLUS = sys.version_info[:2] >= (3, 14)
|
||||||
|
|
||||||
|
|
||||||
|
if PY_3_14_PLUS:
|
||||||
|
import annotationlib
|
||||||
|
|
||||||
|
# We request forward-ref annotations to not break in the presence of
|
||||||
|
# forward references.
|
||||||
|
|
||||||
|
def _get_annotations(cls):
|
||||||
|
return annotationlib.get_annotations(
|
||||||
|
cls, format=annotationlib.Format.FORWARDREF
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
|
||||||
|
def _get_annotations(cls):
|
||||||
|
"""
|
||||||
|
Get annotations for *cls*.
|
||||||
|
"""
|
||||||
|
return cls.__dict__.get("__annotations__", {})
|
||||||
|
|
||||||
|
|
||||||
|
class _AnnotationExtractor:
|
||||||
|
"""
|
||||||
|
Extract type annotations from a callable, returning None whenever there
|
||||||
|
is none.
|
||||||
|
"""
|
||||||
|
|
||||||
|
__slots__ = ["sig"]
|
||||||
|
|
||||||
|
def __init__(self, callable):
|
||||||
|
try:
|
||||||
|
self.sig = inspect.signature(callable)
|
||||||
|
except (ValueError, TypeError): # inspect failed
|
||||||
|
self.sig = None
|
||||||
|
|
||||||
|
def get_first_param_type(self):
|
||||||
|
"""
|
||||||
|
Return the type annotation of the first argument if it's not empty.
|
||||||
|
"""
|
||||||
|
if not self.sig:
|
||||||
|
return None
|
||||||
|
|
||||||
|
params = list(self.sig.parameters.values())
|
||||||
|
if params and params[0].annotation is not inspect.Parameter.empty:
|
||||||
|
return params[0].annotation
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
def get_return_type(self):
|
||||||
|
"""
|
||||||
|
Return the return type if it's not empty.
|
||||||
|
"""
|
||||||
|
if (
|
||||||
|
self.sig
|
||||||
|
and self.sig.return_annotation is not inspect.Signature.empty
|
||||||
|
):
|
||||||
|
return self.sig.return_annotation
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
# Thread-local global to track attrs instances which are already being repr'd.
|
||||||
|
# This is needed because there is no other (thread-safe) way to pass info
|
||||||
|
# about the instances that are already being repr'd through the call stack
|
||||||
|
# in order to ensure we don't perform infinite recursion.
|
||||||
|
#
|
||||||
|
# For instance, if an instance contains a dict which contains that instance,
|
||||||
|
# we need to know that we're already repr'ing the outside instance from within
|
||||||
|
# the dict's repr() call.
|
||||||
|
#
|
||||||
|
# This lives here rather than in _make.py so that the functions in _make.py
|
||||||
|
# don't have a direct reference to the thread-local in their globals dict.
|
||||||
|
# If they have such a reference, it breaks cloudpickle.
|
||||||
|
repr_context = threading.local()
|
||||||
|
|
||||||
|
|
||||||
|
def get_generic_base(cl):
|
||||||
|
"""If this is a generic class (A[str]), return the generic base for it."""
|
||||||
|
if cl.__class__ is _GenericAlias:
|
||||||
|
return cl.__origin__
|
||||||
|
return None
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
__all__ = ["get_run_validators", "set_run_validators"]
|
||||||
|
|
||||||
|
_run_validators = True
|
||||||
|
|
||||||
|
|
||||||
|
def set_run_validators(run):
|
||||||
|
"""
|
||||||
|
Set whether or not validators are run. By default, they are run.
|
||||||
|
|
||||||
|
.. deprecated:: 21.3.0 It will not be removed, but it also will not be
|
||||||
|
moved to new ``attrs`` namespace. Use `attrs.validators.set_disabled()`
|
||||||
|
instead.
|
||||||
|
"""
|
||||||
|
if not isinstance(run, bool):
|
||||||
|
msg = "'run' must be bool."
|
||||||
|
raise TypeError(msg)
|
||||||
|
global _run_validators
|
||||||
|
_run_validators = run
|
||||||
|
|
||||||
|
|
||||||
|
def get_run_validators():
|
||||||
|
"""
|
||||||
|
Return whether or not validators are run.
|
||||||
|
|
||||||
|
.. deprecated:: 21.3.0 It will not be removed, but it also will not be
|
||||||
|
moved to new ``attrs`` namespace. Use `attrs.validators.get_disabled()`
|
||||||
|
instead.
|
||||||
|
"""
|
||||||
|
return _run_validators
|
||||||
|
|
@ -0,0 +1,497 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
|
||||||
|
import copy
|
||||||
|
|
||||||
|
from ._compat import get_generic_base
|
||||||
|
from ._make import _OBJ_SETATTR, NOTHING, fields
|
||||||
|
from .exceptions import AttrsAttributeNotFoundError
|
||||||
|
|
||||||
|
|
||||||
|
_ATOMIC_TYPES = frozenset(
|
||||||
|
{
|
||||||
|
type(None),
|
||||||
|
bool,
|
||||||
|
int,
|
||||||
|
float,
|
||||||
|
str,
|
||||||
|
complex,
|
||||||
|
bytes,
|
||||||
|
type(...),
|
||||||
|
type,
|
||||||
|
range,
|
||||||
|
property,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def asdict(
|
||||||
|
inst,
|
||||||
|
recurse=True,
|
||||||
|
filter=None,
|
||||||
|
dict_factory=dict,
|
||||||
|
retain_collection_types=False,
|
||||||
|
value_serializer=None,
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
Return the *attrs* attribute values of *inst* as a dict.
|
||||||
|
|
||||||
|
Optionally recurse into other *attrs*-decorated classes.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
inst: Instance of an *attrs*-decorated class.
|
||||||
|
|
||||||
|
recurse (bool): Recurse into classes that are also *attrs*-decorated.
|
||||||
|
|
||||||
|
filter (~typing.Callable):
|
||||||
|
A callable whose return code determines whether an attribute or
|
||||||
|
element is included (`True`) or dropped (`False`). Is called with
|
||||||
|
the `attrs.Attribute` as the first argument and the value as the
|
||||||
|
second argument.
|
||||||
|
|
||||||
|
dict_factory (~typing.Callable):
|
||||||
|
A callable to produce dictionaries from. For example, to produce
|
||||||
|
ordered dictionaries instead of normal Python dictionaries, pass in
|
||||||
|
``collections.OrderedDict``.
|
||||||
|
|
||||||
|
retain_collection_types (bool):
|
||||||
|
Do not convert to `list` when encountering an attribute whose type
|
||||||
|
is `tuple` or `set`. Only meaningful if *recurse* is `True`.
|
||||||
|
|
||||||
|
value_serializer (typing.Callable | None):
|
||||||
|
A hook that is called for every attribute or dict key/value. It
|
||||||
|
receives the current instance, field and value and must return the
|
||||||
|
(updated) value. The hook is run *after* the optional *filter* has
|
||||||
|
been applied.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Return type of *dict_factory*.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
attrs.exceptions.NotAnAttrsClassError:
|
||||||
|
If *cls* is not an *attrs* class.
|
||||||
|
|
||||||
|
.. versionadded:: 16.0.0 *dict_factory*
|
||||||
|
.. versionadded:: 16.1.0 *retain_collection_types*
|
||||||
|
.. versionadded:: 20.3.0 *value_serializer*
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
If a dict has a collection for a key, it is serialized as a tuple.
|
||||||
|
"""
|
||||||
|
attrs = fields(inst.__class__)
|
||||||
|
rv = dict_factory()
|
||||||
|
for a in attrs:
|
||||||
|
v = getattr(inst, a.name)
|
||||||
|
if filter is not None and not filter(a, v):
|
||||||
|
continue
|
||||||
|
|
||||||
|
if value_serializer is not None:
|
||||||
|
v = value_serializer(inst, a, v)
|
||||||
|
|
||||||
|
if recurse is True:
|
||||||
|
value_type = type(v)
|
||||||
|
if value_type in _ATOMIC_TYPES:
|
||||||
|
rv[a.name] = v
|
||||||
|
elif has(value_type):
|
||||||
|
rv[a.name] = asdict(
|
||||||
|
v,
|
||||||
|
recurse=True,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=dict_factory,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
)
|
||||||
|
elif issubclass(value_type, (tuple, list, set, frozenset)):
|
||||||
|
cf = value_type if retain_collection_types is True else list
|
||||||
|
items = [
|
||||||
|
_asdict_anything(
|
||||||
|
i,
|
||||||
|
is_key=False,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=dict_factory,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
)
|
||||||
|
for i in v
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
rv[a.name] = cf(items)
|
||||||
|
except TypeError:
|
||||||
|
if not issubclass(cf, tuple):
|
||||||
|
raise
|
||||||
|
# Workaround for TypeError: cf.__new__() missing 1 required
|
||||||
|
# positional argument (which appears, for a namedturle)
|
||||||
|
rv[a.name] = cf(*items)
|
||||||
|
elif issubclass(value_type, dict):
|
||||||
|
df = dict_factory
|
||||||
|
rv[a.name] = df(
|
||||||
|
(
|
||||||
|
_asdict_anything(
|
||||||
|
kk,
|
||||||
|
is_key=True,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=df,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
),
|
||||||
|
_asdict_anything(
|
||||||
|
vv,
|
||||||
|
is_key=False,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=df,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
for kk, vv in v.items()
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
rv[a.name] = v
|
||||||
|
else:
|
||||||
|
rv[a.name] = v
|
||||||
|
return rv
|
||||||
|
|
||||||
|
|
||||||
|
def _asdict_anything(
|
||||||
|
val,
|
||||||
|
is_key,
|
||||||
|
filter,
|
||||||
|
dict_factory,
|
||||||
|
retain_collection_types,
|
||||||
|
value_serializer,
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
``asdict`` only works on attrs instances, this works on anything.
|
||||||
|
"""
|
||||||
|
val_type = type(val)
|
||||||
|
if val_type in _ATOMIC_TYPES:
|
||||||
|
rv = val
|
||||||
|
if value_serializer is not None:
|
||||||
|
rv = value_serializer(None, None, rv)
|
||||||
|
elif getattr(val_type, "__attrs_attrs__", None) is not None:
|
||||||
|
# Attrs class.
|
||||||
|
rv = asdict(
|
||||||
|
val,
|
||||||
|
recurse=True,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=dict_factory,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
)
|
||||||
|
elif issubclass(val_type, (tuple, list, set, frozenset)):
|
||||||
|
if retain_collection_types is True:
|
||||||
|
cf = val.__class__
|
||||||
|
elif is_key:
|
||||||
|
cf = tuple
|
||||||
|
else:
|
||||||
|
cf = list
|
||||||
|
|
||||||
|
rv = cf(
|
||||||
|
[
|
||||||
|
_asdict_anything(
|
||||||
|
i,
|
||||||
|
is_key=False,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=dict_factory,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
)
|
||||||
|
for i in val
|
||||||
|
]
|
||||||
|
)
|
||||||
|
elif issubclass(val_type, dict):
|
||||||
|
df = dict_factory
|
||||||
|
rv = df(
|
||||||
|
(
|
||||||
|
_asdict_anything(
|
||||||
|
kk,
|
||||||
|
is_key=True,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=df,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
),
|
||||||
|
_asdict_anything(
|
||||||
|
vv,
|
||||||
|
is_key=False,
|
||||||
|
filter=filter,
|
||||||
|
dict_factory=df,
|
||||||
|
retain_collection_types=retain_collection_types,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
for kk, vv in val.items()
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
rv = val
|
||||||
|
if value_serializer is not None:
|
||||||
|
rv = value_serializer(None, None, rv)
|
||||||
|
|
||||||
|
return rv
|
||||||
|
|
||||||
|
|
||||||
|
def astuple(
|
||||||
|
inst,
|
||||||
|
recurse=True,
|
||||||
|
filter=None,
|
||||||
|
tuple_factory=tuple,
|
||||||
|
retain_collection_types=False,
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
Return the *attrs* attribute values of *inst* as a tuple.
|
||||||
|
|
||||||
|
Optionally recurse into other *attrs*-decorated classes.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
inst: Instance of an *attrs*-decorated class.
|
||||||
|
|
||||||
|
recurse (bool):
|
||||||
|
Recurse into classes that are also *attrs*-decorated.
|
||||||
|
|
||||||
|
filter (~typing.Callable):
|
||||||
|
A callable whose return code determines whether an attribute or
|
||||||
|
element is included (`True`) or dropped (`False`). Is called with
|
||||||
|
the `attrs.Attribute` as the first argument and the value as the
|
||||||
|
second argument.
|
||||||
|
|
||||||
|
tuple_factory (~typing.Callable):
|
||||||
|
A callable to produce tuples from. For example, to produce lists
|
||||||
|
instead of tuples.
|
||||||
|
|
||||||
|
retain_collection_types (bool):
|
||||||
|
Do not convert to `list` or `dict` when encountering an attribute
|
||||||
|
which type is `tuple`, `dict` or `set`. Only meaningful if
|
||||||
|
*recurse* is `True`.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Return type of *tuple_factory*
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
attrs.exceptions.NotAnAttrsClassError:
|
||||||
|
If *cls* is not an *attrs* class.
|
||||||
|
|
||||||
|
.. versionadded:: 16.2.0
|
||||||
|
"""
|
||||||
|
attrs = fields(inst.__class__)
|
||||||
|
rv = []
|
||||||
|
retain = retain_collection_types # Very long. :/
|
||||||
|
for a in attrs:
|
||||||
|
v = getattr(inst, a.name)
|
||||||
|
if filter is not None and not filter(a, v):
|
||||||
|
continue
|
||||||
|
value_type = type(v)
|
||||||
|
if recurse is True:
|
||||||
|
if value_type in _ATOMIC_TYPES:
|
||||||
|
rv.append(v)
|
||||||
|
elif has(value_type):
|
||||||
|
rv.append(
|
||||||
|
astuple(
|
||||||
|
v,
|
||||||
|
recurse=True,
|
||||||
|
filter=filter,
|
||||||
|
tuple_factory=tuple_factory,
|
||||||
|
retain_collection_types=retain,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
elif issubclass(value_type, (tuple, list, set, frozenset)):
|
||||||
|
cf = v.__class__ if retain is True else list
|
||||||
|
items = [
|
||||||
|
(
|
||||||
|
astuple(
|
||||||
|
j,
|
||||||
|
recurse=True,
|
||||||
|
filter=filter,
|
||||||
|
tuple_factory=tuple_factory,
|
||||||
|
retain_collection_types=retain,
|
||||||
|
)
|
||||||
|
if has(j.__class__)
|
||||||
|
else j
|
||||||
|
)
|
||||||
|
for j in v
|
||||||
|
]
|
||||||
|
try:
|
||||||
|
rv.append(cf(items))
|
||||||
|
except TypeError:
|
||||||
|
if not issubclass(cf, tuple):
|
||||||
|
raise
|
||||||
|
# Workaround for TypeError: cf.__new__() missing 1 required
|
||||||
|
# positional argument (which appears, for a namedturle)
|
||||||
|
rv.append(cf(*items))
|
||||||
|
elif issubclass(value_type, dict):
|
||||||
|
df = value_type if retain is True else dict
|
||||||
|
rv.append(
|
||||||
|
df(
|
||||||
|
(
|
||||||
|
(
|
||||||
|
astuple(
|
||||||
|
kk,
|
||||||
|
tuple_factory=tuple_factory,
|
||||||
|
retain_collection_types=retain,
|
||||||
|
)
|
||||||
|
if has(kk.__class__)
|
||||||
|
else kk
|
||||||
|
),
|
||||||
|
(
|
||||||
|
astuple(
|
||||||
|
vv,
|
||||||
|
tuple_factory=tuple_factory,
|
||||||
|
retain_collection_types=retain,
|
||||||
|
)
|
||||||
|
if has(vv.__class__)
|
||||||
|
else vv
|
||||||
|
),
|
||||||
|
)
|
||||||
|
for kk, vv in v.items()
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
rv.append(v)
|
||||||
|
else:
|
||||||
|
rv.append(v)
|
||||||
|
|
||||||
|
return rv if tuple_factory is list else tuple_factory(rv)
|
||||||
|
|
||||||
|
|
||||||
|
def has(cls):
|
||||||
|
"""
|
||||||
|
Check whether *cls* is a class with *attrs* attributes.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cls (type): Class to introspect.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: If *cls* is not a class.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool:
|
||||||
|
"""
|
||||||
|
attrs = getattr(cls, "__attrs_attrs__", None)
|
||||||
|
if attrs is not None:
|
||||||
|
return True
|
||||||
|
|
||||||
|
# No attrs, maybe it's a specialized generic (A[str])?
|
||||||
|
generic_base = get_generic_base(cls)
|
||||||
|
if generic_base is not None:
|
||||||
|
generic_attrs = getattr(generic_base, "__attrs_attrs__", None)
|
||||||
|
if generic_attrs is not None:
|
||||||
|
# Stick it on here for speed next time.
|
||||||
|
cls.__attrs_attrs__ = generic_attrs
|
||||||
|
return generic_attrs is not None
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def assoc(inst, **changes):
|
||||||
|
"""
|
||||||
|
Copy *inst* and apply *changes*.
|
||||||
|
|
||||||
|
This is different from `evolve` that applies the changes to the arguments
|
||||||
|
that create the new instance.
|
||||||
|
|
||||||
|
`evolve`'s behavior is preferable, but there are `edge cases`_ where it
|
||||||
|
doesn't work. Therefore `assoc` is deprecated, but will not be removed.
|
||||||
|
|
||||||
|
.. _`edge cases`: https://github.com/python-attrs/attrs/issues/251
|
||||||
|
|
||||||
|
Args:
|
||||||
|
inst: Instance of a class with *attrs* attributes.
|
||||||
|
|
||||||
|
changes: Keyword changes in the new copy.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
A copy of inst with *changes* incorporated.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
attrs.exceptions.AttrsAttributeNotFoundError:
|
||||||
|
If *attr_name* couldn't be found on *cls*.
|
||||||
|
|
||||||
|
attrs.exceptions.NotAnAttrsClassError:
|
||||||
|
If *cls* is not an *attrs* class.
|
||||||
|
|
||||||
|
.. deprecated:: 17.1.0
|
||||||
|
Use `attrs.evolve` instead if you can. This function will not be
|
||||||
|
removed du to the slightly different approach compared to
|
||||||
|
`attrs.evolve`, though.
|
||||||
|
"""
|
||||||
|
new = copy.copy(inst)
|
||||||
|
attrs = fields(inst.__class__)
|
||||||
|
for k, v in changes.items():
|
||||||
|
a = getattr(attrs, k, NOTHING)
|
||||||
|
if a is NOTHING:
|
||||||
|
msg = f"{k} is not an attrs attribute on {new.__class__}."
|
||||||
|
raise AttrsAttributeNotFoundError(msg)
|
||||||
|
_OBJ_SETATTR(new, k, v)
|
||||||
|
return new
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_types(
|
||||||
|
cls, globalns=None, localns=None, attribs=None, include_extras=True
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
Resolve any strings and forward annotations in type annotations.
|
||||||
|
|
||||||
|
This is only required if you need concrete types in :class:`Attribute`'s
|
||||||
|
*type* field. In other words, you don't need to resolve your types if you
|
||||||
|
only use them for static type checking.
|
||||||
|
|
||||||
|
With no arguments, names will be looked up in the module in which the class
|
||||||
|
was created. If this is not what you want, for example, if the name only
|
||||||
|
exists inside a method, you may pass *globalns* or *localns* to specify
|
||||||
|
other dictionaries in which to look up these names. See the docs of
|
||||||
|
`typing.get_type_hints` for more details.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cls (type): Class to resolve.
|
||||||
|
|
||||||
|
globalns (dict | None): Dictionary containing global variables.
|
||||||
|
|
||||||
|
localns (dict | None): Dictionary containing local variables.
|
||||||
|
|
||||||
|
attribs (list | None):
|
||||||
|
List of attribs for the given class. This is necessary when calling
|
||||||
|
from inside a ``field_transformer`` since *cls* is not an *attrs*
|
||||||
|
class yet.
|
||||||
|
|
||||||
|
include_extras (bool):
|
||||||
|
Resolve more accurately, if possible. Pass ``include_extras`` to
|
||||||
|
``typing.get_hints``, if supported by the typing module. On
|
||||||
|
supported Python versions (3.9+), this resolves the types more
|
||||||
|
accurately.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: If *cls* is not a class.
|
||||||
|
|
||||||
|
attrs.exceptions.NotAnAttrsClassError:
|
||||||
|
If *cls* is not an *attrs* class and you didn't pass any attribs.
|
||||||
|
|
||||||
|
NameError: If types cannot be resolved because of missing variables.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
*cls* so you can use this function also as a class decorator. Please
|
||||||
|
note that you have to apply it **after** `attrs.define`. That means the
|
||||||
|
decorator has to come in the line **before** `attrs.define`.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
.. versionadded:: 21.1.0 *attribs*
|
||||||
|
.. versionadded:: 23.1.0 *include_extras*
|
||||||
|
"""
|
||||||
|
# Since calling get_type_hints is expensive we cache whether we've
|
||||||
|
# done it already.
|
||||||
|
if getattr(cls, "__attrs_types_resolved__", None) != cls:
|
||||||
|
import typing
|
||||||
|
|
||||||
|
kwargs = {
|
||||||
|
"globalns": globalns,
|
||||||
|
"localns": localns,
|
||||||
|
"include_extras": include_extras,
|
||||||
|
}
|
||||||
|
|
||||||
|
hints = typing.get_type_hints(cls, **kwargs)
|
||||||
|
for field in fields(cls) if attribs is None else attribs:
|
||||||
|
if field.name in hints:
|
||||||
|
# Since fields have been frozen we must work around it.
|
||||||
|
_OBJ_SETATTR(field, "type", hints[field.name])
|
||||||
|
# We store the class we resolved so that subclasses know they haven't
|
||||||
|
# been resolved.
|
||||||
|
cls.__attrs_types_resolved__ = cls
|
||||||
|
|
||||||
|
# Return the class so you can use it as a decorator too.
|
||||||
|
return cls
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,674 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""
|
||||||
|
These are keyword-only APIs that call `attr.s` and `attr.ib` with different
|
||||||
|
default values.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from functools import partial
|
||||||
|
|
||||||
|
from . import setters
|
||||||
|
from ._funcs import asdict as _asdict
|
||||||
|
from ._funcs import astuple as _astuple
|
||||||
|
from ._make import (
|
||||||
|
_DEFAULT_ON_SETATTR,
|
||||||
|
NOTHING,
|
||||||
|
_frozen_setattrs,
|
||||||
|
attrib,
|
||||||
|
attrs,
|
||||||
|
)
|
||||||
|
from .exceptions import NotAnAttrsClassError, UnannotatedAttributeError
|
||||||
|
|
||||||
|
|
||||||
|
def define(
|
||||||
|
maybe_cls=None,
|
||||||
|
*,
|
||||||
|
these=None,
|
||||||
|
repr=None,
|
||||||
|
unsafe_hash=None,
|
||||||
|
hash=None,
|
||||||
|
init=None,
|
||||||
|
slots=True,
|
||||||
|
frozen=False,
|
||||||
|
weakref_slot=True,
|
||||||
|
str=False,
|
||||||
|
auto_attribs=None,
|
||||||
|
kw_only=False,
|
||||||
|
cache_hash=False,
|
||||||
|
auto_exc=True,
|
||||||
|
eq=None,
|
||||||
|
order=False,
|
||||||
|
auto_detect=True,
|
||||||
|
getstate_setstate=None,
|
||||||
|
on_setattr=None,
|
||||||
|
field_transformer=None,
|
||||||
|
match_args=True,
|
||||||
|
force_kw_only=False,
|
||||||
|
):
|
||||||
|
r"""
|
||||||
|
A class decorator that adds :term:`dunder methods` according to
|
||||||
|
:term:`fields <field>` specified using :doc:`type annotations <types>`,
|
||||||
|
`field()` calls, or the *these* argument.
|
||||||
|
|
||||||
|
Since *attrs* patches or replaces an existing class, you cannot use
|
||||||
|
`object.__init_subclass__` with *attrs* classes, because it runs too early.
|
||||||
|
As a replacement, you can define ``__attrs_init_subclass__`` on your class.
|
||||||
|
It will be called by *attrs* classes that subclass it after they're
|
||||||
|
created. See also :ref:`init-subclass`.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
slots (bool):
|
||||||
|
Create a :term:`slotted class <slotted classes>` that's more
|
||||||
|
memory-efficient. Slotted classes are generally superior to the
|
||||||
|
default dict classes, but have some gotchas you should know about,
|
||||||
|
so we encourage you to read the :term:`glossary entry <slotted
|
||||||
|
classes>`.
|
||||||
|
|
||||||
|
auto_detect (bool):
|
||||||
|
Instead of setting the *init*, *repr*, *eq*, and *hash* arguments
|
||||||
|
explicitly, assume they are set to True **unless any** of the
|
||||||
|
involved methods for one of the arguments is implemented in the
|
||||||
|
*current* class (meaning, it is *not* inherited from some base
|
||||||
|
class).
|
||||||
|
|
||||||
|
So, for example by implementing ``__eq__`` on a class yourself,
|
||||||
|
*attrs* will deduce ``eq=False`` and will create *neither*
|
||||||
|
``__eq__`` *nor* ``__ne__`` (but Python classes come with a
|
||||||
|
sensible ``__ne__`` by default, so it *should* be enough to only
|
||||||
|
implement ``__eq__`` in most cases).
|
||||||
|
|
||||||
|
Passing :data:`True` or :data:`False` to *init*, *repr*, *eq*, or *hash*
|
||||||
|
overrides whatever *auto_detect* would determine.
|
||||||
|
|
||||||
|
auto_exc (bool):
|
||||||
|
If the class subclasses `BaseException` (which implicitly includes
|
||||||
|
any subclass of any exception), the following happens to behave
|
||||||
|
like a well-behaved Python exception class:
|
||||||
|
|
||||||
|
- the values for *eq*, *order*, and *hash* are ignored and the
|
||||||
|
instances compare and hash by the instance's ids [#]_ ,
|
||||||
|
- all attributes that are either passed into ``__init__`` or have a
|
||||||
|
default value are additionally available as a tuple in the
|
||||||
|
``args`` attribute,
|
||||||
|
- the value of *str* is ignored leaving ``__str__`` to base
|
||||||
|
classes.
|
||||||
|
|
||||||
|
.. [#]
|
||||||
|
Note that *attrs* will *not* remove existing implementations of
|
||||||
|
``__hash__`` or the equality methods. It just won't add own
|
||||||
|
ones.
|
||||||
|
|
||||||
|
on_setattr (~typing.Callable | list[~typing.Callable] | None | ~typing.Literal[attrs.setters.NO_OP]):
|
||||||
|
A callable that is run whenever the user attempts to set an
|
||||||
|
attribute (either by assignment like ``i.x = 42`` or by using
|
||||||
|
`setattr` like ``setattr(i, "x", 42)``). It receives the same
|
||||||
|
arguments as validators: the instance, the attribute that is being
|
||||||
|
modified, and the new value.
|
||||||
|
|
||||||
|
If no exception is raised, the attribute is set to the return value
|
||||||
|
of the callable.
|
||||||
|
|
||||||
|
If a list of callables is passed, they're automatically wrapped in
|
||||||
|
an `attrs.setters.pipe`.
|
||||||
|
|
||||||
|
If left None, the default behavior is to run converters and
|
||||||
|
validators whenever an attribute is set.
|
||||||
|
|
||||||
|
init (bool):
|
||||||
|
Create a ``__init__`` method that initializes the *attrs*
|
||||||
|
attributes. Leading underscores are stripped for the argument name,
|
||||||
|
unless an alias is set on the attribute.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
`init` shows advanced ways to customize the generated
|
||||||
|
``__init__`` method, including executing code before and after.
|
||||||
|
|
||||||
|
repr(bool):
|
||||||
|
Create a ``__repr__`` method with a human readable representation
|
||||||
|
of *attrs* attributes.
|
||||||
|
|
||||||
|
str (bool):
|
||||||
|
Create a ``__str__`` method that is identical to ``__repr__``. This
|
||||||
|
is usually not necessary except for `Exception`\ s.
|
||||||
|
|
||||||
|
eq (bool | None):
|
||||||
|
If True or None (default), add ``__eq__`` and ``__ne__`` methods
|
||||||
|
that check two instances for equality.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
`comparison` describes how to customize the comparison behavior
|
||||||
|
going as far comparing NumPy arrays.
|
||||||
|
|
||||||
|
order (bool | None):
|
||||||
|
If True, add ``__lt__``, ``__le__``, ``__gt__``, and ``__ge__``
|
||||||
|
methods that behave like *eq* above and allow instances to be
|
||||||
|
ordered.
|
||||||
|
|
||||||
|
They compare the instances as if they were tuples of their *attrs*
|
||||||
|
attributes if and only if the types of both classes are
|
||||||
|
*identical*.
|
||||||
|
|
||||||
|
If `None` mirror value of *eq*.
|
||||||
|
|
||||||
|
.. seealso:: `comparison`
|
||||||
|
|
||||||
|
unsafe_hash (bool | None):
|
||||||
|
If None (default), the ``__hash__`` method is generated according
|
||||||
|
how *eq* and *frozen* are set.
|
||||||
|
|
||||||
|
1. If *both* are True, *attrs* will generate a ``__hash__`` for
|
||||||
|
you.
|
||||||
|
2. If *eq* is True and *frozen* is False, ``__hash__`` will be set
|
||||||
|
to None, marking it unhashable (which it is).
|
||||||
|
3. If *eq* is False, ``__hash__`` will be left untouched meaning
|
||||||
|
the ``__hash__`` method of the base class will be used. If the
|
||||||
|
base class is `object`, this means it will fall back to id-based
|
||||||
|
hashing.
|
||||||
|
|
||||||
|
Although not recommended, you can decide for yourself and force
|
||||||
|
*attrs* to create one (for example, if the class is immutable even
|
||||||
|
though you didn't freeze it programmatically) by passing True or
|
||||||
|
not. Both of these cases are rather special and should be used
|
||||||
|
carefully.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
- Our documentation on `hashing`,
|
||||||
|
- Python's documentation on `object.__hash__`,
|
||||||
|
- and the `GitHub issue that led to the default \ behavior
|
||||||
|
<https://github.com/python-attrs/attrs/issues/136>`_ for more
|
||||||
|
details.
|
||||||
|
|
||||||
|
hash (bool | None):
|
||||||
|
Deprecated alias for *unsafe_hash*. *unsafe_hash* takes precedence.
|
||||||
|
|
||||||
|
cache_hash (bool):
|
||||||
|
Ensure that the object's hash code is computed only once and stored
|
||||||
|
on the object. If this is set to True, hashing must be either
|
||||||
|
explicitly or implicitly enabled for this class. If the hash code
|
||||||
|
is cached, avoid any reassignments of fields involved in hash code
|
||||||
|
computation or mutations of the objects those fields point to after
|
||||||
|
object creation. If such changes occur, the behavior of the
|
||||||
|
object's hash code is undefined.
|
||||||
|
|
||||||
|
frozen (bool):
|
||||||
|
Make instances immutable after initialization. If someone attempts
|
||||||
|
to modify a frozen instance, `attrs.exceptions.FrozenInstanceError`
|
||||||
|
is raised.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
1. This is achieved by installing a custom ``__setattr__``
|
||||||
|
method on your class, so you can't implement your own.
|
||||||
|
|
||||||
|
2. True immutability is impossible in Python.
|
||||||
|
|
||||||
|
3. This *does* have a minor a runtime performance `impact
|
||||||
|
<how-frozen>` when initializing new instances. In other
|
||||||
|
words: ``__init__`` is slightly slower with ``frozen=True``.
|
||||||
|
|
||||||
|
4. If a class is frozen, you cannot modify ``self`` in
|
||||||
|
``__attrs_post_init__`` or a self-written ``__init__``. You
|
||||||
|
can circumvent that limitation by using
|
||||||
|
``object.__setattr__(self, "attribute_name", value)``.
|
||||||
|
|
||||||
|
5. Subclasses of a frozen class are frozen too.
|
||||||
|
|
||||||
|
kw_only (bool):
|
||||||
|
Make attributes keyword-only in the generated ``__init__`` (if
|
||||||
|
*init* is False, this parameter is ignored). Attributes that
|
||||||
|
explicitly set ``kw_only=False`` are not affected; base class
|
||||||
|
attributes are also not affected.
|
||||||
|
|
||||||
|
Also see *force_kw_only*.
|
||||||
|
|
||||||
|
weakref_slot (bool):
|
||||||
|
Make instances weak-referenceable. This has no effect unless
|
||||||
|
*slots* is True.
|
||||||
|
|
||||||
|
field_transformer (~typing.Callable | None):
|
||||||
|
A function that is called with the original class object and all
|
||||||
|
fields right before *attrs* finalizes the class. You can use this,
|
||||||
|
for example, to automatically add converters or validators to
|
||||||
|
fields based on their types.
|
||||||
|
|
||||||
|
.. seealso:: `transform-fields`
|
||||||
|
|
||||||
|
match_args (bool):
|
||||||
|
If True (default), set ``__match_args__`` on the class to support
|
||||||
|
:pep:`634` (*Structural Pattern Matching*). It is a tuple of all
|
||||||
|
non-keyword-only ``__init__`` parameter names on Python 3.10 and
|
||||||
|
later. Ignored on older Python versions.
|
||||||
|
|
||||||
|
collect_by_mro (bool):
|
||||||
|
If True, *attrs* collects attributes from base classes correctly
|
||||||
|
according to the `method resolution order
|
||||||
|
<https://docs.python.org/3/howto/mro.html>`_. If False, *attrs*
|
||||||
|
will mimic the (wrong) behavior of `dataclasses` and :pep:`681`.
|
||||||
|
|
||||||
|
See also `issue #428
|
||||||
|
<https://github.com/python-attrs/attrs/issues/428>`_.
|
||||||
|
|
||||||
|
force_kw_only (bool):
|
||||||
|
A back-compat flag for restoring pre-25.4.0 behavior. If True and
|
||||||
|
``kw_only=True``, all attributes are made keyword-only, including
|
||||||
|
base class attributes, and those set to ``kw_only=False`` at the
|
||||||
|
attribute level. Defaults to False.
|
||||||
|
|
||||||
|
See also `issue #980
|
||||||
|
<https://github.com/python-attrs/attrs/issues/980>`_.
|
||||||
|
|
||||||
|
getstate_setstate (bool | None):
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
This is usually only interesting for slotted classes and you
|
||||||
|
should probably just set *auto_detect* to True.
|
||||||
|
|
||||||
|
If True, ``__getstate__`` and ``__setstate__`` are generated and
|
||||||
|
attached to the class. This is necessary for slotted classes to be
|
||||||
|
pickleable. If left None, it's True by default for slotted classes
|
||||||
|
and False for dict classes.
|
||||||
|
|
||||||
|
If *auto_detect* is True, and *getstate_setstate* is left None, and
|
||||||
|
**either** ``__getstate__`` or ``__setstate__`` is detected
|
||||||
|
directly on the class (meaning: not inherited), it is set to False
|
||||||
|
(this is usually what you want).
|
||||||
|
|
||||||
|
auto_attribs (bool | None):
|
||||||
|
If True, look at type annotations to determine which attributes to
|
||||||
|
use, like `dataclasses`. If False, it will only look for explicit
|
||||||
|
:func:`field` class attributes, like classic *attrs*.
|
||||||
|
|
||||||
|
If left None, it will guess:
|
||||||
|
|
||||||
|
1. If any attributes are annotated and no unannotated
|
||||||
|
`attrs.field`\ s are found, it assumes *auto_attribs=True*.
|
||||||
|
2. Otherwise it assumes *auto_attribs=False* and tries to collect
|
||||||
|
`attrs.field`\ s.
|
||||||
|
|
||||||
|
If *attrs* decides to look at type annotations, **all** fields
|
||||||
|
**must** be annotated. If *attrs* encounters a field that is set to
|
||||||
|
a :func:`field` / `attr.ib` but lacks a type annotation, an
|
||||||
|
`attrs.exceptions.UnannotatedAttributeError` is raised. Use
|
||||||
|
``field_name: typing.Any = field(...)`` if you don't want to set a
|
||||||
|
type.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
For features that use the attribute name to create decorators
|
||||||
|
(for example, :ref:`validators <validators>`), you still *must*
|
||||||
|
assign :func:`field` / `attr.ib` to them. Otherwise Python will
|
||||||
|
either not find the name or try to use the default value to
|
||||||
|
call, for example, ``validator`` on it.
|
||||||
|
|
||||||
|
Attributes annotated as `typing.ClassVar`, and attributes that are
|
||||||
|
neither annotated nor set to an `field()` are **ignored**.
|
||||||
|
|
||||||
|
these (dict[str, object]):
|
||||||
|
A dictionary of name to the (private) return value of `field()`
|
||||||
|
mappings. This is useful to avoid the definition of your attributes
|
||||||
|
within the class body because you can't (for example, if you want
|
||||||
|
to add ``__repr__`` methods to Django models) or don't want to.
|
||||||
|
|
||||||
|
If *these* is not `None`, *attrs* will *not* search the class body
|
||||||
|
for attributes and will *not* remove any attributes from it.
|
||||||
|
|
||||||
|
The order is deduced from the order of the attributes inside
|
||||||
|
*these*.
|
||||||
|
|
||||||
|
Arguably, this is a rather obscure feature.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
.. versionchanged:: 21.3.0 Converters are also run ``on_setattr``.
|
||||||
|
.. versionadded:: 22.2.0
|
||||||
|
*unsafe_hash* as an alias for *hash* (for :pep:`681` compliance).
|
||||||
|
.. versionchanged:: 24.1.0
|
||||||
|
Instances are not compared as tuples of attributes anymore, but using a
|
||||||
|
big ``and`` condition. This is faster and has more correct behavior for
|
||||||
|
uncomparable values like `math.nan`.
|
||||||
|
.. versionadded:: 24.1.0
|
||||||
|
If a class has an *inherited* classmethod called
|
||||||
|
``__attrs_init_subclass__``, it is executed after the class is created.
|
||||||
|
.. deprecated:: 24.1.0 *hash* is deprecated in favor of *unsafe_hash*.
|
||||||
|
.. versionadded:: 24.3.0
|
||||||
|
Unless already present, a ``__replace__`` method is automatically
|
||||||
|
created for `copy.replace` (Python 3.13+ only).
|
||||||
|
.. versionchanged:: 25.4.0
|
||||||
|
*kw_only* now only applies to attributes defined in the current class,
|
||||||
|
and respects attribute-level ``kw_only=False`` settings.
|
||||||
|
.. versionadded:: 25.4.0
|
||||||
|
Added *force_kw_only* to go back to the previous *kw_only* behavior.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
The main differences to the classic `attr.s` are:
|
||||||
|
|
||||||
|
- Automatically detect whether or not *auto_attribs* should be `True`
|
||||||
|
(c.f. *auto_attribs* parameter).
|
||||||
|
- Converters and validators run when attributes are set by default --
|
||||||
|
if *frozen* is `False`.
|
||||||
|
- *slots=True*
|
||||||
|
|
||||||
|
Usually, this has only upsides and few visible effects in everyday
|
||||||
|
programming. But it *can* lead to some surprising behaviors, so
|
||||||
|
please make sure to read :term:`slotted classes`.
|
||||||
|
|
||||||
|
- *auto_exc=True*
|
||||||
|
- *auto_detect=True*
|
||||||
|
- *order=False*
|
||||||
|
- *force_kw_only=False*
|
||||||
|
- Some options that were only relevant on Python 2 or were kept around
|
||||||
|
for backwards-compatibility have been removed.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
def do_it(cls, auto_attribs):
|
||||||
|
return attrs(
|
||||||
|
maybe_cls=cls,
|
||||||
|
these=these,
|
||||||
|
repr=repr,
|
||||||
|
hash=hash,
|
||||||
|
unsafe_hash=unsafe_hash,
|
||||||
|
init=init,
|
||||||
|
slots=slots,
|
||||||
|
frozen=frozen,
|
||||||
|
weakref_slot=weakref_slot,
|
||||||
|
str=str,
|
||||||
|
auto_attribs=auto_attribs,
|
||||||
|
kw_only=kw_only,
|
||||||
|
cache_hash=cache_hash,
|
||||||
|
auto_exc=auto_exc,
|
||||||
|
eq=eq,
|
||||||
|
order=order,
|
||||||
|
auto_detect=auto_detect,
|
||||||
|
collect_by_mro=True,
|
||||||
|
getstate_setstate=getstate_setstate,
|
||||||
|
on_setattr=on_setattr,
|
||||||
|
field_transformer=field_transformer,
|
||||||
|
match_args=match_args,
|
||||||
|
force_kw_only=force_kw_only,
|
||||||
|
)
|
||||||
|
|
||||||
|
def wrap(cls):
|
||||||
|
"""
|
||||||
|
Making this a wrapper ensures this code runs during class creation.
|
||||||
|
|
||||||
|
We also ensure that frozen-ness of classes is inherited.
|
||||||
|
"""
|
||||||
|
nonlocal frozen, on_setattr
|
||||||
|
|
||||||
|
had_on_setattr = on_setattr not in (None, setters.NO_OP)
|
||||||
|
|
||||||
|
# By default, mutable classes convert & validate on setattr.
|
||||||
|
if frozen is False and on_setattr is None:
|
||||||
|
on_setattr = _DEFAULT_ON_SETATTR
|
||||||
|
|
||||||
|
# However, if we subclass a frozen class, we inherit the immutability
|
||||||
|
# and disable on_setattr.
|
||||||
|
for base_cls in cls.__bases__:
|
||||||
|
if base_cls.__setattr__ is _frozen_setattrs:
|
||||||
|
if had_on_setattr:
|
||||||
|
msg = "Frozen classes can't use on_setattr (frozen-ness was inherited)."
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
on_setattr = setters.NO_OP
|
||||||
|
break
|
||||||
|
|
||||||
|
if auto_attribs is not None:
|
||||||
|
return do_it(cls, auto_attribs)
|
||||||
|
|
||||||
|
try:
|
||||||
|
return do_it(cls, True)
|
||||||
|
except UnannotatedAttributeError:
|
||||||
|
return do_it(cls, False)
|
||||||
|
|
||||||
|
# maybe_cls's type depends on the usage of the decorator. It's a class
|
||||||
|
# if it's used as `@attrs` but `None` if used as `@attrs()`.
|
||||||
|
if maybe_cls is None:
|
||||||
|
return wrap
|
||||||
|
|
||||||
|
return wrap(maybe_cls)
|
||||||
|
|
||||||
|
|
||||||
|
mutable = define
|
||||||
|
frozen = partial(define, frozen=True, on_setattr=None)
|
||||||
|
|
||||||
|
|
||||||
|
def field(
|
||||||
|
*,
|
||||||
|
default=NOTHING,
|
||||||
|
validator=None,
|
||||||
|
repr=True,
|
||||||
|
hash=None,
|
||||||
|
init=True,
|
||||||
|
metadata=None,
|
||||||
|
type=None,
|
||||||
|
converter=None,
|
||||||
|
factory=None,
|
||||||
|
kw_only=None,
|
||||||
|
eq=None,
|
||||||
|
order=None,
|
||||||
|
on_setattr=None,
|
||||||
|
alias=None,
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
Create a new :term:`field` / :term:`attribute` on a class.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
Does **nothing** unless the class is also decorated with
|
||||||
|
`attrs.define` (or similar)!
|
||||||
|
|
||||||
|
Args:
|
||||||
|
default:
|
||||||
|
A value that is used if an *attrs*-generated ``__init__`` is used
|
||||||
|
and no value is passed while instantiating or the attribute is
|
||||||
|
excluded using ``init=False``.
|
||||||
|
|
||||||
|
If the value is an instance of `attrs.Factory`, its callable will
|
||||||
|
be used to construct a new value (useful for mutable data types
|
||||||
|
like lists or dicts).
|
||||||
|
|
||||||
|
If a default is not set (or set manually to `attrs.NOTHING`), a
|
||||||
|
value *must* be supplied when instantiating; otherwise a
|
||||||
|
`TypeError` will be raised.
|
||||||
|
|
||||||
|
.. seealso:: `defaults`
|
||||||
|
|
||||||
|
factory (~typing.Callable):
|
||||||
|
Syntactic sugar for ``default=attr.Factory(factory)``.
|
||||||
|
|
||||||
|
validator (~typing.Callable | list[~typing.Callable]):
|
||||||
|
Callable that is called by *attrs*-generated ``__init__`` methods
|
||||||
|
after the instance has been initialized. They receive the
|
||||||
|
initialized instance, the :func:`~attrs.Attribute`, and the passed
|
||||||
|
value.
|
||||||
|
|
||||||
|
The return value is *not* inspected so the validator has to throw
|
||||||
|
an exception itself.
|
||||||
|
|
||||||
|
If a `list` is passed, its items are treated as validators and must
|
||||||
|
all pass.
|
||||||
|
|
||||||
|
Validators can be globally disabled and re-enabled using
|
||||||
|
`attrs.validators.get_disabled` / `attrs.validators.set_disabled`.
|
||||||
|
|
||||||
|
The validator can also be set using decorator notation as shown
|
||||||
|
below.
|
||||||
|
|
||||||
|
.. seealso:: :ref:`validators`
|
||||||
|
|
||||||
|
repr (bool | ~typing.Callable):
|
||||||
|
Include this attribute in the generated ``__repr__`` method. If
|
||||||
|
True, include the attribute; if False, omit it. By default, the
|
||||||
|
built-in ``repr()`` function is used. To override how the attribute
|
||||||
|
value is formatted, pass a ``callable`` that takes a single value
|
||||||
|
and returns a string. Note that the resulting string is used as-is,
|
||||||
|
which means it will be used directly *instead* of calling
|
||||||
|
``repr()`` (the default).
|
||||||
|
|
||||||
|
eq (bool | ~typing.Callable):
|
||||||
|
If True (default), include this attribute in the generated
|
||||||
|
``__eq__`` and ``__ne__`` methods that check two instances for
|
||||||
|
equality. To override how the attribute value is compared, pass a
|
||||||
|
callable that takes a single value and returns the value to be
|
||||||
|
compared.
|
||||||
|
|
||||||
|
.. seealso:: `comparison`
|
||||||
|
|
||||||
|
order (bool | ~typing.Callable):
|
||||||
|
If True (default), include this attributes in the generated
|
||||||
|
``__lt__``, ``__le__``, ``__gt__`` and ``__ge__`` methods. To
|
||||||
|
override how the attribute value is ordered, pass a callable that
|
||||||
|
takes a single value and returns the value to be ordered.
|
||||||
|
|
||||||
|
.. seealso:: `comparison`
|
||||||
|
|
||||||
|
hash (bool | None):
|
||||||
|
Include this attribute in the generated ``__hash__`` method. If
|
||||||
|
None (default), mirror *eq*'s value. This is the correct behavior
|
||||||
|
according the Python spec. Setting this value to anything else
|
||||||
|
than None is *discouraged*.
|
||||||
|
|
||||||
|
.. seealso:: `hashing`
|
||||||
|
|
||||||
|
init (bool):
|
||||||
|
Include this attribute in the generated ``__init__`` method.
|
||||||
|
|
||||||
|
It is possible to set this to False and set a default value. In
|
||||||
|
that case this attributed is unconditionally initialized with the
|
||||||
|
specified default value or factory.
|
||||||
|
|
||||||
|
.. seealso:: `init`
|
||||||
|
|
||||||
|
converter (typing.Callable | Converter):
|
||||||
|
A callable that is called by *attrs*-generated ``__init__`` methods
|
||||||
|
to convert attribute's value to the desired format.
|
||||||
|
|
||||||
|
If a vanilla callable is passed, it is given the passed-in value as
|
||||||
|
the only positional argument. It is possible to receive additional
|
||||||
|
arguments by wrapping the callable in a `Converter`.
|
||||||
|
|
||||||
|
Either way, the returned value will be used as the new value of the
|
||||||
|
attribute. The value is converted before being passed to the
|
||||||
|
validator, if any.
|
||||||
|
|
||||||
|
.. seealso:: :ref:`converters`
|
||||||
|
|
||||||
|
metadata (dict | None):
|
||||||
|
An arbitrary mapping, to be used by third-party code.
|
||||||
|
|
||||||
|
.. seealso:: `extending-metadata`.
|
||||||
|
|
||||||
|
type (type):
|
||||||
|
The type of the attribute. Nowadays, the preferred method to
|
||||||
|
specify the type is using a variable annotation (see :pep:`526`).
|
||||||
|
This argument is provided for backwards-compatibility and for usage
|
||||||
|
with `make_class`. Regardless of the approach used, the type will
|
||||||
|
be stored on ``Attribute.type``.
|
||||||
|
|
||||||
|
Please note that *attrs* doesn't do anything with this metadata by
|
||||||
|
itself. You can use it as part of your own code or for `static type
|
||||||
|
checking <types>`.
|
||||||
|
|
||||||
|
kw_only (bool | None):
|
||||||
|
Make this attribute keyword-only in the generated ``__init__`` (if
|
||||||
|
*init* is False, this parameter is ignored). If None (default),
|
||||||
|
mirror the setting from `attrs.define`.
|
||||||
|
|
||||||
|
on_setattr (~typing.Callable | list[~typing.Callable] | None | ~typing.Literal[attrs.setters.NO_OP]):
|
||||||
|
Allows to overwrite the *on_setattr* setting from `attr.s`. If left
|
||||||
|
None, the *on_setattr* value from `attr.s` is used. Set to
|
||||||
|
`attrs.setters.NO_OP` to run **no** `setattr` hooks for this
|
||||||
|
attribute -- regardless of the setting in `define()`.
|
||||||
|
|
||||||
|
alias (str | None):
|
||||||
|
Override this attribute's parameter name in the generated
|
||||||
|
``__init__`` method. If left None, default to ``name`` stripped
|
||||||
|
of leading underscores. See `private-attributes`.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
.. versionchanged:: 21.1.0
|
||||||
|
*eq*, *order*, and *cmp* also accept a custom callable
|
||||||
|
.. versionadded:: 22.2.0 *alias*
|
||||||
|
.. versionadded:: 23.1.0
|
||||||
|
The *type* parameter has been re-added; mostly for `attrs.make_class`.
|
||||||
|
Please note that type checkers ignore this metadata.
|
||||||
|
.. versionchanged:: 25.4.0
|
||||||
|
*kw_only* can now be None, and its default is also changed from False to
|
||||||
|
None.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
`attr.ib`
|
||||||
|
"""
|
||||||
|
return attrib(
|
||||||
|
default=default,
|
||||||
|
validator=validator,
|
||||||
|
repr=repr,
|
||||||
|
hash=hash,
|
||||||
|
init=init,
|
||||||
|
metadata=metadata,
|
||||||
|
type=type,
|
||||||
|
converter=converter,
|
||||||
|
factory=factory,
|
||||||
|
kw_only=kw_only,
|
||||||
|
eq=eq,
|
||||||
|
order=order,
|
||||||
|
on_setattr=on_setattr,
|
||||||
|
alias=alias,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def asdict(inst, *, recurse=True, filter=None, value_serializer=None):
|
||||||
|
"""
|
||||||
|
Same as `attr.asdict`, except that collections types are always retained
|
||||||
|
and dict is always used as *dict_factory*.
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return _asdict(
|
||||||
|
inst=inst,
|
||||||
|
recurse=recurse,
|
||||||
|
filter=filter,
|
||||||
|
value_serializer=value_serializer,
|
||||||
|
retain_collection_types=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def astuple(inst, *, recurse=True, filter=None):
|
||||||
|
"""
|
||||||
|
Same as `attr.astuple`, except that collections types are always retained
|
||||||
|
and `tuple` is always used as the *tuple_factory*.
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return _astuple(
|
||||||
|
inst=inst, recurse=recurse, filter=filter, retain_collection_types=True
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def inspect(cls):
|
||||||
|
"""
|
||||||
|
Inspect the class and return its effective build parameters.
|
||||||
|
|
||||||
|
Warning:
|
||||||
|
This feature is currently **experimental** and is not covered by our
|
||||||
|
strict backwards-compatibility guarantees.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cls: The *attrs*-decorated class to inspect.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
The effective build parameters of the class.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
NotAnAttrsClassError: If the class is not an *attrs*-decorated class.
|
||||||
|
|
||||||
|
.. versionadded:: 25.4.0
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return cls.__dict__["__attrs_props__"]
|
||||||
|
except KeyError:
|
||||||
|
msg = f"{cls!r} is not an attrs-decorated class."
|
||||||
|
raise NotAnAttrsClassError(msg) from None
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
from typing import Any, ClassVar, Protocol
|
||||||
|
|
||||||
|
# MYPY is a special constant in mypy which works the same way as `TYPE_CHECKING`.
|
||||||
|
MYPY = False
|
||||||
|
|
||||||
|
if MYPY:
|
||||||
|
# A protocol to be able to statically accept an attrs class.
|
||||||
|
class AttrsInstance_(Protocol):
|
||||||
|
__attrs_attrs__: ClassVar[Any]
|
||||||
|
|
||||||
|
else:
|
||||||
|
# For type checkers without plug-in support use an empty protocol that
|
||||||
|
# will (hopefully) be combined into a union.
|
||||||
|
class AttrsInstance_(Protocol):
|
||||||
|
pass
|
||||||
|
|
@ -0,0 +1,89 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
|
||||||
|
from functools import total_ordering
|
||||||
|
|
||||||
|
from ._funcs import astuple
|
||||||
|
from ._make import attrib, attrs
|
||||||
|
|
||||||
|
|
||||||
|
@total_ordering
|
||||||
|
@attrs(eq=False, order=False, slots=True, frozen=True)
|
||||||
|
class VersionInfo:
|
||||||
|
"""
|
||||||
|
A version object that can be compared to tuple of length 1--4:
|
||||||
|
|
||||||
|
>>> attr.VersionInfo(19, 1, 0, "final") <= (19, 2)
|
||||||
|
True
|
||||||
|
>>> attr.VersionInfo(19, 1, 0, "final") < (19, 1, 1)
|
||||||
|
True
|
||||||
|
>>> vi = attr.VersionInfo(19, 2, 0, "final")
|
||||||
|
>>> vi < (19, 1, 1)
|
||||||
|
False
|
||||||
|
>>> vi < (19,)
|
||||||
|
False
|
||||||
|
>>> vi == (19, 2,)
|
||||||
|
True
|
||||||
|
>>> vi == (19, 2, 1)
|
||||||
|
False
|
||||||
|
|
||||||
|
.. versionadded:: 19.2
|
||||||
|
"""
|
||||||
|
|
||||||
|
year = attrib(type=int)
|
||||||
|
minor = attrib(type=int)
|
||||||
|
micro = attrib(type=int)
|
||||||
|
releaselevel = attrib(type=str)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _from_version_string(cls, s):
|
||||||
|
"""
|
||||||
|
Parse *s* and return a _VersionInfo.
|
||||||
|
"""
|
||||||
|
v = s.split(".")
|
||||||
|
if len(v) == 3:
|
||||||
|
v.append("final")
|
||||||
|
|
||||||
|
return cls(
|
||||||
|
year=int(v[0]), minor=int(v[1]), micro=int(v[2]), releaselevel=v[3]
|
||||||
|
)
|
||||||
|
|
||||||
|
def _ensure_tuple(self, other):
|
||||||
|
"""
|
||||||
|
Ensure *other* is a tuple of a valid length.
|
||||||
|
|
||||||
|
Returns a possibly transformed *other* and ourselves as a tuple of
|
||||||
|
the same length as *other*.
|
||||||
|
"""
|
||||||
|
|
||||||
|
if self.__class__ is other.__class__:
|
||||||
|
other = astuple(other)
|
||||||
|
|
||||||
|
if not isinstance(other, tuple):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
if not (1 <= len(other) <= 4):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
return astuple(self)[: len(other)], other
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
try:
|
||||||
|
us, them = self._ensure_tuple(other)
|
||||||
|
except NotImplementedError:
|
||||||
|
return NotImplemented
|
||||||
|
|
||||||
|
return us == them
|
||||||
|
|
||||||
|
def __lt__(self, other):
|
||||||
|
try:
|
||||||
|
us, them = self._ensure_tuple(other)
|
||||||
|
except NotImplementedError:
|
||||||
|
return NotImplemented
|
||||||
|
|
||||||
|
# Since alphabetically "dev0" < "final" < "post1" < "post2", we don't
|
||||||
|
# have to do anything special with releaselevel for now.
|
||||||
|
return us < them
|
||||||
|
|
||||||
|
def __hash__(self):
|
||||||
|
return hash((self.year, self.minor, self.micro, self.releaselevel))
|
||||||
|
|
@ -0,0 +1,9 @@
|
||||||
|
class VersionInfo:
|
||||||
|
@property
|
||||||
|
def year(self) -> int: ...
|
||||||
|
@property
|
||||||
|
def minor(self) -> int: ...
|
||||||
|
@property
|
||||||
|
def micro(self) -> int: ...
|
||||||
|
@property
|
||||||
|
def releaselevel(self) -> str: ...
|
||||||
|
|
@ -0,0 +1,162 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""
|
||||||
|
Commonly useful converters.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import typing
|
||||||
|
|
||||||
|
from ._compat import _AnnotationExtractor
|
||||||
|
from ._make import NOTHING, Converter, Factory, pipe
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"default_if_none",
|
||||||
|
"optional",
|
||||||
|
"pipe",
|
||||||
|
"to_bool",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def optional(converter):
|
||||||
|
"""
|
||||||
|
A converter that allows an attribute to be optional. An optional attribute
|
||||||
|
is one which can be set to `None`.
|
||||||
|
|
||||||
|
Type annotations will be inferred from the wrapped converter's, if it has
|
||||||
|
any.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
converter (typing.Callable):
|
||||||
|
the converter that is used for non-`None` values.
|
||||||
|
|
||||||
|
.. versionadded:: 17.1.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
if isinstance(converter, Converter):
|
||||||
|
|
||||||
|
def optional_converter(val, inst, field):
|
||||||
|
if val is None:
|
||||||
|
return None
|
||||||
|
return converter(val, inst, field)
|
||||||
|
|
||||||
|
else:
|
||||||
|
|
||||||
|
def optional_converter(val):
|
||||||
|
if val is None:
|
||||||
|
return None
|
||||||
|
return converter(val)
|
||||||
|
|
||||||
|
xtr = _AnnotationExtractor(converter)
|
||||||
|
|
||||||
|
t = xtr.get_first_param_type()
|
||||||
|
if t:
|
||||||
|
optional_converter.__annotations__["val"] = typing.Optional[t]
|
||||||
|
|
||||||
|
rt = xtr.get_return_type()
|
||||||
|
if rt:
|
||||||
|
optional_converter.__annotations__["return"] = typing.Optional[rt]
|
||||||
|
|
||||||
|
if isinstance(converter, Converter):
|
||||||
|
return Converter(optional_converter, takes_self=True, takes_field=True)
|
||||||
|
|
||||||
|
return optional_converter
|
||||||
|
|
||||||
|
|
||||||
|
def default_if_none(default=NOTHING, factory=None):
|
||||||
|
"""
|
||||||
|
A converter that allows to replace `None` values by *default* or the result
|
||||||
|
of *factory*.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
default:
|
||||||
|
Value to be used if `None` is passed. Passing an instance of
|
||||||
|
`attrs.Factory` is supported, however the ``takes_self`` option is
|
||||||
|
*not*.
|
||||||
|
|
||||||
|
factory (typing.Callable):
|
||||||
|
A callable that takes no parameters whose result is used if `None`
|
||||||
|
is passed.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: If **neither** *default* or *factory* is passed.
|
||||||
|
|
||||||
|
TypeError: If **both** *default* and *factory* are passed.
|
||||||
|
|
||||||
|
ValueError:
|
||||||
|
If an instance of `attrs.Factory` is passed with
|
||||||
|
``takes_self=True``.
|
||||||
|
|
||||||
|
.. versionadded:: 18.2.0
|
||||||
|
"""
|
||||||
|
if default is NOTHING and factory is None:
|
||||||
|
msg = "Must pass either `default` or `factory`."
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
if default is not NOTHING and factory is not None:
|
||||||
|
msg = "Must pass either `default` or `factory` but not both."
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
if factory is not None:
|
||||||
|
default = Factory(factory)
|
||||||
|
|
||||||
|
if isinstance(default, Factory):
|
||||||
|
if default.takes_self:
|
||||||
|
msg = "`takes_self` is not supported by default_if_none."
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
def default_if_none_converter(val):
|
||||||
|
if val is not None:
|
||||||
|
return val
|
||||||
|
|
||||||
|
return default.factory()
|
||||||
|
|
||||||
|
else:
|
||||||
|
|
||||||
|
def default_if_none_converter(val):
|
||||||
|
if val is not None:
|
||||||
|
return val
|
||||||
|
|
||||||
|
return default
|
||||||
|
|
||||||
|
return default_if_none_converter
|
||||||
|
|
||||||
|
|
||||||
|
def to_bool(val):
|
||||||
|
"""
|
||||||
|
Convert "boolean" strings (for example, from environment variables) to real
|
||||||
|
booleans.
|
||||||
|
|
||||||
|
Values mapping to `True`:
|
||||||
|
|
||||||
|
- ``True``
|
||||||
|
- ``"true"`` / ``"t"``
|
||||||
|
- ``"yes"`` / ``"y"``
|
||||||
|
- ``"on"``
|
||||||
|
- ``"1"``
|
||||||
|
- ``1``
|
||||||
|
|
||||||
|
Values mapping to `False`:
|
||||||
|
|
||||||
|
- ``False``
|
||||||
|
- ``"false"`` / ``"f"``
|
||||||
|
- ``"no"`` / ``"n"``
|
||||||
|
- ``"off"``
|
||||||
|
- ``"0"``
|
||||||
|
- ``0``
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: For any other value.
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
if isinstance(val, str):
|
||||||
|
val = val.lower()
|
||||||
|
|
||||||
|
if val in (True, "true", "t", "yes", "y", "on", "1", 1):
|
||||||
|
return True
|
||||||
|
if val in (False, "false", "f", "no", "n", "off", "0", 0):
|
||||||
|
return False
|
||||||
|
|
||||||
|
msg = f"Cannot convert value to bool: {val!r}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
from typing import Callable, Any, overload
|
||||||
|
|
||||||
|
from attrs import _ConverterType, _CallableConverterType
|
||||||
|
|
||||||
|
@overload
|
||||||
|
def pipe(*validators: _CallableConverterType) -> _CallableConverterType: ...
|
||||||
|
@overload
|
||||||
|
def pipe(*validators: _ConverterType) -> _ConverterType: ...
|
||||||
|
@overload
|
||||||
|
def optional(converter: _CallableConverterType) -> _CallableConverterType: ...
|
||||||
|
@overload
|
||||||
|
def optional(converter: _ConverterType) -> _ConverterType: ...
|
||||||
|
@overload
|
||||||
|
def default_if_none(default: Any) -> _CallableConverterType: ...
|
||||||
|
@overload
|
||||||
|
def default_if_none(
|
||||||
|
*, factory: Callable[[], Any]
|
||||||
|
) -> _CallableConverterType: ...
|
||||||
|
def to_bool(val: str | int | bool) -> bool: ...
|
||||||
|
|
@ -0,0 +1,95 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import ClassVar
|
||||||
|
|
||||||
|
|
||||||
|
class FrozenError(AttributeError):
|
||||||
|
"""
|
||||||
|
A frozen/immutable instance or attribute have been attempted to be
|
||||||
|
modified.
|
||||||
|
|
||||||
|
It mirrors the behavior of ``namedtuples`` by using the same error message
|
||||||
|
and subclassing `AttributeError`.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
msg = "can't set attribute"
|
||||||
|
args: ClassVar[tuple[str]] = [msg]
|
||||||
|
|
||||||
|
|
||||||
|
class FrozenInstanceError(FrozenError):
|
||||||
|
"""
|
||||||
|
A frozen instance has been attempted to be modified.
|
||||||
|
|
||||||
|
.. versionadded:: 16.1.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class FrozenAttributeError(FrozenError):
|
||||||
|
"""
|
||||||
|
A frozen attribute has been attempted to be modified.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class AttrsAttributeNotFoundError(ValueError):
|
||||||
|
"""
|
||||||
|
An *attrs* function couldn't find an attribute that the user asked for.
|
||||||
|
|
||||||
|
.. versionadded:: 16.2.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class NotAnAttrsClassError(ValueError):
|
||||||
|
"""
|
||||||
|
A non-*attrs* class has been passed into an *attrs* function.
|
||||||
|
|
||||||
|
.. versionadded:: 16.2.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class DefaultAlreadySetError(RuntimeError):
|
||||||
|
"""
|
||||||
|
A default has been set when defining the field and is attempted to be reset
|
||||||
|
using the decorator.
|
||||||
|
|
||||||
|
.. versionadded:: 17.1.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class UnannotatedAttributeError(RuntimeError):
|
||||||
|
"""
|
||||||
|
A class with ``auto_attribs=True`` has a field without a type annotation.
|
||||||
|
|
||||||
|
.. versionadded:: 17.3.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class PythonTooOldError(RuntimeError):
|
||||||
|
"""
|
||||||
|
It was attempted to use an *attrs* feature that requires a newer Python
|
||||||
|
version.
|
||||||
|
|
||||||
|
.. versionadded:: 18.2.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class NotCallableError(TypeError):
|
||||||
|
"""
|
||||||
|
A field requiring a callable has been set with a value that is not
|
||||||
|
callable.
|
||||||
|
|
||||||
|
.. versionadded:: 19.2.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, msg, value):
|
||||||
|
super(TypeError, self).__init__(msg, value)
|
||||||
|
self.msg = msg
|
||||||
|
self.value = value
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return str(self.msg)
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
class FrozenError(AttributeError):
|
||||||
|
msg: str = ...
|
||||||
|
|
||||||
|
class FrozenInstanceError(FrozenError): ...
|
||||||
|
class FrozenAttributeError(FrozenError): ...
|
||||||
|
class AttrsAttributeNotFoundError(ValueError): ...
|
||||||
|
class NotAnAttrsClassError(ValueError): ...
|
||||||
|
class DefaultAlreadySetError(RuntimeError): ...
|
||||||
|
class UnannotatedAttributeError(RuntimeError): ...
|
||||||
|
class PythonTooOldError(RuntimeError): ...
|
||||||
|
|
||||||
|
class NotCallableError(TypeError):
|
||||||
|
msg: str = ...
|
||||||
|
value: Any = ...
|
||||||
|
def __init__(self, msg: str, value: Any) -> None: ...
|
||||||
|
|
@ -0,0 +1,72 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""
|
||||||
|
Commonly useful filters for `attrs.asdict` and `attrs.astuple`.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from ._make import Attribute
|
||||||
|
|
||||||
|
|
||||||
|
def _split_what(what):
|
||||||
|
"""
|
||||||
|
Returns a tuple of `frozenset`s of classes and attributes.
|
||||||
|
"""
|
||||||
|
return (
|
||||||
|
frozenset(cls for cls in what if isinstance(cls, type)),
|
||||||
|
frozenset(cls for cls in what if isinstance(cls, str)),
|
||||||
|
frozenset(cls for cls in what if isinstance(cls, Attribute)),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def include(*what):
|
||||||
|
"""
|
||||||
|
Create a filter that only allows *what*.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
what (list[type, str, attrs.Attribute]):
|
||||||
|
What to include. Can be a type, a name, or an attribute.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Callable:
|
||||||
|
A callable that can be passed to `attrs.asdict`'s and
|
||||||
|
`attrs.astuple`'s *filter* argument.
|
||||||
|
|
||||||
|
.. versionchanged:: 23.1.0 Accept strings with field names.
|
||||||
|
"""
|
||||||
|
cls, names, attrs = _split_what(what)
|
||||||
|
|
||||||
|
def include_(attribute, value):
|
||||||
|
return (
|
||||||
|
value.__class__ in cls
|
||||||
|
or attribute.name in names
|
||||||
|
or attribute in attrs
|
||||||
|
)
|
||||||
|
|
||||||
|
return include_
|
||||||
|
|
||||||
|
|
||||||
|
def exclude(*what):
|
||||||
|
"""
|
||||||
|
Create a filter that does **not** allow *what*.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
what (list[type, str, attrs.Attribute]):
|
||||||
|
What to exclude. Can be a type, a name, or an attribute.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Callable:
|
||||||
|
A callable that can be passed to `attrs.asdict`'s and
|
||||||
|
`attrs.astuple`'s *filter* argument.
|
||||||
|
|
||||||
|
.. versionchanged:: 23.3.0 Accept field name string as input argument
|
||||||
|
"""
|
||||||
|
cls, names, attrs = _split_what(what)
|
||||||
|
|
||||||
|
def exclude_(attribute, value):
|
||||||
|
return not (
|
||||||
|
value.__class__ in cls
|
||||||
|
or attribute.name in names
|
||||||
|
or attribute in attrs
|
||||||
|
)
|
||||||
|
|
||||||
|
return exclude_
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from . import Attribute, _FilterType
|
||||||
|
|
||||||
|
def include(*what: type | str | Attribute[Any]) -> _FilterType[Any]: ...
|
||||||
|
def exclude(*what: type | str | Attribute[Any]) -> _FilterType[Any]: ...
|
||||||
|
|
@ -0,0 +1,79 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""
|
||||||
|
Commonly used hooks for on_setattr.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from . import _config
|
||||||
|
from .exceptions import FrozenAttributeError
|
||||||
|
|
||||||
|
|
||||||
|
def pipe(*setters):
|
||||||
|
"""
|
||||||
|
Run all *setters* and return the return value of the last one.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
def wrapped_pipe(instance, attrib, new_value):
|
||||||
|
rv = new_value
|
||||||
|
|
||||||
|
for setter in setters:
|
||||||
|
rv = setter(instance, attrib, rv)
|
||||||
|
|
||||||
|
return rv
|
||||||
|
|
||||||
|
return wrapped_pipe
|
||||||
|
|
||||||
|
|
||||||
|
def frozen(_, __, ___):
|
||||||
|
"""
|
||||||
|
Prevent an attribute to be modified.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
"""
|
||||||
|
raise FrozenAttributeError
|
||||||
|
|
||||||
|
|
||||||
|
def validate(instance, attrib, new_value):
|
||||||
|
"""
|
||||||
|
Run *attrib*'s validator on *new_value* if it has one.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
"""
|
||||||
|
if _config._run_validators is False:
|
||||||
|
return new_value
|
||||||
|
|
||||||
|
v = attrib.validator
|
||||||
|
if not v:
|
||||||
|
return new_value
|
||||||
|
|
||||||
|
v(instance, attrib, new_value)
|
||||||
|
|
||||||
|
return new_value
|
||||||
|
|
||||||
|
|
||||||
|
def convert(instance, attrib, new_value):
|
||||||
|
"""
|
||||||
|
Run *attrib*'s converter -- if it has one -- on *new_value* and return the
|
||||||
|
result.
|
||||||
|
|
||||||
|
.. versionadded:: 20.1.0
|
||||||
|
"""
|
||||||
|
c = attrib.converter
|
||||||
|
if c:
|
||||||
|
# This can be removed once we drop 3.8 and use attrs.Converter instead.
|
||||||
|
from ._make import Converter
|
||||||
|
|
||||||
|
if not isinstance(c, Converter):
|
||||||
|
return c(new_value)
|
||||||
|
|
||||||
|
return c(new_value, instance, attrib)
|
||||||
|
|
||||||
|
return new_value
|
||||||
|
|
||||||
|
|
||||||
|
# Sentinel for disabling class-wide *on_setattr* hooks for certain attributes.
|
||||||
|
# Sphinx's autodata stopped working, so the docstring is inlined in the API
|
||||||
|
# docs.
|
||||||
|
NO_OP = object()
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
from typing import Any, NewType, NoReturn, TypeVar
|
||||||
|
|
||||||
|
from . import Attribute
|
||||||
|
from attrs import _OnSetAttrType
|
||||||
|
|
||||||
|
_T = TypeVar("_T")
|
||||||
|
|
||||||
|
def frozen(
|
||||||
|
instance: Any, attribute: Attribute[Any], new_value: Any
|
||||||
|
) -> NoReturn: ...
|
||||||
|
def pipe(*setters: _OnSetAttrType) -> _OnSetAttrType: ...
|
||||||
|
def validate(instance: Any, attribute: Attribute[_T], new_value: _T) -> _T: ...
|
||||||
|
|
||||||
|
# convert is allowed to return Any, because they can be chained using pipe.
|
||||||
|
def convert(
|
||||||
|
instance: Any, attribute: Attribute[Any], new_value: Any
|
||||||
|
) -> Any: ...
|
||||||
|
|
||||||
|
_NoOpType = NewType("_NoOpType", object)
|
||||||
|
NO_OP: _NoOpType
|
||||||
|
|
@ -0,0 +1,748 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""
|
||||||
|
Commonly useful validators.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import operator
|
||||||
|
import re
|
||||||
|
|
||||||
|
from contextlib import contextmanager
|
||||||
|
from re import Pattern
|
||||||
|
|
||||||
|
from ._config import get_run_validators, set_run_validators
|
||||||
|
from ._make import _AndValidator, and_, attrib, attrs
|
||||||
|
from .converters import default_if_none
|
||||||
|
from .exceptions import NotCallableError
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"and_",
|
||||||
|
"deep_iterable",
|
||||||
|
"deep_mapping",
|
||||||
|
"disabled",
|
||||||
|
"ge",
|
||||||
|
"get_disabled",
|
||||||
|
"gt",
|
||||||
|
"in_",
|
||||||
|
"instance_of",
|
||||||
|
"is_callable",
|
||||||
|
"le",
|
||||||
|
"lt",
|
||||||
|
"matches_re",
|
||||||
|
"max_len",
|
||||||
|
"min_len",
|
||||||
|
"not_",
|
||||||
|
"optional",
|
||||||
|
"or_",
|
||||||
|
"set_disabled",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def set_disabled(disabled):
|
||||||
|
"""
|
||||||
|
Globally disable or enable running validators.
|
||||||
|
|
||||||
|
By default, they are run.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
disabled (bool): If `True`, disable running all validators.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
This function is not thread-safe!
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
set_run_validators(not disabled)
|
||||||
|
|
||||||
|
|
||||||
|
def get_disabled():
|
||||||
|
"""
|
||||||
|
Return a bool indicating whether validators are currently disabled or not.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool:`True` if validators are currently disabled.
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return not get_run_validators()
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def disabled():
|
||||||
|
"""
|
||||||
|
Context manager that disables running validators within its context.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
This context manager is not thread-safe!
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
set_run_validators(False)
|
||||||
|
try:
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
set_run_validators(True)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _InstanceOfValidator:
|
||||||
|
type = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if not isinstance(value, self.type):
|
||||||
|
msg = f"'{attr.name}' must be {self.type!r} (got {value!r} that is a {value.__class__!r})."
|
||||||
|
raise TypeError(
|
||||||
|
msg,
|
||||||
|
attr,
|
||||||
|
self.type,
|
||||||
|
value,
|
||||||
|
)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<instance_of validator for type {self.type!r}>"
|
||||||
|
|
||||||
|
|
||||||
|
def instance_of(type):
|
||||||
|
"""
|
||||||
|
A validator that raises a `TypeError` if the initializer is called with a
|
||||||
|
wrong type for this particular attribute (checks are performed using
|
||||||
|
`isinstance` therefore it's also valid to pass a tuple of types).
|
||||||
|
|
||||||
|
Args:
|
||||||
|
type (type | tuple[type]): The type to check for.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError:
|
||||||
|
With a human readable error message, the attribute (of type
|
||||||
|
`attrs.Attribute`), the expected type, and the value it got.
|
||||||
|
"""
|
||||||
|
return _InstanceOfValidator(type)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, frozen=True, slots=True)
|
||||||
|
class _MatchesReValidator:
|
||||||
|
pattern = attrib()
|
||||||
|
match_func = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if not self.match_func(value):
|
||||||
|
msg = f"'{attr.name}' must match regex {self.pattern.pattern!r} ({value!r} doesn't)"
|
||||||
|
raise ValueError(
|
||||||
|
msg,
|
||||||
|
attr,
|
||||||
|
self.pattern,
|
||||||
|
value,
|
||||||
|
)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<matches_re validator for pattern {self.pattern!r}>"
|
||||||
|
|
||||||
|
|
||||||
|
def matches_re(regex, flags=0, func=None):
|
||||||
|
r"""
|
||||||
|
A validator that raises `ValueError` if the initializer is called with a
|
||||||
|
string that doesn't match *regex*.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
regex (str, re.Pattern):
|
||||||
|
A regex string or precompiled pattern to match against
|
||||||
|
|
||||||
|
flags (int):
|
||||||
|
Flags that will be passed to the underlying re function (default 0)
|
||||||
|
|
||||||
|
func (typing.Callable):
|
||||||
|
Which underlying `re` function to call. Valid options are
|
||||||
|
`re.fullmatch`, `re.search`, and `re.match`; the default `None`
|
||||||
|
means `re.fullmatch`. For performance reasons, the pattern is
|
||||||
|
always precompiled using `re.compile`.
|
||||||
|
|
||||||
|
.. versionadded:: 19.2.0
|
||||||
|
.. versionchanged:: 21.3.0 *regex* can be a pre-compiled pattern.
|
||||||
|
"""
|
||||||
|
valid_funcs = (re.fullmatch, None, re.search, re.match)
|
||||||
|
if func not in valid_funcs:
|
||||||
|
msg = "'func' must be one of {}.".format(
|
||||||
|
", ".join(
|
||||||
|
sorted((e and e.__name__) or "None" for e in set(valid_funcs))
|
||||||
|
)
|
||||||
|
)
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
if isinstance(regex, Pattern):
|
||||||
|
if flags:
|
||||||
|
msg = "'flags' can only be used with a string pattern; pass flags to re.compile() instead"
|
||||||
|
raise TypeError(msg)
|
||||||
|
pattern = regex
|
||||||
|
else:
|
||||||
|
pattern = re.compile(regex, flags)
|
||||||
|
|
||||||
|
if func is re.match:
|
||||||
|
match_func = pattern.match
|
||||||
|
elif func is re.search:
|
||||||
|
match_func = pattern.search
|
||||||
|
else:
|
||||||
|
match_func = pattern.fullmatch
|
||||||
|
|
||||||
|
return _MatchesReValidator(pattern, match_func)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _OptionalValidator:
|
||||||
|
validator = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
if value is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
self.validator(inst, attr, value)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<optional validator for {self.validator!r} or None>"
|
||||||
|
|
||||||
|
|
||||||
|
def optional(validator):
|
||||||
|
"""
|
||||||
|
A validator that makes an attribute optional. An optional attribute is one
|
||||||
|
which can be set to `None` in addition to satisfying the requirements of
|
||||||
|
the sub-validator.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
validator
|
||||||
|
(typing.Callable | tuple[typing.Callable] | list[typing.Callable]):
|
||||||
|
A validator (or validators) that is used for non-`None` values.
|
||||||
|
|
||||||
|
.. versionadded:: 15.1.0
|
||||||
|
.. versionchanged:: 17.1.0 *validator* can be a list of validators.
|
||||||
|
.. versionchanged:: 23.1.0 *validator* can also be a tuple of validators.
|
||||||
|
"""
|
||||||
|
if isinstance(validator, (list, tuple)):
|
||||||
|
return _OptionalValidator(_AndValidator(validator))
|
||||||
|
|
||||||
|
return _OptionalValidator(validator)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _InValidator:
|
||||||
|
options = attrib()
|
||||||
|
_original_options = attrib(hash=False)
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
try:
|
||||||
|
in_options = value in self.options
|
||||||
|
except TypeError: # e.g. `1 in "abc"`
|
||||||
|
in_options = False
|
||||||
|
|
||||||
|
if not in_options:
|
||||||
|
msg = f"'{attr.name}' must be in {self._original_options!r} (got {value!r})"
|
||||||
|
raise ValueError(
|
||||||
|
msg,
|
||||||
|
attr,
|
||||||
|
self._original_options,
|
||||||
|
value,
|
||||||
|
)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<in_ validator with options {self._original_options!r}>"
|
||||||
|
|
||||||
|
|
||||||
|
def in_(options):
|
||||||
|
"""
|
||||||
|
A validator that raises a `ValueError` if the initializer is called with a
|
||||||
|
value that does not belong in the *options* provided.
|
||||||
|
|
||||||
|
The check is performed using ``value in options``, so *options* has to
|
||||||
|
support that operation.
|
||||||
|
|
||||||
|
To keep the validator hashable, dicts, lists, and sets are transparently
|
||||||
|
transformed into a `tuple`.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
options: Allowed options.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError:
|
||||||
|
With a human readable error message, the attribute (of type
|
||||||
|
`attrs.Attribute`), the expected options, and the value it got.
|
||||||
|
|
||||||
|
.. versionadded:: 17.1.0
|
||||||
|
.. versionchanged:: 22.1.0
|
||||||
|
The ValueError was incomplete until now and only contained the human
|
||||||
|
readable error message. Now it contains all the information that has
|
||||||
|
been promised since 17.1.0.
|
||||||
|
.. versionchanged:: 24.1.0
|
||||||
|
*options* that are a list, dict, or a set are now transformed into a
|
||||||
|
tuple to keep the validator hashable.
|
||||||
|
"""
|
||||||
|
repr_options = options
|
||||||
|
if isinstance(options, (list, dict, set)):
|
||||||
|
options = tuple(options)
|
||||||
|
|
||||||
|
return _InValidator(options, repr_options)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=False, unsafe_hash=True)
|
||||||
|
class _IsCallableValidator:
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if not callable(value):
|
||||||
|
message = (
|
||||||
|
"'{name}' must be callable "
|
||||||
|
"(got {value!r} that is a {actual!r})."
|
||||||
|
)
|
||||||
|
raise NotCallableError(
|
||||||
|
msg=message.format(
|
||||||
|
name=attr.name, value=value, actual=value.__class__
|
||||||
|
),
|
||||||
|
value=value,
|
||||||
|
)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return "<is_callable validator>"
|
||||||
|
|
||||||
|
|
||||||
|
def is_callable():
|
||||||
|
"""
|
||||||
|
A validator that raises a `attrs.exceptions.NotCallableError` if the
|
||||||
|
initializer is called with a value for this particular attribute that is
|
||||||
|
not callable.
|
||||||
|
|
||||||
|
.. versionadded:: 19.1.0
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
attrs.exceptions.NotCallableError:
|
||||||
|
With a human readable error message containing the attribute
|
||||||
|
(`attrs.Attribute`) name, and the value it got.
|
||||||
|
"""
|
||||||
|
return _IsCallableValidator()
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _DeepIterable:
|
||||||
|
member_validator = attrib(validator=is_callable())
|
||||||
|
iterable_validator = attrib(
|
||||||
|
default=None, validator=optional(is_callable())
|
||||||
|
)
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if self.iterable_validator is not None:
|
||||||
|
self.iterable_validator(inst, attr, value)
|
||||||
|
|
||||||
|
for member in value:
|
||||||
|
self.member_validator(inst, attr, member)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
iterable_identifier = (
|
||||||
|
""
|
||||||
|
if self.iterable_validator is None
|
||||||
|
else f" {self.iterable_validator!r}"
|
||||||
|
)
|
||||||
|
return (
|
||||||
|
f"<deep_iterable validator for{iterable_identifier}"
|
||||||
|
f" iterables of {self.member_validator!r}>"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def deep_iterable(member_validator, iterable_validator=None):
|
||||||
|
"""
|
||||||
|
A validator that performs deep validation of an iterable.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
member_validator: Validator(s) to apply to iterable members.
|
||||||
|
|
||||||
|
iterable_validator:
|
||||||
|
Validator(s) to apply to iterable itself (optional).
|
||||||
|
|
||||||
|
Raises
|
||||||
|
TypeError: if any sub-validators fail
|
||||||
|
|
||||||
|
.. versionadded:: 19.1.0
|
||||||
|
|
||||||
|
.. versionchanged:: 25.4.0
|
||||||
|
*member_validator* and *iterable_validator* can now be a list or tuple
|
||||||
|
of validators.
|
||||||
|
"""
|
||||||
|
if isinstance(member_validator, (list, tuple)):
|
||||||
|
member_validator = and_(*member_validator)
|
||||||
|
if isinstance(iterable_validator, (list, tuple)):
|
||||||
|
iterable_validator = and_(*iterable_validator)
|
||||||
|
return _DeepIterable(member_validator, iterable_validator)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _DeepMapping:
|
||||||
|
key_validator = attrib(validator=optional(is_callable()))
|
||||||
|
value_validator = attrib(validator=optional(is_callable()))
|
||||||
|
mapping_validator = attrib(validator=optional(is_callable()))
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if self.mapping_validator is not None:
|
||||||
|
self.mapping_validator(inst, attr, value)
|
||||||
|
|
||||||
|
for key in value:
|
||||||
|
if self.key_validator is not None:
|
||||||
|
self.key_validator(inst, attr, key)
|
||||||
|
if self.value_validator is not None:
|
||||||
|
self.value_validator(inst, attr, value[key])
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<deep_mapping validator for objects mapping {self.key_validator!r} to {self.value_validator!r}>"
|
||||||
|
|
||||||
|
|
||||||
|
def deep_mapping(
|
||||||
|
key_validator=None, value_validator=None, mapping_validator=None
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
A validator that performs deep validation of a dictionary.
|
||||||
|
|
||||||
|
All validators are optional, but at least one of *key_validator* or
|
||||||
|
*value_validator* must be provided.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
key_validator: Validator(s) to apply to dictionary keys.
|
||||||
|
|
||||||
|
value_validator: Validator(s) to apply to dictionary values.
|
||||||
|
|
||||||
|
mapping_validator:
|
||||||
|
Validator(s) to apply to top-level mapping attribute.
|
||||||
|
|
||||||
|
.. versionadded:: 19.1.0
|
||||||
|
|
||||||
|
.. versionchanged:: 25.4.0
|
||||||
|
*key_validator* and *value_validator* are now optional, but at least one
|
||||||
|
of them must be provided.
|
||||||
|
|
||||||
|
.. versionchanged:: 25.4.0
|
||||||
|
*key_validator*, *value_validator*, and *mapping_validator* can now be a
|
||||||
|
list or tuple of validators.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: If any sub-validator fails on validation.
|
||||||
|
|
||||||
|
ValueError:
|
||||||
|
If neither *key_validator* nor *value_validator* is provided on
|
||||||
|
instantiation.
|
||||||
|
"""
|
||||||
|
if key_validator is None and value_validator is None:
|
||||||
|
msg = (
|
||||||
|
"At least one of key_validator or value_validator must be provided"
|
||||||
|
)
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
if isinstance(key_validator, (list, tuple)):
|
||||||
|
key_validator = and_(*key_validator)
|
||||||
|
if isinstance(value_validator, (list, tuple)):
|
||||||
|
value_validator = and_(*value_validator)
|
||||||
|
if isinstance(mapping_validator, (list, tuple)):
|
||||||
|
mapping_validator = and_(*mapping_validator)
|
||||||
|
|
||||||
|
return _DeepMapping(key_validator, value_validator, mapping_validator)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, frozen=True, slots=True)
|
||||||
|
class _NumberValidator:
|
||||||
|
bound = attrib()
|
||||||
|
compare_op = attrib()
|
||||||
|
compare_func = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if not self.compare_func(value, self.bound):
|
||||||
|
msg = f"'{attr.name}' must be {self.compare_op} {self.bound}: {value}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<Validator for x {self.compare_op} {self.bound}>"
|
||||||
|
|
||||||
|
|
||||||
|
def lt(val):
|
||||||
|
"""
|
||||||
|
A validator that raises `ValueError` if the initializer is called with a
|
||||||
|
number larger or equal to *val*.
|
||||||
|
|
||||||
|
The validator uses `operator.lt` to compare the values.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
val: Exclusive upper bound for values.
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return _NumberValidator(val, "<", operator.lt)
|
||||||
|
|
||||||
|
|
||||||
|
def le(val):
|
||||||
|
"""
|
||||||
|
A validator that raises `ValueError` if the initializer is called with a
|
||||||
|
number greater than *val*.
|
||||||
|
|
||||||
|
The validator uses `operator.le` to compare the values.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
val: Inclusive upper bound for values.
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return _NumberValidator(val, "<=", operator.le)
|
||||||
|
|
||||||
|
|
||||||
|
def ge(val):
|
||||||
|
"""
|
||||||
|
A validator that raises `ValueError` if the initializer is called with a
|
||||||
|
number smaller than *val*.
|
||||||
|
|
||||||
|
The validator uses `operator.ge` to compare the values.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
val: Inclusive lower bound for values
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return _NumberValidator(val, ">=", operator.ge)
|
||||||
|
|
||||||
|
|
||||||
|
def gt(val):
|
||||||
|
"""
|
||||||
|
A validator that raises `ValueError` if the initializer is called with a
|
||||||
|
number smaller or equal to *val*.
|
||||||
|
|
||||||
|
The validator uses `operator.gt` to compare the values.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
val: Exclusive lower bound for values
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return _NumberValidator(val, ">", operator.gt)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, frozen=True, slots=True)
|
||||||
|
class _MaxLengthValidator:
|
||||||
|
max_length = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if len(value) > self.max_length:
|
||||||
|
msg = f"Length of '{attr.name}' must be <= {self.max_length}: {len(value)}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<max_len validator for {self.max_length}>"
|
||||||
|
|
||||||
|
|
||||||
|
def max_len(length):
|
||||||
|
"""
|
||||||
|
A validator that raises `ValueError` if the initializer is called
|
||||||
|
with a string or iterable that is longer than *length*.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
length (int): Maximum length of the string or iterable
|
||||||
|
|
||||||
|
.. versionadded:: 21.3.0
|
||||||
|
"""
|
||||||
|
return _MaxLengthValidator(length)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, frozen=True, slots=True)
|
||||||
|
class _MinLengthValidator:
|
||||||
|
min_length = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if len(value) < self.min_length:
|
||||||
|
msg = f"Length of '{attr.name}' must be >= {self.min_length}: {len(value)}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<min_len validator for {self.min_length}>"
|
||||||
|
|
||||||
|
|
||||||
|
def min_len(length):
|
||||||
|
"""
|
||||||
|
A validator that raises `ValueError` if the initializer is called
|
||||||
|
with a string or iterable that is shorter than *length*.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
length (int): Minimum length of the string or iterable
|
||||||
|
|
||||||
|
.. versionadded:: 22.1.0
|
||||||
|
"""
|
||||||
|
return _MinLengthValidator(length)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _SubclassOfValidator:
|
||||||
|
type = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
"""
|
||||||
|
We use a callable class to be able to change the ``__repr__``.
|
||||||
|
"""
|
||||||
|
if not issubclass(value, self.type):
|
||||||
|
msg = f"'{attr.name}' must be a subclass of {self.type!r} (got {value!r})."
|
||||||
|
raise TypeError(
|
||||||
|
msg,
|
||||||
|
attr,
|
||||||
|
self.type,
|
||||||
|
value,
|
||||||
|
)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<subclass_of validator for type {self.type!r}>"
|
||||||
|
|
||||||
|
|
||||||
|
def _subclass_of(type):
|
||||||
|
"""
|
||||||
|
A validator that raises a `TypeError` if the initializer is called with a
|
||||||
|
wrong type for this particular attribute (checks are performed using
|
||||||
|
`issubclass` therefore it's also valid to pass a tuple of types).
|
||||||
|
|
||||||
|
Args:
|
||||||
|
type (type | tuple[type, ...]): The type(s) to check for.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError:
|
||||||
|
With a human readable error message, the attribute (of type
|
||||||
|
`attrs.Attribute`), the expected type, and the value it got.
|
||||||
|
"""
|
||||||
|
return _SubclassOfValidator(type)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _NotValidator:
|
||||||
|
validator = attrib()
|
||||||
|
msg = attrib(
|
||||||
|
converter=default_if_none(
|
||||||
|
"not_ validator child '{validator!r}' "
|
||||||
|
"did not raise a captured error"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
exc_types = attrib(
|
||||||
|
validator=deep_iterable(
|
||||||
|
member_validator=_subclass_of(Exception),
|
||||||
|
iterable_validator=instance_of(tuple),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
try:
|
||||||
|
self.validator(inst, attr, value)
|
||||||
|
except self.exc_types:
|
||||||
|
pass # suppress error to invert validity
|
||||||
|
else:
|
||||||
|
raise ValueError(
|
||||||
|
self.msg.format(
|
||||||
|
validator=self.validator,
|
||||||
|
exc_types=self.exc_types,
|
||||||
|
),
|
||||||
|
attr,
|
||||||
|
self.validator,
|
||||||
|
value,
|
||||||
|
self.exc_types,
|
||||||
|
)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<not_ validator wrapping {self.validator!r}, capturing {self.exc_types!r}>"
|
||||||
|
|
||||||
|
|
||||||
|
def not_(validator, *, msg=None, exc_types=(ValueError, TypeError)):
|
||||||
|
"""
|
||||||
|
A validator that wraps and logically 'inverts' the validator passed to it.
|
||||||
|
It will raise a `ValueError` if the provided validator *doesn't* raise a
|
||||||
|
`ValueError` or `TypeError` (by default), and will suppress the exception
|
||||||
|
if the provided validator *does*.
|
||||||
|
|
||||||
|
Intended to be used with existing validators to compose logic without
|
||||||
|
needing to create inverted variants, for example, ``not_(in_(...))``.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
validator: A validator to be logically inverted.
|
||||||
|
|
||||||
|
msg (str):
|
||||||
|
Message to raise if validator fails. Formatted with keys
|
||||||
|
``exc_types`` and ``validator``.
|
||||||
|
|
||||||
|
exc_types (tuple[type, ...]):
|
||||||
|
Exception type(s) to capture. Other types raised by child
|
||||||
|
validators will not be intercepted and pass through.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError:
|
||||||
|
With a human readable error message, the attribute (of type
|
||||||
|
`attrs.Attribute`), the validator that failed to raise an
|
||||||
|
exception, the value it got, and the expected exception types.
|
||||||
|
|
||||||
|
.. versionadded:: 22.2.0
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
exc_types = tuple(exc_types)
|
||||||
|
except TypeError:
|
||||||
|
exc_types = (exc_types,)
|
||||||
|
return _NotValidator(validator, msg, exc_types)
|
||||||
|
|
||||||
|
|
||||||
|
@attrs(repr=False, slots=True, unsafe_hash=True)
|
||||||
|
class _OrValidator:
|
||||||
|
validators = attrib()
|
||||||
|
|
||||||
|
def __call__(self, inst, attr, value):
|
||||||
|
for v in self.validators:
|
||||||
|
try:
|
||||||
|
v(inst, attr, value)
|
||||||
|
except Exception: # noqa: BLE001, PERF203, S112
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
return
|
||||||
|
|
||||||
|
msg = f"None of {self.validators!r} satisfied for value {value!r}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"<or validator wrapping {self.validators!r}>"
|
||||||
|
|
||||||
|
|
||||||
|
def or_(*validators):
|
||||||
|
"""
|
||||||
|
A validator that composes multiple validators into one.
|
||||||
|
|
||||||
|
When called on a value, it runs all wrapped validators until one of them is
|
||||||
|
satisfied.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
validators (~collections.abc.Iterable[typing.Callable]):
|
||||||
|
Arbitrary number of validators.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError:
|
||||||
|
If no validator is satisfied. Raised with a human-readable error
|
||||||
|
message listing all the wrapped validators and the value that
|
||||||
|
failed all of them.
|
||||||
|
|
||||||
|
.. versionadded:: 24.1.0
|
||||||
|
"""
|
||||||
|
vals = []
|
||||||
|
for v in validators:
|
||||||
|
vals.extend(v.validators if isinstance(v, _OrValidator) else [v])
|
||||||
|
|
||||||
|
return _OrValidator(tuple(vals))
|
||||||
|
|
@ -0,0 +1,140 @@
|
||||||
|
from types import UnionType
|
||||||
|
from typing import (
|
||||||
|
Any,
|
||||||
|
AnyStr,
|
||||||
|
Callable,
|
||||||
|
Container,
|
||||||
|
ContextManager,
|
||||||
|
Iterable,
|
||||||
|
Mapping,
|
||||||
|
Match,
|
||||||
|
Pattern,
|
||||||
|
TypeVar,
|
||||||
|
overload,
|
||||||
|
)
|
||||||
|
|
||||||
|
from attrs import _ValidatorType
|
||||||
|
from attrs import _ValidatorArgType
|
||||||
|
|
||||||
|
_T = TypeVar("_T")
|
||||||
|
_T1 = TypeVar("_T1")
|
||||||
|
_T2 = TypeVar("_T2")
|
||||||
|
_T3 = TypeVar("_T3")
|
||||||
|
_T4 = TypeVar("_T4")
|
||||||
|
_T5 = TypeVar("_T5")
|
||||||
|
_T6 = TypeVar("_T6")
|
||||||
|
_I = TypeVar("_I", bound=Iterable)
|
||||||
|
_K = TypeVar("_K")
|
||||||
|
_V = TypeVar("_V")
|
||||||
|
_M = TypeVar("_M", bound=Mapping)
|
||||||
|
|
||||||
|
def set_disabled(run: bool) -> None: ...
|
||||||
|
def get_disabled() -> bool: ...
|
||||||
|
def disabled() -> ContextManager[None]: ...
|
||||||
|
|
||||||
|
# To be more precise on instance_of use some overloads.
|
||||||
|
# If there are more than 3 items in the tuple then we fall back to Any
|
||||||
|
@overload
|
||||||
|
def instance_of(type: type[_T]) -> _ValidatorType[_T]: ...
|
||||||
|
@overload
|
||||||
|
def instance_of(type: tuple[type[_T]]) -> _ValidatorType[_T]: ...
|
||||||
|
@overload
|
||||||
|
def instance_of(
|
||||||
|
type: tuple[type[_T1], type[_T2]],
|
||||||
|
) -> _ValidatorType[_T1 | _T2]: ...
|
||||||
|
@overload
|
||||||
|
def instance_of(
|
||||||
|
type: tuple[type[_T1], type[_T2], type[_T3]],
|
||||||
|
) -> _ValidatorType[_T1 | _T2 | _T3]: ...
|
||||||
|
@overload
|
||||||
|
def instance_of(type: tuple[type, ...]) -> _ValidatorType[Any]: ...
|
||||||
|
@overload
|
||||||
|
def instance_of(type: UnionType) -> _ValidatorType[Any]: ...
|
||||||
|
def optional(
|
||||||
|
validator: (
|
||||||
|
_ValidatorType[_T]
|
||||||
|
| list[_ValidatorType[_T]]
|
||||||
|
| tuple[_ValidatorType[_T]]
|
||||||
|
),
|
||||||
|
) -> _ValidatorType[_T | None]: ...
|
||||||
|
def in_(options: Container[_T]) -> _ValidatorType[_T]: ...
|
||||||
|
def and_(*validators: _ValidatorType[_T]) -> _ValidatorType[_T]: ...
|
||||||
|
def matches_re(
|
||||||
|
regex: Pattern[AnyStr] | AnyStr,
|
||||||
|
flags: int = ...,
|
||||||
|
func: Callable[[AnyStr, AnyStr, int], Match[AnyStr] | None] | None = ...,
|
||||||
|
) -> _ValidatorType[AnyStr]: ...
|
||||||
|
def deep_iterable(
|
||||||
|
member_validator: _ValidatorArgType[_T],
|
||||||
|
iterable_validator: _ValidatorArgType[_I] | None = ...,
|
||||||
|
) -> _ValidatorType[_I]: ...
|
||||||
|
@overload
|
||||||
|
def deep_mapping(
|
||||||
|
key_validator: _ValidatorArgType[_K],
|
||||||
|
value_validator: _ValidatorArgType[_V] | None = ...,
|
||||||
|
mapping_validator: _ValidatorArgType[_M] | None = ...,
|
||||||
|
) -> _ValidatorType[_M]: ...
|
||||||
|
@overload
|
||||||
|
def deep_mapping(
|
||||||
|
key_validator: _ValidatorArgType[_K] | None = ...,
|
||||||
|
value_validator: _ValidatorArgType[_V] = ...,
|
||||||
|
mapping_validator: _ValidatorArgType[_M] | None = ...,
|
||||||
|
) -> _ValidatorType[_M]: ...
|
||||||
|
def is_callable() -> _ValidatorType[_T]: ...
|
||||||
|
def lt(val: _T) -> _ValidatorType[_T]: ...
|
||||||
|
def le(val: _T) -> _ValidatorType[_T]: ...
|
||||||
|
def ge(val: _T) -> _ValidatorType[_T]: ...
|
||||||
|
def gt(val: _T) -> _ValidatorType[_T]: ...
|
||||||
|
def max_len(length: int) -> _ValidatorType[_T]: ...
|
||||||
|
def min_len(length: int) -> _ValidatorType[_T]: ...
|
||||||
|
def not_(
|
||||||
|
validator: _ValidatorType[_T],
|
||||||
|
*,
|
||||||
|
msg: str | None = None,
|
||||||
|
exc_types: type[Exception] | Iterable[type[Exception]] = ...,
|
||||||
|
) -> _ValidatorType[_T]: ...
|
||||||
|
@overload
|
||||||
|
def or_(
|
||||||
|
__v1: _ValidatorType[_T1],
|
||||||
|
__v2: _ValidatorType[_T2],
|
||||||
|
) -> _ValidatorType[_T1 | _T2]: ...
|
||||||
|
@overload
|
||||||
|
def or_(
|
||||||
|
__v1: _ValidatorType[_T1],
|
||||||
|
__v2: _ValidatorType[_T2],
|
||||||
|
__v3: _ValidatorType[_T3],
|
||||||
|
) -> _ValidatorType[_T1 | _T2 | _T3]: ...
|
||||||
|
@overload
|
||||||
|
def or_(
|
||||||
|
__v1: _ValidatorType[_T1],
|
||||||
|
__v2: _ValidatorType[_T2],
|
||||||
|
__v3: _ValidatorType[_T3],
|
||||||
|
__v4: _ValidatorType[_T4],
|
||||||
|
) -> _ValidatorType[_T1 | _T2 | _T3 | _T4]: ...
|
||||||
|
@overload
|
||||||
|
def or_(
|
||||||
|
__v1: _ValidatorType[_T1],
|
||||||
|
__v2: _ValidatorType[_T2],
|
||||||
|
__v3: _ValidatorType[_T3],
|
||||||
|
__v4: _ValidatorType[_T4],
|
||||||
|
__v5: _ValidatorType[_T5],
|
||||||
|
) -> _ValidatorType[_T1 | _T2 | _T3 | _T4 | _T5]: ...
|
||||||
|
@overload
|
||||||
|
def or_(
|
||||||
|
__v1: _ValidatorType[_T1],
|
||||||
|
__v2: _ValidatorType[_T2],
|
||||||
|
__v3: _ValidatorType[_T3],
|
||||||
|
__v4: _ValidatorType[_T4],
|
||||||
|
__v5: _ValidatorType[_T5],
|
||||||
|
__v6: _ValidatorType[_T6],
|
||||||
|
) -> _ValidatorType[_T1 | _T2 | _T3 | _T4 | _T5 | _T6]: ...
|
||||||
|
@overload
|
||||||
|
def or_(
|
||||||
|
__v1: _ValidatorType[Any],
|
||||||
|
__v2: _ValidatorType[Any],
|
||||||
|
__v3: _ValidatorType[Any],
|
||||||
|
__v4: _ValidatorType[Any],
|
||||||
|
__v5: _ValidatorType[Any],
|
||||||
|
__v6: _ValidatorType[Any],
|
||||||
|
*validators: _ValidatorType[Any],
|
||||||
|
) -> _ValidatorType[Any]: ...
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,235 @@
|
||||||
|
Metadata-Version: 2.4
|
||||||
|
Name: attrs
|
||||||
|
Version: 25.4.0
|
||||||
|
Summary: Classes Without Boilerplate
|
||||||
|
Project-URL: Documentation, https://www.attrs.org/
|
||||||
|
Project-URL: Changelog, https://www.attrs.org/en/stable/changelog.html
|
||||||
|
Project-URL: GitHub, https://github.com/python-attrs/attrs
|
||||||
|
Project-URL: Funding, https://github.com/sponsors/hynek
|
||||||
|
Project-URL: Tidelift, https://tidelift.com/subscription/pkg/pypi-attrs?utm_source=pypi-attrs&utm_medium=pypi
|
||||||
|
Author-email: Hynek Schlawack <hs@ox.cx>
|
||||||
|
License-Expression: MIT
|
||||||
|
License-File: LICENSE
|
||||||
|
Keywords: attribute,boilerplate,class
|
||||||
|
Classifier: Development Status :: 5 - Production/Stable
|
||||||
|
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 :: Implementation :: CPython
|
||||||
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||||||
|
Classifier: Typing :: Typed
|
||||||
|
Requires-Python: >=3.9
|
||||||
|
Description-Content-Type: text/markdown
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://www.attrs.org/">
|
||||||
|
<img src="https://raw.githubusercontent.com/python-attrs/attrs/main/docs/_static/attrs_logo.svg" width="35%" alt="attrs" />
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
*attrs* is the Python package that will bring back the **joy** of **writing classes** by relieving you from the drudgery of implementing object protocols (aka [dunder methods](https://www.attrs.org/en/latest/glossary.html#term-dunder-methods)).
|
||||||
|
Trusted by NASA for [Mars missions since 2020](https://github.com/readme/featured/nasa-ingenuity-helicopter)!
|
||||||
|
|
||||||
|
Its main goal is to help you to write **concise** and **correct** software without slowing down your code.
|
||||||
|
|
||||||
|
|
||||||
|
## Sponsors
|
||||||
|
|
||||||
|
*attrs* would not be possible without our [amazing sponsors](https://github.com/sponsors/hynek).
|
||||||
|
Especially those generously supporting us at the *The Organization* tier and higher:
|
||||||
|
|
||||||
|
<!-- sponsor-break-begin -->
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
|
||||||
|
<!-- [[[cog
|
||||||
|
import pathlib, tomllib
|
||||||
|
|
||||||
|
for sponsor in tomllib.loads(pathlib.Path("pyproject.toml").read_text())["tool"]["sponcon"]["sponsors"]:
|
||||||
|
print(f'<a href="{sponsor["url"]}"><img title="{sponsor["title"]}" src="https://www.attrs.org/en/25.4.0/_static/sponsors/{sponsor["img"]}" width="190" /></a>')
|
||||||
|
]]] -->
|
||||||
|
<a href="https://www.variomedia.de/"><img title="Variomedia AG" src="https://www.attrs.org/en/25.4.0/_static/sponsors/Variomedia.svg" width="190" /></a>
|
||||||
|
<a href="https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek"><img title="Tidelift" src="https://www.attrs.org/en/25.4.0/_static/sponsors/Tidelift.svg" width="190" /></a>
|
||||||
|
<a href="https://privacy-solutions.org/"><img title="Privacy Solutions" src="https://www.attrs.org/en/25.4.0/_static/sponsors/Privacy-Solutions.svg" width="190" /></a>
|
||||||
|
<a href="https://filepreviews.io/"><img title="FilePreviews" src="https://www.attrs.org/en/25.4.0/_static/sponsors/FilePreviews.svg" width="190" /></a>
|
||||||
|
<a href="https://polar.sh/"><img title="Polar" src="https://www.attrs.org/en/25.4.0/_static/sponsors/Polar.svg" width="190" /></a>
|
||||||
|
<!-- [[[end]]] -->
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<!-- sponsor-break-end -->
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<strong>Please consider <a href="https://github.com/sponsors/hynek">joining them</a> to help make <em>attrs</em>’s maintenance more sustainable!</strong>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<!-- teaser-end -->
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
*attrs* gives you a class decorator and a way to declaratively define the attributes on that class:
|
||||||
|
|
||||||
|
<!-- code-begin -->
|
||||||
|
|
||||||
|
```pycon
|
||||||
|
>>> from attrs import asdict, define, make_class, Factory
|
||||||
|
|
||||||
|
>>> @define
|
||||||
|
... class SomeClass:
|
||||||
|
... a_number: int = 42
|
||||||
|
... list_of_numbers: list[int] = Factory(list)
|
||||||
|
...
|
||||||
|
... def hard_math(self, another_number):
|
||||||
|
... return self.a_number + sum(self.list_of_numbers) * another_number
|
||||||
|
|
||||||
|
|
||||||
|
>>> sc = SomeClass(1, [1, 2, 3])
|
||||||
|
>>> sc
|
||||||
|
SomeClass(a_number=1, list_of_numbers=[1, 2, 3])
|
||||||
|
|
||||||
|
>>> sc.hard_math(3)
|
||||||
|
19
|
||||||
|
>>> sc == SomeClass(1, [1, 2, 3])
|
||||||
|
True
|
||||||
|
>>> sc != SomeClass(2, [3, 2, 1])
|
||||||
|
True
|
||||||
|
|
||||||
|
>>> asdict(sc)
|
||||||
|
{'a_number': 1, 'list_of_numbers': [1, 2, 3]}
|
||||||
|
|
||||||
|
>>> SomeClass()
|
||||||
|
SomeClass(a_number=42, list_of_numbers=[])
|
||||||
|
|
||||||
|
>>> C = make_class("C", ["a", "b"])
|
||||||
|
>>> C("foo", "bar")
|
||||||
|
C(a='foo', b='bar')
|
||||||
|
```
|
||||||
|
|
||||||
|
After *declaring* your attributes, *attrs* gives you:
|
||||||
|
|
||||||
|
- a concise and explicit overview of the class's attributes,
|
||||||
|
- a nice human-readable `__repr__`,
|
||||||
|
- equality-checking methods,
|
||||||
|
- an initializer,
|
||||||
|
- and much more,
|
||||||
|
|
||||||
|
*without* writing dull boilerplate code again and again and *without* runtime performance penalties.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This example uses *attrs*'s modern APIs that have been introduced in version 20.1.0, and the *attrs* package import name that has been added in version 21.3.0.
|
||||||
|
The classic APIs (`@attr.s`, `attr.ib`, plus their serious-business aliases) and the `attr` package import name will remain **indefinitely**.
|
||||||
|
|
||||||
|
Check out [*On The Core API Names*](https://www.attrs.org/en/latest/names.html) for an in-depth explanation!
|
||||||
|
|
||||||
|
|
||||||
|
### Hate Type Annotations!?
|
||||||
|
|
||||||
|
No problem!
|
||||||
|
Types are entirely **optional** with *attrs*.
|
||||||
|
Simply assign `attrs.field()` to the attributes instead of annotating them with types:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from attrs import define, field
|
||||||
|
|
||||||
|
@define
|
||||||
|
class SomeClass:
|
||||||
|
a_number = field(default=42)
|
||||||
|
list_of_numbers = field(factory=list)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Data Classes
|
||||||
|
|
||||||
|
On the tin, *attrs* might remind you of `dataclasses` (and indeed, `dataclasses` [are a descendant](https://hynek.me/articles/import-attrs/) of *attrs*).
|
||||||
|
In practice it does a lot more and is more flexible.
|
||||||
|
For instance, it allows you to define [special handling of NumPy arrays for equality checks](https://www.attrs.org/en/stable/comparison.html#customization), allows more ways to [plug into the initialization process](https://www.attrs.org/en/stable/init.html#hooking-yourself-into-initialization), has a replacement for `__init_subclass__`, and allows for stepping through the generated methods using a debugger.
|
||||||
|
|
||||||
|
For more details, please refer to our [comparison page](https://www.attrs.org/en/stable/why.html#data-classes), but generally speaking, we are more likely to commit crimes against nature to make things work that one would expect to work, but that are quite complicated in practice.
|
||||||
|
|
||||||
|
|
||||||
|
## Project Information
|
||||||
|
|
||||||
|
- [**Changelog**](https://www.attrs.org/en/stable/changelog.html)
|
||||||
|
- [**Documentation**](https://www.attrs.org/)
|
||||||
|
- [**PyPI**](https://pypi.org/project/attrs/)
|
||||||
|
- [**Source Code**](https://github.com/python-attrs/attrs)
|
||||||
|
- [**Contributing**](https://github.com/python-attrs/attrs/blob/main/.github/CONTRIBUTING.md)
|
||||||
|
- [**Third-party Extensions**](https://github.com/python-attrs/attrs/wiki/Extensions-to-attrs)
|
||||||
|
- **Get Help**: use the `python-attrs` tag on [Stack Overflow](https://stackoverflow.com/questions/tagged/python-attrs)
|
||||||
|
|
||||||
|
|
||||||
|
### *attrs* for Enterprise
|
||||||
|
|
||||||
|
Available as part of the [Tidelift Subscription](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek).
|
||||||
|
|
||||||
|
The maintainers of *attrs* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications.
|
||||||
|
Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
|
||||||
|
|
||||||
|
## Release Information
|
||||||
|
|
||||||
|
### Backwards-incompatible Changes
|
||||||
|
|
||||||
|
- Class-level `kw_only=True` behavior is now consistent with `dataclasses`.
|
||||||
|
|
||||||
|
Previously, a class that sets `kw_only=True` makes all attributes keyword-only, including those from base classes.
|
||||||
|
If an attribute sets `kw_only=False`, that setting is ignored, and it is still made keyword-only.
|
||||||
|
|
||||||
|
Now, only the attributes defined in that class that doesn't explicitly set `kw_only=False` are made keyword-only.
|
||||||
|
|
||||||
|
This shouldn't be a problem for most users, unless you have a pattern like this:
|
||||||
|
|
||||||
|
```python
|
||||||
|
@attrs.define(kw_only=True)
|
||||||
|
class Base:
|
||||||
|
a: int
|
||||||
|
b: int = attrs.field(default=1, kw_only=False)
|
||||||
|
|
||||||
|
@attrs.define
|
||||||
|
class Subclass(Base):
|
||||||
|
c: int
|
||||||
|
```
|
||||||
|
|
||||||
|
Here, we have a `kw_only=True` *attrs* class (`Base`) with an attribute that sets `kw_only=False` and has a default (`Base.b`), and then create a subclass (`Subclass`) with required arguments (`Subclass.c`).
|
||||||
|
Previously this would work, since it would make `Base.b` keyword-only, but now this fails since `Base.b` is positional, and we have a required positional argument (`Subclass.c`) following another argument with defaults.
|
||||||
|
[#1457](https://github.com/python-attrs/attrs/issues/1457)
|
||||||
|
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
- Values passed to the `__init__()` method of `attrs` classes are now correctly passed to `__attrs_pre_init__()` instead of their default values (in cases where *kw_only* was not specified).
|
||||||
|
[#1427](https://github.com/python-attrs/attrs/issues/1427)
|
||||||
|
- Added support for Python 3.14 and [PEP 749](https://peps.python.org/pep-0749/).
|
||||||
|
[#1446](https://github.com/python-attrs/attrs/issues/1446),
|
||||||
|
[#1451](https://github.com/python-attrs/attrs/issues/1451)
|
||||||
|
- `attrs.validators.deep_mapping()` now allows to leave out either *key_validator* xor *value_validator*.
|
||||||
|
[#1448](https://github.com/python-attrs/attrs/issues/1448)
|
||||||
|
- `attrs.validators.deep_iterator()` and `attrs.validators.deep_mapping()` now accept lists and tuples for all validators and wrap them into a `attrs.validators.and_()`.
|
||||||
|
[#1449](https://github.com/python-attrs/attrs/issues/1449)
|
||||||
|
- Added a new **experimental** way to inspect classes:
|
||||||
|
|
||||||
|
`attrs.inspect(cls)` returns the _effective_ class-wide parameters that were used by *attrs* to construct the class.
|
||||||
|
|
||||||
|
The returned class is the same data structure that *attrs* uses internally to decide how to construct the final class.
|
||||||
|
[#1454](https://github.com/python-attrs/attrs/issues/1454)
|
||||||
|
- Fixed annotations for `attrs.field(converter=...)`.
|
||||||
|
Previously, a `tuple` of converters was only accepted if it had exactly one element.
|
||||||
|
[#1461](https://github.com/python-attrs/attrs/issues/1461)
|
||||||
|
- The performance of `attrs.asdict()` has been improved by 45–260%.
|
||||||
|
[#1463](https://github.com/python-attrs/attrs/issues/1463)
|
||||||
|
- The performance of `attrs.astuple()` has been improved by 49–270%.
|
||||||
|
[#1469](https://github.com/python-attrs/attrs/issues/1469)
|
||||||
|
- The type annotation for `attrs.validators.or_()` now allows for different types of validators.
|
||||||
|
|
||||||
|
This was only an issue on Pyright.
|
||||||
|
[#1474](https://github.com/python-attrs/attrs/issues/1474)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[Full changelog →](https://www.attrs.org/en/stable/changelog.html)
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
attr/__init__.py,sha256=fOYIvt1eGSqQre4uCS3sJWKZ0mwAuC8UD6qba5OS9_U,2057
|
||||||
|
attr/__init__.pyi,sha256=IZkzIjvtbRqDWGkDBIF9dd12FgDa379JYq3GHnVOvFQ,11309
|
||||||
|
attr/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/_cmp.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/_compat.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/_config.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/_funcs.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/_make.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/_next_gen.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/_version_info.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/converters.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/exceptions.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/filters.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/setters.cpython-312.pyc,,
|
||||||
|
attr/__pycache__/validators.cpython-312.pyc,,
|
||||||
|
attr/_cmp.py,sha256=3Nn1TjxllUYiX_nJoVnEkXoDk0hM1DYKj5DE7GZe4i0,4117
|
||||||
|
attr/_cmp.pyi,sha256=U-_RU_UZOyPUEQzXE6RMYQQcjkZRY25wTH99sN0s7MM,368
|
||||||
|
attr/_compat.py,sha256=x0g7iEUOnBVJC72zyFCgb1eKqyxS-7f2LGnNyZ_r95s,2829
|
||||||
|
attr/_config.py,sha256=dGq3xR6fgZEF6UBt_L0T-eUHIB4i43kRmH0P28sJVw8,843
|
||||||
|
attr/_funcs.py,sha256=Ix5IETTfz5F01F-12MF_CSFomIn2h8b67EVVz2gCtBE,16479
|
||||||
|
attr/_make.py,sha256=NRJDGS8syg2h3YNflVNoK2FwR3CpdSZxx8M6lacwljA,104141
|
||||||
|
attr/_next_gen.py,sha256=BQtCUlzwg2gWHTYXBQvrEYBnzBUrDvO57u0Py6UCPhc,26274
|
||||||
|
attr/_typing_compat.pyi,sha256=XDP54TUn-ZKhD62TOQebmzrwFyomhUCoGRpclb6alRA,469
|
||||||
|
attr/_version_info.py,sha256=w4R-FYC3NK_kMkGUWJlYP4cVAlH9HRaC-um3fcjYkHM,2222
|
||||||
|
attr/_version_info.pyi,sha256=x_M3L3WuB7r_ULXAWjx959udKQ4HLB8l-hsc1FDGNvk,209
|
||||||
|
attr/converters.py,sha256=GlDeOzPeTFgeBBLbj9G57Ez5lAk68uhSALRYJ_exe84,3861
|
||||||
|
attr/converters.pyi,sha256=orU2bff-VjQa2kMDyvnMQV73oJT2WRyQuw4ZR1ym1bE,643
|
||||||
|
attr/exceptions.py,sha256=HRFq4iybmv7-DcZwyjl6M1euM2YeJVK_hFxuaBGAngI,1977
|
||||||
|
attr/exceptions.pyi,sha256=zZq8bCUnKAy9mDtBEw42ZhPhAUIHoTKedDQInJD883M,539
|
||||||
|
attr/filters.py,sha256=ZBiKWLp3R0LfCZsq7X11pn9WX8NslS2wXM4jsnLOGc8,1795
|
||||||
|
attr/filters.pyi,sha256=3J5BG-dTxltBk1_-RuNRUHrv2qu1v8v4aDNAQ7_mifA,208
|
||||||
|
attr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
attr/setters.py,sha256=5-dcT63GQK35ONEzSgfXCkbB7pPkaR-qv15mm4PVSzQ,1617
|
||||||
|
attr/setters.pyi,sha256=NnVkaFU1BB4JB8E4JuXyrzTUgvtMpj8p3wBdJY7uix4,584
|
||||||
|
attr/validators.py,sha256=1BnYGTuYvSucGEI4ju-RPNJteVzG0ZlfWpJiWoSFHQ8,21458
|
||||||
|
attr/validators.pyi,sha256=ftmW3m4KJ3pQcIXAj-BejT7BY4ZfqrC1G-5W7XvoPds,4082
|
||||||
|
attrs-25.4.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
attrs-25.4.0.dist-info/METADATA,sha256=2Rerxj7agcMRxiwdkt6lC2guqHAmkGKCH13nWWK7ZoQ,10473
|
||||||
|
attrs-25.4.0.dist-info/RECORD,,
|
||||||
|
attrs-25.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
||||||
|
attrs-25.4.0.dist-info/licenses/LICENSE,sha256=iCEVyV38KvHutnFPjsbVy8q_Znyv-HKfQkINpj9xTp8,1109
|
||||||
|
attrs/__init__.py,sha256=RxaAZNwYiEh-fcvHLZNpQ_DWKni73M_jxEPEftiq1Zc,1183
|
||||||
|
attrs/__init__.pyi,sha256=2gV79g9UxJppGSM48hAZJ6h_MHb70dZoJL31ZNJeZYI,9416
|
||||||
|
attrs/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
attrs/__pycache__/converters.cpython-312.pyc,,
|
||||||
|
attrs/__pycache__/exceptions.cpython-312.pyc,,
|
||||||
|
attrs/__pycache__/filters.cpython-312.pyc,,
|
||||||
|
attrs/__pycache__/setters.cpython-312.pyc,,
|
||||||
|
attrs/__pycache__/validators.cpython-312.pyc,,
|
||||||
|
attrs/converters.py,sha256=8kQljrVwfSTRu8INwEk8SI0eGrzmWftsT7rM0EqyohM,76
|
||||||
|
attrs/exceptions.py,sha256=ACCCmg19-vDFaDPY9vFl199SPXCQMN_bENs4DALjzms,76
|
||||||
|
attrs/filters.py,sha256=VOUMZug9uEU6dUuA0dF1jInUK0PL3fLgP0VBS5d-CDE,73
|
||||||
|
attrs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
attrs/setters.py,sha256=eL1YidYQV3T2h9_SYIZSZR1FAcHGb1TuCTy0E0Lv2SU,73
|
||||||
|
attrs/validators.py,sha256=xcy6wD5TtTkdCG1f4XWbocPSO0faBjk5IfVJfP6SUj0,76
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: hatchling 1.27.0
|
||||||
|
Root-Is-Purelib: true
|
||||||
|
Tag: py3-none-any
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2015 Hynek Schlawack and the attrs contributors
|
||||||
|
|
||||||
|
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,72 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from attr import (
|
||||||
|
NOTHING,
|
||||||
|
Attribute,
|
||||||
|
AttrsInstance,
|
||||||
|
Converter,
|
||||||
|
Factory,
|
||||||
|
NothingType,
|
||||||
|
_make_getattr,
|
||||||
|
assoc,
|
||||||
|
cmp_using,
|
||||||
|
define,
|
||||||
|
evolve,
|
||||||
|
field,
|
||||||
|
fields,
|
||||||
|
fields_dict,
|
||||||
|
frozen,
|
||||||
|
has,
|
||||||
|
make_class,
|
||||||
|
mutable,
|
||||||
|
resolve_types,
|
||||||
|
validate,
|
||||||
|
)
|
||||||
|
from attr._make import ClassProps
|
||||||
|
from attr._next_gen import asdict, astuple, inspect
|
||||||
|
|
||||||
|
from . import converters, exceptions, filters, setters, validators
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"NOTHING",
|
||||||
|
"Attribute",
|
||||||
|
"AttrsInstance",
|
||||||
|
"ClassProps",
|
||||||
|
"Converter",
|
||||||
|
"Factory",
|
||||||
|
"NothingType",
|
||||||
|
"__author__",
|
||||||
|
"__copyright__",
|
||||||
|
"__description__",
|
||||||
|
"__doc__",
|
||||||
|
"__email__",
|
||||||
|
"__license__",
|
||||||
|
"__title__",
|
||||||
|
"__url__",
|
||||||
|
"__version__",
|
||||||
|
"__version_info__",
|
||||||
|
"asdict",
|
||||||
|
"assoc",
|
||||||
|
"astuple",
|
||||||
|
"cmp_using",
|
||||||
|
"converters",
|
||||||
|
"define",
|
||||||
|
"evolve",
|
||||||
|
"exceptions",
|
||||||
|
"field",
|
||||||
|
"fields",
|
||||||
|
"fields_dict",
|
||||||
|
"filters",
|
||||||
|
"frozen",
|
||||||
|
"has",
|
||||||
|
"inspect",
|
||||||
|
"make_class",
|
||||||
|
"mutable",
|
||||||
|
"resolve_types",
|
||||||
|
"setters",
|
||||||
|
"validate",
|
||||||
|
"validators",
|
||||||
|
]
|
||||||
|
|
||||||
|
__getattr__ = _make_getattr(__name__)
|
||||||
|
|
@ -0,0 +1,314 @@
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from typing import (
|
||||||
|
Any,
|
||||||
|
Callable,
|
||||||
|
Mapping,
|
||||||
|
Sequence,
|
||||||
|
overload,
|
||||||
|
TypeVar,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Because we need to type our own stuff, we have to make everything from
|
||||||
|
# attr explicitly public too.
|
||||||
|
from attr import __author__ as __author__
|
||||||
|
from attr import __copyright__ as __copyright__
|
||||||
|
from attr import __description__ as __description__
|
||||||
|
from attr import __email__ as __email__
|
||||||
|
from attr import __license__ as __license__
|
||||||
|
from attr import __title__ as __title__
|
||||||
|
from attr import __url__ as __url__
|
||||||
|
from attr import __version__ as __version__
|
||||||
|
from attr import __version_info__ as __version_info__
|
||||||
|
from attr import assoc as assoc
|
||||||
|
from attr import Attribute as Attribute
|
||||||
|
from attr import AttrsInstance as AttrsInstance
|
||||||
|
from attr import cmp_using as cmp_using
|
||||||
|
from attr import converters as converters
|
||||||
|
from attr import Converter as Converter
|
||||||
|
from attr import evolve as evolve
|
||||||
|
from attr import exceptions as exceptions
|
||||||
|
from attr import Factory as Factory
|
||||||
|
from attr import fields as fields
|
||||||
|
from attr import fields_dict as fields_dict
|
||||||
|
from attr import filters as filters
|
||||||
|
from attr import has as has
|
||||||
|
from attr import make_class as make_class
|
||||||
|
from attr import NOTHING as NOTHING
|
||||||
|
from attr import resolve_types as resolve_types
|
||||||
|
from attr import setters as setters
|
||||||
|
from attr import validate as validate
|
||||||
|
from attr import validators as validators
|
||||||
|
from attr import attrib, asdict as asdict, astuple as astuple
|
||||||
|
from attr import NothingType as NothingType
|
||||||
|
|
||||||
|
if sys.version_info >= (3, 11):
|
||||||
|
from typing import dataclass_transform
|
||||||
|
else:
|
||||||
|
from typing_extensions import dataclass_transform
|
||||||
|
|
||||||
|
_T = TypeVar("_T")
|
||||||
|
_C = TypeVar("_C", bound=type)
|
||||||
|
|
||||||
|
_EqOrderType = bool | Callable[[Any], Any]
|
||||||
|
_ValidatorType = Callable[[Any, "Attribute[_T]", _T], Any]
|
||||||
|
_CallableConverterType = Callable[[Any], Any]
|
||||||
|
_ConverterType = _CallableConverterType | Converter[Any, Any]
|
||||||
|
_ReprType = Callable[[Any], str]
|
||||||
|
_ReprArgType = bool | _ReprType
|
||||||
|
_OnSetAttrType = Callable[[Any, "Attribute[Any]", Any], Any]
|
||||||
|
_OnSetAttrArgType = _OnSetAttrType | list[_OnSetAttrType] | setters._NoOpType
|
||||||
|
_FieldTransformer = Callable[
|
||||||
|
[type, list["Attribute[Any]"]], list["Attribute[Any]"]
|
||||||
|
]
|
||||||
|
# FIXME: in reality, if multiple validators are passed they must be in a list
|
||||||
|
# or tuple, but those are invariant and so would prevent subtypes of
|
||||||
|
# _ValidatorType from working when passed in a list or tuple.
|
||||||
|
_ValidatorArgType = _ValidatorType[_T] | Sequence[_ValidatorType[_T]]
|
||||||
|
|
||||||
|
@overload
|
||||||
|
def field(
|
||||||
|
*,
|
||||||
|
default: None = ...,
|
||||||
|
validator: None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
converter: None = ...,
|
||||||
|
factory: None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: bool | None = ...,
|
||||||
|
order: bool | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
type: type | None = ...,
|
||||||
|
) -> Any: ...
|
||||||
|
|
||||||
|
# This form catches an explicit None or no default and infers the type from the
|
||||||
|
# other arguments.
|
||||||
|
@overload
|
||||||
|
def field(
|
||||||
|
*,
|
||||||
|
default: None = ...,
|
||||||
|
validator: _ValidatorArgType[_T] | None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
converter: _ConverterType
|
||||||
|
| list[_ConverterType]
|
||||||
|
| tuple[_ConverterType, ...]
|
||||||
|
| None = ...,
|
||||||
|
factory: Callable[[], _T] | None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
type: type | None = ...,
|
||||||
|
) -> _T: ...
|
||||||
|
|
||||||
|
# This form catches an explicit default argument.
|
||||||
|
@overload
|
||||||
|
def field(
|
||||||
|
*,
|
||||||
|
default: _T,
|
||||||
|
validator: _ValidatorArgType[_T] | None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
converter: _ConverterType
|
||||||
|
| list[_ConverterType]
|
||||||
|
| tuple[_ConverterType, ...]
|
||||||
|
| None = ...,
|
||||||
|
factory: Callable[[], _T] | None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
type: type | None = ...,
|
||||||
|
) -> _T: ...
|
||||||
|
|
||||||
|
# This form covers type=non-Type: e.g. forward references (str), Any
|
||||||
|
@overload
|
||||||
|
def field(
|
||||||
|
*,
|
||||||
|
default: _T | None = ...,
|
||||||
|
validator: _ValidatorArgType[_T] | None = ...,
|
||||||
|
repr: _ReprArgType = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
metadata: Mapping[Any, Any] | None = ...,
|
||||||
|
converter: _ConverterType
|
||||||
|
| list[_ConverterType]
|
||||||
|
| tuple[_ConverterType, ...]
|
||||||
|
| None = ...,
|
||||||
|
factory: Callable[[], _T] | None = ...,
|
||||||
|
kw_only: bool | None = ...,
|
||||||
|
eq: _EqOrderType | None = ...,
|
||||||
|
order: _EqOrderType | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
alias: str | None = ...,
|
||||||
|
type: type | None = ...,
|
||||||
|
) -> Any: ...
|
||||||
|
@overload
|
||||||
|
@dataclass_transform(field_specifiers=(attrib, field))
|
||||||
|
def define(
|
||||||
|
maybe_cls: _C,
|
||||||
|
*,
|
||||||
|
these: dict[str, Any] | None = ...,
|
||||||
|
repr: bool = ...,
|
||||||
|
unsafe_hash: bool | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
slots: bool = ...,
|
||||||
|
frozen: bool = ...,
|
||||||
|
weakref_slot: bool = ...,
|
||||||
|
str: bool = ...,
|
||||||
|
auto_attribs: bool = ...,
|
||||||
|
kw_only: bool = ...,
|
||||||
|
cache_hash: bool = ...,
|
||||||
|
auto_exc: bool = ...,
|
||||||
|
eq: bool | None = ...,
|
||||||
|
order: bool | None = ...,
|
||||||
|
auto_detect: bool = ...,
|
||||||
|
getstate_setstate: bool | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
field_transformer: _FieldTransformer | None = ...,
|
||||||
|
match_args: bool = ...,
|
||||||
|
) -> _C: ...
|
||||||
|
@overload
|
||||||
|
@dataclass_transform(field_specifiers=(attrib, field))
|
||||||
|
def define(
|
||||||
|
maybe_cls: None = ...,
|
||||||
|
*,
|
||||||
|
these: dict[str, Any] | None = ...,
|
||||||
|
repr: bool = ...,
|
||||||
|
unsafe_hash: bool | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
slots: bool = ...,
|
||||||
|
frozen: bool = ...,
|
||||||
|
weakref_slot: bool = ...,
|
||||||
|
str: bool = ...,
|
||||||
|
auto_attribs: bool = ...,
|
||||||
|
kw_only: bool = ...,
|
||||||
|
cache_hash: bool = ...,
|
||||||
|
auto_exc: bool = ...,
|
||||||
|
eq: bool | None = ...,
|
||||||
|
order: bool | None = ...,
|
||||||
|
auto_detect: bool = ...,
|
||||||
|
getstate_setstate: bool | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
field_transformer: _FieldTransformer | None = ...,
|
||||||
|
match_args: bool = ...,
|
||||||
|
) -> Callable[[_C], _C]: ...
|
||||||
|
|
||||||
|
mutable = define
|
||||||
|
|
||||||
|
@overload
|
||||||
|
@dataclass_transform(frozen_default=True, field_specifiers=(attrib, field))
|
||||||
|
def frozen(
|
||||||
|
maybe_cls: _C,
|
||||||
|
*,
|
||||||
|
these: dict[str, Any] | None = ...,
|
||||||
|
repr: bool = ...,
|
||||||
|
unsafe_hash: bool | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
slots: bool = ...,
|
||||||
|
frozen: bool = ...,
|
||||||
|
weakref_slot: bool = ...,
|
||||||
|
str: bool = ...,
|
||||||
|
auto_attribs: bool = ...,
|
||||||
|
kw_only: bool = ...,
|
||||||
|
cache_hash: bool = ...,
|
||||||
|
auto_exc: bool = ...,
|
||||||
|
eq: bool | None = ...,
|
||||||
|
order: bool | None = ...,
|
||||||
|
auto_detect: bool = ...,
|
||||||
|
getstate_setstate: bool | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
field_transformer: _FieldTransformer | None = ...,
|
||||||
|
match_args: bool = ...,
|
||||||
|
) -> _C: ...
|
||||||
|
@overload
|
||||||
|
@dataclass_transform(frozen_default=True, field_specifiers=(attrib, field))
|
||||||
|
def frozen(
|
||||||
|
maybe_cls: None = ...,
|
||||||
|
*,
|
||||||
|
these: dict[str, Any] | None = ...,
|
||||||
|
repr: bool = ...,
|
||||||
|
unsafe_hash: bool | None = ...,
|
||||||
|
hash: bool | None = ...,
|
||||||
|
init: bool = ...,
|
||||||
|
slots: bool = ...,
|
||||||
|
frozen: bool = ...,
|
||||||
|
weakref_slot: bool = ...,
|
||||||
|
str: bool = ...,
|
||||||
|
auto_attribs: bool = ...,
|
||||||
|
kw_only: bool = ...,
|
||||||
|
cache_hash: bool = ...,
|
||||||
|
auto_exc: bool = ...,
|
||||||
|
eq: bool | None = ...,
|
||||||
|
order: bool | None = ...,
|
||||||
|
auto_detect: bool = ...,
|
||||||
|
getstate_setstate: bool | None = ...,
|
||||||
|
on_setattr: _OnSetAttrArgType | None = ...,
|
||||||
|
field_transformer: _FieldTransformer | None = ...,
|
||||||
|
match_args: bool = ...,
|
||||||
|
) -> Callable[[_C], _C]: ...
|
||||||
|
|
||||||
|
class ClassProps:
|
||||||
|
# XXX: somehow when defining/using enums Mypy starts looking at our own
|
||||||
|
# (untyped) code and causes tons of errors.
|
||||||
|
Hashability: Any
|
||||||
|
KeywordOnly: Any
|
||||||
|
|
||||||
|
is_exception: bool
|
||||||
|
is_slotted: bool
|
||||||
|
has_weakref_slot: bool
|
||||||
|
is_frozen: bool
|
||||||
|
# kw_only: ClassProps.KeywordOnly
|
||||||
|
kw_only: Any
|
||||||
|
collected_fields_by_mro: bool
|
||||||
|
added_init: bool
|
||||||
|
added_repr: bool
|
||||||
|
added_eq: bool
|
||||||
|
added_ordering: bool
|
||||||
|
# hashability: ClassProps.Hashability
|
||||||
|
hashability: Any
|
||||||
|
added_match_args: bool
|
||||||
|
added_str: bool
|
||||||
|
added_pickling: bool
|
||||||
|
on_setattr_hook: _OnSetAttrType | None
|
||||||
|
field_transformer: Callable[[Attribute[Any]], Attribute[Any]] | None
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
is_exception: bool,
|
||||||
|
is_slotted: bool,
|
||||||
|
has_weakref_slot: bool,
|
||||||
|
is_frozen: bool,
|
||||||
|
# kw_only: ClassProps.KeywordOnly
|
||||||
|
kw_only: Any,
|
||||||
|
collected_fields_by_mro: bool,
|
||||||
|
added_init: bool,
|
||||||
|
added_repr: bool,
|
||||||
|
added_eq: bool,
|
||||||
|
added_ordering: bool,
|
||||||
|
# hashability: ClassProps.Hashability
|
||||||
|
hashability: Any,
|
||||||
|
added_match_args: bool,
|
||||||
|
added_str: bool,
|
||||||
|
added_pickling: bool,
|
||||||
|
on_setattr_hook: _OnSetAttrType,
|
||||||
|
field_transformer: Callable[[Attribute[Any]], Attribute[Any]],
|
||||||
|
) -> None: ...
|
||||||
|
@property
|
||||||
|
def is_hashable(self) -> bool: ...
|
||||||
|
|
||||||
|
def inspect(cls: type) -> ClassProps: ...
|
||||||
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,3 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from attr.converters import * # noqa: F403
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from attr.exceptions import * # noqa: F403
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from attr.filters import * # noqa: F403
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from attr.setters import * # noqa: F403
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from attr.validators import * # noqa: F403
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
Copyright 2010 Jason Kirtland
|
||||||
|
|
||||||
|
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,60 @@
|
||||||
|
Metadata-Version: 2.3
|
||||||
|
Name: blinker
|
||||||
|
Version: 1.9.0
|
||||||
|
Summary: Fast, simple object-to-object and broadcast signaling
|
||||||
|
Author: Jason Kirtland
|
||||||
|
Maintainer-email: Pallets Ecosystem <contact@palletsprojects.com>
|
||||||
|
Requires-Python: >=3.9
|
||||||
|
Description-Content-Type: text/markdown
|
||||||
|
Classifier: Development Status :: 5 - Production/Stable
|
||||||
|
Classifier: License :: OSI Approved :: MIT License
|
||||||
|
Classifier: Programming Language :: Python
|
||||||
|
Classifier: Typing :: Typed
|
||||||
|
Project-URL: Chat, https://discord.gg/pallets
|
||||||
|
Project-URL: Documentation, https://blinker.readthedocs.io
|
||||||
|
Project-URL: Source, https://github.com/pallets-eco/blinker/
|
||||||
|
|
||||||
|
# Blinker
|
||||||
|
|
||||||
|
Blinker provides a fast dispatching system that allows any number of
|
||||||
|
interested parties to subscribe to events, or "signals".
|
||||||
|
|
||||||
|
|
||||||
|
## Pallets Community Ecosystem
|
||||||
|
|
||||||
|
> [!IMPORTANT]\
|
||||||
|
> This project is part of the Pallets Community Ecosystem. Pallets is the open
|
||||||
|
> source organization that maintains Flask; Pallets-Eco enables community
|
||||||
|
> maintenance of related projects. If you are interested in helping maintain
|
||||||
|
> this project, please reach out on [the Pallets Discord server][discord].
|
||||||
|
>
|
||||||
|
> [discord]: https://discord.gg/pallets
|
||||||
|
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
Signal receivers can subscribe to specific senders or receive signals
|
||||||
|
sent by any sender.
|
||||||
|
|
||||||
|
```pycon
|
||||||
|
>>> from blinker import signal
|
||||||
|
>>> started = signal('round-started')
|
||||||
|
>>> def each(round):
|
||||||
|
... print(f"Round {round}")
|
||||||
|
...
|
||||||
|
>>> started.connect(each)
|
||||||
|
|
||||||
|
>>> def round_two(round):
|
||||||
|
... print("This is round two.")
|
||||||
|
...
|
||||||
|
>>> started.connect(round_two, sender=2)
|
||||||
|
|
||||||
|
>>> for round in range(1, 4):
|
||||||
|
... started.send(round)
|
||||||
|
...
|
||||||
|
Round 1!
|
||||||
|
Round 2!
|
||||||
|
This is round two.
|
||||||
|
Round 3!
|
||||||
|
```
|
||||||
|
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
blinker-1.9.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
blinker-1.9.0.dist-info/LICENSE.txt,sha256=nrc6HzhZekqhcCXSrhvjg5Ykx5XphdTw6Xac4p-spGc,1054
|
||||||
|
blinker-1.9.0.dist-info/METADATA,sha256=uIRiM8wjjbHkCtbCyTvctU37IAZk0kEe5kxAld1dvzA,1633
|
||||||
|
blinker-1.9.0.dist-info/RECORD,,
|
||||||
|
blinker-1.9.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
|
||||||
|
blinker/__init__.py,sha256=I2EdZqpy4LyjX17Hn1yzJGWCjeLaVaPzsMgHkLfj_cQ,317
|
||||||
|
blinker/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
blinker/__pycache__/_utilities.cpython-312.pyc,,
|
||||||
|
blinker/__pycache__/base.cpython-312.pyc,,
|
||||||
|
blinker/_utilities.py,sha256=0J7eeXXTUx0Ivf8asfpx0ycVkp0Eqfqnj117x2mYX9E,1675
|
||||||
|
blinker/base.py,sha256=QpDuvXXcwJF49lUBcH5BiST46Rz9wSG7VW_p7N_027M,19132
|
||||||
|
blinker/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: flit 3.10.1
|
||||||
|
Root-Is-Purelib: true
|
||||||
|
Tag: py3-none-any
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from .base import ANY
|
||||||
|
from .base import default_namespace
|
||||||
|
from .base import NamedSignal
|
||||||
|
from .base import Namespace
|
||||||
|
from .base import Signal
|
||||||
|
from .base import signal
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"ANY",
|
||||||
|
"default_namespace",
|
||||||
|
"NamedSignal",
|
||||||
|
"Namespace",
|
||||||
|
"Signal",
|
||||||
|
"signal",
|
||||||
|
]
|
||||||
Binary file not shown.
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user