probirka 0.3.0__py3-none-any.whl

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/_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/_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/_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/_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/_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]

probirka-0.3.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,10 @@
+probirka/__init__.py,sha256=jsGdY0J3NZgJAO9EkJFc6MSfVxGYlQs_j6mSJZ3FKzM,736
+probirka/_aiohttp.py,sha256=rpOGqfS_BuQY60T3PZ6VF-GeHvgGIh9XNLeYvT34ak4,1098
+probirka/_fastapi.py,sha256=oV82iGuI4jWCil1OMlhqE_pb87h8Vt4Bu7464O5-q5U,960
+probirka/_probes.py,sha256=jokvsTjwZ3sMehQn8vHe4dCt7LgFHAF17lia6aPDDYw,1865
+probirka/_probirka.py,sha256=z7ZN7JGBhj5A6Ly-kupHdbCgjRu74bN7EWdvtptdLFg,3041
+probirka/_results.py,sha256=3-eS6n1JibnXgVFYw3uTYj2Qbh_stehGG_M12BEiAAA,446
+probirka-0.3.0.dist-info/METADATA,sha256=UssUrZcNgjUGYjFuRSVnyXy4_zcc-Ca7cwhAPr-AH-s,1317
+probirka-0.3.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+probirka-0.3.0.dist-info/licenses/LICENSE,sha256=k-1sgbW05GN_ubAXMm7SVTlNtFCa8hrI74rmxiW6ecc,1065
+probirka-0.3.0.dist-info/RECORD,,

probirka-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

probirka-0.3.0.dist-info/licenses/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.