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

codex/librarian/watchdog/emitter.py

@@ -46,14 +46,14 @@ class DatabasePollingEmitter(EventEmitter, WorkerBaseMixin):
 
     _DIR_NOT_FOUND_TIMEOUT = 15 * 60
 
-    def __init__(  # noqa PLR0913
+    def __init__(  # noqa: PLR0913
         self,
         event_queue,
         watch,
         timeout=DEFAULT_EMITTER_TIMEOUT,
         log_queue=None,
         librarian_queue=None,
-        covers_only=False,
+        covers_only=False,  # noqa: FBT002
     ):
         """Initialize snapshot methods."""
         self.init_worker(log_queue, librarian_queue)
@@ -72,7 +72,7 @@ class DatabasePollingEmitter(EventEmitter, WorkerBaseMixin):
             # default stat and listdir params
         )
 
-    def poll(self, force=False):
+    def poll(self, force: bool):
         """Poll now, sooner than timeout."""
         self._force = force
         with self._poll_cond:
@@ -118,7 +118,7 @@ class DatabasePollingEmitter(EventEmitter, WorkerBaseMixin):
         return ok
 
     @property
-    def timeout(self) -> int | None:  # type: ignore
+    def timeout(self) -> int | None:  # type: ignore[reportIncompatibleMethodOverride]
         """Get the timeout for this emitter from its library."""
         # The timeout from the constructor, self._timeout, is thrown away in favor
         # of a dynamic timeout from the database.

codex/librarian/watchdog/event_batcherd.py

@@ -1,4 +1,5 @@
-"""Batch watchdog events into bulk database tasks.
+"""
+Batch watchdog events into bulk database tasks.
 
 Watchdog actually starts events as bulk events with the DirSnapshotDiff
 but the built-in filesystem event emitters serialize them, so the most

codex/librarian/watchdog/events.py

@@ -198,8 +198,7 @@ class CodexLibraryEventHandler(CodexEventHandlerBase):
                 task = WatchdogEventTask(self.library_pk, sub_event)
                 self.librarian_queue.put(task)
 
-            # Calls stub event dispatchers
-            # super().dispatch(event)
+            # Do not call super dispatch to call stub event dispatchers
         except Exception:
             self.log.exception(f"{self.__class__.__name__} dispatch")
 

codex/librarian/watchdog/observers.py

@@ -1,5 +1,6 @@
 """The Codex Library Watchdog Observer threads."""
 
