codex 1.7.9__py3-none-any.whl → 1.7.11__py3-none-any.whl

codex/choices/admin.py

@@ -2,6 +2,14 @@
 
 from types import MappingProxyType
 
+from bidict import frozenbidict
+
+from codex.librarian.covers.status import CoverStatusTypes
+from codex.librarian.importer.status import ImportStatusTypes
+from codex.librarian.janitor.status import JanitorStatusTypes
+from codex.librarian.search.status import SearchIndexStatusTypes
+from codex.librarian.watchdog.status import WatchdogStatusTypes
+
 ADMIN_FLAG_CHOICES = MappingProxyType(
     {
         "AU": "Auto Update",
@@ -14,53 +22,18 @@ ADMIN_FLAG_CHOICES = MappingProxyType(
     }
 )
 
-ADMIN_STATUS_TITLES = MappingProxyType(
-    {
-        "CCC": "Create Covers",
-        "CCD": "Remove Covers",
-        "CFO": "Find Orphan Covers",
-        "IAF": "Adopt Orphan Folders",
-        "ICC": "Create Custom Covers",
-        "ICD": "Delete Custom Covers",
-        "ICL": "Link Custom Covers",
-        "ICM": "Custom Covers Moved",
-        "ICQ": "Discover Missing Custom Covers",
-        "ICU": "Modify Custom Covers",
-        "IDD": "Remove Folders",
-        "IDM": "Move Folders",
-        "IDU": "Modify Folders",
-        "IFC": "Create Books",
-        "IFD": "Remove Books",
-        "IFI": "Record Failed Imports",
-        "IFM": "Move Books",
-        "IFU": "Modify Books",
-        "IGU": "Update First Covers",
-        "IMC": "Link Books to Tags",
-        "IMQ": "Prepare Tags for Linking",
-        "ITC": "Create Missing Tags",
-        "ITQ": "Discover Missing Tags",
-        "ITR": "Read Book Tags",
-        "JCB": "Cleanup Orphan Bookmarks",
-        "JCD": "Cleanup Custom Covers",
-        "JCR": "Restart Codex",
-        "JCS": "Stop Codex",
-        "JCU": "Update Codex Software",
-        "JDB": "Backup Database",
-        "JDO": "Optimize Database",
-        "JFC": "Search Index Integrity Check",
-        "JFR": "Search Index Repair",
-        "JIC": "Database Integrity Check",
-        "JIF": "Database Foreign Key Check",
-        "JLV": "Check Codex Latest Version",
-        "JSD": "Cleanup Expired Sessions",
-        "JTD": "Cleanup Stale Tags",
-        "SIC": "Search Index Create",
-        "SID": "Search Index Remove Stale Records",
-        "SIO": "Search Index Optimize",
-        "SIU": "Search Index Update",
-        "SIX": "Search Index Clear",
-        "WPO": "Poll Library",
-    }
+ADMIN_STATUS_TITLES = frozenbidict(
+    sorted(
+        (key, val)
+        for status_types in (
+            CoverStatusTypes,
+            ImportStatusTypes,
+            JanitorStatusTypes,
+            SearchIndexStatusTypes,
+            WatchdogStatusTypes,
+        )
+        for key, val in status_types.choices
+    )
 )
 
 # Easier to store in vuetify format

codex/choices/reader.py

@@ -6,18 +6,18 @@ READER_CHOICES = MappingProxyType(
     {
         "fit_to": MappingProxyType(
             {
-                "H": "Fit to Height",
-                "O": "Original Size",
                 "S": "Fit to Screen",
                 "W": "Fit to Width",
+                "H": "Fit to Height",
+                "O": "Original Size",
             }
         ),
         "reading_direction": MappingProxyType(
             {
-                "btt": "Bottom to Top",
                 "ltr": "Left to Right",
                 "rtl": "Right to Left",
                 "ttb": "Top to Bottom",
+                "btt": "Bottom to Top",
             }
         ),
     }

codex/db.py

@@ -16,7 +16,7 @@ from codex.librarian.janitor.integrity import (
 )
 from codex.librarian.janitor.janitor import Janitor
 from codex.librarian.mp_queue import LIBRARIAN_QUEUE
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.logger.mp_queue import LOG_QUEUE
 from codex.settings.settings import (
     BACKUP_DB_PATH,

codex/exceptions.py

@@ -12,7 +12,7 @@ from rest_framework.exceptions import APIException
 from rest_framework.status import HTTP_303_SEE_OTHER
 
 from codex.choices.browser import DEFAULT_BROWSER_ROUTE
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.serializers.fields.browser import BreadcrumbsField
 from codex.serializers.route import RouteSerializer
 from codex.views.util import pop_name

codex/librarian/bookmark/tasks.py

@@ -14,6 +14,6 @@ class BookmarkTask:
 class BookmarkUpdateTask(BookmarkTask):
     """Bookmark a page."""
 
-    auth_filter: Mapping[str, int | str]
+    auth_filter: Mapping[str, int | str | None]
     comic_pks: tuple[int]
     updates: Mapping[str, Any]

codex/librarian/covers/status.py

@@ -1,9 +1,9 @@
 """Cover status types."""
 
-from django.db.models import Choices
+from django.db.models import TextChoices
 
 
-class CoverStatusTypes(Choices):
+class CoverStatusTypes(TextChoices):
     """Cover Types."""
 
     CREATE_COVERS = "CCC"

codex/librarian/covers/tasks.py

@@ -18,13 +18,6 @@ class CoverRemoveOrphansTask(CoverTask):
     """Clean up covers from missing comics."""
 
 
-@dataclass
-class LibrariesTask:
-    """Tasks over a set of libraries."""
-
-    library_ids: frozenset
-
-
 @dataclass
 class CoverRemoveTask(CoverTask):
     """Purge a set of comic covers."""

codex/librarian/cron/crond.py

@@ -6,10 +6,10 @@ from types import MappingProxyType
 
 from django.utils import timezone as django_timezone
 
+from codex.librarian.janitor.scheduled_time import get_janitor_time
 from codex.librarian.janitor.tasks import JanitorNightlyTask
-from codex.librarian.janitor.time import get_janitor_time
+from codex.librarian.telemeter.scheduled_time import get_telemeter_time
 from codex.librarian.telemeter.tasks import TelemeterTask
-from codex.librarian.telemeter.time import get_telemeter_time
 from codex.threads import NamedThread
 
 _TASK_TIME_FUNCTION_MAP = MappingProxyType(

codex/librarian/importer/link_comics.py

@@ -1,5 +1,6 @@
 """Bulk update m2m fields."""
 
+from collections.abc import Mapping
 from pathlib import Path
 
 from django.db.models import Q
@@ -126,13 +127,13 @@ class LinkComicsImporter(LinkCoversImporter):
         result = frozenset(pks)
         all_m2m_links[key][comic_pk] = result
 
-    def _link_comic_m2m_fields(self):
+    def _link_comic_m2m_fields(self) -> tuple[Mapping, int]:
         """Get the complete m2m field data to create."""
         total = 0
         all_m2m_links = {}
         comic_paths = frozenset(self.metadata.get(M2M_MDS, {}).keys())
         if not comic_paths:
-            return all_m2m_links
+            return all_m2m_links, total
         comics = Comic.objects.filter(path__in=comic_paths).values_list("pk", "path")
         for comic_pk, comic_path in comics:
             md = self.metadata[M2M_MDS][comic_path]

codex/librarian/importer/query_covers.py

@@ -6,7 +6,7 @@ from codex.librarian.importer.const import (
 )
 from codex.librarian.importer.create_fks import CreateForeignKeysImporter
 from codex.librarian.importer.status import ImportStatusTypes
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.models.paths import CustomCover
 from codex.status import Status
 

codex/librarian/importer/query_fks.py

@@ -35,7 +35,7 @@ from codex.librarian.importer.const import (
 )
 from codex.librarian.importer.query_covers import QueryCustomCoversImporter
 from codex.librarian.importer.status import ImportStatusTypes
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.models import (
     Comic,
     Contributor,

codex/librarian/importer/status.py

@@ -1,9 +1,9 @@
 """Librarian Status for imports."""
 
-from django.db.models import Choices
+from django.db.models import TextChoices
 
 
-class ImportStatusTypes(Choices):
+class ImportStatusTypes(TextChoices):
     """Keys for Import tasks."""
 
     DIRS_MOVED = "IDM"

codex/librarian/janitor/integrity.py

@@ -11,7 +11,7 @@ from django.db.utils import OperationalError
 
 from codex.librarian.janitor.status import JanitorStatusTypes
 from codex.librarian.janitor.tasks import JanitorFTSRebuildTask
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.settings.settings import (
     CONFIG_PATH,
     CUSTOM_COVERS_DIR,

codex/librarian/janitor/status.py

@@ -1,9 +1,9 @@
 """Janitor Status Types."""
 
-from django.db.models import Choices
+from django.db.models import TextChoices
 
 
-class JanitorStatusTypes(Choices):
+class JanitorStatusTypes(TextChoices):
     """Janitor Status Types."""
 
     CLEANUP_FK = "JTD"

codex/librarian/search/status.py

@@ -1,9 +1,9 @@
 """Search Index Status Types."""
 
-from django.db.models import Choices
+from django.db.models import TextChoices
 
 
-class SearchIndexStatusTypes(Choices):
+class SearchIndexStatusTypes(TextChoices):
     """Search Index Status Types."""
 
     SEARCH_INDEX_CLEAR = "SIX"

codex/librarian/telemeter/stats.py

@@ -9,7 +9,7 @@ from caseconverter import snakecase
 from django.contrib.sessions.models import Session
 from django.db.models import Count
 
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.models import (
     Comic,
     Library,

codex/librarian/telemeter/telemeter.py

@@ -10,7 +10,6 @@ from requests import Session
 
 from codex.librarian.telemeter.stats import CodexStats
 from codex.models.admin import AdminFlag, Timestamp
-from codex.settings.settings import DEBUG
 
 # Version
 _APP_NAME = "codex"
@@ -43,23 +42,19 @@ def get_telemeter_timestamp():
     return ts
 
 
-def _post_stats(log, data):
+def _post_stats(data):
     """Post telemetry to endpoint."""
     data_json = json.dumps(data)
     json_bytes = data_json.encode()
     compressed_data = compress(json_bytes)
-    if DEBUG:
-        msg = f"{_POST} {len(compressed_data)}, {_HEADERS}, {_TIMEOUT}"
-        log.debug(msg)
-    else:
-        with Session() as session:
-            response = session.post(
-                _POST, data=compressed_data, headers=_HEADERS, timeout=_TIMEOUT
-            )
-            response.raise_for_status()
+    with Session() as session:
+        response = session.post(
+            _POST, data=compressed_data, headers=_HEADERS, timeout=_TIMEOUT
+        )
+        response.raise_for_status()
 
 
-def _send_telemetry(log):
+def _send_telemetry():
     """Send telemetry to server."""
     if not AdminFlag.objects.get(key=AdminFlag.FlagChoices.SEND_TELEMETRY.value).on:
         reason = "Send Telemetry flag is off."
@@ -67,13 +62,13 @@ def _send_telemetry(log):
     ts = get_telemeter_timestamp()
     stats = CodexStats().get()
     data = {"stats": stats, "uuid": ts.version}
-    _post_stats(log, data)
+    _post_stats(data)
     ts.save()  # update updated_at
 
 
 def send_telemetry(log):
     """Send anonymous telemetry during one window per week."""
     try:
-        _send_telemetry(log)
+        _send_telemetry()
     except Exception as exc:
         log.debug(f"Failed to send anonyomous stats: {exc}")

codex/librarian/watchdog/events.py

@@ -22,7 +22,7 @@ from watchdog.events import (
 )
 
 from codex.librarian.watchdog.tasks import WatchdogEventTask
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.logger_base import LoggerBaseMixin
 from codex.models import CustomCover
 from codex.settings.settings import CUSTOM_COVERS_DIR, CUSTOM_COVERS_GROUP_DIRS

codex/librarian/watchdog/observers.py

@@ -182,7 +182,7 @@ class LibraryPollingObserver(UatuMixin):
         """Put a dummy event on the queue that blocks forever."""
         # The global timeout is None because the emitters have their own
         # per watch timeout. This makes self.dispatch_events() block
-        # forever on the queue. Sending it an event lets it check the
+        # forever on the queue. Sending it an event makes it check the
         # shutdown event next.
         self.event_queue.put(self._SHUTDOWN_EVENT)
         super().on_thread_stop()

codex/librarian/watchdog/status.py

@@ -1,9 +1,9 @@
 """Watchdog Status Types."""
 
-from django.db.models import Choices
+from django.db.models import TextChoices
 
 
-class WatchdogStatusTypes(Choices):
+class WatchdogStatusTypes(TextChoices):
     """Watchdog Status Types."""
 
     POLL = "WPO"

codex/logger/{logging.py → logger.py}

@@ -20,7 +20,7 @@ class CodexQueueHandler(QueueHandler):
         super().enqueue(record)
 
 
-LOG_HANDLER = CodexQueueHandler(LOG_QUEUE)
+_LOG_HANDLER = CodexQueueHandler(LOG_QUEUE)
 
 
 def _ensure_handler(logger, queue):
@@ -33,7 +33,7 @@ def _ensure_handler(logger, queue):
             logger.removeHandler(handler)
 
     if not logger.handlers:
-        handler = LOG_HANDLER if queue == LOG_QUEUE else CodexQueueHandler(queue)
+        handler = _LOG_HANDLER if queue == LOG_QUEUE else CodexQueueHandler(queue)
         logger.addHandler(handler)
 
 

codex/logger_base.py

@@ -1,6 +1,6 @@
 """Class to run librarian tasks inline without a thread."""
 
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 
 
 class LoggerBaseMixin:

codex/middleware.py

@@ -5,7 +5,7 @@ from time import time
 from django.db import connection
 from django.utils import timezone
 
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.settings.settings import LOG_RESPONSE_TIME, SLOW_QUERY_LIMIT
 
 LOG = get_logger(__name__)

codex/migrations/0001_init.py

@@ -473,7 +473,7 @@ class Migration(migrations.Migration):
                     models.DecimalField(
                         db_index=True,
                         decimal_places=2,
-                        default=Decimal(0.0),
+                        default=Decimal("0.0"),
                         max_digits=6,
                     ),
                 ),

codex/migrations/0033_alter_librarianstatus_status_type.py

@@ -0,0 +1,68 @@
+"""Generated by Django 5.1.4 on 2024-12-21 03:50."""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migrate DB."""
+
+    dependencies = [
+        ("codex", "0032_alter_librarianstatus_preactive"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="librarianstatus",
+            name="status_type",
+            field=models.CharField(
+                choices=[
+                    ("CCC", "Create Covers"),
+                    ("CCD", "Purge Covers"),
+                    ("CFO", "Find Orphan"),
+                    ("IAF", "Adopt Folders"),
+                    ("ICC", "Covers Created"),
+                    ("ICD", "Covers Deleted"),
+                    ("ICL", "Covers Link"),
+                    ("ICM", "Covers Moved"),
+                    ("ICQ", "Query Missing Covers"),
+                    ("ICU", "Covers Modified"),
+                    ("IDD", "Dirs Deleted"),
+                    ("IDM", "Dirs Moved"),
+                    ("IDU", "Dirs Modified"),
+                    ("IFC", "Files Created"),
+                    ("IFD", "Files Deleted"),
+                    ("IFI", "Failed Imports"),
+                    ("IFM", "Files Moved"),
+                    ("IFU", "Files Modified"),
+                    ("IGU", "Group Update"),
+                    ("IMC", "Link M2M Fields"),
+                    ("IMQ", "Query M2M Fields"),
+                    ("ITC", "Create Fks"),
+                    ("ITQ", "Query Missing Fks"),
+                    ("ITR", "Aggregate Tags"),
+                    ("JCB", "Cleanup Bookmarks"),
+                    ("JCD", "Cleanup Covers"),
+                    ("JCR", "Codex Restart"),
+                    ("JCS", "Codex Stop"),
+                    ("JCU", "Codex Update"),
+                    ("JDB", "Db Backup"),
+                    ("JDO", "Db Optimize"),
+                    ("JFC", "Fts Integrity Check"),
+                    ("JFR", "Fts Rebuild"),
+                    ("JIC", "Integrity Check"),
+                    ("JIF", "Integrity Fk"),
+                    ("JLV", "Codex Latest Version"),
+                    ("JSD", "Cleanup Sessions"),
+                    ("JTD", "Cleanup Fk"),
+                    ("SIC", "Search Index Create"),
+                    ("SID", "Search Index Remove"),
+                    ("SIO", "Search Index Optimize"),
+                    ("SIU", "Search Index Update"),
+                    ("SIX", "Search Index Clear"),
+                    ("WPO", "Poll"),
+                ],
+                db_index=True,
+                max_length=3,
+            ),
+        ),
+    ]

codex/models/admin.py

@@ -9,7 +9,6 @@ from django.db.models import (
     CASCADE,
     BooleanField,
     CharField,
-    Choices,
     DateTimeField,
     OneToOneField,
     PositiveSmallIntegerField,
@@ -17,11 +16,7 @@ from django.db.models import (
 )
 from django.utils.translation import gettext_lazy as _
 
-from codex.librarian.covers.status import CoverStatusTypes
-from codex.librarian.importer.status import ImportStatusTypes
-from codex.librarian.janitor.status import JanitorStatusTypes
-from codex.librarian.search.status import SearchIndexStatusTypes
-from codex.librarian.watchdog.status import WatchdogStatusTypes
+from codex.choices.admin import ADMIN_STATUS_TITLES
 from codex.models.base import MAX_FIELD_LEN, MAX_NAME_LEN, BaseModel, max_choices_len
 
 __all__ = ("AdminFlag", "LibrarianStatus", "Timestamp", "UserActive")
@@ -30,7 +25,7 @@ __all__ = ("AdminFlag", "LibrarianStatus", "Timestamp", "UserActive")
 class AdminFlag(BaseModel):
     """Flags set by administrators."""
 
-    class FlagChoices(Choices):
+    class FlagChoices(TextChoices):
         """Choices for Admin Flags."""
 
         FOLDER_VIEW = "FV"
@@ -60,16 +55,12 @@ class AdminFlag(BaseModel):
 class LibrarianStatus(BaseModel):
     """Active Library Tasks."""
 
-    CHOICES = tuple(
-        CoverStatusTypes.choices
-        + ImportStatusTypes.choices
-        + JanitorStatusTypes.choices
-        + SearchIndexStatusTypes.choices
-        + WatchdogStatusTypes.choices
-    )
+    CHOICES = TextChoices("LibrarianStatusTypes", ADMIN_STATUS_TITLES.inverse)
 
     status_type = CharField(
-        db_index=True, max_length=max_choices_len(CHOICES), choices=CHOICES
+        db_index=True,
+        max_length=max_choices_len(CHOICES),
+        choices=CHOICES.choices,
     )
     subtitle = CharField(db_index=True, max_length=MAX_NAME_LEN)
     complete = PositiveSmallIntegerField(null=True, default=None)

codex/models/bookmark.py

@@ -6,9 +6,9 @@ from django.db.models import (
     CASCADE,
     BooleanField,
     CharField,
-    Choices,
     ForeignKey,
     PositiveSmallIntegerField,
+    TextChoices,
 )
 
 from codex.models.base import BaseModel, max_choices_len
@@ -49,7 +49,7 @@ def cascade_if_user_null(
 class Bookmark(BaseModel):
     """Persist user's bookmarks and settings."""
 
-    class FitTo(Choices):
+    class FitTo(TextChoices):
         """Identifiers for Readder fit_to choices."""
 
         SCREEN = "S"

codex/models/comic.py

@@ -6,12 +6,11 @@ import re
 from datetime import MAXYEAR, MINYEAR, date
 from pathlib import Path
 
-from comicbox.fields.enum import ReadingDirectionEnum
+from comicbox.fields.enum_fields import ReadingDirectionEnum
 from django.db.models import (
     CASCADE,
     BooleanField,
     CharField,
-    Choices,
     DateField,
     DateTimeField,
     DecimalField,
@@ -20,6 +19,7 @@ from django.db.models import (
     OneToOneField,
     PositiveIntegerField,
     PositiveSmallIntegerField,
+    TextChoices,
     TextField,
 )
 
@@ -59,7 +59,7 @@ from codex.models.named import (
 __all__ = ("Comic",)
 
 
-class ReadingDirection(Choices):
+class ReadingDirection(TextChoices):
     """Reading direction choices."""
 
     LTR = ReadingDirectionEnum.LTR.value
@@ -68,7 +68,7 @@ class ReadingDirection(Choices):
     BTT = ReadingDirectionEnum.BTT.value
 
 
-class FileType(Choices):
+class FileType(TextChoices):
     """Identifiers for file formats."""
 
     CBZ = "CBZ"

codex/models/groups.py

@@ -11,7 +11,7 @@ from codex.models.base import MAX_NAME_LEN, BaseModel
 from codex.models.paths import CustomCover, WatchedPath
 from codex.models.util import get_sort_name
 
-__all__ = ("BrowserGroupModel", "Publisher", "Imprint", "Series", "Volume", "Folder")
+__all__ = ("BrowserGroupModel", "Folder", "Imprint", "Publisher", "Series", "Volume")
 
 
 class BrowserGroupModel(BaseModel):

codex/models/named.py

@@ -14,9 +14,9 @@ from codex.models.groups import BrowserGroupModel
 __all__ = (
     "AgeRating",
     "Character",
+    "Contributor",
     "ContributorPerson",
     "ContributorRole",
-    "Contributor",
     "Country",
     "Genre",
     "Identifier",

codex/models/paths.py

@@ -3,8 +3,7 @@
 from pathlib import Path
 from types import MappingProxyType
 
-from django.db.models import CASCADE, CharField, ForeignKey, JSONField
-from django.db.models.enums import Choices
+from django.db.models import CASCADE, CharField, ForeignKey, JSONField, TextChoices
 
 from codex.models.base import MAX_NAME_LEN, BaseModel, max_choices_len
 from codex.models.library import MAX_PATH_LEN, Library
@@ -81,7 +80,7 @@ class FailedImport(WatchedPath):
 class CustomCover(WatchedPath):
     """Custom Cover Image."""
 
-    class GroupChoice(Choices):
+    class GroupChoice(TextChoices):
         """Reading direction choices."""
 
         P = "p"

codex/run.py

@@ -11,8 +11,8 @@ from hypercorn.asyncio import serve
 from codex.asgi import application
 from codex.librarian.librariand import LibrarianDaemon
 from codex.librarian.mp_queue import LIBRARIAN_QUEUE
+from codex.logger.logger import get_logger
 from codex.logger.loggerd import CodexLogQueueListener
-from codex.logger.logging import get_logger
 from codex.logger.mp_queue import LOG_QUEUE
 from codex.settings.settings import HYPERCORN_CONFIG
 from codex.signals.os_signals import RESTART_EVENT, SHUTDOWN_EVENT

codex/serializers/browser/mixins.py

@@ -12,7 +12,7 @@ from rest_framework.serializers import (
     SerializerMethodField,
 )
 
-from codex.logger.logging import get_logger
+from codex.logger.logger import get_logger
 from codex.serializers.fields.browser import TopGroupField
 from codex.util import max_none
 from codex.views.const import EPOCH_START