libres 0.7.3__py3-none-any.whl → 0.9.0__py3-none-any.whl

libres/db/models/timestamp.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import sedate
 
 from libres.db.models.types import UTCDateTime
@@ -6,8 +8,8 @@ from sqlalchemy.orm import deferred
 from sqlalchemy.schema import Column
 
 
-import typing as _t
-if _t.TYPE_CHECKING:
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
     from datetime import datetime
 
 
@@ -22,16 +24,16 @@ class TimestampMixin:
     """
 
     @staticmethod
-    def timestamp() -> 'datetime':
+    def timestamp() -> datetime:
         return sedate.utcnow()
 
-    if _t.TYPE_CHECKING:
+    if TYPE_CHECKING:
         created: Column[datetime]
-        modified: Column[_t.Optional[datetime]]
+        modified: Column[datetime | None]
 
     else:
         @declared_attr
-        def created(cls) -> 'Column[datetime]':
+        def created(cls) -> Column[datetime]:
             return deferred(
                 Column(
                     UTCDateTime(timezone=False),
@@ -40,7 +42,7 @@ class TimestampMixin:
             )
 
         @declared_attr
-        def modified(cls) -> 'Column[_t.Optional[datetime]]':
+        def modified(cls) -> Column[datetime | None]:
             return deferred(
                 Column(
                     UTCDateTime(timezone=False),

libres/db/models/types/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from .json_type import JSON
 from .utcdatetime import UTCDateTime
 from .uuid_type import UUID

libres/db/models/types/json_type.py

@@ -1,48 +1,46 @@
-from json import loads, dumps
-from sqlalchemy.types import TypeDecorator, TEXT
+from __future__ import annotations
 
+from sqlalchemy.ext.mutable import MutableDict
+from sqlalchemy.types import TypeDecorator
+from sqlalchemy.dialects.postgresql import JSONB
 
-import typing as _t
-if _t.TYPE_CHECKING:
+
+from typing import Any
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
     from sqlalchemy.engine import Dialect
 
-    _Base = TypeDecorator[_t.Any]
+    _Base = TypeDecorator[dict[str, Any]]
 else:
     _Base = TypeDecorator
 
 
 class JSON(_Base):
-    """Like the default JSON, but using the json serializer from the dialect
-    (postgres) each time the value is read, even if it never left the ORM. The
-    default json type will only do it when the record is read from the
-    database.
+    """ A JSONB based type that coerces None's to empty dictionaries.
+
+    That is, this JSONB column cannot be `'null'::jsonb`. It could
+    still be `NULL` though, if it's nullable and never explicitly
+    set. But on the Python end you should always see a dictionary.
 
     """
 
-    # Use TEXT for now to stay compatible with Postgres 9.1. In the future
-    # this will be replaced by JSON (or JSONB) though that requires that we
-    # require a later Postgres release. For now we stay backwards compatible
-    # with a version that's still widely used (9.1).
-    impl = TEXT
+    impl = JSONB
 
-    def process_bind_param(
+    def process_bind_param(  # type:ignore[override]
         self,
-        value: _t.Any,
-        dialect: 'Dialect'
-    ) -> _t.Optional[str]:
+        value: dict[str, Any] | None,
+        dialect: Dialect
+    ) -> dict[str, Any]:
 
-        if value is not None:
-            value = (dialect._json_serializer or dumps)(value)  # type:ignore
-
-        return value
+        return {} if value is None else value
 
     def process_result_value(
         self,
-        value: _t.Optional[str],
-        dialect: 'Dialect'
-    ) -> _t.Optional[_t.Any]:
+        value: dict[str, Any] | None,
+        dialect: Dialect
+    ) -> dict[str, Any]:
+
+        return {} if value is None else value
 
-        if value is not None:
-            value = (dialect._json_deserializer or loads)(value)  # type:ignore
 
-        return value
+MutableDict.associate_with(JSON)  # type:ignore[no-untyped-call]

libres/db/models/types/utcdatetime.py

@@ -1,10 +1,12 @@
+from __future__ import annotations
+
 import sedate
 
 from sqlalchemy import types
 
 
