python3-commons 0.2.6__tar.gz → 0.13.5__tar.gz

python3_commons-0.13.5/.devcontainer/Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.13.9-slim-trixie
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+
+RUN apt update && \
+    apt install -y curl ca-certificates apt-transport-https wget gnupg && \
+    wget -O- https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor | tee /usr/share/keyrings/postgresql.gpg && \
+    echo deb [arch=amd64,arm64,ppc64el signed-by=/usr/share/keyrings/postgresql.gpg] http://apt.postgresql.org/pub/repos/apt/ trixie-pgdg main | tee /etc/apt/sources.list.d/postgresql.list && \
+    apt update && \
+    apt install -y --no-install-recommends libpq-dev gcc g++ make postgresql-server-dev-18 libffi-dev git cargo pkg-config ssh && \
+    apt clean && \
+    rm -rf /var/lib/{apt,dpkg,cache,log}/

python3_commons-0.13.5/.devcontainer/devcontainer.json

@@ -0,0 +1,23 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/postgres
+{
+    "name": "python3-commons",
+    "dockerComposeFile": "docker-compose.yml",
+    "service": "python3-commons",
+    "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+    // Features to add to the dev container. More info: https://containers.dev/features.
+    // "features": {},
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // This can be used to network with other containers or the host.
+     "forwardPorts": [8080, 5432],
+
+    "postCreateCommand": "uv sync --all-groups --all-extras",
+    "customizations": {
+        "jetbrains": {
+            "backend": "PyCharm"
+        }
+    },
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    "remoteUser": "root"
+}

python3_commons-0.13.5/.devcontainer/docker-compose.yml

@@ -0,0 +1,17 @@
+services:
+  db:
+    image: postgres:18-alpine
+    container_name: db
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_DB: "${POSTGRES_DB:-python3-commons}"
+      POSTGRES_PASSWORD: "${POSTGRES_PASSWORD:-dev}"
+      POSTGRES_USER: "${POSTGRES_USER:-dev}"
+    restart: unless-stopped
+
+    # Add "forwardPorts": ["5432"] to **devcontainer.json** to forward PostgreSQL locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+
+volumes:
+  postgres-data:

python3_commons-0.13.5/.github/workflows/checks.yml

@@ -0,0 +1,63 @@
+name: Checks
+
+on:
+  push:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check Out Repo
+        uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Ruff format check
+        run: |
+          uvx ruff format --diff ./src/ ./tests/
+
+      - name: Ruff default rules and import check
+        run: |
+          uvx ruff check --extend-select I ./src/ ./tests/
+
+#      - name: Pyright check
+#        run: |
+#          uvx pyright ./src/
+#  tests:
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: Check Out Repo
+#        uses: actions/checkout@v5
+#
+#      - name: Install uv
+#        uses: astral-sh/setup-uv@v6
+#        with:
+#          enable-cache: true
+#          cache-dependency-glob: "uv.lock"
+#
+#      - name: "Set up Python"
+#        uses: actions/setup-python@v6
+#        with:
+#          python-version-file: "pyproject.toml"
+#
+#      - name: Install the project
+#        run: uv sync --locked --all-extras --all-groups --dev
+#
+#      - name: Run unittests
+#        run: uv run pytest tests/

{python3-commons-0.2.6 → python3_commons-0.13.5}/.github/workflows/python-publish.yaml

@@ -21,19 +21,27 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v6
       with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
+        python-version-file: "pyproject.toml"
+
+    - name: Install build package
+      run: uv pip install --system build setuptools_scm
+
     - name: Build package
       run: python -m build
+
     - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
         user: __token__
         password: ${{ secrets.PYPI_API_TOKEN }}

python3_commons-0.13.5/.github/workflows/release-on-tag-push.yml

@@ -0,0 +1,52 @@
+name: Create Release on Tag
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags') }}
+    steps:
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+        run: |
+          gh release create "$tag" \
+            --repo="$GITHUB_REPOSITORY" \
+            --title="v${tag#v}" \
+            --generate-notes
+  pypi-build-and-push:
+    name: Build and push wheel package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install build package
+        run: uv pip install --system build setuptools_scm
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

python3_commons-0.13.5/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.9.9
+    hooks:
+      - id: uv-lock
+#      - id: uv-export
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.4
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: [ --fix ]
+        files: ^(migrations/|src/|tests/).*
+        types_or: [ python, pyi ]
+      # Run the import sort.
+      - id: ruff-check
+        args:
+          - --select
+          - I
+          - --fix
+        files: ^(migrations/|src/|tests/).*
+        types_or: [ python, pyi ]
+      # Run the formatter.
+      - id: ruff-format
+        files: ^(migrations/|src/|tests/).*
+        types_or: [ python, pyi ]
+
+#  - repo: local
+#    hooks:
+#      - id: pyright
+#        name: Run pyright via uvx
+#        entry: uvx pyright ./src ./tests
+#        language: system
+#        pass_filenames: false

python3_commons-0.13.5/.python-version

@@ -0,0 +1 @@
+>=3.13.9,<3.15.0

