codex 1.7.2__py3-none-any.whl → 1.7.3__py3-none-any.whl

codex/logger/loggerd.py

@@ -1,34 +1,59 @@
 """Central Logging Thread."""
 
 import logging
+import shutil
 from logging.handlers import QueueListener, RotatingFileHandler
+from lzma import LZMAFile
+from pathlib import Path
 
 from codex.logger.formatter import ColorFormatter
 from codex.settings.settings import DEBUG, LOG_DIR, LOG_TO_CONSOLE, LOG_TO_FILE
 
+_LOG_FMT = "{asctime} {levelname:7} {message}"
+_DEBUG_LOG_FMT = "{asctime} {levelname:7} {name:25} {message}"
+_DATEFMT = "%Y-%m-%d %H:%M:%S %Z"
+_FORMATTER_STYLE = "{"
+_LOG_PATH = LOG_DIR / "codex.log"
+_LOG_MAX_BYTES = 10 * 2**20  # 10 MiB
+_LOG_BACKUP_COUNT = 30
+
+
+class RotatingXZFileHandler(RotatingFileHandler):
+    """Rotating File Handler rotates into XZ."""
+
+    @staticmethod
+    def namer(name):
+        """Name files with xz."""
+        return name + ".xz"
+
+    @staticmethod
+    def rotator(source, dest):
+        """Compress File."""
+        source_path = Path(source)
+        with (
+            source_path.open("rb") as f_in,
+            LZMAFile(dest, mode="wb", preset=9) as f_out,
+        ):
+            shutil.copyfileobj(f_in, f_out)
+        source_path.unlink()
+
 
 class CodexLogQueueListener(QueueListener):
     """Host for logging queue listener."""
 
-    _LOG_FMT = "{asctime} {levelname:7} {message}"
-    _DEBUG_LOG_FMT = "{asctime} {levelname:7} {name:25} {message}"
-    _DATEFMT = "%Y-%m-%d %H:%M:%S %Z"
-    _FORMATTER_STYLE = "{"
-    _LOG_PATH = LOG_DIR / "codex.log"
-    _LOG_MAX_BYTES = 10 * 1024 * 1024
-
     @classmethod
     def _get_file_log_handler(cls, fmt):
         """Get the log handlers for initialization."""
         handler = None
         try:
