codex 1.6.0__py3-none-any.whl → 1.6.0a0__py3-none-any.whl

codex/serializers/browser/filters.py

@@ -1,16 +1,24 @@
 """Browser Settings Filter Serializers."""
 
-from rest_framework.serializers import BooleanField, ListField, Serializer
-
-from codex.serializers.fields import (
-    BookmarkFilterField,
-    VuetifyBooleanField,
-    VuetifyCharField,
-    VuetifyDecadeField,
-    VuetifyFloatField,
-    VuetifyIntegerField,
+from abc import ABC
+
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+from rest_framework.fields import Field
+from rest_framework.serializers import (
+    BooleanField,
+    CharField,
+    ChoiceField,
+    FloatField,
+    IntegerField,
+    ListField,
+    Serializer,
 )
 
+from codex.serializers.choices import CHOICES, VUETIFY_NULL_CODE
+
+VUETIFY_NULL_CODE_STR = str(VUETIFY_NULL_CODE)
+
 
 class BrowserFilterChoicesSerializer(Serializer):
     """All dynamic filters."""
@@ -39,30 +47,121 @@ class BrowserFilterChoicesSerializer(Serializer):
     year = BooleanField(read_only=True)
 
 
+def validate_decades(decades):
+    """Validate decades."""
+    if not decades:
+        return
+    # * We don't need a whole db call just to be perfectly accurate
+    # * -1s are decoded back into None before validation
+    exists = False
+    for decade in decades:
+        if decade is None or decade % 10 == 0:
+            exists = True
+            break
+    if not exists:
+        raise ValidationError(_(f"Invalid decade in: {decades}"))
+
+
+def validate_int_null(values):
+    """Use a special code for null.
+
+    Because if a vuetify component has a null key it changes it to the
+    array index.
+    """
+    for index, value in enumerate(values):
+        if value == VUETIFY_NULL_CODE:
+            values[index] = None
+    return values
+
+
+def validate_str_null(values):
+    """Use a special code for null.
+
+    Because if a vuetify component has a null key it changes it to the
+    array index. This is the version for CharFields.
+    """
+    for index, value in enumerate(values):
+        if value == VUETIFY_NULL_CODE_STR:
+            values[index] = None
+    return values
+
+
+class FilterListField(ListField, ABC):
+    """Filter List field with custom arguments."""
+
+    CHILD_CLASS = Field
+    VALIDATORS = ()
+
+    def __init__(self, *args, **kwargs):
+        """Apply the subclass's arguments."""
+        super().__init__(
+            *args,
+            child=self.CHILD_CLASS(allow_null=True, **kwargs),
+            required=False,
+            validators=self.VALIDATORS,
+        )
+
+
+class FloatListField(FilterListField):
+    """Decimal List Field with validation."""
+
+    CHILD_CLASS = FloatField  # type: ignore
+    VALIDATORS = (validate_int_null,)
+
+
+class IntListField(FilterListField):
+    """Integer List Field with validation."""
+
+    CHILD_CLASS = IntegerField  # type: ignore
+    VALIDATORS = (validate_int_null,)
+
+
+class DecadeListField(IntListField):
+    """Integer List Field with validation for decades."""
+
+    VALIDATORS = (validate_int_null, validate_decades)
+
+
+class CharListField(FilterListField):
+    """Char List Field with validation."""
+
+    CHILD_CLASS = CharField  # type: ignore
+    VALIDATORS = (validate_str_null,)
+
+
+class BooleanListField(FilterListField):
+    """Bool List Field with validation."""
+
+    CHILD_CLASS = BooleanField  # type: ignore
+    VALIDATORS = (validate_int_null,)
+
+
 class BrowserSettingsFilterSerializer(Serializer):
     """Filter values for settings."""
 
-    bookmark = BookmarkFilterField(required=False)
+    bookmark = ChoiceField(
+        choices=tuple(CHOICES["bookmarkFilter"].keys()), required=False
+    )
     # Dynamic filters
-    age_rating = ListField(child=VuetifyCharField(), required=False)
-    characters = ListField(child=VuetifyIntegerField(), required=False)
-    community_rating = ListField(child=VuetifyFloatField(), required=False)
-    country = ListField(child=VuetifyIntegerField(), required=False)
-    contributors = ListField(child=VuetifyIntegerField(), required=False)
-    critical_rating = ListField(child=VuetifyFloatField(), required=False)
-    decade = ListField(child=VuetifyDecadeField(), required=False)
-    file_type = ListField(child=VuetifyCharField(), required=False)
-    genres = ListField(child=VuetifyIntegerField(), required=False)
-    identifier_type = ListField(child=VuetifyCharField(), required=False)
-    language = ListField(child=VuetifyIntegerField(), required=False)
-    locations = ListField(child=VuetifyIntegerField(), required=False)
-    monochrome = ListField(child=VuetifyBooleanField(), required=False)
-    original_format = ListField(child=VuetifyCharField(), required=False)
-    reading_direction = ListField(child=VuetifyCharField(), required=False)
-    series_groups = ListField(child=VuetifyIntegerField(), required=False)
-    stories = ListField(child=VuetifyIntegerField(), required=False)
-    story_arcs = ListField(child=VuetifyIntegerField(), required=False)
-    tagger = ListField(child=VuetifyCharField(), required=False)
-    tags = ListField(child=VuetifyIntegerField(), required=False)
-    teams = ListField(child=VuetifyIntegerField(), required=False)
-    year = ListField(child=VuetifyIntegerField(), required=False)
+    age_rating = CharListField(allow_blank=True, required=False)
+    characters = IntListField(required=False)
+    community_rating = FloatListField(required=False)
+    country = CharListField(allow_blank=True, required=False)
+    contributors = IntListField(required=False)
+    critical_rating = FloatListField(required=False)
+    decade = DecadeListField(required=False)
+    file_type = CharListField(allow_blank=True, required=False)
+    genres = IntListField(required=False)
+    identifier_type = CharListField(allow_blank=True, required=False)
+    language = CharListField(allow_blank=True, required=False)
+    locations = IntListField()
+    monochrome = BooleanListField(required=False)
+    original_format = CharListField(required=False, allow_blank=True)
+    reading_direction = CharListField(required=False)
+    series_groups = IntListField(required=False)
+    stories = IntListField(required=False)
+    story_arcs = IntListField(required=False)
+    tagger = CharListField(required=False)
+    tags = IntListField(required=False)
+    teams = IntListField(required=False)
+    year = IntListField(required=False)

codex/serializers/browser/metadata.py

@@ -1,23 +1,9 @@
 """Codex Serializers for the metadata box."""
 
-from rest_framework.serializers import CharField, IntegerField, ListField, Serializer
+from rest_framework.serializers import CharField, IntegerField
 
 from codex.serializers.browser.mixins import BrowserAggregateSerializerMixin
 from codex.serializers.models.comic import ComicSerializer
-from codex.serializers.models.named import (
-    ContributorSerializer,
-    IdentifierSeralizer,
-    StoryArcNumberSerializer,
-)
-
-PREFETCH_PREFIX = "attached_"
-
-
-class GroupSerializer(Serializer):
-    """Serialize a group pk and name."""
-
-    ids = ListField(child=IntegerField(), read_only=True)
-    name = CharField(read_only=True)
 
 
 class MetadataSerializer(BrowserAggregateSerializerMixin, ComicSerializer):
@@ -27,33 +13,3 @@ class MetadataSerializer(BrowserAggregateSerializerMixin, ComicSerializer):
     parent_folder_id = IntegerField(read_only=True, required=False)
     series_volume_count = IntegerField(read_only=True)
     volume_issue_count = IntegerField(read_only=True)
-
-    publisher_list = GroupSerializer(many=True, required=False)
-    imprint_list = GroupSerializer(many=True, required=False)
-    series_list = GroupSerializer(many=True, required=False)
-    volume_list = GroupSerializer(many=True, required=False)
-    publisher = None
-    imprint = None
-    series = None
-    volume = None
-
-    identifiers = IdentifierSeralizer(
-        source=f"{PREFETCH_PREFIX}identifiers", many=True, allow_null=True
-    )
-    contributors = ContributorSerializer(
-        source=f"{PREFETCH_PREFIX}contributors", many=True, allow_null=True
-    )
-    stroy_arc_numbers = StoryArcNumberSerializer(
-        source=f"{PREFETCH_PREFIX}story_arc_numbers", many=True, allow_null=True
-    )
-
-    class Meta(ComicSerializer.Meta):
-        """Configure the model."""
-
-        exclude = (
-            *ComicSerializer.Meta.exclude,
-            "publisher",
-            "imprint",
-            "series",
-            "volume",
-        )

codex/serializers/browser/mixins.py

@@ -1,33 +1,27 @@
 """Serializer mixins."""
 
-from datetime import datetime, timezone
-
 from rest_framework.serializers import (
     BooleanField,
     CharField,
     DateTimeField,
     DecimalField,
     IntegerField,
-    ListField,
     Serializer,
-    SerializerMethodField,
 )
 
-from codex.logger.logging import get_logger
-from codex.views.const import COMIC_GROUP, EPOCH_START
-
-LOG = get_logger(__name__)
+from codex.serializers.browser.filters import IntListField
 
 
 class BrowserAggregateSerializerMixin(Serializer):
     """Mixin for browser, opds & metadata serializers."""
 
     group = CharField(read_only=True, max_length=1)
-    ids = ListField(child=IntegerField(), read_only=True)
+    ids = IntListField(read_only=True)
 
     # Aggregate Annotations
     child_count = IntegerField(read_only=True)
-    mtime = SerializerMethodField(read_only=True)
+    cover_pk = IntegerField(read_only=True)
+    cover_mtime = DateTimeField(format="%s", read_only=True)
 
     # Bookmark annotations
     page = IntegerField(read_only=True)
@@ -36,30 +30,3 @@ class BrowserAggregateSerializerMixin(Serializer):
     progress = DecimalField(
         max_digits=5, decimal_places=2, read_only=True, coerce_to_string=False
     )
-
-    def get_mtime(self, obj) -> int:
-        """Compute mtime from json array aggregates."""
-        mtime = EPOCH_START
-        for dt_str in obj.updated_ats:
-            if not dt_str:
-                continue
-            try:
-                dt = datetime.strptime(dt_str, "%Y-%m-%d %H:%M:%S.%f").replace(
-                    tzinfo=timezone.utc
-                )
-            except ValueError:
-                LOG.warning(
-                    f"computing group mtime: {dt_str} is not a valid datetime string."
-                )
-                continue
-
-            if dt > mtime:
-                mtime = dt
-
-        if obj.group != COMIC_GROUP and (
-            mbua := getattr(obj, "max_bookmark_updated_at", None)
-        ):
-            mtime = max(mtime, mbua)
-
-        # print(obj.group, obj.pk, obj.name, obj.updated_ats, obj.max_bookmark_updated_at, "max:", mtime)
-        return int(mtime.timestamp() * 1000)

codex/serializers/browser/page.py

@@ -3,15 +3,17 @@
 from rest_framework.serializers import (
     BooleanField,
     CharField,
+    DateTimeField,
     DecimalField,
     IntegerField,
+    ListSerializer,
     Serializer,
 )
 
 from codex.serializers.browser.mixins import (
     BrowserAggregateSerializerMixin,
 )
-from codex.serializers.fields import BreadcrumbsField, TimestampField
+from codex.serializers.route import RouteSerializer
 
 
 class BrowserCardSerializer(BrowserAggregateSerializerMixin):
@@ -32,6 +34,7 @@ class BrowserCardSerializer(BrowserAggregateSerializerMixin):
     order_value = CharField(read_only=True)
     page_count = IntegerField(read_only=True)
     reading_direction = CharField(read_only=True)
+    mtime = DateTimeField(format="%s", read_only=True)
 
 
 class BrowserAdminFlagsSerializer(Serializer):
@@ -52,12 +55,12 @@ class BrowserPageSerializer(Serializer):
     """The main browse list."""
 
     admin_flags = BrowserAdminFlagsSerializer(read_only=True)
-    breadcrumbs = BreadcrumbsField(read_only=True)
+    breadcrumbs = ListSerializer(child=RouteSerializer())
     title = BrowserTitleSerializer(read_only=True)
+    covers_timestamp = IntegerField(read_only=True)
     zero_pad = IntegerField(read_only=True)
     libraries_exist = BooleanField(read_only=True)
     model_group = CharField(read_only=True)
     num_pages = IntegerField(read_only=True)
     groups = BrowserCardSerializer(allow_empty=True, read_only=True, many=True)
     books = BrowserCardSerializer(allow_empty=True, read_only=True, many=True)
-    mtime = TimestampField(read_only=True)

codex/serializers/browser/settings.py

@@ -10,8 +10,6 @@ from rest_framework.serializers import (
 
 from codex.serializers.browser.filters import BrowserSettingsFilterSerializer
 from codex.serializers.choices import CHOICES, VUETIFY_NULL_CODE
-from codex.serializers.fields import BreadcrumbsField, TimestampField, TopGroupField
-from codex.serializers.route import SimpleRouteSerializer
 
 VUETIFY_NULL_CODE_STR = str(VUETIFY_NULL_CODE)
 
@@ -25,50 +23,21 @@ class BrowserSettingsShowGroupFlagsSerializer(Serializer):
     v = BooleanField()
 
 
-class BrowserFilterChoicesInputSerilalizer(Serializer):
-    """Browser Settings for the filter choices response."""
-
-    filters = BrowserSettingsFilterSerializer(required=False)
-    q = CharField(allow_blank=True, required=False)
-
+class BrowserSettingsSerializer(Serializer):
+    """Browser Settings that the user can change.
 
-class BrowserCoverInputSerializerBase(BrowserFilterChoicesInputSerilalizer):
-    """Base Serializer for Cover and Settings."""
+    This is the only browse serializer that's submitted.
+    It is also sent to the browser as part of BrowserOpenedSerializer.
+    """
 
-    custom_covers = BooleanField(required=False)
-    dynamic_covers = BooleanField(required=False)
+    filters = BrowserSettingsFilterSerializer(required=False)
     order_by = ChoiceField(choices=tuple(CHOICES["orderBy"].keys()), required=False)
     order_reverse = BooleanField(required=False)
+    q = CharField(allow_blank=True, required=False)
+    query = CharField(allow_blank=True, required=False)  # OPDS 2.0
     show = BrowserSettingsShowGroupFlagsSerializer(required=False)
-
-
-class BrowserCoverInputSerializer(BrowserCoverInputSerializerBase):
-    """Browser Settings for the cover response."""
-
-    parent = SimpleRouteSerializer(required=False)
-
-
-class BrowserSettingsSerializerBase(BrowserCoverInputSerializerBase):
-    """Base Serializer for Browser & OPDS Settings."""
-
     # search_results_limit = IntegerField(required=False)
-    top_group = TopGroupField(required=False)
-
-
-class OPDSSettingsSerializer(BrowserSettingsSerializerBase):
-    """Browser Settings for the OPDS."""
-
-    limit = IntegerField(required=False)
-    opds_metadata = BooleanField(required=False)
-    query = CharField(allow_blank=True, required=False)  # OPDS 2.0
-
-
-class BrowserSettingsSerializer(BrowserSettingsSerializerBase):
-    """Browser Settings that the user can change.
-
-    This is the only browse serializer that's submitted.
-    """
-
-    breadcrumbs = BreadcrumbsField(required=False)
-    mtime = TimestampField(read_only=True)
     twenty_four_hour_time = BooleanField(required=False)
+    top_group = ChoiceField(choices=tuple(CHOICES["topGroup"].keys()), required=False)
+    opds_metadata = BooleanField(required=False)
+    limit = IntegerField(required=False)

codex/serializers/choices.py

@@ -49,26 +49,13 @@ _CHOICES_FN_RE = {
     _CHOICES_MODULE_NAME: create_choices_fn_regexes(_CHOICES_MODULE_NAME),
     _ADMIN_CHOICES_MODULE_NAME: create_choices_fn_regexes(_ADMIN_CHOICES_MODULE_NAME),
 }
-_SINGLE_VALUE_KEYS = frozenset(
-    {
-        "customCovers",
-        "dynamicCovers",
-        "finishOnLastPage",
-        "orderReverse",
-        "q",
-        "readRtlInReverse",
-        "searchResultsLimit",
-        "twentyFourHourTime",
-        "twoPages",
-    }
-)
+_SINGLE_VALUE_KEYS = frozenset({"orderReverse", "q", "searchResultsLimit"})
 
 # Exports
 CHOICES = {}
 DEFAULTS = {}
 WEBSOCKET_MESSAGES = {}
 VUETIFY_NULL_CODE = -1
-DUMMY_NULL_NAME = "_none_"
 
 
 def _find_filename_regex(js_root, module_name):

codex/serializers/models/pycountry.py

@@ -1,33 +1,73 @@
 """Pycountry Model Serializers."""
 
-from codex.logger.logging import get_logger
+import pycountry
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema_field
+from rest_framework.serializers import (
+    SerializerMethodField,
+)
+
 from codex.models import (
     Country,
     Language,
 )
-from codex.serializers.fields import CountryField, LanguageField
 from codex.serializers.models.named import NamedModelSerializer
 
-LOG = get_logger(__name__)
 
+class PyCountrySerializer(NamedModelSerializer):
+    """PyCountry tag serializer to include long names.
 
-class CountrySerializer(NamedModelSerializer):
-    """Pycountry serializer for country field."""
+    Takes a single string value and serializes the value to
+    a pk attribute and a pycountry long name lookup of that value to
+    the name.
+    """
+
+    LOOKUP_MODULE = pycountry.countries
+    _ALPHA_2_LEN = 2
 
-    name = CountryField(read_only=True)
+    name = SerializerMethodField()
 
     class Meta(NamedModelSerializer.Meta):
-        """Configure model."""
+        """Abstract class."""
 
-        model = Country
+        abstract = True
+
+    @classmethod
+    def lookup_name(cls, lookup_module, obj):
+        """Lookup the name with pycountry, just copy the key on fail."""
+        name = obj.name
+        if not name:
+            return ""
+        # fix for https://github.com/flyingcircusio/pycountry/issues/41
+        lookup_obj = (
+            lookup_module.get(alpha_2=name)
+            if len(name) == cls._ALPHA_2_LEN
+            else lookup_module.lookup(name)
+        )
+        # If lookup fails, return the key as the name
+        return lookup_obj.name if lookup_obj else name
+
+    @extend_schema_field(OpenApiTypes.STR)
+    def get_name(self, obj):
+        """Lookup the name with pycountry, just copy the key on fail."""
+        return self.lookup_name(self.LOOKUP_MODULE, obj)
 
 
-class LanguageSerializer(NamedModelSerializer):
+class LanguageSerializer(PyCountrySerializer):
     """Pycountry serializer for language field."""
 
-    name = LanguageField(read_only=True)
+    LOOKUP_MODULE = pycountry.languages
 
-    class Meta(NamedModelSerializer.Meta):
+    class Meta(PyCountrySerializer.Meta):
         """Configure model."""
 
         model = Language
+
+
+class CountrySerializer(PyCountrySerializer):
+    """Pycountry serializer for country field."""
+
+    class Meta(PyCountrySerializer.Meta):
+        """Configure model."""
+
+        model = Country

codex/serializers/opds/v2.py

@@ -12,6 +12,12 @@ from rest_framework.fields import (
 from rest_framework.serializers import Serializer
 
 
+class CharListField(ListField):
+    """List of CharFields."""
+
+    child = CharField()
+
+
 class OPDS2LinkPropertiesSerializer(Serializer):
     """Link Properties.
 
@@ -49,9 +55,9 @@ class OPDS2LinkSerializer(Serializer):
     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)
+    # language = CharListField(read_only=True, required=False)
+    alternate = CharListField(read_only=True, required=False)
+    children = CharListField(read_only=True, required=False)
     properties = OPDS2LinkPropertiesSerializer(read_only=True, required=False)
 
     def get_rel(self, obj) -> str | None:
@@ -63,7 +69,7 @@ class OPDS2LinkSerializer(Serializer):
         return obj.get("rel")
 
 
-class OPDS2LinkListField(ListField):
+class LinkListField(ListField):
     """Link List."""
 
     child = OPDS2LinkSerializer()
@@ -125,7 +131,7 @@ class OPDS2PublicationMetadataSerializer(OPDS2MetadataSerializer):
     #####################
     # Extended metadata #
     #####################
-    subject = ListField(child=CharField(), read_only=True, required=False)
+    subject = CharListField(read_only=True, required=False)
     author = OPDS2ContributorObjectSerializer(many=True, required=False)
     # translator = OPDS2ContributorObjectSerializer(many=True, required=False)
     editor = OPDS2ContributorObjectSerializer(many=True, required=False)
@@ -142,7 +148,7 @@ class OPDS2FacetSerializer(Serializer):
     """Facets."""
 
     metadata = OPDS2MetadataSerializer(read_only=True)
-    links = OPDS2LinkListField(read_only=True)
+    links = LinkListField(read_only=True)
 
 
 class OPDS2PublicationSerializer(OPDS2FacetSerializer):
@@ -152,19 +158,19 @@ class OPDS2PublicationSerializer(OPDS2FacetSerializer):
     """
 
     metadata = OPDS2PublicationMetadataSerializer(read_only=True)
-    links = OPDS2LinkListField(read_only=True)
-    images = OPDS2LinkListField(read_only=True, required=False)
+    links = LinkListField(read_only=True)
+    images = LinkListField(read_only=True, required=False)
 
 
 class OPDS2GroupSerializer(Serializer):
     """Group."""
 
     metadata = OPDS2MetadataSerializer(read_only=True)
-    links = OPDS2LinkListField(read_only=True, required=False)
+    links = LinkListField(read_only=True, required=False)
     publications = ListField(
         child=OPDS2PublicationSerializer(), read_only=True, required=False
     )
-    navigation = OPDS2LinkListField(read_only=True, required=False)
+    navigation = LinkListField(read_only=True, required=False)
 
 
 class OPDS2FeedSerializer(OPDS2GroupSerializer):

codex/serializers/opds/v2_unused.py

@@ -3,7 +3,7 @@
 from rest_framework.fields import CharField, DateTimeField, DecimalField, IntegerField
 from rest_framework.serializers import ChoiceField, Serializer
 
-from codex.serializers.opds.v2 import OPDS2LinkListField
+from codex.serializers.opds.v2 import LinkListField
 
 
 class RecursiveField(Serializer):
@@ -15,9 +15,7 @@ class RecursiveField(Serializer):
 
     def to_representation(self, instance):
         """Represent with own class."""
-        parent = self.parent
-        # Should not be ignored but is currently unused
-        serializer = parent.parent.__class__(instance, context=self.context)  # type: ignore
+        serializer = self.parent.parent.__class__(instance, context=self.context)
         return serializer.data
 
 
@@ -70,7 +68,7 @@ class OPDS2ProfileSerializer(Serializer):
 
     name = CharField(read_only=True)
     email = CharField(read_only=True)
-    links = OPDS2LinkListField(read_only=True, required=False)
+    links = LinkListField(read_only=True, required=False)
     loans = OPDS2CopiesSerializer(read_only=True)
     holds = OPDS2HoldsSerializer(read_only=True)