codex 1.7.3a2__py3-none-any.whl → 1.7.5__py3-none-any.whl

codex/serializers/fields/__init__.py

@@ -0,0 +1,37 @@
+"""Custom Serializer Fields."""
+
+from codex.serializers.fields.auth import TimestampField, TimezoneField
+from codex.serializers.fields.group import BrowseGroupField
+from codex.serializers.fields.reader import FitToField, ReadingDirectionField
+from codex.serializers.fields.sanitized import SanitizedCharField
+from codex.serializers.fields.session import SessionKeyField
+from codex.serializers.fields.stats import (
+    CountDictField,
+    SerializerChoicesField,
+    StringListMultipleChoiceField,
+)
+from codex.serializers.fields.vuetify import (
+    VuetifyBooleanField,
+    VuetifyCharField,
+    VuetifyDecadeField,
+    VuetifyFloatField,
+    VuetifyIntegerField,
+)
+
+__all__ = (
+    "TimestampField",
+    "TimezoneField",
+    "BrowseGroupField",
+    "SanitizedCharField",
+    "StringListMultipleChoiceField",
+    "SerializerChoicesField",
+    "CountDictField",
+    "VuetifyFloatField",
+    "VuetifyIntegerField",
+    "VuetifyCharField",
+    "VuetifyBooleanField",
+    "VuetifyDecadeField",
+    "FitToField",
+    "ReadingDirectionField",
+    "SessionKeyField",
+)

codex/serializers/fields/auth.py

@@ -0,0 +1,45 @@
+"""Custom fields."""
+
+from datetime import datetime, timezone
+from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
+
+from rest_framework.exceptions import ValidationError
+from rest_framework.serializers import (
+    CharField,
+    IntegerField,
+)
+
+from codex.logger.logging import get_logger
+
+LOG = get_logger(__name__)
+
+
+class TimestampField(IntegerField):
+    """IntegerTimestampField."""
+
+    def to_representation(self, value) -> int:
+        """Convert to Jascript millisecond int timestamp from datetime, or castable."""
+        if isinstance(value, datetime):
+            value = value.timestamp()
+        return int(float(value) * 1000)
+
+    def to_internal_value(self, data) -> datetime:  # type: ignore[reportIncompatibleMethodOverride]
+        """Convert from castable, likely string to datetime."""
+        return datetime.fromtimestamp(float(data) / 1000, tz=timezone.utc)
+
+
+def validate_timezone(data):
+    """Validate Timezone."""
+    try:
+        ZoneInfo(data)
+    except ZoneInfoNotFoundError as exc:
+        raise ValidationError from exc
+    return data
+
+
+class TimezoneField(CharField):
+    """Timezone field."""
+
+    def __init__(self, *args, **kwargs):
+        """Call Charfield with defaults."""
+        super().__init__(*args, min_length=2, validators=[validate_timezone], **kwargs)

codex/serializers/fields/browser.py

