ecodev-core 0.0.1__py3-none-any.whl

ecodev_core/safe_utils.py

@@ -0,0 +1,197 @@
+"""
+Unittest wrapper ensuring safe setUp / tearDown of all tests.
+This boilerplate code is not to be touched under any circumstances.
+"""
+import contextlib
+import shutil
+from pathlib import Path
+from typing import Any
+from typing import Callable
+from typing import List
+from typing import Union
+from unittest import TestCase
+
+import numpy as np
+from pydantic import Field
+
+from ecodev_core.logger import log_critical
+from ecodev_core.logger import logger_get
+from ecodev_core.pydantic_utils import Frozen
+
+
+log = logger_get(__name__)
+
+
+class SafeTestCase(TestCase):
+    """
+    SafeTestCase makes sure that setUp / tearDown methods are always run when they should be.
+    This boilerplate code is not to be touched under any circumstances.
+    """
+    files_created: List[Path]
+    directories_created: List[Path]
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        """
+        Class set up, prompt class name and set files and folders to be suppressed at tearDownClass
+        """
+        log.info(f'Running test module: {cls.__module__.upper()}')
+        super().setUpClass()
+        cls.directories_created = []
+        cls.files_created = []
+
+    @classmethod
+    def tearDownClass(cls) -> None:
+        """
+        Safely suppress all files and directories used for this class
+        """
+        log.info(f'Done running test module: {cls.__module__.upper()}')
+        cls.safe_delete(cls.directories_created, cls.files_created)
+
+    def setUp(self) -> None:
+        """
+        Test set up, prompt test name and set files and folders to be suppressed at tearDown
+        """
+        super().setUp()
+        log.debug(f'Running test: {self._testMethodName.upper()}')
+        self.directories_created: List[Path] = []
+        self.files_created: List[Path] = []
+
+    def tearDown(self) -> None:
+        """
+        Safely suppress all files and directories used for this test
+        """
+        log.debug(f'Done running test: {self._testMethodName.upper()}')
+        self.safe_delete(self.directories_created, self.files_created)
+
+    @classmethod
+    def safe_delete(cls, directories_created: List[Path], files_created: List[Path]) -> None:
+        """
+        Safely suppress all passed files_created and directories_created
+
+        Args:
+            directories_created: directories used for the test making the call
+            files_created: files_created used for the test making the call
+        """
+        for directory in directories_created:
+            with contextlib.suppress(FileNotFoundError):
+                shutil.rmtree(directory)
+        for file_path in files_created:
+            file_path.unlink(missing_ok=True)
+
+    def run(self, result=None):
+        """
+        Wrapper around unittest run
+        """
+        test_method = getattr(self, self._testMethodName)
+        wrapped_test = self._cleanup_wrapper(test_method, KeyboardInterrupt)
+        setattr(self, self._testMethodName, wrapped_test)
+        self.setUp = self._cleanup_wrapper(self.setUp, BaseException)
+
+        return super().run(result)
+
+    def _cleanup_wrapper(self, method, exception):
+        """
+        Boilerplate code for clean setup and teardown
+        """
+
+        def _wrapped(*args, **kwargs):
+            try:
+                return method(*args, **kwargs)
+            except exception:
+                self.tearDown()
+                self.doCleanups()
+                raise
+
+        return _wrapped
+
+
+class SimpleReturn(Frozen):
+    """
+    Simple output for routes not returning anything
+    """
+    success: bool = Field(..., description=' True if the treatment went well.')
+    error: Union[str, None] = Field(..., description='the error that happened, if any.')
+
+    @classmethod
+    def route_success(cls) -> 'SimpleReturn':
+        """
+        Format DropDocumentReturn if the document was successfully dropped
+        """
+        return SimpleReturn(success=True, error=None)
+
+    @classmethod
+    def route_failure(cls, error: str) -> 'SimpleReturn':
+        """
+        Format DropDocumentReturn if the document failed to be dropped
+        """
+        return SimpleReturn(success=False, error=error)
+
+
+def safe_clt(func):
+    """
+    Safe execution of typer commands
+    """
+    def inner_function(*args, **kwargs):
+        try:
+            func(*args, **kwargs)
+            return SimpleReturn.route_success()
+        except Exception as error:
+            log_critical(f'something wrong happened: {error}', log)
+            return SimpleReturn.route_failure(str(error))
+    return inner_function
+
+
+def stringify(x: Union[str, float]) -> Union[str, None]:
+    """
+    Safe conversion of a (str, np.nan) value into a (str,None) one
+    """
+    return _transformify(x, str)
+
+
+def boolify(x: Union[Any]) -> Union[bool, None]:
+    """
+    Safe conversion of a (str, np.nan) value into a (str,None) one
+    """
+    return _transformify(x, _bool_check)
+
+
+def intify(x: Union[str, float]) -> Union[int, None]:
+    """
+    Safe conversion of a (int, np.nan) value into a (int,None) one
+    """
+    return _transformify(x, int)
+
+
+def floatify(x: Union[str, float]) -> Union[float, None]:
+    """
+    Safe conversion of a (float, np.nan) value into a (float,None) one
+    """
+    return _transformify(x, float)
+
+
+def _transformify(x: Union[Any, float], transformation: Callable) -> Union[Any, None]:
+    """
+    Safe conversion of a (Any, np.nan) value into a (Any,None) one thanks to transformation
+    """
+    if x is None or (isinstance(x, float) and np.isnan(x)):
+        return None
+
+    try:
+        return transformation(x)
+
+    except ValueError:
+        return None
+
+
+def _bool_check(x: Union[Any, float]):
+    """
+    Check if the passed element can be cast into a boolean, or the boolean value inferred.
+    """
+    if isinstance(x, bool):
+        return x
+
+    if not isinstance(x, str) or x.lower() not in ['true', 'yes', 'false', 'no']:
+        return None
+
+    return x.lower() in ['true', 'yes']