python3_commons-0.13.5/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: python3-commons
+Version: 0.13.5
+Summary: Re-usable Python3 code
+Author-email: Oleg Korsak <kamikaze.is.waiting.you@gmail.com>
+License-Expression: GPL-3.0
+Project-URL: Homepage, https://github.com/kamikaze/python3-commons
+Project-URL: Documentation, https://github.com/kamikaze/python3-commons/wiki
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Python: <3.15.0,>=3.13.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: aiobotocore~=2.25.2
+Requires-Dist: aiohttp[speedups]<3.15.0,>=3.12.0
+Requires-Dist: asyncpg~=0.30.0
+Requires-Dist: lxml~=6.0.2
+Requires-Dist: msgpack~=1.1.2
+Requires-Dist: msgspec~=0.19.0
+Requires-Dist: pydantic-settings~=2.12.0
+Requires-Dist: SQLAlchemy[asyncio]~=2.0.44
+Requires-Dist: valkey[libvalkey]~=6.1.1
+Requires-Dist: zeep~=4.3.2
+Dynamic: license-file
+
+Re-usable Python3 code
+======================
+
+Some description here

python3_commons-0.13.5/pyproject.toml

@@ -0,0 +1,154 @@
+[build-system]
+requires = ["setuptools", "wheel", "setuptools_scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python3-commons"
+dynamic = ["version"]
+description = "Re-usable Python3 code"
+authors = [
+    {name = "Oleg Korsak", email = "kamikaze.is.waiting.you@gmail.com"}
+]
+license = "GPL-3.0"
+readme = {file = "README.rst", content-type = "text/x-rst"}
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python"
+]
+keywords = []
+requires-python = ">=3.13.9,<3.15.0"
+dependencies = [
+    "aiobotocore~=2.25.2",
+    "aiohttp[speedups]>=3.12.0,<3.15.0",
+    "asyncpg~=0.30.0",
+    "lxml~=6.0.2",
+    "msgpack~=1.1.2",
+    "msgspec~=0.19.0",
+    "pydantic-settings~=2.12.0",
+    "SQLAlchemy[asyncio]~=2.0.44",
+    "valkey[libvalkey]~=6.1.1",
+    "zeep~=4.3.2"
+]
+
+[dependency-groups]
+dev = [
+    "build",
+    "pip",
+    "pre-commit",
+    "pyright",
+    "ruff",
+    "setuptools",
+    "setuptools_scm",
+    "types-aiobotocore[s3]",
+    "wheel",
+]
+testing = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-mock",
+]
+
+[project.urls]
+Homepage = "https://github.com/kamikaze/python3-commons"
+Documentation = "https://github.com/kamikaze/python3-commons/wiki"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["tests"]
+
+[tool.setuptools_scm]
+
+[tool.bdist_wheel]
+universal = true
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+target-version = "py313"
+
+[tool.ruff.analyze]
+detect-string-imports = true
+
+[tool.ruff.lint]
+select = [
+    "FAST",
+    "YTT",
+#    "ANN",
+    "I",
+    "E",
+    "W",
+    "PYI",
+
+    "A",
+#    "ARG",
+    "ASYNC",
+    "B",
+    "C4",
+#    "DTZ",
+    "EM",
+    "EXE",
+    "F",
+    "FA",
+    "FBT",
+    "FLY",
+    "FURB",
+#    "G",
+    "ICN",
+    "INP",
+    "ISC",
+    "LOG",
+    "N",
+    "NPY",
+    "PD",
+    "PERF",
+    "PIE",
+    "PLC",
+    "PLE",
+#    "PLR",
+    "PLW",
+    "PT",
+    "PTH",
+    "Q",
+    "RET",
+    "RSE",
+    "RUF",
+    "S",
+    "SIM",
+    "SLF",
+    "SLOT",
+    "T20",
+    "TC",
+    "TID",
+    "TRY",
+    "UP",
+]
+ignore = [
+    "ASYNC109",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*.py" = ["DTZ", "S101"]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+inline-quotes = "single"
+
+[tool.ruff.format]
+exclude = ["*.pyi"]
+indent-style = "space"
+quote-style = "single"
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"
+reportMatchNotExhaustive = "error"
+reportUnnecessaryComparison = "error"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+asyncio_mode = "strict"
+asyncio_default_fixture_loop_scope = "function"
+addopts = "--cov python3_commons --cov-fail-under=20 --cov-report term-missing --verbose"
+norecursedirs = ["dist", "build", ".tox"]
+testpaths = ["tests"]

python3_commons-0.13.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

python3_commons-0.13.5/src/python3_commons/__init__.py

@@ -0,0 +1,7 @@
+import importlib.metadata
+
+try:
+    dist_name = __name__
+    __version__ = importlib.metadata.version(dist_name)
+except importlib.metadata.PackageNotFoundError:
+    __version__ = 'unknown'

python3_commons-0.13.5/src/python3_commons/api_client.py

@@ -0,0 +1,148 @@
+import errno
+import logging
+from collections.abc import AsyncGenerator, Mapping, Sequence
+from contextlib import asynccontextmanager
+from datetime import UTC, datetime
+from enum import Enum
+from http import HTTPStatus
+from json import dumps
+from typing import Literal
+from uuid import uuid4
+
+from aiohttp import ClientResponse, ClientSession, ClientTimeout, client_exceptions
+from aiohttp.abc import URL
+
+from python3_commons import audit
+from python3_commons.conf import s3_settings
+from python3_commons.helpers import request_to_curl
+from python3_commons.serializers.json import CustomJSONEncoder
+
+logger = logging.getLogger(__name__)
+
+
+async def _store_response_for_audit(
+    response: ClientResponse, audit_name: str, uri_path: str, method: str, request_id: str
+) -> None:
+    response_text = await response.text()
+
+    if response_text:
+        now = datetime.now(tz=UTC)
+        date_path = now.strftime('%Y/%m/%d')
+        timestamp = now.strftime('%H%M%S_%f')
+
+        await audit.write_audit_data(
+            s3_settings,
+            f'{date_path}/{audit_name}/{uri_path}/{method}_{timestamp}_{request_id}_response.txt',
+            response_text.encode('utf-8'),
+        )
+
+
+@asynccontextmanager
+async def request(
+    client: ClientSession,
+    base_url: str,
+    uri: str,
+    query: Mapping | None = None,
+    method: Literal['get', 'post', 'put', 'patch', 'options', 'head', 'delete'] = 'get',
+    headers: Mapping | None = None,
+    json: Mapping | Sequence | str | None = None,
+    data: bytes | None = None,
+    timeout: ClientTimeout | Enum | None = None,
+    audit_name: str | None = None,
+) -> AsyncGenerator[ClientResponse]:
+    now = datetime.now(tz=UTC)
+    date_path = now.strftime('%Y/%m/%d')
+    timestamp = now.strftime('%H%M%S_%f')
+    request_id = str(uuid4())[-12:]
+    uri_path = uri.removesuffix('/')
+    uri_path = uri_path.removeprefix('/')
+    url = f'{u[:-1] if (u := str(base_url)).endswith("/") else u}{uri}'
+
+    if audit_name:
+        curl_request = None
+        cookies = client.cookie_jar.filter_cookies(URL(base_url)) if base_url else None
+
+        if method == 'get':
+            if headers or query:
+                curl_request = request_to_curl(url=url, query=query, method=method, headers=headers, cookies=cookies)
+        else:
+            curl_request = request_to_curl(
+                url=url, query=query, method=method, headers=headers, cookies=cookies, json=json, data=data
+            )
+
+        if curl_request:
+            await audit.write_audit_data(
+                s3_settings,
+                f'{date_path}/{audit_name}/{uri_path}/{method}_{timestamp}_{request_id}_request.txt',
+                curl_request.encode('utf-8'),
+            )
+
+    client_method = getattr(client, method)
+
+    logger.debug(f'Requesting {method} {url}')
+
+    try:
+        if method == 'get':
+            async with client_method(url, params=query, headers=headers, timeout=timeout) as response:
+                if audit_name:
+                    await _store_response_for_audit(response, audit_name, uri_path, method, request_id)
+
+                if response.ok:
+                    yield response
+                else:
+                    match response.status:
+                        case HTTPStatus.UNAUTHORIZED:
+                            msg = 'Unauthorized'
+
+                            raise PermissionError(msg)
+                        case HTTPStatus.FORBIDDEN:
+                            msg = 'Forbidden'
+
+                            raise PermissionError(msg)
+                        case HTTPStatus.NOT_FOUND:
+                            msg = 'Not found'
+
+                            raise LookupError(msg)
+                        case HTTPStatus.BAD_REQUEST:
+                            msg = 'Bad request'
+
+                            raise ValueError(msg)
+                        case HTTPStatus.TOO_MANY_REQUESTS:
+                            msg = 'Too many requests'
+
+                            raise InterruptedError(msg)
+                        case _:
+                            response.raise_for_status()
+        else:
+            if json:
+                data = dumps(json, cls=CustomJSONEncoder).encode('utf-8')
+
+                if headers:
+                    headers = {**headers, 'Content-Type': 'application/json'}
+                else:
+                    headers = {'Content-Type': 'application/json'}
+
+            async with client_method(url, params=query, data=data, headers=headers, timeout=timeout) as response:
+                if audit_name:
+                    await _store_response_for_audit(response, audit_name, uri_path, method, request_id)
+
+                yield response
+    except client_exceptions.ClientConnectorError as e:
+        msg = 'Cient connection error'
+
+        raise ConnectionRefusedError(msg) from e
+    except client_exceptions.ClientOSError as e:
+        if e.errno == errno.EPIPE:
+            msg = 'Broken pipe'
+
+            raise ConnectionResetError(msg) from e
+        elif e.errno == errno.ECONNRESET:
+            msg = 'Connection reset by peer'
+
+            raise ConnectionResetError(msg) from e
+
+        raise
+    except client_exceptions.ServerDisconnectedError as e:
+        msg = 'Server disconnected'
+
+        raise ConnectionResetError(msg) from e