-import typing as _t
-if _t.TYPE_CHECKING:
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
     from datetime import datetime
     from sqlalchemy.engine import Dialect
 
@@ -29,9 +31,9 @@ class UTCDateTime(_Base):
 
     def process_bind_param(  # type:ignore[override]
         self,
-        value: _t.Optional['datetime'],
-        dialect: 'Dialect'
-    ) -> _t.Optional['datetime']:
+        value: datetime | None,
+        dialect: Dialect
+    ) -> datetime | None:
 
         if value is not None:
             return sedate.to_timezone(value, 'UTC').replace(tzinfo=None)
@@ -39,9 +41,9 @@ class UTCDateTime(_Base):
 
     def process_result_value(
         self,
-        value: _t.Optional['datetime'],
-        dialect: 'Dialect'
-    ) -> _t.Optional['datetime']:
+        value: datetime | None,
+        dialect: Dialect
+    ) -> datetime | None:
 
         if value is not None:
             return sedate.replace_timezone(value, 'UTC')

libres/db/models/types/uuid_type.py

@@ -1,11 +1,13 @@
+from __future__ import annotations
+
 import uuid
 
 from sqlalchemy.types import TypeDecorator
 from sqlalchemy.dialects import postgresql
 
 
-import typing as _t
-if _t.TYPE_CHECKING:
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
     from sqlalchemy.engine import Dialect
 
     _Base = TypeDecorator['SoftUUID']
@@ -46,9 +48,9 @@ class UUID(_Base):
 
     def process_bind_param(
         self,
-        value: _t.Optional[uuid.UUID],
-        dialect: 'Dialect'
-    ) -> _t.Optional[str]:
+        value: uuid.UUID | None,
+        dialect: Dialect
+    ) -> str | None:
 
         if value is not None:
             return str(value)
@@ -56,9 +58,9 @@ class UUID(_Base):
 
     def process_result_value(
         self,
-        value: _t.Optional[str],
-        dialect: 'Dialect'
-    ) -> _t.Optional[SoftUUID]:
+        value: str | None,
+        dialect: Dialect
+    ) -> SoftUUID | None:
         if value is not None:
             # Postgres always returns the uuid in the same format, so we
             # can turn it into an int immediately, avoiding some checks

libres/db/queries.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 import sedate
 
@@ -11,14 +13,17 @@ from sqlalchemy.orm import joinedload
 from sqlalchemy.sql import and_, or_
 
 
-import typing as _t
-if _t.TYPE_CHECKING:
+from typing import TypeVar
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from collections.abc import Collection
+    from collections.abc import Iterable
     from sqlalchemy.orm import Query
     from uuid import UUID
 
     from libres.context.core import Context
 
-_T = _t.TypeVar('_T')
+_T = TypeVar('_T')
 
 
 log = logging.getLogger('libres')
@@ -34,24 +39,24 @@ class Queries(ContextServicesMixin):
 
     """
 
-    def __init__(self, context: 'Context'):
+    def __init__(self, context: Context):
         self.context = context
 
     def all_allocations_in_range(
         self,
         start: datetime,
         end: datetime
-    ) -> 'Query[Allocation]':
+    ) -> Query[Allocation]:
         return self.allocations_in_range(
             self.session.query(Allocation), start, end
         )
 
     @staticmethod
     def allocations_in_range(
-        query: 'Query[_T]',
+        query: Query[_T],
         start: datetime,
         end: datetime
-    ) -> 'Query[_T]':
+    ) -> Query[_T]:
         """ Takes an allocation query and limits it to the allocations
         overlapping with start and end.
 
@@ -71,9 +76,9 @@ class Queries(ContextServicesMixin):
 
     @staticmethod
     def overlapping_allocations(
-        query: 'Query[_T]',
-        dates: _t.Iterable[_t.Tuple[datetime, datetime]]
-    ) -> 'Query[_T]':
+        query: Query[_T],
+        dates: Iterable[tuple[datetime, datetime]]
+    ) -> Query[_T]:
         """ Takes an allocation query and limits it to the allocations
         overlapping with any of the passed in datetime ranges
 
@@ -94,7 +99,7 @@ class Queries(ContextServicesMixin):
 
     @staticmethod
     def availability_by_allocations(
-        allocations: _t.Iterable['Allocation']
+        allocations: Iterable[Allocation]
     ) -> float:
         """Takes any iterable with alloctions and calculates the availability.
         Counts missing mirrors as 100% free and returns a value between 0-100