@@ -0,0 +1,85 @@
+"""Custom fields."""
+
+from abc import ABC
+
+import pycountry
+from rest_framework.serializers import (
+    ChoiceField,
+    ListField,
+)
+
+from codex.choices.browser import (
+    BROWSER_BOOKMARK_FILTER_CHOICES,
+    BROWSER_TOP_GROUP_CHOICES,
+    DUMMY_NULL_NAME,
+)
+from codex.logger.logging import get_logger
+from codex.serializers.fields.sanitized import SanitizedCharField
+from codex.serializers.route import RouteSerializer
+
+LOG = get_logger(__name__)
+
+
+class TopGroupField(ChoiceField):
+    """Valid Top Groups Only."""
+
+    class_choices = tuple(BROWSER_TOP_GROUP_CHOICES.keys())
+
+    def __init__(self, *args, **kwargs):
+        """Initialize with choices."""
+        super().__init__(*args, choices=self.class_choices, **kwargs)
+
+
+class BookmarkFilterField(ChoiceField):
+    """Bookmark Choice Field."""
+
+    def __init__(self, *args, **kwargs):
+        """Use bookmark filter choices."""
+        super().__init__(
+            *args, choices=tuple(BROWSER_BOOKMARK_FILTER_CHOICES.keys()), **kwargs
+        )
+
+
+class PyCountryField(SanitizedCharField, ABC):
+    """Serialize to a long pycountry name."""
+
+    LOOKUP_MODULE = pycountry.countries
+    _ALPHA_2_LEN = 2
+
+    def to_representation(self, value):
+        """Lookup the name with pycountry, just copy the value on fail."""
+        if not value:
+            return ""
+        if value == DUMMY_NULL_NAME:
+            return value
+        try:
+            # fix for https://github.com/flyingcircusio/pycountry/issues/41
+            lookup_obj = (
+                self.LOOKUP_MODULE.get(alpha_2=value)
+                if len(value) == self._ALPHA_2_LEN
+                else self.LOOKUP_MODULE.lookup(value)
+            )
+            # If lookup fails, return the key as the name
+        except Exception:
+            LOG.warning(f"Could not serialize name with pycountry {value}")
+            return value
+        else:
+            return lookup_obj.name if lookup_obj else value
+
+
+class CountryField(PyCountryField):
+    """Serializer to long country name."""
+
+    LOOKUP_MODULE = pycountry.countries
+
+
+class LanguageField(PyCountryField):
+    """Serializer to long language name."""
+
+    LOOKUP_MODULE = pycountry.languages
+
+
+class BreadcrumbsField(ListField):
+    """And Array of Routes."""
+
+    child = RouteSerializer()

codex/serializers/fields/group.py

@@ -0,0 +1,13 @@
+"""Browser Group Field."""
+
+from rest_framework.fields import ChoiceField
+
+from codex.choices.browser import BROWSER_GROUP_CHOICES
+
+
+class BrowseGroupField(ChoiceField):
+    """BrowseGroup Field."""
+
+    def __init__(self, *args, **kwargs):
+        """Add choices."""
+        super().__init__(*args, choices=tuple(BROWSER_GROUP_CHOICES.keys()), **kwargs)

codex/serializers/fields/reader.py

@@ -0,0 +1,22 @@
+"""Reader Fields."""
+
+from rest_framework.serializers import ChoiceField
+
+from codex.models import Bookmark
+from codex.models.comic import ReadingDirection
+
+
+class FitToField(ChoiceField):
+    """Bookmark FitTo Fieild."""
+
+    def __init__(self, *args, **kwargs):
+        """Add Choices."""
+        super().__init__(*args, choices=Bookmark.FitTo.values, **kwargs)
+
+
+class ReadingDirectionField(ChoiceField):
+    """Reading Direction Field."""
+
+    def __init__(self, *args, **kwargs):
+        """Add Choices."""
+        super().__init__(*args, choices=ReadingDirection.values, **kwargs)

codex/serializers/fields/sanitized.py

@@ -0,0 +1,13 @@
+"""Sanitied Fields."""
+
+from nh3 import clean
+from rest_framework.fields import CharField
+
+
+class SanitizedCharField(CharField):
+    """Sanitize CharField using NH3."""
+
+    def to_internal_value(self, data):
+        """Sanitize CharField using NH3."""
+        sanitized_data = clean(data)
+        return super().to_internal_value(sanitized_data)

codex/serializers/fields/session.py

@@ -0,0 +1,16 @@
+"""Session Custom Fields."""
+
+from rest_framework.fields import ChoiceField
+
+from codex.choices.browser import BROWSER_DEFAULTS
+from codex.choices.reader import READER_DEFAULTS
+
+_SESSION_KEYS = (*READER_DEFAULTS.keys(), *BROWSER_DEFAULTS.keys(), "filters")
+
+
+class SessionKeyField(ChoiceField):
+    """Session Key Field."""
+
+    def __init__(self, *args, **kwargs):
+        """Add choices."""
+        super().__init__(*args, choices=_SESSION_KEYS, **kwargs)

