yookassax 1.2__tar.gz

yookassax-1.2/.github/workflows/release.yml

@@ -0,0 +1,75 @@
+# Публикация на PyPI по тегу вида v1.2.
+#
+# Токен нигде не хранится: PyPI доверяет этому workflow по OIDC (доверенная
+# публикация). Настраивается один раз на pypi.org, в разделе Publishing:
+# владелец Sepera-okeq, репозиторий yookassax, файл release.yml, окружение pypi.
+name: release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Установить зависимости
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]" build
+
+      # Версию нельзя перезалить, поэтому расхождение тега и пакета ловим до
+      # сборки: иначе тег v1.2 опубликует что-нибудь другое, и это навсегда.
+      - name: Сверить тег с версией пакета
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          version=$(python -c "import yookassax; print(yookassax.__version__)")
+          if [ "$tag" != "$version" ]; then
+            echo "тег $tag, а версия пакета $version"
+            exit 1
+          fi
+
+      - name: Тесты
+        run: pytest -q
+
+      - name: Проверки
+        run: |
+          ruff check .
+          mypy src
+
+      - name: Собрать пакет
+        run: python -m build
+
+      # twine check смотрит, отрендерится ли README на странице пакета.
+      - name: Проверить пакет
+        run: |
+          pip install twine
+          twine check dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # Право выпустить OIDC-токен, которым PyPI опознаёт этот workflow.
+      # Без него доверенная публикация не работает.
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

yookassax-1.2/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

yookassax-1.2/AGENTS.md

@@ -0,0 +1,123 @@
+# Правила работы в этом репозитории
+
+Гайд для того, кто правит `yookassax`, включая ИИ-ассистентов. Библиотека
+неофициальная: с ЮKassa и ЮMoney не связана, ими не поддерживается. В
+документации и в описании пакета это должно быть сказано прямо, иначе
+пользователь решит, что перед ним продукт ЮKassa. Справочник по
+самой библиотеке лежит отдельно: [`docs/llms.txt`](docs/llms.txt).
+
+## Устройство
+
+```
+src/yookassax/
+    errors.py           иерархия исключений
+    credentials.py      ключи доступа
+    retry.py            политика повторов
+    operation.py        описание одного вызова API
+    transport.py        сборка запроса и разбор ответа
+    unknown_fields.py   предупреждение о полях, которых нет в моделях
+    models/             типизированные модели, по файлу на домен
+    operations/         каталог операций, по файлу на ресурс
+    resources/          фасады ресурсов, оба режима рядом
+    clients/            синхронный и асинхронный клиенты
+    webhooks/           разбор уведомлений и проверка источника
+```
+
+Ключевая идея: **операция описывается один раз**. Клиенты не содержат своей
+логики, они только исполняют описание. Поэтому синхронный и асинхронный режимы
+не могут разойтись в поведении.
+
+## Как добавить эндпоинт
+
+1. Функция-построитель в `operations/<ресурс>.py`, возвращает `Operation`.
+2. По методу в синхронный и асинхронный класс в `resources/<ресурс>.py`.
+   Тело метода одна строка: вызов `self._client.send(...)`.
+3. Если появился новый тип объекта, модель в `models/`.
+4. Тест.
+
+Новое поле в ответе описывается в модели, а не оставляется на `extra()`. Тест
+`test_models_cover_documented_fields` сверяет модели со спецификацией: пока
+поле не описано, разбор ответа выдаёт `UnknownFieldWarning`, и предупреждение,
+которое срабатывает на давно документированном поле, начинают глушить фильтром
+вместе с настоящими новыми полями.
+
+Сверьтесь со спецификацией: `docs/yookassa-openapi.yaml`. Тест
+`test_spec_coverage.py` проверяет, что реализованы все её маршруты и что в
+библиотеке нет путей, которых в спецификации нет. Именно он поймал опечатку в
+кассовых ссылках: метод называется `change_recipient`, а путь в API просто
+`/recipient`.
+
+## Стиль
+
+PEP 8, длина строки 88. Проверяется `ruff check .`.
+
+Комментарии и docstring-и на русском. Комментарий объясняет **почему**, а не
+пересказывает код. Неочевидное решение и грабли комментируем, очевидное нет.
+
+Не украшаем текст символами псевдографики и стрелками: обычные дефисы, обычные
+слова.
+
+Идентификаторы только латиницей, включая имена тестов. Docstring теста может
+быть на русском и должен объяснять, что именно и зачем проверяется.
+
+## Что нельзя менять, не подумав
+
+**Ключи живут в экземпляре клиента.** Не переносите их в глобальную
+переменную или на класс. Именно из-за этого в официальном SDK возможна гонка:
+при работе с несколькими магазинами два платежа переписывают токен друг другу,
+и платёж уходит через чужой магазин.
+
+**Ключ идемпотентности при повторе тот же.** Повтор с новым ключом создаст
+второй платёж. Это правило проверяется тестом
+`test_network_failure_retries_with_same_key`.
+
+**Ошибки данных не повторяются.** Повторять 400 и 404 бессмысленно, а на
+платёжных путях ещё и вредно: это лишняя нагрузка в момент, когда что-то уже
+пошло не так.
+
+**Модели терпимы к новым полям.** ЮKassa добавляет поля в ответы. Строгая
+валидация превратила бы это в отказ обслуживать платежи. Неизвестное
+складывается в `raw`.
+
+**Суммы только `Decimal`.** Ни `float`, ни `Decimal(float)`: разбирайте через
+строку, иначе `Decimal(0.1)` даст `0.1000000000000000055`.
+
+**Предупреждение о неизвестном поле дедуплицируется.** Один раз на пару
+"модель плюс поле" за жизнь процесса. Без этого страница из ста платежей даёт
+сто одинаковых строк, а лог, в котором одно и то же повторяется сотнями,
+читать перестают, и предупреждение теряет смысл.
+
+**Поле `type` перекрывает встроенный `type`.** У части моделей есть поле с
+таким именем, и внутри класса аннотация `dict[str, type]` начинает ссылаться на
+поле, а не на класс. Для таких случаев в `models/base.py` объявлен псевдоним
+`ModelClass`, используйте его.
+
+## Документация
+
+Вся документация парная: русская версия и английская. Русская основная,
+английская её перевод.
+
+```
+README.md            README.en.md
+docs/llms.txt        docs/llms.en.txt
+docs/examples/ru/    docs/examples/en/
+```
+
+Новый эндпоинт или изменившееся поведение правится сразу в обеих версиях.
+Файл, у которого нет пары, хуже отсутствующего: читатель второй версии решит,
+что описанного там просто нет в библиотеке.
+
+Примеры показывают оба режима: сначала синхронный, следом тот же вызов с
+`await`. Именно это различие и есть весь переход между режимами, показывать
+его каждый раз дешевле, чем объяснять один раз в начале.
+
+## Проверка перед сдачей
+
+```bash
+pytest
+ruff check .
+mypy src
+```
+
+Тесты не ходят в сеть: HTTP подменяется через `respx`. Если тесту нужен
+реальный запрос, значит он проверяет не то.

yookassax-1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sepera_okeq
+
+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.