Add type hints to sqlalchemy Patron model (PP-1728) (#2086)

pyproject.toml

@@ -114,6 +114,7 @@ module = [
     "palace.manager.sqlalchemy.model.collection",
     "palace.manager.sqlalchemy.model.integration",
     "palace.manager.sqlalchemy.model.library",
+    "palace.manager.sqlalchemy.model.patron",
     "palace.manager.util.authentication_for_opds",
     "palace.manager.util.base64",
     "palace.manager.util.cache",

src/palace/manager/api/annotations.py

@@ -11,6 +11,7 @@
 )
 from palace.manager.sqlalchemy.model.identifier import Identifier
 from palace.manager.sqlalchemy.model.patron import Annotation
+from palace.manager.sqlalchemy.util import get_one_or_create
 from palace.manager.util.datetime_helpers import utc_now
 
 
@@ -210,8 +211,9 @@ def parse(cls, _db, data, patron):
             # per target.
             extra_kwargs["target"] = target
 
-        annotation, ignore = Annotation.get_one_or_create(
+        annotation, ignore = get_one_or_create(
             _db,
+            Annotation,
             patron=patron,
             identifier=identifier,
             motivation=motivation,

src/palace/manager/feed/acquisition.py

@@ -2,7 +2,7 @@
 from __future__ import annotations
 
 import logging
-from collections.abc import Callable, Generator
+from collections.abc import Callable, Generator, Iterable
 from typing import TYPE_CHECKING, Any
 
 from dependency_injector.wiring import Provide, inject
@@ -56,7 +56,7 @@ def __init__(
         self,
         title: str,
         url: str,
-        works: list[Work],
+        works: Iterable[Work],
         annotator: CirculationManagerAnnotator,
         facets: FacetsWithEntryPoint | None = None,
         pagination: Pagination | None = None,

src/palace/manager/sqlalchemy/model/collection.py

@@ -315,7 +315,7 @@ def protocol(self, new_protocol: str) -> None:
     STANDARD_DEFAULT_LOAN_PERIOD = 21
 
     def default_loan_period(
-        self, library: Library, medium: str = EditionConstants.BOOK_MEDIUM
+        self, library: Library | None, medium: str = EditionConstants.BOOK_MEDIUM
     ) -> int:
         """Until we hear otherwise from the license provider, we assume
         that someone who borrows a non-open-access item from this
@@ -336,7 +336,7 @@ def loan_period_key(cls, medium: str = EditionConstants.BOOK_MEDIUM) -> str:
 
     def default_loan_period_setting(
         self,
-        library: Library,
+        library: Library | None,
         medium: str = EditionConstants.BOOK_MEDIUM,
     ) -> int | None:
         """Until we hear otherwise from the license provider, we assume

src/palace/manager/sqlalchemy/model/edition.py

@@ -101,7 +101,7 @@ class Edition(Base, EditionConstants):
 
     # An Edition may be the presentation edition for many LicensePools.
     is_presentation_for: Mapped[list[LicensePool]] = relationship(
-        "LicensePool", backref="presentation_edition"
+        "LicensePool", back_populates="presentation_edition"
     )
 
     title = Column(Unicode, index=True)

src/palace/manager/sqlalchemy/model/licensing.py

@@ -32,8 +32,10 @@
 if TYPE_CHECKING:
     from palace.manager.sqlalchemy.model.collection import Collection
     from palace.manager.sqlalchemy.model.datasource import DataSource
+    from palace.manager.sqlalchemy.model.edition import Edition
     from palace.manager.sqlalchemy.model.identifier import Identifier
     from palace.manager.sqlalchemy.model.resource import Resource
+    from palace.manager.sqlalchemy.model.work import Work
 
 
 class PolicyException(BasePalaceException):
@@ -199,6 +201,7 @@ class LicensePool(Base):
     # A LicensePool may be associated with a Work. (If it's not, no one
     # can check it out.)
     work_id = Column(Integer, ForeignKey("works.id"), index=True)
+    work: Mapped[Work] = relationship("Work", back_populates="license_pools")
 
     # Each LicensePool is associated with one DataSource and one
     # Identifier.
@@ -224,6 +227,9 @@ class LicensePool(Base):
     # Each LicensePool has an Edition which contains the metadata used
     # to describe this book.
     presentation_edition_id = Column(Integer, ForeignKey("editions.id"), index=True)
+    presentation_edition: Mapped[Edition] = relationship(
+        "Edition", back_populates="is_presentation_for"
+    )
 
     # If the source provides information about individual licenses, the
     # LicensePool may have many Licenses.