codex/serializers/fields/stats.py

@@ -0,0 +1,36 @@
+"""Custom Vuetify fields."""
+
+from rest_framework.fields import DictField, IntegerField
+from rest_framework.serializers import MultipleChoiceField
+
+from codex.logger.logging import get_logger
+
+LOG = get_logger(__name__)
+
+
+class StringListMultipleChoiceField(MultipleChoiceField):
+    """A Multiple Choice Field expressed as as a comma delimited string."""
+
+    def to_internal_value(self, data):
+        """Convert comma delimited strings to sets."""
+        if isinstance(data, str):
+            data = frozenset(data.split(","))
+        return super().to_internal_value(data)  # type: ignore[reportIncompatibleMethodOverride]
+
+
+class SerializerChoicesField(StringListMultipleChoiceField):
+    """A String List Multiple Choice Field limited to a specified serializer's fields."""
+
+    def __init__(self, *args, serializer=None, **kwargs):
+        """Limit choices to fields from serializers."""
+        if not serializer:
+            reason = "serializer required for this field."
+            raise ValueError(reason)
+        choices = serializer().get_fields().keys()
+        super().__init__(*args, choices=choices, **kwargs)
+
+
+class CountDictField(DictField):
+    """Dict for counting things."""
+
+    child = IntegerField(read_only=True)

codex/serializers/fields/vuetify.py

@@ -0,0 +1,62 @@
+"""Custom Vuetify fields."""
+
+from django.utils.translation import gettext_lazy as _
+from rest_framework.exceptions import ValidationError
+from rest_framework.serializers import (
+    BooleanField,
+    CharField,
+    FloatField,
+    IntegerField,
+)
+
+from codex.choices.browser import VUETIFY_NULL_CODE
+from codex.logger.logging import get_logger
+
+LOG = get_logger(__name__)
+
+
+class VuetifyNullCodeFieldMixin:
+    """Convert Vuetify null codes to None."""
+
+    NULL_CODE = VUETIFY_NULL_CODE
+
+    def to_internal_value(self, data):
+        """Convert numeric null code to None."""
+        return None if data == self.NULL_CODE else data
+
+
+class VuetifyFloatField(VuetifyNullCodeFieldMixin, FloatField):  # type: ignore[reportIncompatibleMethodOverride]
+    """Float Field with null code conversion."""
+
+
+class VuetifyIntegerField(VuetifyNullCodeFieldMixin, IntegerField):  # type: ignore[reportIncompatibleMethodOverride]
+    """Integer Field with null code conversion."""
+
+
+class VuetifyCharField(VuetifyNullCodeFieldMixin, CharField):  # type: ignore[reportIncompatibleMethodOverride]
+    """Char Field with null code conversion."""
+
+    NULL_CODE = str(VUETIFY_NULL_CODE)
+
+
+class VuetifyBooleanField(VuetifyNullCodeFieldMixin, BooleanField):  # type: ignore[reportIncompatibleMethodOverride]
+    """Boolean Field with null code conversion."""
+
+
+def validate_decade(decade):
+    """Validate decades."""
+    # * We don't need a whole db call just to be perfectly accurate
+    # * -1s are decoded back into None before validation
+    if decade is not None and decade % 10 != 0:
+        raise ValidationError(_("Invalid decade: ") + f"{decade}")
+    return True
+
+
+class VuetifyDecadeField(VuetifyIntegerField):
+    """Integer field with null code conversion and decade validation."""
+
+    VALIDATORS = (validate_decade,)
+
+    def __init__(self, *args, **kwargs):
+        """Use decade validator."""
+        super().__init__(*args, validators=self.VALIDATORS, **kwargs)

codex/serializers/models/base.py

@@ -6,7 +6,7 @@ from rest_framework.serializers import ModelSerializer, SerializerMetaclass
 class BaseModelSerializer(ModelSerializer):
     """BaseModel Serializer for inheritance."""
 
