tquality-py-core 0.1.4__tar.gz

tquality_py_core-0.1.4/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+*.pyc
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.venv/
+.env
+*.log
+logs/
+.pytest_cache/
+uv.lock
+.idea/
+.vscode/

tquality_py_core-0.1.4/CONTRIBUTING.md

@@ -0,0 +1,196 @@
+# Руководство для контрибьюторов
+
+## Требования
+
+- Python 3.12+
+- [uv](https://docs.astral.sh/uv/) для управления окружением и зависимостями
+
+## Настройка окружения
+
+```bash
+uv sync
+```
+
+Команда создаст `.venv/` и установит зависимости проекта плюс dev-группу
+(mypy и др.).
+
+## Установка git-хуков
+
+Для автоматической проверки типов mypy перед каждым коммитом выполните:
+
+```bash
+./scripts/install-hooks.sh
+```
+
+Скрипт установит pre-commit хук, который запускает `uv run mypy` и блокирует
+коммит при ошибках типов.
+
+## Стиль кода
+
+- Все комментарии, docstring, сообщения логов - на русском языке.
+- Не используйте m-тире (длинное тире). Используйте обычное тире или
+  переформулируйте.
+- Не добавляйте строку `Co-Authored-By` в commit-сообщения.
+
+## Формат commit-сообщений
+
+Каждый коммит начинается с одного или нескольких тегов в квадратных скобках
+(на английском), затем краткое описание на русском языке.
+
+### Доступные теги
+
+- `[{module}]` - название затронутого модуля: `[Config]`, `[Logger]`, `[BaseForm]`, `[BaseElement]`, `[StringUtils]`, `[CI]`
+- `[Docs]` - изменения документации (README, CONTRIBUTING, docstring'и)
+- `[Fix]` - исправление бага без привязки к issue
+- `[Fix #{issueId}]` - исправление бага по конкретному issue, например `[Fix #42]`
+- `[Style]` - только форматирование, без изменения логики (whitespace, импорты)
+- `[Feature]` - новая функциональность
+
+### Примеры
+
+```
+[Logger] Имена файлов логов на основе pytest node_id
+[Config][Feature] Поддержка config.json на уровне workspace
+[Fix #12] Исправлен stale element в type_text
+[Docs] Обновлен CONTRIBUTING с процессом релиза
+[BaseElement][Style] Упорядочены объявления абстрактных методов
+[CI][Fix] Unshallow clone перед push'ем в зеркало
+```
+
+Теги можно комбинировать, например `[Config][Feature]` или `[BaseForm][Fix]`.
+Теги остаются на английском, чтобы легко фильтровать и автоматизировать.
+
+## Проверка типов
+
+Проект использует `mypy` в strict-режиме. Перед push'ем проверьте:
+
+```bash
+uv run mypy
+```
+
+Ошибки типов блокируют merge в master.
+
+## Запуск тестов
+
+```bash
+uv run pytest -v
+```
+
+Тесты запускаются автоматически в CI на каждый MR.
+
+## Обновление JSON-схемы
+
+Схема `schema/config.schema.json` должна совпадать со схемой, генерируемой
+из `BaseConfig`. Если вы изменили поля `BaseConfig`, обновите схему:
+
+```bash
+uv run tquality-config schema
+```
+
+Коммит с изменением `BaseConfig` без обновления схемы провалит тест
+`test_committed_schema_matches_base_config` в CI.
+
+## Сборка пакета
+
+```bash
+uv build
+```
+
+Артефакты появятся в `dist/`.
+
+## Релиз
+
+Версия пакета берется из последнего git-тега вида `vX.Y.Z` через
+`hatch-vcs`. В `pyproject.toml` версия не указывается (поле `dynamic`),
+поэтому рассинхронизация тега и пакета невозможна.
+
+Ставьте тег **только на master** (после merge соответствующего MR).
+`mirror-to-github` публикует на GitHub именно то, что на master, и
+проверяет, что коммит тега достижим из master. Тег на feature-ветке
+провалит зеркалирование.
+
+```bash
+git checkout master
+git pull
+git tag -a v0.2.0 -m "v0.2.0"
+git push origin v0.2.0
+```
+
+Push тега `vX.Y.Z` триггерит три CI-джоба в stage `release`:
+
+- **`publish-pypi`** - сборка (`uv build` получает версию из тега через
+  `hatch-vcs`) и публикация пакета в публичный
+  [PyPI](https://pypi.org/project/tquality-py-core/). Это основной канал
+  установки для всех потребителей.
+- **`publish`** - дублирующая публикация в GitLab Package Registry
+  (`https://git.tquality.ru/frameworks/python/tquality-py-core/-/packages`)
+  как внутреннее зеркало.
+- **`mirror-to-github`** - пушит `master` и сам тег в
+  https://github.com/Tquality-ru/tquality-py-core (feature-ветки и
+  служебные refs не зеркалируются).
+
+### Настройка публикации в PyPI (однократно)
+
+1. На https://pypi.org/manage/account/token/ создать API-токен со
+   scope, ограниченным проектом `tquality-py-core` (после первой
+   ручной публикации). Для самой первой публикации нужен токен с
+   глобальным scope.
+2. В GitLab: **Settings → CI/CD → Variables** добавить переменную:
+   - Key: `PYPI_TOKEN`
+   - Value: токен с PyPI (включая префикс `pypi-`)
+   - Protected: yes (только для protected refs, включая теги `v*`)
+   - Masked: yes
+
+### Установка пакета из GitLab Package Registry (внутренний канал)
+
+```bash
+uv pip install tquality-py-core \
+  --index-url "https://gitlab-ci-token:${GITLAB_TOKEN}@git.tquality.ru/api/v4/projects/42/packages/pypi/simple"
+```
+
+Либо добавьте в `pyproject.toml` консьюмера:
+
+```toml
+[[tool.uv.index]]
+name = "tquality"
+url = "https://git.tquality.ru/api/v4/projects/42/packages/pypi/simple"
+explicit = true
+
+[tool.uv.sources]
+tquality-py-core = { index = "tquality" }
+```
+
+### Настройка зеркалирования в GitHub (однократно)
+
+1. Создать GitHub Personal Access Token с правами `public_repo` (или `repo`
+   для приватных).
+2. В GitLab: **Settings → CI/CD → Variables** добавить переменную:
+   - Key: `GITHUB_MIRROR_TOKEN`
+   - Value: токен с GitHub
+   - Protected: yes (только для protected refs, включая теги `v*`)
+   - Masked: yes
+
+Для публикации в Package Registry дополнительная настройка не нужна: джоб
+использует встроенный `CI_JOB_TOKEN`.
+
+## Структура репозитория
+
+```
+tquality-py-core/
+├── .gitlab-ci.yml          # CI: mypy + pytest на MR и master
+├── pyproject.toml          # конфиг проекта, mypy, зависимости
+├── scripts/
+│   └── install-hooks.sh    # установка git pre-commit хука
+├── schema/
+│   └── config.schema.json  # JSON-схема BaseConfig (публикуется через jsDelivr)
+├── src/tquality_core/
+│   ├── cli.py              # CLI: tquality-config init / schema
+│   ├── config.py           # BaseConfig
+│   ├── schema.py           # генератор JSON-схемы
+│   ├── elements/           # BaseElement (ABC)
+│   ├── pages/              # BaseForm
+│   ├── services/           # Logger, step, ScreenshotProvider
+│   └── utils/              # StringUtils
+├── tests/                  # pytest тесты
+└── README.md
+```

tquality_py_core-0.1.4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ООО «Точка качества»
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tquality_py_core-0.1.4/NOTICE

@@ -0,0 +1,5 @@
+tquality-py-core
+Copyright 2026 ООО «Точка качества»
+
+This product includes software developed by
+ООО «Точка качества» (https://tquality.ru).

tquality_py_core-0.1.4/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.4
+Name: tquality-py-core
+Version: 0.1.4
+Summary: Driver-agnostic core for tquality test automation (Selenium, Appium, WinAppDriver, etc.)
+Project-URL: Homepage, https://github.com/Tquality-ru/tquality-py-core
+Project-URL: Repository, https://github.com/Tquality-ru/tquality-py-core
+Project-URL: Issues, https://github.com/Tquality-ru/tquality-py-core/issues
+Project-URL: Changelog, https://github.com/Tquality-ru/tquality-py-core/blob/master/CHANGELOG.md
+Author: ООО «Точка качества»
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: allure,appium,page-object,qa,selenium,test-automation,testing,tquality,winappdriver
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: allure-python-commons>=2.13
+Requires-Dist: dependency-injector>=4.41
+Requires-Dist: json5>=0.9
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic>=2.0
+Description-Content-Type: text/markdown
+
+# tquality-py-core
+
+Независимое от драйвера ядро для автоматизации тестирования tquality. Предоставляет
+основу, на которой строятся пакеты, специфичные для драйверов (Selenium,
+Appium, WinAppDriver).
+
+## Компоненты
+
+- **`BaseConfig`** - конфигурация на основе pydantic-settings с загрузкой из
+  `config.json5` (с поддержкой комментариев и висячих запятых через json5),
+  переменных окружения и dotenv. Для добавления полей, специфичных для
+  драйвера, используется наследование.
+- **`Logger`, `LogLevel`, `step`** - журналирование в контексте одного теста
+  с интеграцией allure. Уровни шагов: `NORMAL`, `CRITICAL` (снимок экрана в
+  конце) и `WITH_SCREENCAST` (видеозапись шага через подключаемый поставщик).
+- **`BaseForm`** - базовый класс для страниц и форм (страница - форма с полным
+  контекстом).
+- **`BaseElement`** - абстрактный интерфейс, который реализуют элементы,
+  специфичные для драйвера.
+- **`StringUtils`** - вспомогательные функции разбора строк.
+
+## Не входит в ядро
+
+- Конкретная интеграция с драйверами (Selenium, Appium, WinAppDriver) -
+  живёт в отдельных пакетах, зависящих от этого ядра.
+- Типы элементов (`Button`, `Input`, `Label` и т. п.) - реализации,
+  специфичные для драйвера, живут рядом с интеграцией драйвера.
+- Настройка контейнера внедрения зависимостей - каждый использующий пакет
+  собирает свой контейнер через `dependency-injector`, регистрируя службы
+  ядра и службы, специфичные для драйвера.
+
+## Контракт интеграции
+
+Использующие пакеты должны:
+
+1. Наследовать `BaseConfig` с полями, специфичными для драйвера.
+2. Зарегистрировать функцию получения `Logger` через
+   `set_logger_resolver(lambda: YourServices.logger())`, где `YourServices` -
+   контейнер использующего пакета. Это нужно, чтобы `step()` из ядра
+   находил активный `Logger` в любом модуле.
+3. При необходимости реализовать `ScreenshotProvider` / `ScreencastProvider`
+   и внедрить их в `Logger` через контейнер, чтобы шаги уровня `CRITICAL`
+   прикрепляли снимки экрана, а `WITH_SCREENCAST` - видеозапись (конкретный
+   формат - на стороне поставщика, например webm в Selenium) к отчёту
+   allure. Без поставщиков шаги проходят с предупреждением в журнал.
+4. Предоставить конкретные подклассы `BaseElement` с логикой поиска и
+   ожидания.
+
+## Требования
+
+- Python 3.12+
+
+## Установка
+
+Пакет публикуется в [публичный PyPI](https://pypi.org/project/tquality-py-core/).
+Это рекомендуемый способ установки для всех потребителей:
+
+```bash
+pip install tquality-py-core
+```
+
+или с использованием [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add tquality-py-core
+```
+
+В `pyproject.toml` потребителя:
+
+```toml
+dependencies = [
+    "tquality-py-core>=0.1.3",
+]
+```
+
+### Альтернатива: установка из GitHub-зеркала
+
+Если нужна сборка из исходников (например, для проверки коммита,
+ещё не вышедшего в релиз), пакет также доступен из публичного
+GitHub-зеркала по тегу:
+
+```bash
+uv pip install "tquality-py-core @ git+https://github.com/Tquality-ru/tquality-py-core.git@v0.1.3"
+```
+
+В этом случае hatch у потребителя требует явного разрешения
+`direct-references`:
+
+```toml
+[tool.hatch.metadata]
+allow-direct-references = true
+```
+
+## CLI
+
+После установки доступна команда `tquality-config`:
+
+```bash
+tquality-config init        # сгенерировать config.json5 со значениями по умолчанию
+tquality-config schema      # сгенерировать schema/config.schema.json (для сопровождающих)
+```
+
+Сгенерированный `config.json5` включает ссылку на JSON-схему, опубликованную
+через jsDelivr. Адрес автоматически привязан к версии пакета: при установке
+выпущенной версии (`0.1.3`) → `@v0.1.3`, при установке невыпущенной версии
+(`+g...`, `.dev`) → `@master`:
+
+```jsonc
+{
+    "$schema": "https://cdn.jsdelivr.net/gh/Tquality-ru/tquality-py-core@v0.1.3/schema/config.schema.json",
+    // Комментарии поддерживаются - можно пояснить выбор значения.
+    "base_url": "http://localhost",
+    "default_timeout": 10.0,
+    "log_dir": "logs",
+    "highlight_elements": false,
+}
+```
+
+Редакторы с поддержкой JSON Schema (VS Code, JetBrains IDE) автоматически
+подсказывают доступные поля и проверяют значения. Синтаксис jsonc/json5
+позволяет оставлять комментарии `//` и `/* */` и висячие запятые.
+
+## Разработка
+
+См. [CONTRIBUTING.md](CONTRIBUTING.md) для инструкций по настройке окружения
+разработчика, установке перехватчиков git и проверке типов mypy.
+
+## CI/CD
+
+GitLab CI запускает две проверки на каждом MR и на master:
+
+- **`mypy`** - строгий режим проверки типов.
+- **`tests`** - запуск pytest с отчётом JUnit.
+
+При публикации тега git вида `vX.Y.Z`:
+
+- **`publish-pypi`** - сборка (версия берётся из тега через `hatch-vcs`)
+  и загрузка пакета в публичный
+  [PyPI](https://pypi.org/project/tquality-py-core/). Требует переменную
+  `PYPI_TOKEN` в настройках CI/CD (protected, masked).
+- **`publish`** - дублирующая публикация в GitLab Package Registry
+  (внутреннее зеркало).
+- **`mirror-to-github`** - master и сам тег отправляются в
+  https://github.com/Tquality-ru/tquality-py-core (ветки `feature/*`
+  на зеркало не копируются).
+
+История версий - в [CHANGELOG.md](CHANGELOG.md).
+
+## Зачем это существует
+
+Отделяет универсальные шаблоны (журналирование, объекты страниц, загрузка
+конфигурации) от кода, специфичного для драйвера. Appium и WinAppDriver
+повторно используют ту же модель объектов страниц, отчётность по шагам и
+конвейер конфигурации без обязательной зависимости от Selenium.