ecodev-core 0.0.67__py3-none-any.whl

ecodev_core/version.py

@@ -0,0 +1,144 @@
+"""
+Module implementing the Version table
+"""
+from datetime import datetime
+from enum import Enum
+from enum import EnumType
+from enum import unique
+from typing import Optional
+
+from sqlmodel import desc
+from sqlmodel import Field
+from sqlmodel import Index
+from sqlmodel import select
+from sqlmodel import Session
+from sqlmodel import SQLModel
+
+
+@unique
+class ColType(str, Enum):
+    """
+    Enum listing all col types allowed to be stored in version
+    """
+    STR = 'str'
+    BOOL = 'bool'
+    INT = 'int'
+    FLOAT = 'float'
+    DATE = 'datetime'
+    ENUM = 'enum'
+
+
+COL_TYPES = str | int | bool | float | datetime | Enum | None
+
+
+class Version(SQLModel, table=True):  # type: ignore
+    """
+    Table handling versioning.
+
+    Attributes are:
+        - table: the table to version
+        - column: the column of table to version
+        - row_id: the row id of the column of table to version
+        - col_type: the column type
+        - value: the value to store (previous row/column/table version)
+    """
+    __tablename__ = 'version'
+    id: Optional[int] = Field(default=None, primary_key=True)
+    created_at: datetime = Field(default_factory=datetime.utcnow)
+    table: str = Field(index=True)
+    column: str = Field(index=True)
+    row_id: int = Field(index=True)
+    col_type: ColType
+    value: str | None = Field(index=True)
+
+    __table_args__ = (
+        Index(
+            'version_filter_id',
+            'table',
+            'row_id',
+            'column'
+        ),
+    )
+
+    @classmethod
+    def from_table_row(cls, table: str,
+                       column: str,
+                       row_id: int,
+                       raw_type: type | EnumType,
+                       raw_val: COL_TYPES
+                       ) -> 'Version':
+        """
+        Create a new Version out of the passed information
+        """
+        col_type = _col_type_to_db(raw_type)
+        value = _value_to_db(raw_val, col_type)
+        return cls(table=table, column=column, row_id=row_id, col_type=col_type, value=value)
+
+
+def get_versions(table: str, column: str, row_id: int, session: Session) -> list[Version]:
+    """
+    Retrieve all previous versions of a (table, column, row_id) triplet
+    """
+    query = select(Version).where(Version.table == table, Version.row_id == row_id,
+                                  Version.column == column).order_by(desc(Version.created_at))
+    return session.exec(query).all()
+
+
+def get_row_versions(table: str, row_id: int, session: Session) -> list[Version]:
+    """
+    Retrieve all previous versions of a (table, row_id) couples. Hence all columns previous versions
+    """
+    query = select(Version).where(Version.table == table, Version.row_id == row_id
+                                  ).order_by(desc(Version.created_at))
+    return session.exec(query).all()
+
+
+def _col_type_to_db(col_type: type | EnumType) -> ColType:
+    """
+    Forge ColType out of passed col_type
+    """
+    if issubclass(int, col_type):
+        return ColType.INT
+    if issubclass(bool, col_type):
+        return ColType.BOOL
+    if issubclass(float, col_type):
+        return ColType.FLOAT
+    if issubclass(str, col_type):
+        return ColType.STR
+    if issubclass(datetime, col_type):
+        return ColType.DATE
+    return ColType.ENUM
+
+
+def _value_to_db(value: COL_TYPES, col_type: ColType) -> str | None:
+    """
+    Convert a value to version to it's str version
+    """
+    if value is None:
+        return None
+
+    match col_type:
+        case ColType.BOOL | ColType.STR | ColType.INT | ColType.FLOAT:
+            return str(value)
+        case ColType.DATE:
+            return value.strftime('%Y-%m-%d %H:%M:%S.%f')  # type: ignore[union-attr]
+        case ColType.ENUM:
+            return value.name  # type: ignore[union-attr]
+        case _:
+            return None
+
+
+def db_to_value(db_value: str | None, col_type: type | EnumType) -> COL_TYPES:
+    """
+    Convert back a str version value stored to a real value (types handled listed in ColType)
+    NB: assumption that if the type is not known, this is an enum type.
+    """
+    if db_value is None:
+        return None
+    if col_type in [int, str, float]:
+        return col_type(db_value)
+    if col_type == bool:
+        return db_value == 'True'
+    if col_type == datetime:
+        return datetime.strptime(db_value, '%Y-%m-%d %H:%M:%S.%f')
+    return col_type[db_value]  # type: ignore[index]

