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

codex/asgi.py

@@ -1,5 +1,4 @@
-"""
-ASGI config for codex project.
+"""ASGI config for codex project.
 
 It exposes the ASGI callable as a module-level variable named ``DJANGO_APPLICATION``.
 

codex/choices.py

@@ -93,6 +93,7 @@ BROWSER_DEFAULTS = MappingProxyType(
         "order_by": "sort_name",
         "order_reverse": False,
         "q": "",
+        # "search_results_limit": 100,
         "show": _DEFAULT_SHOW,
         "top_group": "p",
         "twenty_four_hour_time": False,
@@ -390,9 +391,11 @@ ADMIN_TASK_GROUPS = MappingProxyType(
 
 def _group_task_values(groups):
     """Extract values into sorted tuple."""
-    return tuple(
-        sorted([item["value"] for group in groups["tasks"] for item in group["tasks"]])
-    )
+    values = []
+    for group in groups["tasks"]:
+        for item in group["tasks"]:
+            values.append(item["value"])
+    return tuple(sorted(values))
 
 
 ADMIN_TASKS = _group_task_values(ADMIN_TASK_GROUPS)

codex/choices_to_json.py

@@ -18,7 +18,6 @@ from codex.choices import (
     READER_DEFAULTS,
     WEBSOCKET_MESSAGES,
 )
-from codex.serializers.route import RouteSerializer
 
 _DEFAULTS = MappingProxyType(
     {"browser-choices.json": BROWSER_DEFAULTS, "reader-choices.json": READER_DEFAULTS}
@@ -69,11 +68,12 @@ def _make_json_serializable(data):
     if isinstance(data, Mapping):
         json_dict = {}
         for key, value in data.items():
-            if key == "breadcrumbs":
-                json_value = tuple(RouteSerializer(dict(route)).data for route in value)
+            if key == "pks":
+                # Special route serializer
+                # XXX possibly should use actual route serializer for route not just pks
+                json_dict[key] = ",".join(str(pk) for pk in sorted(value))
             else:
-                json_value = _make_json_serializable(value)
-            json_dict[_json_key(key)] = json_value
+                json_dict[_json_key(key)] = _make_json_serializable(value)
         return json_dict
     if isinstance(data, list | tuple | frozenset | set):
         return [_make_json_serializable(item) for item in data]
@@ -93,7 +93,7 @@ def _to_vuetify_dict(fn, data):
     return vuetify_data
 
 
-def _dump(parent_path, fn, data, vuetify):
+def _dump(parent_path, fn, data, vuetify=True):
     """Dump data to json file."""
     vuetify_data = (
         _to_vuetify_dict(fn, data) if vuetify else _make_json_serializable(data)
@@ -112,10 +112,10 @@ def main():
     parent_path = Path(parent_path)
     parent_path.mkdir(exist_ok=True)
     for fn, data in _DUMPS.items():
-        _dump(parent_path, fn, data, vuetify=True)
+        _dump(parent_path, fn, data)
 
     for fn, data in _MAP_DUMPS.items():
-        _dump(parent_path, fn, data, vuetify=False)
+        _dump(parent_path, fn, data, False)
 
 
 if __name__ == "__main__":

codex/db.py

@@ -62,7 +62,7 @@ def _backup_db_before_migration():
     """If there are migrations to do, backup the db."""
     backup_path = _get_backup_db_path(f"before-v{VERSION}")
     janitor = Janitor(LOG_QUEUE, LIBRARIAN_QUEUE)
-    janitor.backup_db(show_status=False, backup_path=backup_path)
+    janitor.backup_db(backup_path, show_status=False)
     LOG.info("Backed up database before migrations")
 
 
@@ -71,7 +71,7 @@ def _repair_db():
     if FIX_FOREIGN_KEYS:
         fix_foreign_keys()
     if INTEGRITY_CHECK:
-        integrity_check(long=True)
+        integrity_check()
     success = fts_integrity_check() if FTS_INTEGRITY_CHECK else True
     if FTS_REBUILD or not success:
         fts_rebuild()

codex/exceptions.py

@@ -1,8 +1,8 @@
 """Special Redirect Error."""
 
-from collections.abc import Mapping
 from copy import deepcopy
 from pprint import pformat
+from typing import TYPE_CHECKING
 
 from django.core.validators import EMPTY_VALUES
 from django.shortcuts import redirect
@@ -17,6 +17,10 @@ from codex.serializers.fields import BreadcrumbsField
 from codex.serializers.route import RouteSerializer
 from codex.views.util import pop_name
 
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+
 LOG = get_logger(__name__)
 _OPDS_REDIRECT_SETTINGS_KEYS = ("order_by", "top_group")
 _REDIRECT_SETTINGS_KEYS = ("breadcrumbs", *_OPDS_REDIRECT_SETTINGS_KEYS)
@@ -67,10 +71,7 @@ class SeeOtherRedirectError(APIException):
     def _add_query_params(self, url):
         """Change OPDS settings like the frontend does with error.detail."""
         query_params = {}
-        if isinstance(self.detail, Mapping):
-            settings = self.detail.get("settings", {})
-        else:
-            settings = {}
+        settings: Mapping = self.detail.get("settings", {})  # type: ignore
         for key in _OPDS_REDIRECT_SETTINGS_KEYS:
             value = settings.get(key)
             if value not in EMPTY_VALUES:

codex/librarian/bookmark/bookmarkd.py

@@ -21,19 +21,15 @@ class BookmarkThread(AggregateMessageQueuedThread, BookmarkUpdate):
         else:
             self.log.warning(f"Unknown Bookmark task {item}")
 
-    def _send_item(self, filters, updates):
-        """Process one item."""
-        auth_filter, comic_pks = filters
-        auth_filter = dict(auth_filter)
-        self.update_bookmarks(auth_filter, comic_pks, updates, self.log)
-        self.log.debug(f"updated {auth_filter} pk__in={comic_pks}")
-
     def send_all_items(self):
         """Run the task method."""
         cleanup = set()
         for filters, updates in self.cache.items():
             try:
-                self._send_item(filters, updates)
+                auth_filter, comic_pks = filters
+                auth_filter = dict(auth_filter)
+                self.update_bookmarks(auth_filter, comic_pks, updates, self.log)
+                self.log.debug(f"updated {auth_filter} pk__in={comic_pks}")
                 cleanup.add(filters)
             except Exception:
                 self.log.exception("Updating bookmarks")

codex/librarian/bookmark/update.py

@@ -120,7 +120,7 @@ class BookmarkUpdate(GroupACLMixin):
             Bookmark.objects.bulk_create(
                 create_bookmarks,
                 update_fields=tuple(_BOOKMARK_UPDATE_FIELDS),
-                unique_fields=Bookmark._meta.unique_together[0],
+                unique_fields=Bookmark._meta.unique_together[0],  # type: ignore
             )
         return count
 
@@ -131,7 +131,7 @@ class BookmarkUpdate(GroupACLMixin):
         try:
             UserActive.objects.update_or_create(user=user)
         except Exception as exc:
-            reason = f"Update user activity {exc}"
+            reason = f"update user activity {exc}"
             log.warning(reason)
 
     @classmethod

codex/librarian/covers/create.py

@@ -32,7 +32,7 @@ class CoverCreateThread(QueuedThread, CoverPathMixin):
             with Image.open(image_io) as cover_image:
                 cover_image.thumbnail(
                     _THUMBNAIL_SIZE,
-                    Image.Resampling.LANCZOS,
+                    Image.Resampling.LANCZOS,  # type: ignore
                     reducing_gap=3.0,
                 )
                 cover_image.save(cover_thumb_buffer, "WEBP", method=6)
@@ -41,8 +41,7 @@ class CoverCreateThread(QueuedThread, CoverPathMixin):
 
     @classmethod
     def _get_comic_cover_image(cls, comic_path):
-        """
-        Create comic cover if none exists.
+        """Create comic cover if none exists.
 
         Return image thumb data or path to missing file thumb.
         """
@@ -60,9 +59,8 @@ class CoverCreateThread(QueuedThread, CoverPathMixin):
             return f.read()
 
     @classmethod
-    def create_cover_from_path(cls, pk, cover_path, log, librarian_queue, custom):
-        """
-        Create cover for path.
+    def create_cover_from_path(cls, pk, cover_path, log, librarian_queue, custom=False):
+        """Create cover for path.
 
         Called from views/cover.
         """
@@ -97,7 +95,7 @@ class CoverCreateThread(QueuedThread, CoverPathMixin):
             # zero length file is code for missing.
             cover_path.touch()
 
-    def _bulk_create_comic_covers(self, pks, custom):
+    def _bulk_create_comic_covers(self, pks, custom=False):
         """Create bulk comic covers."""
         num_comics = len(pks)
         if not num_comics:
@@ -117,7 +115,7 @@ class CoverCreateThread(QueuedThread, CoverPathMixin):
                 else:
                     # bulk contributor creates covers inline
                     data = self.create_cover_from_path(
-                        pk, cover_path, self.log, self.librarian_queue, custom=False
+                        pk, cover_path, self.log, self.librarian_queue
                     )
                     if data:
                         data.close()
@@ -136,6 +134,6 @@ class CoverCreateThread(QueuedThread, CoverPathMixin):
     def create_all_covers(self):
         """Create all covers for all libraries."""
         pks = CustomCover.objects.values_list("pk", flat=True)
-        self._bulk_create_comic_covers(pks, custom=True)
+        self._bulk_create_comic_covers(pks, True)
         pks = Comic.objects.values_list("pk", flat=True)
-        self._bulk_create_comic_covers(pks, custom=False)
+        self._bulk_create_comic_covers(pks, False)

codex/librarian/covers/path.py

@@ -21,21 +21,20 @@ class CoverPathMixin:
         """Translate an integer into an efficient filesystem path."""
         fnv = fnv1a_32(bytes(str(pk).zfill(cls._ZFILL), "utf-8"))
         hex_str = format(fnv, f"0{cls._ZFILL}x")
-        parts = [
-            hex_str[i : i + cls._PATH_STEP]
-            for i in range(0, len(hex_str), cls._PATH_STEP)
-        ]
+        parts = []
+        for i in range(0, len(hex_str), cls._PATH_STEP):
+            parts.append(hex_str[i : i + cls._PATH_STEP])
         return Path("/".join(parts))
 
     @classmethod
-    def get_cover_path(cls, pk, custom):
+    def get_cover_path(cls, pk, custom=False):
         """Get cover path for comic pk."""
         cover_path = cls._hex_path(pk)
         root = cls.CUSTOM_COVERS_ROOT if custom else cls.COVERS_ROOT
         return root / cover_path.with_suffix(".webp")
 
     @classmethod
-    def get_cover_paths(cls, pks, custom):
+    def get_cover_paths(cls, pks, custom=False):
         """Get cover paths for many comic pks."""
         cover_paths = set()
         for pk in pks:

codex/librarian/covers/purge.py

@@ -67,7 +67,7 @@ class CoverPurgeThread(CoverCreateThread):
             self.log.info("Removed entire comic cover cache.")
             shutil.rmtree(self.CUSTOM_COVERS_ROOT)
             self.log.info("Removed entire custom cover cache.")
-        except OSError as exc:
+        except Exception as exc:
             self.log.warning(exc)
         librarian_queue.put(LIBRARY_CHANGED_TASK)
 
@@ -77,7 +77,7 @@ class CoverPurgeThread(CoverCreateThread):
             self.log.debug(f"Removing covers from missing {name}.")
             self.status_controller.start_many(self._CLEANUP_STATUS_MAP)
             pks = cover_class.objects.all().values_list("pk", flat=True)
-            db_cover_paths = self.get_cover_paths(pks, custom=False)
+            db_cover_paths = self.get_cover_paths(pks)
 
             orphan_cover_paths = set()
             for root, _, filenames in os.walk(cover_root):

codex/librarian/importer/aggregate.py

@@ -222,10 +222,10 @@ class AggregateMetadataImporter(ExtractMetadataImporter):
         if self.task.force_import_metadata:
             import_metadata = True
         else:
-            key = AdminFlag.FlagChoices.IMPORT_METADATA.value
+            key = AdminFlag.FlagChoices.IMPORT_METADATA.value  # type: ignore
             import_metadata = AdminFlag.objects.get(key=key).on
         if not import_metadata:
-            self.log.warning("Admin flag set to NOT import metadata.")
+            self.log.warn("Admin flag set to NOT import metadata.")
 
         # Init metadata, extract and aggregate
         self.metadata[MDS] = {}

codex/librarian/importer/cache.py

@@ -73,6 +73,7 @@ class CacheUpdateImporter(InitImporter):
         try:
             log_list = []
             for model in GROUP_MODELS:
+                # self.log.debug(f"Updating timestamps for {model.__name__}s...")
                 count = self._update_group_model(
                     force_update_group_map, model, start_time, log_list
                 )
@@ -84,7 +85,9 @@ class CacheUpdateImporter(InitImporter):
 
             if total_count:
                 groups_log = ", ".join(log_list)
-                self.log.info(f"Updated timestamps for {groups_log}.")
+                self.log.info(  # type: ignore
+                    f"Updated timestamps for {groups_log}."
+                )
                 self.changed += total_count
         finally:
             self.status_controller.finish(status)

codex/librarian/importer/create_comics.py

@@ -78,7 +78,7 @@ class CreateComicsImporter(LinkComicsImporter):
             Comic.objects.bulk_update(update_comics, BULK_UPDATE_COMIC_FIELDS)
             count = len(update_comics)
 
-            self._remove_covers(comic_pks, custom=False)
+            self._remove_covers(comic_pks, False)  # type: ignore
             self.log.debug(f"Purging covers for {len(comic_pks)} updated comics.")
             if count:
                 self.log.info(f"Updated {count} comics.")
@@ -126,7 +126,7 @@ class CreateComicsImporter(LinkComicsImporter):
                     create_comics,
                     update_conflicts=True,
                     update_fields=BULK_CREATE_COMIC_FIELDS,
-                    unique_fields=Comic._meta.unique_together[0],
+                    unique_fields=Comic._meta.unique_together[0],  # type: ignore
                 )
                 count = len(create_comics)
                 if count:

codex/librarian/importer/create_covers.py

@@ -43,7 +43,7 @@ class CreateCoversImporter(CreateComicsImporter):
             if LINK_COVER_PKS not in self.metadata:
                 self.metadata[LINK_COVER_PKS] = set()
             self.metadata[LINK_COVER_PKS].update(update_cover_pks)
-            self._remove_covers(update_cover_pks, custom=True)
+            self._remove_covers(update_cover_pks, custom=True)  # type: ignore
             count = len(update_covers)
             if status:
                 status.add_complete(count)

codex/librarian/importer/create_fks.py

@@ -1,5 +1,4 @@
-"""
-Create all missing comic foreign keys for an import.
+"""Create all missing comic foreign keys for an import.
 
 So we may safely create the comics next.
 """
@@ -190,7 +189,7 @@ class CreateForeignKeysImporter(CreateCoversImporter):
             create_folders,
             update_conflicts=True,
             update_fields=BULK_UPDATE_FOLDER_FIELDS,
-            unique_fields=Folder._meta.unique_together[0],
+            unique_fields=Folder._meta.unique_together[0],  # type: ignore
         )
         count = len(create_folders)
         status.add_complete(count)
@@ -297,7 +296,7 @@ class CreateForeignKeysImporter(CreateCoversImporter):
             create_objs,
             update_conflicts=True,
             update_fields=CREATE_DICT_UPDATE_FIELDS[model],
-            unique_fields=model._meta.unique_together[0],
+            unique_fields=model._meta.unique_together[0],  # type: ignore
         )
         count = len(create_objs)
         if count:

codex/librarian/importer/deleted.py

@@ -13,7 +13,7 @@ from codex.status import Status
 class DeletedImporter(CacheUpdateImporter):
     """Clean up database methods."""
 
-    def _remove_covers(self, delete_pks, custom: bool):
+    def _remove_covers(self, delete_pks, custom=False):
         task = CoverRemoveTask(delete_pks, custom)
         self.librarian_queue.put(task)
 
@@ -34,7 +34,7 @@ class DeletedImporter(CacheUpdateImporter):
         )
         folders.delete()
 
-        self._remove_covers(delete_comic_pks, custom=False)
+        self._remove_covers(delete_comic_pks)
 
         count = len(delete_comic_pks)
         if count:
@@ -96,7 +96,7 @@ class DeletedImporter(CacheUpdateImporter):
         delete_comic_pks = frozenset(delete_qs.values_list("pk", flat=True))
         delete_qs.delete()
 
-        self._remove_covers(delete_comic_pks, custom=False)
+        self._remove_covers(delete_comic_pks)
 
         count = len(delete_comic_pks)
         if count:

codex/librarian/importer/extract.py

@@ -94,7 +94,7 @@ class ExtractMetadataImporter(QueryForeignKeysImporter):
 
     @classmethod
     def _clean_decimal(cls, value, field_name: str):
-        field: DecimalField = Comic._meta.get_field(field_name)  # type: ignore[reportAssignmentType]
+        field: DecimalField = Comic._meta.get_field(field_name)  # type: ignore
         try:
             quantize_str = Decimal(f"1e-{field.decimal_places}")
             value = value.quantize(quantize_str, rounding=ROUND_DOWN)
@@ -147,7 +147,7 @@ class ExtractMetadataImporter(QueryForeignKeysImporter):
     @staticmethod
     def _clean_charfield(model, field_name, value):
         try:
-            field: CharField = model._meta.get_field(field_name)  # type: ignore[reportAssignmentType]
+            field: CharField = model._meta.get_field(field_name)  # type: ignore
             if value:
                 value = value[: field.max_length].strip()
             if not value:

codex/librarian/importer/failed_imports.py

@@ -120,7 +120,7 @@ class FailedImportsImporter(DeletedImporter):
             create_objs,
             update_conflicts=True,
             update_fields=_BULK_UPDATE_FAILED_IMPORT_FIELDS,
-            unique_fields=FailedImport._meta.unique_together[0],
+            unique_fields=FailedImport._meta.unique_together[0],  # type: ignore
         )
         count = len(create_objs)
         if count:

codex/librarian/importer/importer.py

@@ -43,9 +43,7 @@ class ComicImporter(MovedImporter):
 
             # Wait to start the search index update in case more updates are incoming.
             until = time() + 1
-            delayed_search_task = DelayedTasks(
-                until, (SearchIndexUpdateTask(rebuild=False),)
-            )
+            delayed_search_task = DelayedTasks(until, (SearchIndexUpdateTask(False),))
             self.librarian_queue.put(delayed_search_task)
         else:
             self.log.info("No updates neccissary.")

codex/librarian/importer/importerd.py

@@ -35,7 +35,7 @@ class ComicImporterThread(QueuedThread):
         import_comics = Comic.objects.filter(pk__in=task.pks).only("path", "library_id")
         library_path_map = {}
         for import_comic in import_comics:
-            library_id = import_comic.library_id  # type: ignore[reportAttributeAccessIssue]
+            library_id = import_comic.library_id  # type: ignore
             if library_id not in library_path_map:
                 library_path_map[library_id] = set()
             library_path_map[library_id].add(import_comic.path)
@@ -89,7 +89,7 @@ class ComicImporterThread(QueuedThread):
         importer.bulk_folders_moved()
         return True
 
-    def _adopt_orphan_folders(self, janitor: bool):
+    def _adopt_orphan_folders(self, janitor=False):
         """Find orphan folders and move them into their correct place."""
         status = Status(ImportStatusTypes.ADOPT_FOLDERS)
         moved_status = Status(ImportStatusTypes.DIRS_MOVED)
@@ -118,6 +118,6 @@ class ComicImporterThread(QueuedThread):
         elif isinstance(task, UpdateGroupsTask):
             self._update_groups(task)
         elif isinstance(task, AdoptOrphanFoldersTask):
-            self._adopt_orphan_folders(janitor=task.janitor)
+            self._adopt_orphan_folders(task.janitor)
         else:
             self.log.warning(f"Bad task sent to library updater {task}")

codex/librarian/importer/link_comics.py

@@ -186,8 +186,7 @@ class LinkComicsImporter(LinkCoversImporter):
         return tms, all_del_pks
 
     def bulk_fix_comic_m2m_field(self, field_name, m2m_links, status):
-        """
-        Recreate an m2m field for a set of comics.
+        """Recreate an m2m field for a set of comics.
 
         Since we can't bulk_update or bulk_create m2m fields use a trick.
         bulk_create() on the through table:

codex/librarian/importer/moved.py

@@ -46,7 +46,9 @@ class MovedImporter(AggregateMetadataImporter):
             new_path = self.task.files_moved[comic.path]
             comic.path = new_path
             new_path = Path(new_path)
-            comic.parent_folder = Folder.objects.get(path=new_path.parent)
+            comic.parent_folder = Folder.objects.get(  # type: ignore
+                path=new_path.parent
+            )
             comic.updated_at = Now()
             comic.presave()
             folder_m2m_links[comic.pk] = Folder.objects.filter(
@@ -135,7 +137,7 @@ class MovedImporter(AggregateMetadataImporter):
                     f"Unlinked {len(unlink_groups)} {model.__name__} moved custom covers."
                 )
 
-        self._remove_covers(unlink_pks, custom=True)
+        self._remove_covers(unlink_pks, custom=True)  # type: ignore
 
     def _bulk_covers_moved(self, status=None):
         """Move covers."""
@@ -192,6 +194,8 @@ class MovedImporter(AggregateMetadataImporter):
             folder.updated_at = Now()
             update_folders.append(folder)
 
+        # delete_folders = Folder.objects.filter(library=self.library, path__in=new_paths)
+
         update_folders = sorted(update_folders, key=lambda x: len(Path(x.path).parts))
 
         Folder.objects.bulk_update(update_folders, MOVED_BULK_FOLDER_UPDATE_FIELDS)
@@ -208,6 +212,7 @@ class MovedImporter(AggregateMetadataImporter):
         """Move folders under existing folders."""
         while True:
             # Get existing parent folders
+            # dest_parent_paths = tuple(str(path) for path in dest_parent_folder_paths_map)
             dest_parent_paths = tuple(dest_parent_folder_paths_map.keys())
             extant_parent_folders = Folder.objects.filter(
                 library=self.library, path__in=dest_parent_paths

codex/librarian/importer/query_fks.py

@@ -229,7 +229,9 @@ class QueryForeignKeysImporter(QueryCustomCoversImporter):
 
         group_filter = Q()
         for group_tree, count_value in update_group_trees.items():
-            compare_filter = dict(zip(compare_fields, group_tree, strict=False))
+            compare_filter = {}
+            for field_name, value in zip(compare_fields, group_tree, strict=False):
+                compare_filter[field_name] = value
             compare_filter[count_field_name] = count_value
             group_filter |= Q(**compare_filter)
         return group_filter
@@ -492,6 +494,7 @@ class QueryForeignKeysImporter(QueryCustomCoversImporter):
 
     def _query_missing_simple_models(self, names, fk_data, status):
         """Find missing named models and folders."""
+        # count = 0
         if not names:
             return 0
         create_fks, base_cls, field, fk_field = fk_data

codex/librarian/importer/tasks.py

@@ -18,7 +18,7 @@ class ImportDBDiffTask(ImportTask):
 
     dirs_moved: Mapping[str, str] = field(default_factory=dict)
     dirs_modified: frozenset[str] = frozenset()
-    # dirs_created: frozenset[str] | None = frozenset() # noqa: ERA001
+    # dirs_created: frozenset[str] | None = frozenset()
     dirs_deleted: frozenset[str] = frozenset()
 
     files_moved: Mapping[str, str] = field(default_factory=dict)