diracx-db 0.0.1a21__py3-none-any.whl → 0.0.6__py3-none-any.whl

diracx/db/sql/utils/types.py

@@ -0,0 +1,137 @@
+from __future__ import annotations
+
+from datetime import datetime
+from functools import partial
+from zoneinfo import ZoneInfo
+
+import sqlalchemy.types as types
+from sqlalchemy import Column as RawColumn
+from sqlalchemy import DateTime, Enum
+
+from .functions import utcnow
+
+Column: partial[RawColumn] = partial(RawColumn, nullable=False)
+NullColumn: partial[RawColumn] = partial(RawColumn, nullable=True)
+DateNowColumn = partial(Column, type_=DateTime(timezone=True), server_default=utcnow())
+
+
+def EnumColumn(name, enum_type, **kwargs):  # noqa: N802
+    return Column(name, Enum(enum_type, native_enum=False, length=16), **kwargs)
+
+
+class EnumBackedBool(types.TypeDecorator):
+    """Maps a ``EnumBackedBool()`` column to True/False in Python."""
+
+    impl = types.Enum("True", "False", name="enum_backed_bool")
+    cache_ok = True
+
+    def process_bind_param(self, value, dialect) -> str:
+        if value is True:
+            return "True"
+        elif value is False:
+            return "False"
+        else:
+            raise NotImplementedError(value, dialect)
+
+    def process_result_value(self, value, dialect) -> bool:
+        if value == "True":
+            return True
+        elif value == "False":
+            return False
+        else:
+            raise NotImplementedError(f"Unknown {value=}")
+
+
+class SmarterDateTime(types.TypeDecorator):
+    """A DateTime type that also accepts ISO8601 strings.
+
+    Takes into account converting timezone aware datetime objects into
+    naive form and back when needed.
+
+    """
+
+    impl = DateTime()
+    cache_ok = True
+
+    def __init__(
+        self,
+        stored_tz: ZoneInfo | None = ZoneInfo("UTC"),
+        returned_tz: ZoneInfo = ZoneInfo("UTC"),
+        stored_naive_sqlite=True,
+        stored_naive_mysql=True,
+        stored_naive_postgres=False,  # Forces timezone-awareness
+    ):
+        self._stored_naive_dialect = {
+            "sqlite": stored_naive_sqlite,
+            "mysql": stored_naive_mysql,
+            "postgres": stored_naive_postgres,
+        }
+        self._stored_tz: ZoneInfo | None = stored_tz  # None = Local timezone
+        self._returned_tz: ZoneInfo = returned_tz
+
+    def _stored_naive(self, dialect):
+        if dialect.name not in self._stored_naive_dialect:
+            raise NotImplementedError(dialect.name)
+        return self._stored_naive_dialect.get(dialect.name)
+
+    def process_bind_param(self, value, dialect):
+        if value is None:
+            return None
+
+        if isinstance(value, str):
+            try:
+                value: datetime = datetime.fromisoformat(value)
+            except ValueError as err:
+                raise ValueError(f"Unable to parse datetime string: {value}") from err
+
+        if not isinstance(value, datetime):
+            raise ValueError(f"Expected datetime or ISO8601 string, but got {value!r}")
+
+        if not value.tzinfo:
+            raise ValueError(
+                f"Provided timestamp {value=} has no tzinfo -"
+                " this is problematic and may cause inconsistencies in stored timestamps.\n"
+                " Please always work with tz-aware datetimes / attach tzinfo to your datetime objects:"
+                " e.g. datetime.now(tz=timezone.utc) or use datetime_obj.astimezone() with no arguments if you need to "
+                "attach the local timezone to a local naive timestamp."
+            )
+
+        # Check that we need to convert the timezone to match self._stored_tz timezone:
+        if self._stored_naive(dialect):
+            # if self._stored_tz is None, we use our local/system timezone.
+            stored_tz = self._stored_tz
+
+            # astimezone converts to the stored timezone (local timezone if None)
+            # replace strips the TZ info --> naive datetime object
+            value = value.astimezone(tz=stored_tz).replace(tzinfo=None)
+
+        return value
+
+    def process_result_value(self, value, dialect):
+        if value is None:
+            return None
+        if not isinstance(value, datetime):
+            raise NotImplementedError(f"{value=} not a datetime object")
+
+        if self._stored_naive(dialect):
+            # Here we add back the tzinfo to the naive timestamp
+            # from the DB to make it aware again.
+            if value.tzinfo is None:
+                # we are definitely given a naive timestamp, so handle it.
+                # add back the timezone info if stored_tz is set
+                if self._stored_tz:
+                    value = value.replace(tzinfo=self._stored_tz)
+                else:
+                    # if stored as a local time, add back the system timezone info...
+                    value = value.astimezone()
+            else:
+                raise ValueError(
+                    f"stored_naive is True for {dialect.name=}, but the database engine returned "
+                    "a tz-aware datetime. You need to check the SQLAlchemy model is consistent with the DB schema."
+                )
+
+        # finally, convert the datetime according to the "returned_tz"
+        value = value.astimezone(self._returned_tz)
+
+        # phew...
+        return value