-            cls._LOG_PATH.parent.mkdir(exist_ok=True, parents=True)
-            handler = RotatingFileHandler(
-                cls._LOG_PATH, maxBytes=cls._LOG_MAX_BYTES, backupCount=30, delay=True
-            )
-            formatter = logging.Formatter(
-                fmt, style=cls._FORMATTER_STYLE, datefmt=cls._DATEFMT
+            _LOG_PATH.parent.mkdir(exist_ok=True, parents=True)
+            handler = RotatingXZFileHandler(
+                _LOG_PATH,
+                maxBytes=_LOG_MAX_BYTES,
+                backupCount=_LOG_BACKUP_COUNT,
+                delay=True,
             )
+            formatter = logging.Formatter(fmt, style=_FORMATTER_STYLE, datefmt=_DATEFMT)
             handler.setFormatter(formatter)
         except Exception as exc:
             print("ERROR creating file logging handler", exc)
@@ -40,9 +65,7 @@ class CodexLogQueueListener(QueueListener):
         handler = None
         try:
             handler = logging.StreamHandler()
-            formatter = ColorFormatter(
-                fmt, style=cls._FORMATTER_STYLE, datefmt=cls._DATEFMT
-            )
+            formatter = ColorFormatter(fmt, style=_FORMATTER_STYLE, datefmt=_DATEFMT)
             handler.setFormatter(formatter)
         except Exception as exc:
             print("ERROR creating console logging handler", exc)
@@ -52,7 +75,7 @@ class CodexLogQueueListener(QueueListener):
     def _get_log_handlers(cls):
         """Get handlers."""
         handlers = []
-        fmt = cls._DEBUG_LOG_FMT if DEBUG else cls._LOG_FMT
+        fmt = _DEBUG_LOG_FMT if DEBUG else _LOG_FMT
 
         if LOG_TO_FILE:
             handlers.append(cls._get_file_log_handler(fmt))

codex/logger/logging.py

@@ -20,7 +20,7 @@ class CodexQueueHandler(QueueHandler):
         super().enqueue(record)
 
 
-LOG_HANDLER = CodexQueueHandler(LOG_QUEUE)  # type: ignore
+LOG_HANDLER = CodexQueueHandler(LOG_QUEUE)
 
 
 def _ensure_handler(logger, queue):

codex/memory.py

@@ -26,7 +26,7 @@ def get_cgroups1_mem_limit():
     with Path(MEMORY_STAT_PATH).open("r") as mem_stat_file:
         for line in mem_stat_file:
             parts = line.split()
-            if not parts or len(parts) < 2:  # noqa PLR2004
+            if not parts or len(parts) < 2:  # noqa: PLR2004
                 continue
             if "hierarchical_memory_limit" in parts[0]:
                 return int(parts[1])
@@ -34,7 +34,8 @@ def get_cgroups1_mem_limit():
 
 
 def get_mem_limit(divisor="b"):
-    """Get the current memlimit.
+    """
+    Get the current memlimit.
 
     If we're in a container set the limit too.
     """

codex/migrations/0001_init.py

@@ -632,8 +632,7 @@ class Migration(migrations.Migration):
                         default=None,
                         max_length=6,
                         null=True,
-                        # Removed in the future
-                        # validators=[codex.models.validate_fit_to_choice],
+                        # Old code dependent validators removed in the future
                     ),
                 ),
                 ("two_pages", models.BooleanField(default=None, null=True)),

codex/migrations/0014_pdf_issue_suffix_remove_cover_image_sort_name.py

@@ -151,8 +151,7 @@ class Migration(migrations.Migration):
             field=models.CharField(
                 default="comic",
                 max_length=5,
-                # Removed in the future
-                # validators=[codex.models.validate_file_format_choice],
+                # codex dependent validators removed in the future
             ),
         ),
         migrations.AddField(

codex/migrations/0018_rename_userbookmark_bookmark.py

@@ -28,8 +28,7 @@ class Migration(migrations.Migration):
                 blank=True,
                 default="",
                 max_length=6,
-                # removed in the future
-                # validators=[codex.models.validate_fit_to_choice],
+                # Code dependent validators removed in the future
             ),
         ),
         migrations.AlterField(

codex/migrations/0028_telemeter.py

@@ -1,16 +1,12 @@
 """Generated by Django 5.0.6 on 2024-07-02 21:01."""
 
-from typing import ClassVar
-
 from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
     """Migrate db."""
 
-    dependencies: ClassVar[list] = [  # type: ignore
-        ("codex", "0027_import_order_and_covers"),
-    ]
+    dependencies = [("codex", "0027_import_order_and_covers")]
 
     operations = [
         migrations.AlterField(

codex/migrations/0031_adminflag_banner.py

@@ -0,0 +1,50 @@
+"""Generated by Django 5.1.2 on 2024-10-22 03:09."""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migrate db."""
+
+    dependencies = [
+        ("codex", "0030_nocase_collation_day_month_indexes_status_types"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="adminflag",
+            name="value",
+            field=models.CharField(blank=True, default="", max_length=128),
+        ),
+        migrations.AlterField(
+            model_name="adminflag",
+            name="key",
+            field=models.CharField(
+                choices=[
+                    ("FV", "Folder View"),
+                    ("RG", "Registration"),
+                    ("NU", "Non Users"),
+                    ("AU", "Auto Update"),
+                    ("IM", "Import Metadata"),
+                    ("ST", "Send Telemetry"),
+                    ("BT", "Banner Text"),
+                ],
+                db_index=True,
+                max_length=2,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="timestamp",
+            name="key",
+            field=models.CharField(
+                choices=[
+                    ("AP", "API Key"),
+                    ("VR", "Codex Version"),
+                    ("JA", "Janitor"),
+                    ("TS", "Telemeter Sent"),
+                ],
+                db_index=True,
+                max_length=2,
+            ),
+        ),
+    ]

codex/models/admin.py

@@ -39,6 +39,7 @@ class AdminFlag(BaseModel):
         AUTO_UPDATE = "AU"
         IMPORT_METADATA = "IM"
         SEND_TELEMETRY = "ST"
+        BANNER_TEXT = "BT"
 
     FALSE_DEFAULTS = frozenset({FlagChoices.AUTO_UPDATE})
 
@@ -48,6 +49,7 @@ class AdminFlag(BaseModel):
         choices=FlagChoices.choices,
     )
     on = BooleanField(default=True)
+    value = CharField(max_length=MAX_NAME_LEN, default="", blank=True)
 
     class Meta(BaseModel.Meta):
         """Constraints."""
@@ -88,10 +90,9 @@ class Timestamp(BaseModel):
     class TimestampChoices(TextChoices):
         """Choices for Timestamps."""
 
-        JANITOR = "JA", _("Janitor")
-        CODEX_VERSION = "VR", _("Codex Version")
-        SEARCH_INDEX_UUID = "SI", _("Search Index UUID")
         API_KEY = "AP", _("API Key")
+        CODEX_VERSION = "VR", _("Codex Version")
+        JANITOR = "JA", _("Janitor")
         TELEMETER_SENT = "TS", _("Telemeter Sent")
 
     key = CharField(

codex/models/base.py

@@ -27,9 +27,11 @@ class BaseModel(Model):
     updated_at = DateTimeField(auto_now=True)
     objects = GroupByManager()
 
-    class Meta(ModelBase):  # type: ignore
+    class Meta(ModelBase):  # type: ignore[reportIncompatibleVariableOverride]
         """Without this a real table is created and joined to."""
 
+        # Model.Meta is not inheritable.
+
         abstract = True
         get_latest_by = "updated_at"
 

codex/models/bookmark.py

@@ -23,18 +23,15 @@ def cascade_if_user_null(
     sub_objs,
     using,  # noqa: ARG001
 ):
-    """Cascade only if the user field is null.
+    """
+    Cascade only if the user field is null.
 
     Do this to keep deleting ephemeral session data from Bookmark table.
     Adapted from:
     https://github.com/django/django/blob/master/django/db/models/deletion.py#L23
     """
-    null_user_sub_objs = []
-    for sub_obj in sub_objs:
-        # only cascade the ones with null user fields.
-        if sub_obj.user is None:
-            null_user_sub_objs.append(sub_obj)
-
+    # only cascade the ones with null user fields.
+    null_user_sub_objs = [sub_obj for sub_obj in sub_objs if sub_obj.user is None]
     if null_user_sub_objs:
         collector.collect(
             null_user_sub_objs,

codex/models/comic.py

@@ -263,7 +263,7 @@ class Comic(WatchedPathBrowserGroup):
 
     @classmethod
     def get_title(
-        cls, obj, volume=True, zero_pad=None, name=True, filename_fallback=False
+        cls, obj, volume: bool, name: bool, filename_fallback: bool, zero_pad=None
     ):
         """Create the comic title for display."""
         names = []
@@ -293,7 +293,7 @@ class Comic(WatchedPathBrowserGroup):
 
     def __str__(self):
         """Most common text representation for logging."""
-        return self.get_title(self, filename_fallback=True)
+        return self.get_title(self, volume=True, name=True, filename_fallback=True)
 
     def issue(self) -> str:
         """Combine issue parts for search."""

codex/models/functions.py

@@ -14,7 +14,10 @@ class JsonGroupArray(Aggregate):
     allow_distinct = True
     function = "JSON_GROUP_ARRAY"
     name = "JsonGroupArray"
-    output_field = JSONField()  # type: ignore
+
+    def __init__(self, *args, **kwargs):
+        """output_field is set in the constructor."""
+        super().__init__(*args, output_field=JSONField(), **kwargs)
 
 
 class GroupConcat(Aggregate):
@@ -25,7 +28,10 @@ class GroupConcat(Aggregate):
     allow_distinct = True
     function = "GROUP_CONCAT"
     name = "GroupConcat"
-    output_field = CharField()  # type: ignore
+
+    def __init__(self, *args, **kwargs):
+        """output_field is set in the constructor."""
+        super().__init__(*args, output_field=CharField(), **kwargs)
 
 
 @OneToOneField.register_lookup
@@ -36,8 +42,6 @@ class FTS5Match(Lookup):
 
     def as_sql(self, compiler, connection):
         """Generate MATCH sql."""
-        # lhs, lhs_params = self.process_lhs(compiler, connection)
-        # fts_table = lhs.split(".")[0]
         rhs, rhs_params = self.process_rhs(compiler, connection)
         # MATCH works on the table itself not the one_to_one rel.
         # Force the table name without substitutions by the optimizer
@@ -67,4 +71,7 @@ class ComicFTSRank(Func):
 
     function = "rank"
     template = '("codex_comicfts"."rank" * -1)'
-    output_field = FloatField()  # type: ignore
+
+    def __init__(self, *args, **kwargs):
+        """output_field is set in the constructor."""
+        super().__init__(*args, output_field=FloatField(), **kwargs)

codex/models/groups.py

@@ -136,7 +136,7 @@ class WatchedPathBrowserGroup(BrowserGroupModel, WatchedPath):
         super().presave()
         WatchedPath.presave(self)
 
-    class Meta(WatchedPath.Meta):  # type: ignore
+    class Meta(BrowserGroupModel.Meta, WatchedPath.Meta):
         """Use Mixin Meta."""
 
         abstract = True

codex/models/library.py

@@ -23,7 +23,7 @@ __all__ = ("Library", "validate_dir_exists")
 def validate_dir_exists(path):
     """Validate that a library exists."""
     if not Path(path).is_dir():
-        raise ValidationError(_(f"{path} is not a directory"), params={"path": path})
+        raise ValidationError(_("{path} is not a directory"), params={"path": path})
 
 
 class Library(BaseModel):

codex/models/paths.py

@@ -36,11 +36,11 @@ class WatchedPath(BaseModel):
         st[0] = st_record.st_mode
         st[1] = st_record.st_ino
         # st[2] = st_record.st_dev is ignored by diff
-        # st[3] = st_record.st_nlink
-        # st[4] = st_record.st_uid
-        # st[5] = st_record.st_gid
+        # st[3] = st_record.st_nlink ignored
+        # st[4] = st_record.st_uid ignored
+        # st[5] = st_record.st_gid ignored
         st[6] = st_record.st_size
-        # st[7] = st_record.st_atime
+        # st[7] = st_record.st_atime ignored
         st[8] = st_record.st_mtime
         self.stat = st
 

codex/models/query.py

@@ -45,7 +45,7 @@ class GroupByQuery(Query):
         self.force_group_by_table = ""
         self.force_group_by_fields = ()
 
-    def get_compiler(self, using=None, connection=None, elide_empty=True):
+    def get_compiler(self, using=None, connection=None, elide_empty=True):  # noqa: FBT002
         """Use the custom compiler instead of SQLCompiler."""
         if self.compiler == "SQLCompiler":
             if using is None and connection is None:
@@ -59,7 +59,11 @@ class GroupByQuery(Query):
             )
         else:
             # Normal super() operation.
-            compiler = super().get_compiler(using, connection, elide_empty)  # type: ignore
+            compiler = super().get_compiler(
+                using=using,
+                connection=connection,
+                elide_empty=elide_empty,  # type: ignore[reportCallIssue]
+            )
 
         return compiler
 
@@ -82,13 +86,13 @@ class GroupByQuerySet(QuerySet):
 
     def group_by(self, *fields, model=None):
         """Force group_by operator."""
-        obj = self._chain()  # type: ignore
+        obj = self._chain()  # type: ignore[reportAttributeAccessIssue]
         obj.query.set_force_group_by(fields, model=model)
         return obj
 
     def demote_joins(self, tables):
         """Force INNER JOINS."""
-        obj = self._chain()  # type: ignore
+        obj = self._chain()  # type: ignore[reportAttributeAccessIssue]
         obj.query.demote_joins(tables)
         return obj
 

codex/models/util.py

@@ -1,7 +1,7 @@
 """Utilities for models."""
 
 _ARTICLES = frozenset(
-    ("a", "an", "the")  # en    # noqa RUF005
+    ("a", "an", "the")  # en    # noqa: RUF005
     + ("un", "unos", "unas", "el", "los", "la", "las")  # es
     + ("un", "une", "le", "les", "la", "les", "l'")  # fr
     + ("o", "a", "os")  # pt

codex/permissions.py

@@ -8,7 +8,7 @@ from codex.models import Timestamp
 class HasAPIKeyOrIsAdminUser(BasePermission):
     """Does the request have the current api key."""
 
-    def has_permission(self, request, view):  # type: ignore
+    def has_permission(self, request, view):
         """Test the request api key against the database."""
         data = request.GET if request.method == "GET" else request.POST
         api_key = data.get("apiKey")

codex/run.py

@@ -63,7 +63,7 @@ def run():
         serve(
             application,
             HYPERCORN_CONFIG,
-            shutdown_trigger=SHUTDOWN_EVENT.wait,  # type: ignore
+            shutdown_trigger=SHUTDOWN_EVENT.wait,
         )
     )
     librarian.stop()

codex/serializers/admin/flags.py

@@ -11,5 +11,5 @@ class AdminFlagSerializer(BaseModelSerializer):
         """Specify Model."""
 
         model = AdminFlag
-        fields = ("key", "on")
+        fields = ("key", "on", "value")
         read_only_fields = ("key",)

codex/serializers/admin/libraries.py

@@ -85,6 +85,4 @@ class AdminFolderSerializer(Serializer):
 
     def validate_show_hidden(self, show_hidden):
         """Snakecase the showHidden field."""
-        return (
-            show_hidden == "true" or self.initial_data.get("showHidden") == "true"  # type: ignore
-        )
+        return show_hidden == "true" or self.initial_data.get("showHidden") == "true"

codex/serializers/auth.py

@@ -78,3 +78,4 @@ class AuthAdminFlagsSerializer(Serializer):
 
     non_users = BooleanField(read_only=True)
     registration = BooleanField(read_only=True)
+    banner_text = CharField(read_only=True)

codex/serializers/browser/choices.py

@@ -50,9 +50,9 @@ class BrowserChoicesFilterSerializer(Serializer):
         if serializer_class:
             value = serializer_class(choices, many=True).data
         elif not serializer_class and field_name in _LIST_FIELDS:
-            field: ListField = (
+            field: ListField = (  # type: ignore[reportAssignmentType]
                 BrowserSettingsFilterSerializer().get_fields().get(field_name)
-            )  # type: ignore
+            )
             value = field.to_representation(choices)
         else:
             value = BrowserChoicesIntegerPkSerializer(choices, many=True).data

codex/serializers/browser/mixins.py

@@ -64,5 +64,9 @@ class BrowserAggregateSerializerMixin(Serializer):
         )
         mtime = self._get_max_updated_at(EPOCH_START, updated_ats)
         if obj.bmua_is_max:
-            mtime: datetime = max_none(mtime, obj.bookmark_updated_at, EPOCH_START)  # type: ignore
+            mtime: datetime | None = max_none(
+                mtime, obj.bookmark_updated_at, EPOCH_START
+            )
+        if mtime is None:
+            return 0
         return int(mtime.timestamp() * 1000)

codex/serializers/browser/settings.py

@@ -51,7 +51,6 @@ class BrowserCoverInputSerializer(BrowserCoverInputSerializerBase):
 class BrowserSettingsSerializerBase(BrowserCoverInputSerializerBase):
     """Base Serializer for Browser & OPDS Settings."""
 
-    # search_results_limit = IntegerField(required=False)
     top_group = TopGroupField(required=False)
 
 
@@ -64,7 +63,8 @@ class OPDSSettingsSerializer(BrowserSettingsSerializerBase):
 
 
 class BrowserSettingsSerializer(BrowserSettingsSerializerBase):
-    """Browser Settings that the user can change.
+    """
+    Browser Settings that the user can change.
 
     This is the only browse serializer that's submitted.
     """

codex/serializers/fields.py

@@ -38,7 +38,7 @@ class TimestampField(IntegerField):
             value = value.timestamp()
         return int(float(value) * 1000)
 
-    def to_internal_value(self, data) -> datetime:  # type: ignore
+    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)
 
@@ -48,7 +48,7 @@ def validate_decade(decade):
     # * 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(_(f"Invalid decade: {decade}"))
+        raise ValidationError(_("Invalid decade: {decade}"), params={"decade": decade})
     return True
 
 
@@ -62,21 +62,21 @@ class VuetifyNullCodeFieldMixin:
         return None if data == self.NULL_CODE else data
 
 
-class VuetifyFloatField(VuetifyNullCodeFieldMixin, FloatField):  # type: ignore
+class VuetifyFloatField(VuetifyNullCodeFieldMixin, FloatField):  # type: ignore[reportIncompatibleMethodOverride]
     """Float Field with null code conversion."""
 
 
-class VuetifyIntegerField(VuetifyNullCodeFieldMixin, IntegerField):  # type: ignore
+class VuetifyIntegerField(VuetifyNullCodeFieldMixin, IntegerField):  # type: ignore[reportIncompatibleMethodOverride]
     """Integer Field with null code conversion."""
 
 
-class VuetifyCharField(VuetifyNullCodeFieldMixin, CharField):  # type: ignore
+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
+class VuetifyBooleanField(VuetifyNullCodeFieldMixin, BooleanField):  # type: ignore[reportIncompatibleMethodOverride]
     """Boolean Field with null code conversion."""
 
 
@@ -168,7 +168,7 @@ class StringListMultipleChoiceField(MultipleChoiceField):
         """Convert comma delimited strings to sets."""
         if isinstance(data, str):
             data = frozenset(data.split(","))
-        return super().to_internal_value(data)  # type: ignore
+        return super().to_internal_value(data)  # type: ignore[reportIncompatibleMethodOverride]
 
 
 class SerializerChoicesField(StringListMultipleChoiceField):

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/opds/authentication.py

@@ -1,4 +1,5 @@
-"""OPDS Authentication 1.0 Serializer.
+"""
+OPDS Authentication 1.0 Serializer.
 
 https://drafts.opds.io/schema/authentication.schema.json
 """

codex/serializers/opds/v2/__init__.py

@@ -0,0 +1 @@
+"""OPDS v2.0 Serializers."""

codex/serializers/opds/v2/facet.py

@@ -0,0 +1,13 @@
+"""OPDS v2.0 Facet Serializer."""
+
+from rest_framework.serializers import Serializer
+
+from codex.serializers.opds.v2.links import OPDS2LinkListField
+from codex.serializers.opds.v2.metadata import OPDS2MetadataSerializer
+
+
+class OPDS2FacetSerializer(Serializer):
+    """Facets."""
+
+    metadata = OPDS2MetadataSerializer(read_only=True)
+    links = OPDS2LinkListField(read_only=True)