ecodev_core-0.0.67.dist-info/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2025 - Schneider Electric
+
+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.67.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: ecodev-core
+Version: 0.0.67
+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: cryptography (>=46,<47)
+Requires-Dist: elasticsearch (>=8.14.0,<9.0.0)
+Requires-Dist: fastapi (>=0,<1)
+Requires-Dist: httpx (>=0,<1)
+Requires-Dist: numpy (>=1,<2)
+Requires-Dist: openpyxl (>=3,<4)
+Requires-Dist: orjson (>=3.10.5,<4.0.0)
+Requires-Dist: pandas (>=2,<3)
+Requires-Dist: passlib[bcyrypt] (>=1,<2)
+Requires-Dist: progressbar2 (>=4.4.2,<5.0.0)
+Requires-Dist: psycopg2-binary (>=2,<3)
+Requires-Dist: pydantic (==2.11.7)
+Requires-Dist: pydantic-settings (>=2,<3)
+Requires-Dist: python-jose[cryptography] (>=3,<4)
+Requires-Dist: pyyaml (>=6,<7)
+Requires-Dist: requests (>=2,<3)
+Requires-Dist: sqladmin (==0.15.2)
+Requires-Dist: sqlmodel (>=0,<1)
+Requires-Dist: uvicorn (==0.28.1)
+Requires-Dist: xlsxwriter (>=3,<4)
+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`).
+
+## Documentation
+
+Please find it in the [associated mkdoc website!](https://ecodev-doc.lcabox.com/)
+

ecodev_core-0.0.67.dist-info/RECORD

@@ -0,0 +1,37 @@
+ecodev_core/__init__.py,sha256=kNgcvv4JFZZKVAObIRqAFjpNuJrQVXF8A5bEJvaQ6Eg,7070
+ecodev_core/app_activity.py,sha256=KBtI-35LBLPDppFB7xjxWthXQrY3Z_aGDnC-HrW8Ea0,4641
+ecodev_core/app_rights.py,sha256=RZPdDtydFqc_nFj96huKAc56BS0qS6ScKv4Kghqd6lc,726
+ecodev_core/app_user.py,sha256=r1bqA4H08x53XmxmjwyGKl_PFjYQazzBbVErdkztqeE,2947
+ecodev_core/auth_configuration.py,sha256=qZ1Dkk7n1AH7w0tVKQ8AYswukOeMZH6mmbixPEAQnJ8,764
+ecodev_core/authentication.py,sha256=JJz_ezjCEBz_RGwFYyPzZHnM6pyk3rLOcKxkV5UESjA,11554
+ecodev_core/backup.py,sha256=rtKJ4XVfJBQcsglkLUnzbaCyQuqFcl8Doc4KBmC2LV8,3984
+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=5cYDfGw2Xp7khwhHlIaqAhRv7WFO3zuKmpTrnfyLMXg,3186
+ecodev_core/db_filters.py,sha256=T_5JVF27UEu7sC6NOm7-W3_Y0GLfbWQO_EeTXcD2cv8,5041
+ecodev_core/db_i18n.py,sha256=P8GWfdBtXTloVjeW6K2_F-VsXUMyQWcE2-F736w8gvM,8305
+ecodev_core/db_insertion.py,sha256=k-r798MMrW1sRb-gb8lQTxyJrb4QP5iZT8GDzCYYwlo,4544
+ecodev_core/db_retrieval.py,sha256=sCP7TDGIcTOK5gT3Inga91bE4S31HbQPw4yI22WJbss,7392
+ecodev_core/db_upsertion.py,sha256=ttngwZzJUQdr9Mc-qkDljJpru5yN3kvAzAMTW84CLHo,13136
+ecodev_core/deployment.py,sha256=z8ACI00EtKknXOB8xyPwYIXTvPjIDOH9z9cBGEU0YrA,281
+ecodev_core/email_sender.py,sha256=V3UGweuq6Iy09Z9to8HzM6JOVDVGHZXHGjUSkW94Tac,1912
+ecodev_core/encryption.py,sha256=eGIjMVqpoi81Y_4JarATCJZoeEyD8NeyRqx8LfcpmKE,1073
+ecodev_core/enum_utils.py,sha256=BkQ4YQ97tXBYmMcQiSIi0mbioD5CgVU79myg1BBAXuA,556
+ecodev_core/es_connection.py,sha256=WC2_BIWBoxgihF1tyHhHsBlcFhM6nZD7eDrPuoJJOqI,2208
+ecodev_core/list_utils.py,sha256=QFchUnD9CvMiBFBUaxkZTyDyEqpIJBwCNPubNUSl8TA,4877
+ecodev_core/logger.py,sha256=_v63vq7jh72RRkzajHB9QkRfEPcwCMNcLh7maLeKwRg,3596
+ecodev_core/pandas_utils.py,sha256=Juc6gvPnoBiSVF2SR6_vfMi5W-QEkY3fnpo5ROB1L9s,2191
+ecodev_core/permissions.py,sha256=WAx-ilMu8LlQp2sjJVdkhNQieytEaEm8577ZF1HWeTY,502
+ecodev_core/pydantic_utils.py,sha256=e3GH50JmcpTmd2UgrB94QSwWOlOCW3WIlVdyX9C4T-U,741
+ecodev_core/read_write.py,sha256=YIGRERvFHU7vy-JIaCWAza4CPMysLRUHKJxN-ZgFmu0,1208
+ecodev_core/rest_api_client.py,sha256=T2PsNicItfWcHZXrni4n8xXOx6euxOk3kXzLIh_Kpcc,7161
+ecodev_core/rest_api_configuration.py,sha256=Gy_8xDMnmNmkBzRQY4CQmqJg-ti1DIAekBj5-nSa8vw,623
+ecodev_core/safe_utils.py,sha256=NT46ddWcMHW6nmKAZiiHH4wdg2VXJqa2RU_01rCFzOk,7552
+ecodev_core/settings.py,sha256=UvaTv8S_HvfFAL-m1Rfqv_geSGcccuV3ziR1o1d5wu4,1795
+ecodev_core/sqlmodel_utils.py,sha256=t57H3QPtKRy4ujic1clMK_2L4p0yjGJLZbDjHPZ8M94,453
+ecodev_core/token_banlist.py,sha256=rKXG9QkfCpjOTr8gBgdX-KYNHAkKvQ9TRnGS99VC9Co,491
+ecodev_core/version.py,sha256=eyIf8KkW_t-hMuYFIoy0cUlNaMewLe6i45m2HKZKh0Q,4403
+ecodev_core-0.0.67.dist-info/LICENSE.md,sha256=8dqVJEbwXjPWjjRKjdLMym5k9Gi8hwtrHh84sti6KIs,1068
+ecodev_core-0.0.67.dist-info/METADATA,sha256=KVLXo_A8m7nP0wJ61DA00fKmtkJTDo_51lhLfpkv170,3582
+ecodev_core-0.0.67.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+ecodev_core-0.0.67.dist-info/RECORD,,

ecodev_core-0.0.67.dist-info/WHEEL

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