{diracx_db-0.0.1a21.dist-info → diracx_db-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: diracx-db
-Version: 0.0.1a21
+Version: 0.0.6
 Summary: TODO
 License: GPL-3.0-only
 Classifier: Intended Audience :: Science/Research
@@ -9,12 +9,14 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: System :: Distributed Computing
 Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: dirac
 Requires-Dist: diracx-core
-Requires-Dist: fastapi
 Requires-Dist: opensearch-py[async]
 Requires-Dist: pydantic>=2.10
+Requires-Dist: python-dateutil
 Requires-Dist: sqlalchemy[aiomysql,aiosqlite]>=2
+Requires-Dist: uuid-utils
 Provides-Extra: testing
-Requires-Dist: diracx-testing; extra == "testing"
+Requires-Dist: diracx-testing; extra == 'testing'
+Requires-Dist: freezegun; extra == 'testing'
+Provides-Extra: types
+Requires-Dist: types-python-dateutil; extra == 'types'

diracx_db-0.0.6.dist-info/RECORD

@@ -0,0 +1,37 @@
+diracx/db/__init__.py,sha256=2oeUeVwZq53bo_ZOflEYZsBn7tcR5Tzb2AIu0TAWELM,109
+diracx/db/__main__.py,sha256=6YlmpiU1cLLHjKLy1DfdEOQUyvSla-MbJsJ7aQwAOVs,1757
+diracx/db/exceptions.py,sha256=1nn-SZLG-nQwkxbvHjZqXhE5ouzWj1f3qhSda2B4ZEg,83
+diracx/db/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/os/__init__.py,sha256=IZr6z6SefrRvuC8sTC4RmB3_wwOyEt1GzpDuwSMH8O4,112
+diracx/db/os/job_parameters.py,sha256=3w_CeA2z-cY5pWwXkGu-Fod27FobbUXuwVKK-jN037U,1479
+diracx/db/os/utils.py,sha256=V4T-taos64SFNcorfIr7mq5l5y88K6TzyCj1YqWk8VI,11562
+diracx/db/sql/__init__.py,sha256=JYu0b0IVhoXy3lX2m2r2dmAjsRS7IbECBUMEDvX0Te4,391
+diracx/db/sql/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/sql/auth/db.py,sha256=F9s05K-9C6kL2nUZY7P8zD79fiuo2biREMhfI7oCjh4,11979
+diracx/db/sql/auth/schema.py,sha256=9fUV7taDPnoAcoiwRAmQraOmF2Ytoizjs2TFvN7zsVs,3132
+diracx/db/sql/dummy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/sql/dummy/db.py,sha256=MKSUSJI1BlRgK08tjCfkCkOz02asvJAeBw60pAdiGV8,1212
+diracx/db/sql/dummy/schema.py,sha256=9zI53pKlzc6qBezsyjkatOQrNZdGCjwgjQ8Iz_pyAXs,789
+diracx/db/sql/job/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/sql/job/db.py,sha256=bX-4OMyW4h9tqeTE3OvonxTXlL6j_Qvv9uEtK5SthN8,10120
+diracx/db/sql/job/schema.py,sha256=fJdmiLp6psdAjo_CoBfSAGSYk2NJkSBwvik9tznESD0,5740
+diracx/db/sql/job_logging/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/sql/job_logging/db.py,sha256=hyklARuEj3R1sSJ8UaObRprmsRx7RjbKAcbfgT9BwRg,5496
+diracx/db/sql/job_logging/schema.py,sha256=k6uBw-RHAcJ5GEleNpiWoXEJBhCiNG-y4xAgBKHZjjM,2524
+diracx/db/sql/pilot_agents/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/sql/pilot_agents/db.py,sha256=6CQ0QGV4NhsGKVCygEtE4kmIjT89xJwrIMuYZTslWFE,1231
+diracx/db/sql/pilot_agents/schema.py,sha256=BTFLuiwcxAvAtTvTP9C7DbGtXoM-IHVDG9k7HMx62AA,2211
+diracx/db/sql/sandbox_metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/sql/sandbox_metadata/db.py,sha256=FtyPx6GAGJAH-lmuw8PQj6_KGHG6t3AC3-E9uWf-JNs,10236
+diracx/db/sql/sandbox_metadata/schema.py,sha256=V5gV2PHwzTbBz_th9ribLfE7Lqk8YGemDmvqq4jWQJ4,1530
+diracx/db/sql/task_queue/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diracx/db/sql/task_queue/db.py,sha256=2qul1D2tX2uCI92N591WK5xWHakG0pNibzDwKQ7W-I8,6246
+diracx/db/sql/task_queue/schema.py,sha256=5efAgvNYRkLlaJ2NzRInRfmVa3tyIzQu2l0oRPy4Kzw,3258
+diracx/db/sql/utils/__init__.py,sha256=k1DI4Idlqv36pXn2BhQysb947Peio9DnYaePslkTpUQ,685
+diracx/db/sql/utils/base.py,sha256=DqW-JYgjqvqkwLFqou5uzg73lZ83C0jHCgkt9qR1NTg,17255
+diracx/db/sql/utils/functions.py,sha256=_E4tc9Gti6LuSh7QEyoqPJSvCuByVqvRenOXCzxsulE,4014
+diracx/db/sql/utils/types.py,sha256=KNZWJfpvHTjfIPg6Nn7zY-rS0q3ybnirHcTcLAYSYbE,5118
+diracx_db-0.0.6.dist-info/METADATA,sha256=Lu8x2pR3BfnKGgHYz4w5Z4CTCf7tPi9p9tlldVFJiLo,780
+diracx_db-0.0.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+diracx_db-0.0.6.dist-info/entry_points.txt,sha256=UPqhLvb9gui0kOyWeI_edtefcrHToZmQt1p76vIwujo,317
+diracx_db-0.0.6.dist-info/RECORD,,

{diracx_db-0.0.1a21.dist-info → diracx_db-0.0.6.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

{diracx_db-0.0.1a21.dist-info → diracx_db-0.0.6.dist-info}/entry_points.txt

@@ -1,7 +1,7 @@
-[diracx.db.os]
+[diracx.dbs.os]
 JobParametersDB = diracx.db.os:JobParametersDB
 
-[diracx.db.sql]
+[diracx.dbs.sql]
 AuthDB = diracx.db.sql:AuthDB
 JobDB = diracx.db.sql:JobDB
 JobLoggingDB = diracx.db.sql:JobLoggingDB