codex 1.7.15__py3-none-any.whl → 1.8.0__py3-none-any.whl

codex/serializers/models/named.py

@@ -1,13 +1,14 @@
 """Named model Serializers."""
 
 from rest_framework.fields import CharField
+from rest_framework.serializers import URLField
 
 from codex.models import (
     AgeRating,
     Character,
-    Contributor,
-    ContributorPerson,
-    ContributorRole,
+    Credit,
+    CreditPerson,
+    CreditRole,
     Genre,
     Location,
     OriginalFormat,
@@ -20,7 +21,8 @@ from codex.models import (
     Tagger,
     Team,
 )
-from codex.models.named import Identifier, IdentifierType
+from codex.models.identifier import Identifier, IdentifierSource
+from codex.models.named import Universe
 from codex.serializers.models.base import BaseModelSerializer
 
 
@@ -28,69 +30,81 @@ class NamedModelSerializer(BaseModelSerializer):
     """A common class for NamedModels."""
 
     class Meta(BaseModelSerializer.Meta):
-        """Not Abstract."""
+        """Abstract."""
 
-        fields = ("pk", "name")
+        fields: tuple[str, ...] = ("pk", "name")
         abstract = True
 
 
-class ContributorPersonSerializer(NamedModelSerializer):
-    """ContributorPerson model."""
+class URLNamedModelSerializer(NamedModelSerializer):
+    """A common class for NamedModels with URLs."""
+
+    url = URLField(read_only=True, source="identifier.url")
 
     class Meta(NamedModelSerializer.Meta):
+        """Abstract."""
+
+        fields: tuple[str, ...] = ("pk", "name", "url")
+        abstract = True
+
+
+class CreditPersonSerializer(URLNamedModelSerializer):
+    """CreditPerson model."""
+
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
-        model = ContributorPerson
+        model = CreditPerson
 
 
-class ContributorRoleSerializer(NamedModelSerializer):
-    """ContributorRole model."""
+class CreditRoleSerializer(URLNamedModelSerializer):
+    """CreditRole model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
-        model = ContributorRole
+        model = CreditRole
 
 
-class ContributorSerializer(BaseModelSerializer):
-    """Contributor model serializer."""
+class CreditSerializer(BaseModelSerializer):
+    """Credit model serializer."""
 
-    role = ContributorRoleSerializer()
-    person = ContributorPersonSerializer()
+    role = CreditRoleSerializer()
+    person = CreditPersonSerializer()
 
     class Meta(BaseModelSerializer.Meta):
         """Model spec."""
 
-        model = Contributor
+        model = Credit
         fields = ("pk", "person", "role")
         depth = 1
 
 
-class CharacterSerializer(NamedModelSerializer):
+class CharacterSerializer(URLNamedModelSerializer):
     """Character model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
         model = Character
 
 
-class GenreSerializer(NamedModelSerializer):
+class GenreSerializer(URLNamedModelSerializer):
     """Genre model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
         model = Genre
 
 
-class IdentifierTypeSerializer(NamedModelSerializer):
-    """IdentifierType model."""
+class IdentifierSourceSerializer(NamedModelSerializer):
+    """IdentifierSource model."""
 
     class Meta(NamedModelSerializer.Meta):
         """Configure model."""
 
-        model = IdentifierType
+        model = IdentifierSource
 
 
 class IdentifierSeralizer(BaseModelSerializer):
@@ -102,14 +116,14 @@ class IdentifierSeralizer(BaseModelSerializer):
         """Configure model."""
 
         model = Identifier
-        fields = ("pk", "name", "nss", "url")
+        fields = ("pk", "name", "key", "url")
         depth = 1
 
 
-class LocationSerializer(NamedModelSerializer):
+class LocationSerializer(URLNamedModelSerializer):
     """Location model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
         model = Location
@@ -124,19 +138,19 @@ class SeriesGroupSerializer(NamedModelSerializer):
         model = SeriesGroup
 
 
-class StorySerializer(NamedModelSerializer):
+class StorySerializer(URLNamedModelSerializer):
     """StoryArc model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
         model = Story
 
 
-class StoryArcSerializer(NamedModelSerializer):
+class StoryArcSerializer(URLNamedModelSerializer):
     """StoryArc model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
         model = StoryArc
@@ -146,12 +160,13 @@ class StoryArcNumberSerializer(BaseModelSerializer):
     """StoryArc model."""
 
     name = CharField(read_only=True)
+    url = URLField(read_only=True, source="story_arc.identifier.url")
 
     class Meta(BaseModelSerializer.Meta):
         """Configure model."""
 
         model = StoryArcNumber
-        fields = ("pk", "name", "number")
+        fields = ("pk", "name", "number", "url")
         depth = 1
 
 
@@ -173,10 +188,10 @@ class AgeRatingSerializer(NamedModelSerializer):
         model = AgeRating
 
 
-class TagSerializer(NamedModelSerializer):
+class TagSerializer(URLNamedModelSerializer):
     """Tag model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
         model = Tag
@@ -200,10 +215,20 @@ class ScanInfoSerializer(NamedModelSerializer):
         model = ScanInfo
 
 
-class TeamSerializer(NamedModelSerializer):
+class TeamSerializer(URLNamedModelSerializer):
     """Team model."""
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(URLNamedModelSerializer.Meta):
         """Configure model."""
 
         model = Team
+
+
+class UniverseSerializer(URLNamedModelSerializer):
+    """Team model."""
+
+    class Meta(URLNamedModelSerializer.Meta):
+        """Configure model."""
+
+        model = Universe
+        fields: tuple[str, ...] = ("pk", "name", "designation", "url")

codex/serializers/models/pycountry.py

@@ -1,6 +1,5 @@
 """Pycountry Model Serializers."""
 
-from codex.logger.logger import get_logger
 from codex.models import (
     Country,
     Language,
@@ -8,8 +7,6 @@ from codex.models import (
 from codex.serializers.fields.browser import CountryField, LanguageField
 from codex.serializers.models.named import NamedModelSerializer
 
-LOG = get_logger(__name__)
-
 
 class CountrySerializer(NamedModelSerializer):
     """Pycountry serializer for country field."""

codex/serializers/opds/v1.py

@@ -12,7 +12,7 @@ from rest_framework.fields import (
 )
 from rest_framework.serializers import Serializer
 
-from codex.serializers.fields.browser import TopGroupField
+from codex.serializers.fields.group import BrowseGroupField
 from codex.serializers.models.pycountry import LanguageSerializer
 
 UTC_TZ = ZoneInfo("UTC")
@@ -26,7 +26,7 @@ class OPDS1TemplateLinkSerializer(Serializer):
     mime_type = CharField(read_only=True)
     title = CharField(read_only=True, required=False)
     length = IntegerField(read_only=True, required=False)
-    facet_group = TopGroupField(read_only=True, required=False)
+    facet_group = BrowseGroupField(read_only=True, required=False)
     facet_active = BooleanField(read_only=True, required=False)
     thr_count = IntegerField(read_only=True, required=False)
     pse_count = IntegerField(read_only=True, required=False)
@@ -34,8 +34,8 @@ class OPDS1TemplateLinkSerializer(Serializer):
     pse_last_read_date = DateTimeField(read_only=True, required=False)
 
 
-class OPDS1ContributorSerializer(Serializer):
-    """OPDS 1 Contributor."""
+class OPDS1CreditSerializer(Serializer):
+    """OPDS 1 Credit."""
 
     name = CharField(read_only=True)
     url = CharField(read_only=True, required=False)
@@ -53,8 +53,8 @@ class OPDS1TemplateEntrySerializer(Serializer):
     publisher = CharField(read_only=True, required=False)
     language = LanguageSerializer(read_only=True, required=False)
     summary = CharField(read_only=True, required=False)
-    authors = OPDS1ContributorSerializer(many=True, required=False, read_only=True)
-    contributors = OPDS1ContributorSerializer(many=True, required=False, read_only=True)
+    authors = OPDS1CreditSerializer(many=True, required=False, read_only=True)
+    credits = OPDS1CreditSerializer(many=True, required=False, read_only=True)
     category_groups = DictField(required=False, read_only=True)
 
 

codex/serializers/opds/v2/feed.py

@@ -7,10 +7,8 @@ from rest_framework.serializers import Serializer
 
 from codex.serializers.opds.v2.facet import OPDS2FacetSerializer
 from codex.serializers.opds.v2.links import OPDS2LinkListField
-from codex.serializers.opds.v2.publication import (
-    OPDS2MetadataSerializer,
-    OPDS2PublicationSerializer,
-)
+from codex.serializers.opds.v2.metadata import OPDS2MetadataSerializer
+from codex.serializers.opds.v2.publication import OPDS2PublicationSerializer
 
 
 class OPDS2GroupSerializer(Serializer):

codex/serializers/opds/v2/publication.py

@@ -16,11 +16,11 @@ class OPDS2FeedMetadataSerializer(OPDS2MetadataSerializer):
     number_of_items = IntegerField(read_only=True, required=False)
 
 
-class OPDS2ContributorObjectSerializer(Serializer):
+class OPDS2CreditObjectSerializer(Serializer):
     """
-    Contributor Object.
+    Credit Object.
 
-    https://readium.org/webpub-manifest/schema/contributor-object.schema.json
+    https://readium.org/webpub-manifest/schema/credit-object.schema.json
     """
 
     name = CharField(read_only=True)
@@ -52,16 +52,16 @@ class OPDS2PublicationMetadataSerializer(OPDS2MetadataSerializer):
     # Extended metadata #
     #####################
     subject = ListField(child=CharField(read_only=True), read_only=True, required=False)
-    author = OPDS2ContributorObjectSerializer(many=True, required=False)
-    # translator = OPDS2ContributorObjectSerializer(many=True, required=False) unused
-    editor = OPDS2ContributorObjectSerializer(many=True, required=False)
-    artist = OPDS2ContributorObjectSerializer(many=True, required=False)
-    # illustrator = OPDS2ContributorObjectSerializer(many=True, required=False) unused
-    letterer = OPDS2ContributorObjectSerializer(many=True, required=False)
-    peniciller = OPDS2ContributorObjectSerializer(many=True, required=False)
-    colorist = OPDS2ContributorObjectSerializer(many=True, required=False)
-    inker = OPDS2ContributorObjectSerializer(many=True, required=False)
-    contributor = OPDS2ContributorObjectSerializer(many=True, required=False)
+    author = OPDS2CreditObjectSerializer(many=True, required=False)
+    # translator = OPDS2CreditObjectSerializer(many=True, required=False) unused
+    editor = OPDS2CreditObjectSerializer(many=True, required=False)
+    artist = OPDS2CreditObjectSerializer(many=True, required=False)
+    # illustrator = OPDS2CreditObjectSerializer(many=True, required=False) unused
+    letterer = OPDS2CreditObjectSerializer(many=True, required=False)
+    peniciller = OPDS2CreditObjectSerializer(many=True, required=False)
+    colorist = OPDS2CreditObjectSerializer(many=True, required=False)
+    inker = OPDS2CreditObjectSerializer(many=True, required=False)
+    credit = OPDS2CreditObjectSerializer(many=True, required=False)
 
 
 class OPDS2PublicationSerializer(OPDS2FacetSerializer):
@@ -71,6 +71,6 @@ class OPDS2PublicationSerializer(OPDS2FacetSerializer):
     https://drafts.opds.io/schema/publication.schema.json
     """
 
-    metadata = OPDS2PublicationMetadataSerializer(read_only=True)
+    metadata = OPDS2PublicationMetadataSerializer(read_only=True)  # pyright: ignore[reportIncompatibleUnannotatedOverride]
     links = OPDS2LinkListField(read_only=True)
     images = OPDS2LinkListField(read_only=True, required=False)

codex/serializers/opds/v2/unused.py

@@ -2,6 +2,7 @@
 
 from rest_framework.fields import CharField, DateTimeField, DecimalField, IntegerField
 from rest_framework.serializers import ChoiceField, Serializer
+from typing_extensions import override
 
 from codex.serializers.opds.v2.links import OPDS2LinkListField
 
@@ -14,6 +15,7 @@ class RecursiveField(Serializer):
     https://pypi.org/project/djangorestframework-recursive/
     """
 
+    @override
     def to_representation(self, instance):
         """Represent with own class."""
         parent = self.parent

codex/serializers/reader.py

@@ -1,27 +1,24 @@
 """Codex Reader Serializers."""
 
-from rest_framework.serializers import (
+from rest_framework.fields import (
     BooleanField,
     CharField,
     DecimalField,
+    DictField,
     IntegerField,
-    Serializer,
+    ListField,
 )
+from rest_framework.serializers import Serializer
+from typing_extensions import override
 
-from codex.serializers.browser.settings import (
-    BrowserSettingsFilterInputSerializer,
-    BrowserSettingsShowGroupFlagsSerializer,
-)
 from codex.serializers.fields import (
     FitToField,
     ReadingDirectionField,
     TimestampField,
 )
-from codex.serializers.fields.browser import (
-    BreadcrumbsField,
-    TopGroupField,
-)
-from codex.serializers.route import RouteSerializer, SimpleRouteSerializer
+from codex.serializers.fields.reader import ArcGroupField
+from codex.serializers.mixins import JSONFieldSerializer
+from codex.serializers.route import RouteSerializer
 
 
 class ReaderSettingsSerializer(Serializer):
@@ -44,26 +41,31 @@ class ReaderComicSerializer(Serializer):
     max_page = IntegerField(read_only=True)
     reading_direction = ReadingDirectionField(read_only=True)
     mtime = TimestampField(read_only=True)
+    has_metadata = BooleanField(read_only=True)
 
 
-class ReaderArcSerializer(SimpleRouteSerializer):
+class ReaderArcInfoSerializer(Serializer):
     """Information about the current Arc."""
 
-    count = IntegerField(required=False, read_only=True)
-    index = IntegerField(required=False)
-    filters = BrowserSettingsFilterInputSerializer(required=False)
+    name = CharField(read_only=True)
     mtime = TimestampField(read_only=True)
-    name = CharField(required=False, read_only=True)
 
 
-class ReaderViewInputSerializer(Serializer):
+class ReaderSelectedArcSerializer(Serializer):
+    """And arc key serializer."""
+
+    group = ArcGroupField(required=False)
+    ids = ListField(child=IntegerField(), required=False)
+    index = IntegerField(read_only=True, required=False)
+    count = IntegerField(read_only=True, required=False)
+
+
+class ReaderViewInputSerializer(JSONFieldSerializer):
     """Input for the reader serailizer."""
 
-    arc = ReaderArcSerializer(required=False)
-    breadcrumbs = BreadcrumbsField(required=False)
-    browser_arc = ReaderArcSerializer(required=False)
-    show = BrowserSettingsShowGroupFlagsSerializer(required=False)
-    top_group = TopGroupField(required=False)
+    JSON_FIELDS = frozenset({"arc"})
+
+    arc = ReaderSelectedArcSerializer(required=False)
 
 
 class ReaderCurrentComicSerializer(ReaderComicSerializer):
@@ -72,6 +74,7 @@ class ReaderCurrentComicSerializer(ReaderComicSerializer):
     # For title
     series_name = CharField(read_only=True, required=False)
     volume_name = CharField(read_only=True, required=False)
+    volume_number_to = CharField(read_only=True, required=False)
     issue_number = DecimalField(
         max_digits=None,
         decimal_places=3,
@@ -80,11 +83,7 @@ class ReaderCurrentComicSerializer(ReaderComicSerializer):
         required=False,
     )
     issue_suffix = CharField(read_only=True, required=False)
-    issue_count = IntegerField(
-        read_only=True,
-        required=False,
-    )
-
+    issue_count = IntegerField(read_only=True, required=False)
     file_type = CharField(read_only=True, required=False)
     filename = CharField(read_only=True, required=False)
     name = CharField(read_only=True, required=False)
@@ -94,15 +93,37 @@ class ReaderBooksSerializer(Serializer):
     """All comics relevant to the reader."""
 
     current = ReaderCurrentComicSerializer(read_only=True)
-    prev_book = ReaderComicSerializer(read_only=True, required=False)
-    next_book = ReaderComicSerializer(read_only=True, required=False)
+    prev = ReaderComicSerializer(read_only=True, required=False)
+    next = ReaderComicSerializer(read_only=True, required=False)
+
+
+class ArcsIdsField(DictField):
+    """Arcs Ids level."""
+
+    @override
+    def to_representation(self, value):
+        """Serialize the ids to a string."""
+        string_keyed_map = {}
+        for ids, arc_info in value.items():
+            string_key = ",".join(str(pk) for pk in ids)
+            string_keyed_map[string_key] = arc_info
+
+        return super().to_representation(string_keyed_map)
+
+    child = ReaderArcInfoSerializer(read_only=True)
+
+
+class ArcsField(DictField):
+    """Arcs Field."""
+
+    child = ArcsIdsField(read_only=True)
 
 
 class ReaderComicsSerializer(Serializer):
     """Books and arcs."""
 
+    arcs = ArcsField(read_only=True)
+    arc = ReaderSelectedArcSerializer(read_only=True)
     books = ReaderBooksSerializer(read_only=True)
-    arcs = ReaderArcSerializer(many=True, read_only=True)
-    arc = ReaderArcSerializer(read_only=True)
     close_route = RouteSerializer(read_only=True)
     mtime = TimestampField(read_only=True)

codex/serializers/route.py

@@ -4,8 +4,9 @@ from dataclasses import asdict
 
 from rest_framework.fields import CharField, IntegerField
 from rest_framework.serializers import Serializer
+from typing_extensions import override
 
-from codex.serializers.fields.group import BrowseGroupField
+from codex.serializers.fields.group import BrowserRouteGroupField
 from codex.serializers.fields.sanitized import SanitizedCharField
 from codex.views.util import Route
 
@@ -13,13 +14,13 @@ from codex.views.util import Route
 class SimpleRouteSerializer(Serializer):
     """A an abbreviated vue route for the browser."""
 
-    group = BrowseGroupField()
+    group = BrowserRouteGroupField()
     pks = CharField()
 
+    @override
     def to_representation(self, instance):
         """Allow submission of sequences instead of strings for pks."""
-        if isinstance(instance, Route):
-            instance = asdict(instance)
+        instance = asdict(instance) if isinstance(instance, Route) else dict(instance)
         pks = instance["pks"]
         if not pks:
             instance["pks"] = "0"
@@ -27,6 +28,7 @@ class SimpleRouteSerializer(Serializer):
             instance["pks"] = ",".join(str(pk) for pk in sorted(pks))
         return super().to_representation(instance)
 
+    @override
     def to_internal_value(self, data):
         """Convert pk strings to tuples."""
         instance = super().to_internal_value(data)

codex/serializers/settings.py

@@ -1,14 +1,14 @@
 """Settings Serializer."""
 
-from rest_framework.fields import BooleanField
-from rest_framework.serializers import ListSerializer, Serializer
+from rest_framework.serializers import ListSerializer
 
-from codex.serializers.fields import BrowseGroupField, SessionKeyField
+from codex.serializers.fields import SessionKeyField
+from codex.serializers.mixins import JSONFieldSerializer
 
 
-class SettingsSerializer(Serializer):
+class SettingsInputSerializer(JSONFieldSerializer):
     """For requesting settings."""
 
+    JSON_PARAMS = frozenset({"only"})
+
     only = ListSerializer(child=SessionKeyField(), required=False)
-    group = BrowseGroupField(required=False)
-    breadcrumb_names = BooleanField(required=False, default=True)