ecodev_core-0.0.1.dist-info/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2024 Thomas EPELBAUM
+
+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.

ecodev_core-0.0.1.dist-info/METADATA

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: ecodev-core
+Version: 0.0.1
+Summary: Low level sqlmodel/fastapi/pydantic building blocks
+License: MIT
+Author: Thomas Epelbaum
+Author-email: tomepel@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Pydantic
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: fastapi (>=0,<1)
+Requires-Dist: httpx (>=0,<1)
+Requires-Dist: numpy (>=1,<2)
+Requires-Dist: pandas (>=2,<3)
+Requires-Dist: passlib[bcyrypt] (>=1,<2)
+Requires-Dist: pydantic[python-dotenv] (>=2,<3)
+Requires-Dist: python-jose[cryptography] (>=3,<4)
+Requires-Dist: sqladmin (==0.15.2)
+Requires-Dist: sqlmodel (>=0,<1)
+Description-Content-Type: text/markdown
+
+# ecodev-core
+
+<p align="center">
+<a href="https://github.com/FR-PAR-ECOACT/ecodev-core/actions" target="_blank">
+    <img src="https://github.com/FR-PAR-ECOACT/ecodev-core/blob/main/badges/coverage.svg" alt="Coverage">
+</a>
+<a href="https://github.com/FR-PAR-ECOACT/ecodev-core/actions" target="_blank">
+    <img src="https://github.com/FR-PAR-ECOACT/ecodev-core/blob/main/badges/pylint.svg" alt="Publish">
+</a>
+<a href="https://github.com/FR-PAR-ECOACT/ecodev-core/actions/workflows/code-quality.yml/badge.svg" target="_blank">
+    <img src="https://github.com/FR-PAR-ECOACT/ecodev-core/actions/workflows/code-quality.yml/badge.svg" alt="Package version">
+</a>
+</p>
+
+Low level ecoact generic code. Aimed at being published in open source with poetry
+
+## Installation of this package
+
+You are strongly encouraged to install this package via Docker.
+
+Starting from a project with a Docker file:
+* add the module ecodev-core in the `requirements.txt` file
+* make sure the `.env` file includes all required fields (see `BaseSettings` and `AuthenticationConfiguration`)
+* build the new version of the Docker container (typically `docker build --tag xxx .`)
+* run it with docker compose (`dc up -d`).
+