-    class Meta(SerializerMetaclass):  # type: ignore
+    class Meta(SerializerMetaclass):  # type: ignore[reportIncompatibleVariableOverride]
         """Use explicit metaclass instead of python 3 method."""
 
         abstract = True

codex/serializers/models/comic.py

@@ -38,8 +38,8 @@ class ComicSerializer(BaseModelSerializer):
     pk = IntegerField(source="id")
 
     # Annotations
-    # issue_count = IntegerField(allow_null=True)
-    # volume_count = IntegerField(allow_null=True)
+    # issue_count = IntegerField(allow_null=True) could be 1
+    # volume_count = IntegerField(allow_null=True) could be 1
 
     # Group FKs
     publisher = PublisherSerializer(allow_null=True)

codex/serializers/models/groups.py

@@ -43,7 +43,6 @@ class SeriesSerializer(GroupModelSerializer):
         """Configure model."""
 
         model = Series
-        # fields = (*NamedModelMeta.fields, "volume_count")
 
 
 class VolumeSerializer(GroupModelSerializer):
@@ -53,4 +52,3 @@ class VolumeSerializer(GroupModelSerializer):
         """Configure model."""
 
         model = Volume
-        # fields = (*NamedModelMeta.fields, "issue_count")

codex/serializers/models/named.py

@@ -1,6 +1,6 @@
 """Named model Serializers."""
 
