libres 0.8.0__tar.gz → 0.9.0__tar.gz

{libres-0.8.0 → libres-0.9.0}/HISTORY.rst

@@ -1,6 +1,21 @@
 Changelog
 ---------
 
+0.9.0 (23.05.2025)
+~~~~~~~~~~~~~~~~~~~
+
+- Replaces `JSON` database type with `JSONB`, this means
+  Postgres as a backend is not required. You will also need
+  to write a migration for existing JSON columns. You may use
+  the following recipe using an alembic `Operations` object::
+
+    operations.alter_column(
+      'table_name',
+      'column_name',
+      type_=JSON,
+      postgresql_using='"column_name"::jsonb'
+    )
+
 0.8.0 (15.01.2025)
 ~~~~~~~~~~~~~~~~~~~
 

{libres-0.8.0/src/libres.egg-info → libres-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: libres
-Version: 0.8.0
+Version: 0.9.0
 Summary: A library to reserve things
 Home-page: http://github.com/seantis/libres/
 Author: Denis Krienbühl
@@ -51,13 +51,14 @@ Requires-Dist: types-psycopg2; extra == "mypy"
 Requires-Dist: types-python-dateutil; extra == "mypy"
 Requires-Dist: types-pytz; extra == "mypy"
 Requires-Dist: typing-extensions; extra == "mypy"
+Dynamic: license-file
 
 Libres
 ======
 
 Libres is a reservations management library to reserve things like tables at
-a restaurant or tickets at an event. It works with Python 3.8+
-and requires Postgresql 9.1+.
+a restaurant or tickets at an event. It works with Python 3.9+
+and requires Postgresql 9.2+.
 
 `Documentation <http://libres.readthedocs.org/en/latest/>`_ | `Source <http://github.com/seantis/libres/>`_ | `Bugs <http://github.com/seantis/libres/issues>`_
 
@@ -141,6 +142,21 @@ After this, create a new release on Github.
 Changelog
 ---------
 
+0.9.0 (23.05.2025)
+~~~~~~~~~~~~~~~~~~~
+
+- Replaces `JSON` database type with `JSONB`, this means
+  Postgres as a backend is not required. You will also need
+  to write a migration for existing JSON columns. You may use
+  the following recipe using an alembic `Operations` object::
+
+    operations.alter_column(
+      'table_name',
+      'column_name',
+      type_=JSON,
+      postgresql_using='"column_name"::jsonb'
+    )
+
 0.8.0 (15.01.2025)
 ~~~~~~~~~~~~~~~~~~~
 

{libres-0.8.0 → libres-0.9.0}/README.rst

@@ -2,8 +2,8 @@ Libres
 ======
 
 Libres is a reservations management library to reserve things like tables at
-a restaurant or tickets at an event. It works with Python 3.8+
-and requires Postgresql 9.1+.
+a restaurant or tickets at an event. It works with Python 3.9+
+and requires Postgresql 9.2+.
 
 `Documentation <http://libres.readthedocs.org/en/latest/>`_ | `Source <http://github.com/seantis/libres/>`_ | `Bugs <http://github.com/seantis/libres/issues>`_
 

{libres-0.8.0 → libres-0.9.0}/pyproject.toml

@@ -11,7 +11,7 @@ branch = true
 source = ["src"]
 
 [tool.bumpversion]
-current_version = "0.8.0"
+current_version = "0.9.0"
 commit = true
 message = "Release {new_version}"
 tag = true
@@ -36,14 +36,12 @@ replace = """
 
 [tool.mypy]
 python_version = "3.9"
-follow_imports = "silent"
 namespace_packages = true
 explicit_package_bases = true
-warn_unused_ignores = true
-warn_redundant_casts = true
+strict = true
 warn_unreachable = true
-disallow_any_generics = true
-disallow_untyped_defs = true
+# FIXME: remove this exclusion when upgrading to SQlAlchemy 2.0
+untyped_calls_exclude = "sqlalchemy"
 plugins = "sqlmypy"
 mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
 

{libres-0.8.0 → libres-0.9.0}/src/libres/__init__.py

@@ -5,7 +5,7 @@ from libres.db import new_scheduler
 
 registry = create_default_registry()
 
-__version__ = '0.8.0'
+__version__ = '0.9.0'
 __all__ = (
     'new_scheduler',
     'registry'

{libres-0.8.0 → libres-0.9.0}/src/libres/context/core.py

@@ -61,15 +61,15 @@ class ContextServicesMixin:
 
     @cached_property
     def is_allocation_exposed(self) -> Callable[[Allocation], bool]:
-        return self.context.get_service('exposure').is_allocation_exposed
+        return self.context.get_service('exposure').is_allocation_exposed  # type: ignore[no-any-return]
 
     @cached_property
     def generate_uuid(self) -> Callable[[str], UUID]:
-        return self.context.get_service('uuid_generator')
+        return self.context.get_service('uuid_generator')  # type: ignore[no-any-return]
 
     @cached_property
     def validate_email(self) -> Callable[[str], bool]:
-        return self.context.get_service('email_validator')
+        return self.context.get_service('email_validator')  # type: ignore[no-any-return]
 
     def clear_cache(self) -> None:
         """ Clears the cache of the mixin. """
@@ -91,12 +91,12 @@ class ContextServicesMixin:
 
     @property
     def session_provider(self) -> SessionProvider:
-        return self.context.get_service('session_provider')
+        return self.context.get_service('session_provider')  # type: ignore[no-any-return]
 
     @property
     def session(self) -> Session:
         """ Returns the current session. """
-        return self.session_provider.session()
+        return self.session_provider.session()  # type: ignore[no-any-return]
 
     def close(self) -> None:
         """ Closes the current session. """

{libres-0.8.0 → libres-0.9.0}/src/libres/context/registry.py

@@ -98,7 +98,7 @@ class Registry:
         if not hasattr(self.local, 'current_context'):
             self.local.current_context = self.master_context
 
-        return self.local.current_context
+        return self.local.current_context  # type: ignore[no-any-return]
 
     def is_existing_context(self, name: str) -> bool:
         return name in self.contexts

{libres-0.8.0 → libres-0.9.0}/src/libres/db/models/allocation.py

@@ -34,14 +34,18 @@ if TYPE_CHECKING:
     from collections.abc import Iterator
     from sedate.types import TzInfoOrName
     from sqlalchemy.orm import Query
+    from typing import NamedTuple
     from typing_extensions import Self
 
-    from libres.db.models import Reservation, ReservedSlot
+    from libres.db.models import ReservedSlot
     from libres.modules.rasterizer import Raster
 
     _OptDT1 = TypeVar('_OptDT1', 'datetime | None', datetime, None)
     _OptDT2 = TypeVar('_OptDT2', 'datetime | None', datetime, None)
 
+    class _ReservationIdRow(NamedTuple):
+        id: int
+
 
 class Allocation(TimestampMixin, ORMBase, OtherModels):
     """Describes a timespan within which one or many timeslots can be
@@ -114,7 +118,7 @@ class Allocation(TimestampMixin, ORMBase, OtherModels):
     timezone: Column[str | None] = Column(types.String())
 
     #: Custom data reserved for the user
-    data: Column[Any | None] = Column(
+    data: Column[dict[str, Any] | None] = Column(
         JSON(),
         nullable=True
     )
@@ -470,7 +474,7 @@ class Allocation(TimestampMixin, ORMBase, OtherModels):
             return self.display_start(timezone), self.display_end(timezone)
 
     @property
-    def pending_reservations(self) -> Query[Reservation]:
+    def pending_reservations(self) -> Query[_ReservationIdRow]:
         """ Returns the pending reservations query for this allocation.
         As the pending reservations target the group and not a specific
         allocation this function returns the same value for masters and
@@ -482,6 +486,7 @@ class Allocation(TimestampMixin, ORMBase, OtherModels):
         )
 
         Reservation = self.models.Reservation  # noqa: N806
+        query: Query[_ReservationIdRow]
         query = object_session(self).query(Reservation.id)
         query = query.filter(Reservation.target == self.group)
         query = query.filter(Reservation.status == 'pending')
@@ -794,7 +799,9 @@ class Allocation(TimestampMixin, ORMBase, OtherModels):
         if self.is_master:
             return self
         else:
-            query = object_session(self).query(Allocation)
+            # FIXME: This should either query `self.__class__` or
+            #        we need to return `Allocation` rather than `Self`
+            query: Query[Self] = object_session(self).query(Allocation)
             query = query.filter(Allocation._start == self._start)
             query = query.filter(Allocation.resource == self.mirror_of)
 
@@ -818,7 +825,9 @@ class Allocation(TimestampMixin, ORMBase, OtherModels):
             assert self.is_master
             return [self]
 
-        query = object_session(self).query(Allocation)
+        # FIXME: This should either query `self.__class__` or
+        #        we need to return `Allocation` rather than `Self`
+        query: Query[Self] = object_session(self).query(Allocation)
         query = query.filter(Allocation.mirror_of == self.mirror_of)
         query = query.filter(Allocation._start == self._start)
 

{libres-0.8.0 → libres-0.9.0}/src/libres/db/models/reservation.py

@@ -96,7 +96,7 @@ class Reservation(TimestampMixin, ORMBase, OtherModels):
         nullable=False
     )
 
-    data: Column[Any | None] = deferred(
+    data: Column[dict[str, Any] | None] = deferred(
         Column(
             JSON(),
             nullable=True
@@ -148,7 +148,7 @@ class Reservation(TimestampMixin, ORMBase, OtherModels):
         # order by date
         query = query.order_by(Allocation._start)
 
-        return query
+        return query  # type: ignore[no-any-return]
 
     def display_start(
         self,
@@ -212,4 +212,4 @@ class Reservation(TimestampMixin, ORMBase, OtherModels):
         # A reservation is deemed autoapprovable if no allocation
         # requires explicit approval
 
-        return object_session(self).query(~query.exists()).scalar()
+        return object_session(self).query(~query.exists()).scalar()  # type: ignore[no-any-return]

libres-0.9.0/src/libres/db/models/types/json_type.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from sqlalchemy.ext.mutable import MutableDict
+from sqlalchemy.types import TypeDecorator
+from sqlalchemy.dialects.postgresql import JSONB
+
+
+from typing import Any
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from sqlalchemy.engine import Dialect
+
+    _Base = TypeDecorator[dict[str, Any]]
+else:
+    _Base = TypeDecorator
+
+
+class JSON(_Base):
+    """ 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.
+
+    """
+
+    impl = JSONB
+
+    def process_bind_param(  # type:ignore[override]
+        self,
+        value: dict[str, Any] | None,
+        dialect: Dialect
+    ) -> dict[str, Any]:
+
+        return {} if value is None else value
+
+    def process_result_value(
+        self,
+        value: dict[str, Any] | None,
+        dialect: Dialect
+    ) -> dict[str, Any]:
+
+        return {} if value is None else value
+
+
+MutableDict.associate_with(JSON)  # type:ignore[no-untyped-call]

{libres-0.8.0 → libres-0.9.0}/src/libres/db/scheduler.py

@@ -306,7 +306,10 @@ class Scheduler(ContextServicesMixin):
     ) -> list[tuple[datetime, datetime]]:
 
         query = self.allocations_by_group(group)
-        dates_query = query.with_entities(Allocation._start, Allocation._end)
+        dates_query: Query[tuple[datetime, datetime]] = query.with_entities(
+            Allocation._start,
+            Allocation._end
+        )
         return dates_query.all()
 
     def allocation_mirrors_by_master(
@@ -336,7 +339,7 @@ class Scheduler(ContextServicesMixin):
         query = self.allocations_by_ids(ids)
         query = query.filter(Allocation.approve_manually == True)
 
-        return self.session.query(query.exists()).scalar()
+        return self.session.query(query.exists()).scalar()  # type: ignore[no-any-return]
 
     def allocate(
         self,
@@ -1273,8 +1276,9 @@ class Scheduler(ContextServicesMixin):
         # reservation twice on a single session
         if session_id:
             found = self.queries.reservations_by_session(session_id)
-            found = found.with_entities(Reservation.target, Reservation.start)
-            found_set = set(found)
+            found_set: set[tuple[UUID, datetime | None]] = set(
+                found.with_entities(Reservation.target, Reservation.start)
+            )
 
             for reservation in reservations:
                 if (reservation.target, reservation.start) in found_set:

{libres-0.8.0 → libres-0.9.0/src/libres.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: libres
-Version: 0.8.0
+Version: 0.9.0
 Summary: A library to reserve things
 Home-page: http://github.com/seantis/libres/
 Author: Denis Krienbühl
@@ -51,13 +51,14 @@ Requires-Dist: types-psycopg2; extra == "mypy"
 Requires-Dist: types-python-dateutil; extra == "mypy"
 Requires-Dist: types-pytz; extra == "mypy"
 Requires-Dist: typing-extensions; extra == "mypy"
+Dynamic: license-file
 
 Libres
 ======
 
 Libres is a reservations management library to reserve things like tables at
-a restaurant or tickets at an event. It works with Python 3.8+
-and requires Postgresql 9.1+.
+a restaurant or tickets at an event. It works with Python 3.9+
+and requires Postgresql 9.2+.
 
 `Documentation <http://libres.readthedocs.org/en/latest/>`_ | `Source <http://github.com/seantis/libres/>`_ | `Bugs <http://github.com/seantis/libres/issues>`_
 
@@ -141,6 +142,21 @@ After this, create a new release on Github.
 Changelog
 ---------
 
+0.9.0 (23.05.2025)
+~~~~~~~~~~~~~~~~~~~
+
+- Replaces `JSON` database type with `JSONB`, this means
+  Postgres as a backend is not required. You will also need
+  to write a migration for existing JSON columns. You may use
+  the following recipe using an alembic `Operations` object::
+
+    operations.alter_column(
+      'table_name',
+      'column_name',
+      type_=JSON,
+      postgresql_using='"column_name"::jsonb'
+    )
+
 0.8.0 (15.01.2025)
 ~~~~~~~~~~~~~~~~~~~
 

{libres-0.8.0 → libres-0.9.0}/tests/test_scheduler.py

@@ -1821,7 +1821,7 @@ def test_data_coding(scheduler):
     scheduler.allocate((start, end), data=None)
     scheduler.commit()
 
-    assert scheduler.managed_allocations().first().data is None
+    assert scheduler.managed_allocations().first().data == {}
 
 
 def test_no_reservations_to_confirm(scheduler):

libres-0.8.0/src/libres/db/models/types/json_type.py

@@ -1,51 +0,0 @@
-from __future__ import annotations
-
-from json import loads, dumps
-from sqlalchemy.types import TypeDecorator, TEXT
-
-
-from typing import Any
-from typing import TYPE_CHECKING
-if TYPE_CHECKING:
-    from sqlalchemy.engine import Dialect
-
-    _Base = TypeDecorator[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.
-
-    """
-
-    # 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
-
-    def process_bind_param(
-        self,
-        value: Any,
-        dialect: Dialect
-    ) -> str | None:
-
-        if value is not None:
-            value = (dialect._json_serializer or dumps)(value)  # type:ignore
-
-        return value
-
-    def process_result_value(
-        self,
-        value: str | None,
-        dialect: Dialect
-    ) -> Any | None:
-
-        if value is not None:
-            value = (dialect._json_deserializer or loads)(value)  # type:ignore
-
-        return value