probirka 0.3.0__tar.gz

probirka-0.3.0/.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_size = 4
+
+[{Makefile,**.mk}]
+indent_style = tab
+
+[*.{md,txt,rst}]
+trim_trailing_whitespace = false

probirka-0.3.0/.github/workflows/pypi.yml

@@ -0,0 +1,25 @@
+---
+name: 👷🏼 pypi
+
+on:
+  release:
+    types: [ created ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Extract branch name
+        shell: bash
+        run: |
+          echo "##[set-output name=ver;]$(echo ${GITHUB_REF#refs/*/})"
+        id: extract_name_and_version
+      - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' pyproject.toml
+      - run: head -n 10 pyproject.toml
+      - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' probirka/__init__.py
+      - uses: astral-sh/setup-uv@v4
+      - run: uv python install 3.12
+      - run: uv sync --all-extras --dev
+      - run: uv build
+      - run: uv publish --username __token__ --password ${{ secrets.PYPI_TOKEN }}

probirka-0.3.0/.github/workflows/tests.yml

@@ -0,0 +1,29 @@
+---
+name: 🧐 test
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        just-trigger:
+          - "lint"
+          - "tests"
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v2
+      - uses: astral-sh/setup-uv@v4
+      - run: uv python install ${{ matrix.python-version }}
+      - run: uv sync --all-extras --dev
+      - run: just ${{ matrix.just-trigger }}

probirka-0.3.0/.gitignore

@@ -0,0 +1,164 @@
+.python-version
+.idea/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/

probirka-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+---
+default_install_hook_types:
+  - pre-commit
+
+repos:
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: python -m mypy
+        language: system
+        'types_or': [ python, pyi ]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.8.1"
+    hooks:
+      - id: ruff
+        args: [ --fix, --unsafe-fixes ]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: double-quote-string-fixer
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: ^.+(\.md)$

probirka-0.3.0/LICENSE

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

probirka-0.3.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.3
+Name: probirka
+Version: 0.3.0
+Summary: Python 3 library to write simple asynchronous health checks (probes)
+Project-URL: Repository, https://github.com/appKODE/probirka
+Author-email: KODE <slurm@kode.ru>
+License: MIT
+Keywords: health-check,monitoring,probes
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+#  PROB🧪RKA 
+
+Python 3 library to write simple asynchronous health checks (probes) 
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![PyPI](https://img.shields.io/pypi/v/probirka.svg)](https://pypi.python.org/pypi/probirka)
+[![PyPI](https://img.shields.io/pypi/dm/probirka.svg)](https://pypi.python.org/pypi/probirka)
+
+## Installation
+
+```shell
+pip install probirka
+```

probirka-0.3.0/README.md

@@ -0,0 +1,13 @@
+#  PROB🧪RKA 
+
+Python 3 library to write simple asynchronous health checks (probes) 
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![PyPI](https://img.shields.io/pypi/v/probirka.svg)](https://pypi.python.org/pypi/probirka)
+[![PyPI](https://img.shields.io/pypi/dm/probirka.svg)](https://pypi.python.org/pypi/probirka)
+
+## Installation
+
+```shell
+pip install probirka
+```

probirka-0.3.0/justfile

@@ -0,0 +1,20 @@
+SOURCE_PATH := "probirka"
+TESTS_PATH := "tests"
+
+upgrade:
+    uv lock --upgrade
+
+fmt:
+    uv run ruff format {{ SOURCE_PATH }}
+
+lint:
+    uv run ruff check {{ SOURCE_PATH }}
+
+mypy:
+    uv run python -m mypy --pretty {{ SOURCE_PATH }}
+
+fix:
+    uv run ruff check --fix --unsafe-fixes {{ SOURCE_PATH }}
+
+tests:
+    uv run pytest tests/

probirka-0.3.0/probirka/__init__.py

@@ -0,0 +1,32 @@
+from contextlib import suppress
+
+from probirka._probes import Probe, ProbeBase
+from probirka._probirka import Probirka
+from probirka._results import HealthCheckResult, ProbeResult
+
+__title__ = 'probirka'
+__version__ = '0.3.0'
+__url__ = 'https://github.com/appKODE/probirka'
+__author__ = ''
+__author_email__ = ''
+__license__ = ''
+
+__all__ = [
+    'HealthCheckResult',
+    # types
+    'Probe',
+    'ProbeBase',
+    # results
+    'ProbeResult',
+    'Probirka',
+]
+
+with suppress(ImportError):
+    from probirka._aiohttp import make_aiohttp_endpoint  # noqa
+
+    __all__.append('make_aiohttp_endpoint')
+
+with suppress(ImportError):
+    from probirka._fastapi import make_fastapi_endpoint  # noqa
+
+    __all__.append('make_fastapi_endpoint')

probirka-0.3.0/probirka/_aiohttp.py

@@ -0,0 +1,41 @@
+import json
+
+from dataclasses import asdict
+from typing import Any, Callable, Coroutine, List, Optional, Union
+
+from aiohttp import web
+
+from probirka import Probirka
+
+
+def make_aiohttp_endpoint(
+    probirka: Probirka,
+    timeout: Optional[int] = None,
+    with_groups: Union[str, List[str]] = '',
+    skip_required: bool = False,
+    return_results: bool = True,
+    success_code: int = 200,
+    error_code: int = 500,
+) -> Callable[[web.Request], Coroutine[Any, Any, web.Response]]:
+    async def endpoint(
+        _: web.Request,
+    ) -> web.Response:
+        res = await probirka.run(
+            timeout=timeout,
+            with_groups=with_groups,
+            skip_required=skip_required,
+        )
+        status_code = success_code if res.ok else error_code
+        return (
+            web.json_response(
+                text=json.dumps(obj=asdict(res), default=str),
+                status=status_code,
+            )
+            if return_results
+            else web.Response(
+                body='',
+                status=status_code,
+            )
+        )
+
+    return endpoint

probirka-0.3.0/probirka/_fastapi.py

@@ -0,0 +1,29 @@
+from typing import Any, Callable, Coroutine, List, Optional, Union
+
+from fastapi import status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import JSONResponse, Response
+
+from probirka import Probirka
+
+
+def make_fastapi_endpoint(
+    probirka: Probirka,
+    timeout: Optional[int] = None,
+    with_groups: Union[str, List[str]] = '',
+    skip_required: bool = False,
+    return_results: bool = True,
+    success_code: int = status.HTTP_200_OK,
+    error_code: int = status.HTTP_500_INTERNAL_SERVER_ERROR,
+) -> Callable[[], Coroutine[Any, Any, Response]]:
+    async def endpoint() -> Response:
+        res = await probirka.run(
+            timeout=timeout,
+            with_groups=with_groups,
+            skip_required=skip_required,
+        )
+        resp = JSONResponse(jsonable_encoder(res)) if return_results else Response()
+        resp.status_code = success_code if res.ok else error_code
+        return resp
+
+    return endpoint

probirka-0.3.0/probirka/_probes.py

@@ -0,0 +1,81 @@
+from abc import ABC, abstractmethod
+from asyncio import iscoroutinefunction, wait_for
+from datetime import datetime
+from typing import Callable, Optional, Protocol
+
+from probirka._results import ProbeResult
+
+
+class Probe(
+    Protocol,
+):
+    async def run_check(
+        self,
+    ) -> ProbeResult: ...
+
+
+class ProbeBase(
+    ABC,
+):
+    def __init__(
+        self,
+        name: Optional[str] = None,
+        timeout: Optional[int] = None,
+    ) -> None:
+        self._timeout = timeout
+        self._name = name or self.__class__.__name__
+
+    @abstractmethod
+    async def _check(
+        self,
+    ) -> Optional[bool]:
+        raise NotImplementedError
+
+    async def run_check(
+        self,
+    ) -> ProbeResult:
+        started_at = datetime.now()
+        error = None
+        task = self._check()
+        try:
+            result = await wait_for(
+                fut=task,
+                timeout=self._timeout,
+            )
+            if result is None:
+                result = True
+        except Exception as exc:
+            result = False
+            error = str(exc)
+        finally:
+            task.close()
+        return ProbeResult(
+            ok=False if result is None else result,
+            started_at=started_at,
+            elapsed=datetime.now() - started_at,
+            name=self._name,
+            error=error,
+        )
+
+
+class CallableProbe(
+    ProbeBase,
+):
+    def __init__(
+        self,
+        func: Callable[[], Optional[bool]],
+        name: Optional[str] = None,
+        timeout: Optional[int] = None,
+    ) -> None:
+        self._func = func
+        super().__init__(
+            name=name or func.__name__,
+            timeout=timeout,
+        )
+
+    async def _check(
+        self,
+    ) -> Optional[bool]:
+        if iscoroutinefunction(self._func):
+            return await self._func()
+        return self._func()

probirka-0.3.0/probirka/_probirka.py

@@ -0,0 +1,110 @@
+from asyncio import gather, wait_for
+from collections import defaultdict
+from datetime import datetime
+from typing import Any, Callable, Dict, List, Optional, Sequence, Union
+
+from probirka._probes import CallableProbe, Probe
+from probirka._results import HealthCheckResult, ProbeResult
+
+
+class Probirka:
+    def __init__(
+        self,
+    ) -> None:
+        self._required_probes: List[Probe] = []
+        self._optional_probes: Dict[str, List[Probe]] = defaultdict(list)
+        self._info: Dict[str, Any] = {}
+
+    def add_info(
+        self,
+        name: str,
+        value: Any,
+    ) -> None:
+        self._info[name] = value
+
+    @property
+    def info(
+        self,
+    ) -> Dict[str, Any]:
+        return self._info
+
+    def add_probes(
+        self,
+        *probes: Probe,
+        groups: Union[str, List[str]] = '',
+    ) -> None:
+        if groups:
+            if isinstance(groups, str):
+                groups = [groups]
+            for group in groups:
+                self._optional_probes[group].extend(probes)
+            return
+        self._required_probes.extend(probes)
+
+    def add(
+        self,
+        name: Optional[str] = None,
+        timeout: Optional[int] = None,
+        groups: Union[str, List[str]] = '',
+    ) -> Callable:
+        def _wrapper(
+            func: Callable,
+        ) -> Any:
+            self.add_probes(
+                CallableProbe(
+                    func=func,
+                    name=name,
+                    timeout=timeout,
+                ),
+                groups=groups,
+            )
+            return func
+
+        return _wrapper
+
+    async def _inner_run(
+        self,
+        with_groups: List[str],
+        skip_required: bool,
+    ) -> Sequence[ProbeResult]:
+        tasks = [] if skip_required else [probe.run_check() for probe in self._required_probes]
+        for group in with_groups:
+            tasks += [probe.run_check() for probe in self._optional_probes[group]]
+        results = await gather(*tasks)
+        for coro in tasks:
+            coro.close()
+        return results
+
+    async def run(
+        self,
+        timeout: Optional[int] = None,
+        with_groups: Union[str, List[str]] = '',
+        skip_required: bool = False,
+    ) -> HealthCheckResult:
+        if with_groups and isinstance(with_groups, str):
+            with_groups = [with_groups]
+        started_at = datetime.now()
+        fut = self._inner_run(
+            with_groups=with_groups,  # type: ignore
+            skip_required=skip_required,
+        )
+        results = (
+            await wait_for(
+                fut=fut,
+                timeout=timeout,
+            )
+            if timeout
+            else await fut
+        )
+        ok = True
+        for result in results:
+            if result.ok is False:
+                ok = False
+                break
+        return HealthCheckResult(
+            ok=ok,
+            info=self._info,
+            started_at=started_at,
+            total_elapsed=datetime.now() - started_at,
+            checks=results,
+        )

probirka-0.3.0/probirka/_results.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from datetime import datetime, timedelta
+from typing import Any, Dict, Optional, Sequence
+
+
+@dataclass(frozen=True)
+class ProbeResult:
+    ok: bool
+    started_at: datetime
+    elapsed: timedelta
+    name: str
+    error: Optional[str]
+
+
+@dataclass(frozen=True)
+class HealthCheckResult:
+    ok: bool
+    info: Dict[str, Any]
+    started_at: datetime
+    total_elapsed: timedelta
+    checks: Sequence[ProbeResult]