ecodev_core-0.0.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+ecodev_core/__init__.py,sha256=1DXQiiIgldhxRKg8d1SQsh5O1Ncgo2vz3mFBCPPzM_4,4128
+ecodev_core/app_activity.py,sha256=_rU5uPfttHxXX5IaCuTA7K9We5w2qluJ3Xpf6i12HhY,3763
+ecodev_core/app_rights.py,sha256=RZPdDtydFqc_nFj96huKAc56BS0qS6ScKv4Kghqd6lc,726
+ecodev_core/app_user.py,sha256=qXvu0GOm2fAY_KxjkPEUIw7Rb9uxm2kvyFvcTTBQvEg,2949
+ecodev_core/auth_configuration.py,sha256=qMaiv3F18cQiIT7QBML76FY4LP6XkmFy9t7a_bbBYQk,462
+ecodev_core/authentication.py,sha256=x-lJMeZKOeP93NhqZbLJ-to9rgjW26S5qBOakeYzS_g,7635
+ecodev_core/check_dependencies.py,sha256=aFn8GI4eBbuJT8RxsfhSSnlpNYYj_LPOH-tZF0EqfKQ,6917
+ecodev_core/custom_equal.py,sha256=2gRn0qpyJ8-Kw9GQSueu0nLngLrRrwyMPlP6zqPac0U,899
+ecodev_core/db_connection.py,sha256=Z5tvaLL2SmScwft38X1yliAxgQPGY8IRRa2-XNyzQTY,1732
+ecodev_core/db_filters.py,sha256=T_5JVF27UEu7sC6NOm7-W3_Y0GLfbWQO_EeTXcD2cv8,5041
+ecodev_core/db_insertion.py,sha256=hwDr_S0PhMrOqA9eAnye9-s15yFmVsbz8XI_tZ9WCnU,3629
+ecodev_core/db_retrieval.py,sha256=fYSD0q2jYxfZzxWVrg-M3uPOnfAgvxf3VZd1pg9Pf5M,7413
+ecodev_core/enum_utils.py,sha256=BkQ4YQ97tXBYmMcQiSIi0mbioD5CgVU79myg1BBAXuA,556
+ecodev_core/list_utils.py,sha256=z6jdXR7dRL1djaWWlTKmUfSVH60VHUwlM1FC3clO100,2364
+ecodev_core/logger.py,sha256=AWGGNZz12Ql0JDq1wCJQxwxK2syiczEBftmuJkjbAPw,3149
+ecodev_core/pandas_utils.py,sha256=fSB1cAOHwgC0loum-LVd_9u5sSf2CXZGotHo56Q5bcE,1079
+ecodev_core/permissions.py,sha256=dMaRQyjrF8Y51gkbkFvFsGVdzQGLZtA72IQ7REYamxg,320
+ecodev_core/pydantic_utils.py,sha256=KKZ9Dhek-QX64Cvl_SNWUj1DwwGIEnybYkO4joHIGXA,1006
+ecodev_core/read_write.py,sha256=auJ5bBJTVGkLRkiP_vZxVCX64B0Y-9qpsaDhovHmbas,996
+ecodev_core/safe_utils.py,sha256=uTHzLnKBoV_MiFsI65X-WYmgzLpIBH5Cio80KSLd6wg,5933
+ecodev_core-0.0.1.dist-info/LICENSE.md,sha256=rZtBt3Nj4cv7-tvFHCundioUJ00zCya33G-jnuR9fNw,1063
+ecodev_core-0.0.1.dist-info/METADATA,sha256=TolpNhlTmUzJjl5_ZtLYCfI2nJQVWItRhQ01KZQJmg4,3074
+ecodev_core-0.0.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+ecodev_core-0.0.1.dist-info/RECORD,,

ecodev_core-0.0.1.dist-info/WHEEL

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