@@ -124,7 +129,7 @@ class Queries(ContextServicesMixin):
         self,
         start: datetime,
         end: datetime,
-        resources: _t.Collection['UUID']
+        resources: Collection[UUID]
     ) -> float:
         """Returns the availability for the given resources in the given range.
         The exposure is used to check if the allocation is visible.
@@ -143,8 +148,8 @@ class Queries(ContextServicesMixin):
         self,
         start: datetime,
         end: datetime,
-        resources: _t.Collection['UUID']
-    ) -> _t.Dict[date, _t.Tuple[float, _t.Set['UUID']]]:
+        resources: Collection[UUID]
+    ) -> dict[date, tuple[float, set[UUID]]]:
         """Availability by range with a twist. Instead of returning a grand
         total, a dictionary is returned with each day in the range as key and
         a tuple of availability and the resources counted for that day.
@@ -181,8 +186,8 @@ class Queries(ContextServicesMixin):
 
     def reservations_by_session(
         self,
-        session_id: _t.Optional['UUID']
-    ) -> 'Query[Reservation]':
+        session_id: UUID | None
+    ) -> Query[Reservation]:
 
         # be sure to not query for all reservations. since a query should be
         # returned in any case we just use an impossible clause
@@ -190,7 +195,7 @@ class Queries(ContextServicesMixin):
         # this is mainly a security feature
         if not session_id:
             log.warn('empty session id')
-            return self.session.query(Reservation).filter("0=1")
+            return self.session.query(Reservation).filter('0=1')
 
         query = self.session.query(Reservation)
         query = query.filter(Reservation.session_id == session_id)
@@ -200,8 +205,8 @@ class Queries(ContextServicesMixin):
 
     def confirm_reservations_for_session(
         self,
-        session_id: 'UUID',
-        token: _t.Optional['UUID'] = None
+        session_id: UUID,
+        token: UUID | None = None
     ) -> None:
         """ Confirms all reservations of the given session id. Optionally
         confirms only the reservations with the given token. All if None.
@@ -229,8 +234,8 @@ class Queries(ContextServicesMixin):
 
     def remove_reservation_from_session(
         self,
-        session_id: 'UUID',
-        token: 'UUID'
+        session_id: UUID,
+        token: UUID
     ) -> None:
         """ Removes the reservation with the given session_id and token. """
 
@@ -262,12 +267,12 @@ class Queries(ContextServicesMixin):
         query = self.session.query(Reservation)
         query = query.filter(Reservation.session_id == session_id)
 
-        query.update({"modified": sedate.utcnow()})
+        query.update({'modified': sedate.utcnow()})
 
     def find_expired_reservation_sessions(
         self,
-        expiration_date: _t.Optional[datetime]
-    ) -> _t.List['UUID']:
+        expiration_date: datetime | None
+    ) -> list[UUID]:
         """ Goes through all reservations and returns the session ids of the
         unconfirmed ones which are older than the given expiration date.
         By default the expiration date is now - 15 minutes.
@@ -282,7 +287,7 @@ class Queries(ContextServicesMixin):
         )
 
         # first get the session ids which are expired
-        query: 'Query[_t.Tuple[UUID, datetime, _t.Optional[datetime]]]'
+        query: Query[tuple[UUID, datetime, datetime | None]]
         query = self.session.query(
             Reservation.session_id,
             func.max(Reservation.created),
@@ -306,8 +311,8 @@ class Queries(ContextServicesMixin):
 
     def remove_expired_reservation_sessions(
         self,
-        expiration_date: _t.Optional[datetime] = None
-    ) -> _t.List['UUID']:
+        expiration_date: datetime | None = None
+    ) -> list[UUID]:
         """ Removes all reservations which have an expired session id.
         By default the expiration date is now - 15 minutes.