+from watchdog.events import FileSystemEvent, FileSystemEventHandler
 from watchdog.observers import Observer
 from watchdog.observers.api import (
     DEFAULT_OBSERVER_TIMEOUT,
@@ -98,14 +99,16 @@ class UatuMixin(BaseObserver, WorkerBaseMixin):
         except Exception:
             self.log.exception(f"{self.__class__.__name__} sync library watches")
 
-    def schedule(  # type: ignore
+    def schedule(
         self,
-        event_handler,
-        path,
-        recursive=False,
-        _event_filter=None,
-    ):
-        """Override BaseObserver for Codex emitter class.
+        event_handler: FileSystemEventHandler,
+        path: str,
+        *,
+        recursive: bool = False,
+        event_filter: list[type[FileSystemEvent]] | None = None,  # noqa: ARG002, F841, RUF100
+    ) -> ObservedWatch:
+        """
+        Override BaseObserver for Codex emitter class.
 
         https://pythonhosted.org/watchdog/_modules/watchdog/observers/api.html#BaseObserver
         """
@@ -137,9 +140,11 @@ class UatuMixin(BaseObserver, WorkerBaseMixin):
 #     watchdog class structure doesn't work that way.
 
 
-class LibraryEventObserver(UatuMixin, Observer):  # type: ignore
+class LibraryEventObserver(UatuMixin, Observer):  # type: ignore[reportGeneralTypeIssues]
     """Regular observer."""
 
+    # Observer is a dynamically generated class by platform at runtime.
+
     ENABLE_FIELD = "events"
 
 
@@ -156,7 +161,7 @@ class LibraryPollingObserver(UatuMixin):
             *args, emitter_class=DatabasePollingEmitter, timeout=timeout, **kwargs
         )
 
-    def poll(self, library_pks, force=False):
+    def poll(self, library_pks, force: bool):
         """Poll each requested emitter."""
         try:
             qs = Library.objects.all()
@@ -165,7 +170,7 @@ class LibraryPollingObserver(UatuMixin):
             paths = frozenset(qs.values_list("path", flat=True))
 
             for emitter in self.emitters:
-                polling_emitter: DatabasePollingEmitter = emitter  # type: ignore
+                polling_emitter: DatabasePollingEmitter = emitter  # type: ignore[reportAssignmentType]
                 if emitter.watch.path in paths:
                     polling_emitter.poll(force)
         except Exception:

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/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/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/admin/stats.py

@@ -19,8 +19,8 @@ FILE_TYPES_CHOICES = ("CBZ", "CBR", "CBT", "PDF", "UNKNOWN")
 class StatsSystemSerializer(Serializer):
     """Platform System Information."""
 
-    name = CharField(required=False, read_only=True)
-    release = CharField(required=False, read_only=True)
+    name = CharField(read_only=True, required=False)
+    release = CharField(read_only=True, required=False)
 
 
 class StatsPlatformSerializer(Serializer):
@@ -42,7 +42,7 @@ class StatsConfigSerializer(Serializer):
     user_registered_count = IntegerField(required=False, read_only=True)
     auth_group_count = IntegerField(required=False, read_only=True)
     # Only for api
-    api_key = CharField(required=False, read_only=True)
+    api_key = CharField(read_only=True, required=False)
 
 
 class StatsSessionsSerializer(Serializer):
@@ -123,4 +123,4 @@ class AdminStatsRequestSerializer(Serializer):
 class APIKeySerializer(Serializer):
     """API Key."""
 
-    api_key = CharField(source="name")
+    api_key = CharField(source="name", read_only=True)

codex/serializers/auth.py

@@ -8,6 +8,8 @@ from rest_framework.serializers import (
 )
 
 from codex.models import AdminFlag
+from codex.serializers.fields.auth import TimezoneField
+from codex.serializers.fields.sanitized import SanitizedCharField
 from codex.serializers.models.base import BaseModelSerializer
 
 
@@ -49,7 +51,7 @@ class UserSerializer(BaseModelSerializer):
 class TimezoneSerializer(Serializer):
     """Serialize Timezone submission from front end."""
 
-    timezone = CharField(min_length=2)
+    timezone = TimezoneField(write_only=True)
 
 
 class UserCreateSerializer(BaseModelSerializer, TimezoneSerializer):
@@ -67,7 +69,7 @@ class UserLoginSerializer(UserCreateSerializer):
     """Serialize user login input."""
 
     # specify this so it doesn't trigger the username unique constraint.
-    username = CharField(min_length=2)
+    username = SanitizedCharField(min_length=2)
 
     class Meta(UserCreateSerializer.Meta):
         """Explicit meta inheritance required."""

codex/serializers/browser/choices.py

@@ -2,28 +2,106 @@
 
 from types import MappingProxyType
 
-from rest_framework.fields import ListField, SerializerMethodField
-from rest_framework.serializers import CharField, Serializer
+from rest_framework.fields import (
+    BooleanField,
+    CharField,
+    ListField,
+    SerializerMethodField,
+)
+from rest_framework.serializers import Serializer
 
-from codex.serializers.browser.filters import BrowserSettingsFilterSerializer
 from codex.serializers.fields import (
+    VuetifyBooleanField,
     VuetifyCharField,
+    VuetifyDecadeField,
+    VuetifyFloatField,
     VuetifyIntegerField,
 )
+from codex.serializers.fields.browser import BookmarkFilterField
 from codex.serializers.models.pycountry import CountrySerializer, LanguageSerializer
 
 
-class BrowserChoicesCharPkSerializer(Serializer):
+class BrowserFilterChoicesSerializer(Serializer):
+    """All dynamic filters."""
+
+    age_rating = BooleanField(read_only=True)
+    community_rating = BooleanField(read_only=True)
+    characters = BooleanField(read_only=True)
+    country = BooleanField(read_only=True)
+    critical_rating = BooleanField(read_only=True)
+    contributors = BooleanField(read_only=True)
+    decade = BooleanField(read_only=True)
+    genres = BooleanField(read_only=True)
+    file_type = BooleanField(read_only=True)
+    identifier_type = BooleanField(read_only=True)
+    monochrome = BooleanField(read_only=True)
+    language = BooleanField(read_only=True)
+    locations = BooleanField(read_only=True)
+    original_format = BooleanField(read_only=True)
+    reading_direction = BooleanField(read_only=True)
+    series_groups = BooleanField(read_only=True)
+    stories = BooleanField(read_only=True)
+    story_arcs = BooleanField(read_only=True)
+    tagger = BooleanField(read_only=True)
+    tags = BooleanField(read_only=True)
+    teams = BooleanField(read_only=True)
+    year = BooleanField(read_only=True)
+
+
+class BrowserSettingsFilterSerializer(Serializer):
+    """Filter values for settings."""
+
+    bookmark = BookmarkFilterField(required=False, read_only=True)
+    # Dynamic filters
+    age_rating = ListField(child=VuetifyCharField(), required=False, read_only=True)
+    characters = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    community_rating = ListField(
+        child=VuetifyFloatField(), required=False, read_only=True
+    )
+    country = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    contributors = ListField(
+        child=VuetifyIntegerField(), required=False, read_only=True
+    )
+    critical_rating = ListField(
+        child=VuetifyFloatField(), required=False, read_only=True
+    )
+    decade = ListField(child=VuetifyDecadeField(), required=False, read_only=True)
+    file_type = ListField(child=VuetifyCharField(), required=False, read_only=True)
+    genres = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    identifier_type = ListField(
+        child=VuetifyCharField(), required=False, read_only=True
+    )
+    language = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    locations = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    monochrome = ListField(child=VuetifyBooleanField(), required=False, read_only=True)
+    original_format = ListField(
+        child=VuetifyCharField(), required=False, read_only=True
+    )
+    reading_direction = ListField(
+        child=VuetifyCharField(), required=False, read_only=True
+    )
+    series_groups = ListField(
+        child=VuetifyIntegerField(), required=False, read_only=True
+    )
+    stories = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    story_arcs = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    tagger = ListField(child=VuetifyCharField(), required=False, read_only=True)
+    tags = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    teams = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+    year = ListField(child=VuetifyIntegerField(), required=False, read_only=True)
+
+
+class BrowserChoicesIntegerPkSerializer(Serializer):
     """Named Model Serializer."""
 
-    pk = VuetifyCharField(read_only=True)
+    pk = VuetifyIntegerField(read_only=True)
     name = CharField(read_only=True)
 
 
-class BrowserChoicesIntegerPkSerializer(BrowserChoicesCharPkSerializer):
+class BrowserChoicesCharPkSerializer(BrowserChoicesIntegerPkSerializer):
     """Named Model Serailizer with pk = char hack for languages & countries."""
 
-    pk = VuetifyIntegerField(read_only=True)
+    pk = VuetifyCharField(read_only=True)
 
 
 _CHOICES_NAME_SERIALIZER_MAP = MappingProxyType(
@@ -50,9 +128,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