-from rest_framework.serializers import CharField
+from rest_framework.fields import CharField
 
 from codex.models import (
     AgeRating,

codex/serializers/models/pycountry.py

@@ -5,7 +5,7 @@ from codex.models import (
     Country,
     Language,
 )
-from codex.serializers.fields import CountryField, LanguageField
+from codex.serializers.fields.browser import CountryField, LanguageField
 from codex.serializers.models.named import NamedModelSerializer
 
 LOG = get_logger(__name__)

codex/serializers/opds/authentication.py

@@ -1,9 +1,11 @@
-"""OPDS Authentication 1.0 Serializer.
+"""
+OPDS Authentication 1.0 Serializer.
 
 https://drafts.opds.io/schema/authentication.schema.json
 """
 
-from rest_framework.serializers import CharField, IntegerField, Serializer
+from rest_framework.fields import CharField
+from rest_framework.serializers import IntegerField, Serializer
 
 
 class OPDSAuth1LinksSerializer(Serializer):

codex/serializers/opds/urls.py

@@ -1,6 +1,7 @@
 """OPDS URLs."""
 
-from rest_framework.serializers import CharField, Serializer
+from rest_framework.fields import CharField
+from rest_framework.serializers import Serializer
 
 
 class OPDSURLsSerializer(Serializer):

codex/serializers/opds/v1.py

@@ -2,16 +2,17 @@
 
 from zoneinfo import ZoneInfo
 
-from rest_framework.serializers import (
+from rest_framework.fields import (
     BooleanField,
     CharField,
     DateField,
     DateTimeField,
     DictField,
     IntegerField,
-    Serializer,
 )
+from rest_framework.serializers import Serializer
 
+from codex.serializers.fields.browser import TopGroupField
 from codex.serializers.models.pycountry import LanguageSerializer
 
 UTC_TZ = ZoneInfo("UTC")
@@ -25,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 = CharField(read_only=True, required=False)
+    facet_group = TopGroupField(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)

codex/serializers/opds/v2/feed.py

@@ -25,7 +25,8 @@ class OPDS2GroupSerializer(Serializer):
 
 
 class OPDS2FeedSerializer(OPDS2GroupSerializer):
-    """Feed.
+    """
+    Feed.
 
     https://drafts.opds.io/schema/feed.schema.json
     https://readium.org/webpub-manifest/schema/subcollection.schema.json

codex/serializers/opds/v2/links.py

@@ -13,16 +13,12 @@ from rest_framework.serializers import Serializer
 class OPSD2AuthenticateSerializer(Serializer):
     """Minimal Link Serializer for Authenticate."""
 
-    href = CharField(
-        read_only=True,
-    )
-    rel = SerializerMethodField(
-        read_only=True,
-    )
+    href = CharField(read_only=True)
+    rel = SerializerMethodField(read_only=True)
     type = CharField(read_only=True, required=False)
 
     def get_rel(self, obj) -> str | None:
-        """Allow for CharField or CharListField types."""
+        """Allow for SanitizedCharField or CharListField types."""
         rel = obj.get("rel")
         if not isinstance(rel, list | str):
             reason = "OPDS2LinkSerializer.rel is not a list or a string."
@@ -31,24 +27,26 @@ class OPSD2AuthenticateSerializer(Serializer):
 
 
 class OPDS2LinkPropertiesSerializer(Serializer):
-    """Link Properties.
+    """
+    Link Properties.
 
     https://drafts.opds.io/schema/properties.schema.json
     """
 
     number_of_items = IntegerField(read_only=True, required=False)
-    # price = OPDS2PriceSerializer(read_only=True, required=False)
-    # indirect_aquisition = OPDS2AcquisitionObjectSerializer(
-    #    read_only=True, many=True, required=False
-    # )
-    # holds = OPDS2HoldsSerializer(read_only=True, required=False)
-    # copies = OPDS2CopiesSerializer(read_only=True, required=False)
-    # availability = OPDS2AvailabilitySerializer(read_only=True, required=False)
+    # price = OPDS2PriceSerializer(read_only=True, required=False) unused
+    # indirect_aquisition = OPDS2AcquisitionObjectSerializer( unused
+    #    read_only=True, many=True, required=False unused
+    # ) unused
+    # holds = OPDS2HoldsSerializer(read_only=True, required=False) unused
+    # copies = OPDS2CopiesSerializer(read_only=True, required=False) unused
+    # availability = OPDS2AvailabilitySerializer(read_only=True, required=False) unused
     authenticate = OPSD2AuthenticateSerializer(required=False)
 
 
 class OPDS2LinkSerializer(OPSD2AuthenticateSerializer):
-    """Link.
+    """
+    Link.
 
     https://readium.org/webpub-manifest/schema/link.schema.json
     """
@@ -59,11 +57,15 @@ class OPDS2LinkSerializer(OPSD2AuthenticateSerializer):
     # Uncommon
     height = IntegerField(read_only=True, required=False)
     width = IntegerField(read_only=True, required=False)
-    # bitrate = IntegerField(read_only=True, required=False)
-    # duration = IntegerField(read_only=True, required=False)
-    # language = CharField(many=True, read_only=True, required=False)
-    alternate = ListField(child=CharField(), read_only=True, required=False)
-    children = ListField(child=CharField(), read_only=True, required=False)
+    # bitrate = IntegerField(read_only=True, required=False) unused
+    # duration = IntegerField(read_only=True, required=False) unused
+    # language = CharField(many=True, read_only=True, required=False) unused
+    alternate = ListField(
+        child=CharField(read_only=True), read_only=True, required=False
+    )
+    children = ListField(
+        child=CharField(read_only=True), read_only=True, required=False
+    )
     properties = OPDS2LinkPropertiesSerializer(read_only=True, required=False)
 
 

codex/serializers/opds/v2/metadata.py

@@ -1,22 +1,18 @@
 """OPDS 2.0 Metadata Serializer."""
 
-from rest_framework.fields import (
-    CharField,
-    DateTimeField,
-)
+from rest_framework.fields import CharField, DateTimeField
 from rest_framework.serializers import Serializer
 
 
 class OPDS2MetadataSerializer(Serializer):
-    """Metadata.
+    """
+    Metadata.
 
     https://drafts.opds.io/schema/feed-metadata.schema.json
     """
 
     identifier = CharField(read_only=True, required=False)
-    title = CharField(
-        read_only=True,
-    )
+    title = CharField(read_only=True)
     subtitle = CharField(read_only=True, required=False)
     modified = DateTimeField(read_only=True, required=False)
     description = CharField(read_only=True, required=False)

codex/serializers/opds/v2/progression.py

@@ -1,4 +1,5 @@
-"""OPDS v2 Progression Serializer.
+"""
+OPDS v2 Progression Serializer.
 
 https://github.com/opds-community/drafts/discussions/67
 """
@@ -25,7 +26,7 @@ class OPDS2ProgressionDeviceSerializer(Serializer):
 class OPDS2ProgressionLocationsSerializer(Serializer):
     """Progression Location Element."""
 
-    fragments = ListField(child=CharField(), read_only=True)
+    fragments = ListField(child=CharField(read_only=True), read_only=True)
     position = IntegerField(read_only=True)
     progression = DecimalField(
         max_digits=7,
@@ -53,7 +54,8 @@ class OPDS2ProgressionLocatorSerializer(Serializer):
 
 
 class OPDS2ProgressionSerializer(Serializer):
-    """Progression.
+    """
+    Progression.
 
     https://github.com/opds-community/drafts/discussions/67#discussioncomment-6414507
     """

codex/serializers/opds/v2/publication.py

@@ -1,11 +1,6 @@
 """OPDS 2 Publication Serializers."""
 
-from rest_framework.fields import (
-    CharField,
-    DateField,
-    IntegerField,
-    ListField,
-)
+from rest_framework.fields import CharField, DateField, IntegerField, ListField
 from rest_framework.serializers import Serializer
 
 from codex.serializers.opds.v2.facet import OPDS2FacetSerializer
@@ -22,22 +17,24 @@ class OPDS2FeedMetadataSerializer(OPDS2MetadataSerializer):
 
 
 class OPDS2ContributorObjectSerializer(Serializer):
-    """Contributor Object.
+    """
+    Contributor Object.
 
     https://readium.org/webpub-manifest/schema/contributor-object.schema.json
     """
 
     name = CharField(read_only=True)
-    # identifier= CharField(read_only=True, required=False)
-    # sort_as = CharField(read_only=True, required=False)
+    # identifier= CharField(read_only=True, required=False)  unused
+    # sort_as = CharField(read_only=True, required=False)  unused
     role = CharField(read_only=True, source="role_name")
-    # role = CharListField(read_only=True)
-    # position = IntegerField(read_only=True, required=False)
-    # links = LinkListField(read_only=True)
+    # role = CharListField(read_only=True)  unused
+    # position = IntegerField(read_only=True, required=False)  unused
+    # links = LinkListField(read_only=True)  unused
 
 
 class OPDS2PublicationMetadataSerializer(OPDS2MetadataSerializer):
-    """Metadata for publications.
+    """
+    Metadata for publications.
 
     https://readium.org/webpub-manifest/schema/metadata.schema.json
     """
@@ -49,17 +46,17 @@ class OPDS2PublicationMetadataSerializer(OPDS2MetadataSerializer):
     language = CharField(read_only=True, required=False)
     published = DateField(read_only=True, required=False)
     number_of_pages = IntegerField(read_only=True, required=False)
-    # reading_progression = ChoiceField()
+    # reading_progression = ChoiceField() unused
 
     #####################
     # Extended metadata #
     #####################
-    subject = ListField(child=CharField(), read_only=True, required=False)
+    subject = ListField(child=CharField(read_only=True), read_only=True, required=False)
     author = OPDS2ContributorObjectSerializer(many=True, required=False)
-    # translator = 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)
+    # 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)
@@ -68,7 +65,8 @@ class OPDS2PublicationMetadataSerializer(OPDS2MetadataSerializer):
 
 
 class OPDS2PublicationSerializer(OPDS2FacetSerializer):
-    """Publication.
+    """
+    Publication.
 
     https://drafts.opds.io/schema/publication.schema.json
     """