codex 1.7.14__py3-none-any.whl → 1.8.0a2__py3-none-any.whl

codex/models/__init__.py

@@ -4,6 +4,7 @@ from codex.models.admin import *
 from codex.models.bookmark import *
 from codex.models.comic import *
 from codex.models.groups import *
+from codex.models.identifier import *
 from codex.models.library import *
 from codex.models.named import *
 from codex.models.paths import *

codex/models/admin.py

@@ -15,8 +15,10 @@ from django.db.models import (
     TextChoices,
 )
 from django.utils.translation import gettext_lazy as _
+from typing_extensions import override
 
-from codex.choices.admin import ADMIN_STATUS_TITLES
+from codex.choices.admin import AdminFlagChoices
+from codex.choices.statii import ADMIN_STATUS_TITLES
 from codex.models.base import MAX_FIELD_LEN, MAX_NAME_LEN, BaseModel, max_choices_len
 
 __all__ = ("AdminFlag", "LibrarianStatus", "Timestamp", "UserActive")
@@ -25,23 +27,12 @@ __all__ = ("AdminFlag", "LibrarianStatus", "Timestamp", "UserActive")
 class AdminFlag(BaseModel):
     """Flags set by administrators."""
 
-    class FlagChoices(TextChoices):
-        """Choices for Admin Flags."""
-
-        FOLDER_VIEW = "FV"
-        REGISTRATION = "RG"
-        NON_USERS = "NU"
-        AUTO_UPDATE = "AU"
-        IMPORT_METADATA = "IM"
-        SEND_TELEMETRY = "ST"
-        BANNER_TEXT = "BT"
-
-    FALSE_DEFAULTS = frozenset({FlagChoices.AUTO_UPDATE})
+    FALSE_DEFAULTS = frozenset({AdminFlagChoices.AUTO_UPDATE})
 
     key = CharField(
         db_index=True,
-        max_length=max_choices_len(FlagChoices),
-        choices=FlagChoices.choices,
+        max_length=max_choices_len(AdminFlagChoices),
+        choices=AdminFlagChoices.choices,
     )
     on = BooleanField(default=True)
     value = CharField(max_length=MAX_NAME_LEN, default="", blank=True)
@@ -55,7 +46,7 @@ class AdminFlag(BaseModel):
 class LibrarianStatus(BaseModel):
     """Active Library Tasks."""
 
-    CHOICES = TextChoices("LibrarianStatusTypes", ADMIN_STATUS_TITLES.inverse)
+    CHOICES = TextChoices("LibrarianStatusTypes", ADMIN_STATUS_TITLES.inverse.items())
 
     status_type = CharField(
         db_index=True,
@@ -78,7 +69,7 @@ class LibrarianStatus(BaseModel):
 class Timestamp(BaseModel):
     """Timestamped Named Strings."""
 
-    class TimestampChoices(TextChoices):
+    class Choices(TextChoices):
         """Choices for Timestamps."""
 
         API_KEY = "AP", _("API Key")
@@ -88,8 +79,8 @@ class Timestamp(BaseModel):
 
     key = CharField(
         db_index=True,
-        max_length=max_choices_len(TimestampChoices),
-        choices=TimestampChoices.choices,
+        max_length=max_choices_len(Choices),
+        choices=Choices.choices,
     )
     version = CharField(max_length=MAX_FIELD_LEN, default="")
 
@@ -110,9 +101,10 @@ class Timestamp(BaseModel):
 
         unique_together = ("key",)
 
-    def __str__(self):
+    @override
+    def __repr__(self):
         """Print name for choice."""
-        return self.TimestampChoices(self.key).name
+        return self.Choices(self.key).name
 
 
 class UserActive(BaseModel):

codex/models/base.py

@@ -2,10 +2,12 @@
 
 from django.db.models import DateTimeField, Model
 from django.db.models.base import ModelBase
+from typing_extensions import override
 
+from codex.models.fields import CleaningCharField
 from codex.models.query import GroupByManager
 
-__all__ = ("BaseModel",)
+__all__ = ("BaseModel", "NamedModel")
 
 MAX_PATH_LEN = 4095
 MAX_NAME_LEN = 128
@@ -27,7 +29,7 @@ class BaseModel(Model):
     updated_at = DateTimeField(auto_now=True)
     objects = GroupByManager()
 
-    class Meta(ModelBase):  # type: ignore[reportIncompatibleVariableOverride]
+    class Meta(ModelBase):
         """Without this a real table is created and joined to."""
 
         # Model.Meta is not inheritable.
@@ -37,3 +39,20 @@ class BaseModel(Model):
 
     def presave(self):
         """Create values before save."""
+
+
+class NamedModel(BaseModel):
+    """A for simple named tables."""
+
+    name = CleaningCharField(db_index=True, max_length=MAX_NAME_LEN)
+
+    class Meta(BaseModel.Meta):
+        """Defaults to uniquely named, must be overridden."""
+
+        abstract = True
+        unique_together: tuple[str, ...] = ("name",)
+
+    @override
+    def __repr__(self):
+        """Return the name."""
+        return self.name

codex/models/comic.py

@@ -6,22 +6,21 @@ import re
 from datetime import MAXYEAR, MINYEAR, date
 from pathlib import Path
 
-from comicbox.fields.enum_fields import ReadingDirectionEnum
+from comicbox.enums.comicbox import FileTypeEnum, ReadingDirectionEnum
 from django.db.models import (
     CASCADE,
     BooleanField,
     CharField,
     DateField,
     DateTimeField,
-    DecimalField,
     ForeignKey,
     ManyToManyField,
     OneToOneField,
     PositiveIntegerField,
-    PositiveSmallIntegerField,
     TextChoices,
     TextField,
 )
+from typing_extensions import override
 
 from codex.models.base import (
     MAX_ISSUE_SUFFIX_LEN,
@@ -29,6 +28,12 @@ from codex.models.base import (
     BaseModel,
     max_choices_len,
 )
+from codex.models.fields import (
+    CleaningCharField,
+    CleaningTextField,
+    CoercingDecimalField,
+    CoercingPositiveSmallIntegerField,
+)
 from codex.models.groups import (
     Folder,
     Imprint,
@@ -37,13 +42,13 @@ from codex.models.groups import (
     Volume,
     WatchedPathBrowserGroup,
 )
+from codex.models.identifier import Identifier
 from codex.models.named import (
     AgeRating,
     Character,
-    Contributor,
     Country,
+    Credit,
     Genre,
-    Identifier,
     Language,
     Location,
     OriginalFormat,
@@ -54,6 +59,7 @@ from codex.models.named import (
     Tag,
     Tagger,
     Team,
+    Universe,
 )
 
 __all__ = ("Comic",)
@@ -71,10 +77,11 @@ class ReadingDirection(TextChoices):
 class FileType(TextChoices):
     """Identifiers for file formats."""
 
-    CBZ = "CBZ"
-    CBR = "CBR"
-    CBT = "CBT"
-    PDF = "PDF"
+    CBR = FileTypeEnum.CBR.value
+    CBZ = FileTypeEnum.CBZ.value
+    CBT = FileTypeEnum.CBT.value
+    CB7 = FileTypeEnum.CB7.value
+    PDF = FileTypeEnum.PDF.value
 
 
 class Comic(WatchedPathBrowserGroup):
@@ -92,15 +99,21 @@ class Comic(WatchedPathBrowserGroup):
     updated_at = DateTimeField(auto_now=True, db_index=True)
 
     # From WatchedPath, but interferes with related_name from folders m2m field
-    parent_folder = ForeignKey(
+    parent_folder: ForeignKey | None = ForeignKey(
         "Folder", on_delete=CASCADE, null=True, related_name="comic_in"
     )
 
     # Unique comic fields
-    issue_number = DecimalField(
+    collection_title = CleaningCharField(
+        db_index=True,
+        max_length=MAX_NAME_LEN,
+        default="",
+        db_collation="nocase",
+    )
+    issue_number = CoercingDecimalField(
         db_index=True, decimal_places=2, max_digits=10, null=True
     )
-    issue_suffix = CharField(
+    issue_suffix = CleaningCharField(
         db_index=True,
         max_length=MAX_ISSUE_SUFFIX_LEN,
         default="",
@@ -111,6 +124,7 @@ class Comic(WatchedPathBrowserGroup):
     series = ForeignKey(Series, db_index=True, on_delete=CASCADE)
     imprint = ForeignKey(Imprint, db_index=True, on_delete=CASCADE)
     publisher = ForeignKey(Publisher, db_index=True, on_delete=CASCADE)
+
     # Other FKs
     age_rating = ForeignKey(AgeRating, db_index=True, null=True, on_delete=CASCADE)
     original_format = ForeignKey(
@@ -118,31 +132,43 @@ class Comic(WatchedPathBrowserGroup):
     )
     scan_info = ForeignKey(ScanInfo, db_index=True, null=True, on_delete=CASCADE)
     tagger = ForeignKey(Tagger, db_index=True, null=True, on_delete=CASCADE)
+    main_character = ForeignKey(
+        Character,
+        db_index=True,
+        null=True,
+        on_delete=CASCADE,
+        related_name="main_character_in_comics",
+    )
+    main_team = ForeignKey(
+        Character,
+        db_index=True,
+        null=True,
+        on_delete=CASCADE,
+        related_name="main_team_in_comics",
+    )
+
     # Alpha2 codes
     country = ForeignKey(Country, db_index=True, null=True, on_delete=CASCADE)
     language = ForeignKey(Language, db_index=True, null=True, on_delete=CASCADE)
 
     # Date
-    year = PositiveSmallIntegerField(db_index=True, null=True)
-    month = PositiveSmallIntegerField(db_index=True, null=True)
-    day = PositiveSmallIntegerField(db_index=True, null=True)
+    year = CoercingPositiveSmallIntegerField(db_index=True, null=True)
+    month = CoercingPositiveSmallIntegerField(db_index=True, null=True)
+    day = CoercingPositiveSmallIntegerField(db_index=True, null=True)
 
     # Text
-    summary = TextField(default="", db_collation="nocase")
-    review = TextField(default="", db_collation="nocase")
-    notes = TextField(default="", db_collation="nocase")
+    summary = CleaningCharField(default="", db_collation="nocase")
+    review = CleaningTextField(default="", db_collation="nocase")
+    notes = CleaningTextField(default="", db_collation="nocase")
 
     # Ratings
-    community_rating = DecimalField(
-        db_index=True, decimal_places=2, max_digits=5, default=None, null=True
-    )
-    critical_rating = DecimalField(
+    critical_rating = CoercingDecimalField(
         db_index=True, decimal_places=2, max_digits=5, default=None, null=True
     )
 
     # Reader
-    page_count = PositiveSmallIntegerField(db_index=True, default=0)
-    reading_direction = CharField(
+    page_count = CoercingPositiveSmallIntegerField(db_index=True, default=0)
+    reading_direction = CleaningCharField(
         db_index=True,
         choices=ReadingDirection.choices,
         default=ReadingDirectionEnum.LTR.value,
@@ -155,7 +181,7 @@ class Comic(WatchedPathBrowserGroup):
 
     # ManyToMany
     characters = ManyToManyField(Character)
-    contributors = ManyToManyField(Contributor)
+    credits = ManyToManyField(Credit)
     genres = ManyToManyField(Genre)
     identifiers = ManyToManyField(Identifier)
     locations = ManyToManyField(Location)
@@ -164,6 +190,7 @@ class Comic(WatchedPathBrowserGroup):
     story_arc_numbers = ManyToManyField(StoryArcNumber)
     tags = ManyToManyField(Tag)
     teams = ManyToManyField(Team)
+    universes = ManyToManyField(Universe)
 
     #####################
     # Comicbox Ignored:
@@ -178,10 +205,10 @@ class Comic(WatchedPathBrowserGroup):
 
     # codex only
     date = DateField(db_index=True, null=True)
-    decade = PositiveSmallIntegerField(db_index=True, null=True)
+    decade = CoercingPositiveSmallIntegerField(db_index=True, null=True)
     folders = ManyToManyField(Folder)
     size = PositiveIntegerField(db_index=True)
-    file_type = CharField(
+    file_type = CleaningCharField(
         db_index=True,
         choices=FileType.choices,
         max_length=max_choices_len(FileType),
@@ -189,9 +216,10 @@ class Comic(WatchedPathBrowserGroup):
         default="",
         db_collation="nocase",
     )
+    metadata_mtime = DateTimeField(null=True)
 
     # Not useful
-    custom_cover = None
+    custom_cover: ForeignKey | None = None
 
     class Meta(WatchedPathBrowserGroup.Meta):
         """Constraints."""
@@ -218,6 +246,7 @@ class Comic(WatchedPathBrowserGroup):
         else:
             self.decade = self.year - (self.year % 10)
 
+    @override
     def presave(self):
         """Set computed values."""
         super().presave()
@@ -263,7 +292,7 @@ class Comic(WatchedPathBrowserGroup):
 
     @classmethod
     def get_title(
-        cls, obj, volume: bool, name: bool, filename_fallback: bool, zero_pad=None
+        cls, obj, *, volume: bool, name: bool, filename_fallback: bool, zero_pad=None
     ):
         """Create the comic title for display."""
         names = []
@@ -274,7 +303,8 @@ class Comic(WatchedPathBrowserGroup):
 
         # Volume
         if volume and (vn := obj.volume.name):
-            vn = Volume.to_str(vn)
+            vn_to = obj.volume.number_to
+            vn = Volume.to_str(vn, vn_to)
             names.append(vn)
 
         # Issue
@@ -291,7 +321,8 @@ class Comic(WatchedPathBrowserGroup):
             title = obj.get_filename()
         return title
 
-    def __str__(self):
+    @override
+    def __repr__(self):
         """Most common text representation for logging."""
         return self.get_title(self, volume=True, name=True, filename_fallback=True)
 
@@ -307,35 +338,41 @@ class Comic(WatchedPathBrowserGroup):
 
 class ComicFTS(BaseModel):
     comic = OneToOneField(primary_key=True, to=Comic, on_delete=CASCADE)
+    # Attributes
+    collection_title = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    issue = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    name = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    notes = TextField(db_collation="nocase")
+    review = TextField(db_collation="nocase")
+    summary = TextField(db_collation="nocase")
+    # FK groups
     publisher = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     imprint = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     series = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
-    volume = PositiveIntegerField()
-    issue = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
-    name = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    # FK
     age_rating = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     country = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    file_type = CharField(db_collation="nocase", max_length=max_choices_len(FileType))
     language = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
-    notes = TextField(db_collation="nocase")
     original_format = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
-    review = TextField(db_collation="nocase")
     scan_info = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
-    summary = TextField(db_collation="nocase")
     tagger = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    # M2M
     characters = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
-    contributors = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    credits = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     genres = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    identifiers = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    sources = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     locations = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    reading_direction = CharField(
+        db_collation="nocase", max_length=max_choices_len(ReadingDirection)
+    )
     series_groups = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     stories = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     story_arcs = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     tags = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
     teams = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
-
-    reading_direction = CharField(
-        db_collation="nocase", max_length=max_choices_len(ReadingDirection)
-    )
-    file_type = CharField(db_collation="nocase", max_length=max_choices_len(FileType))
+    universes = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
 
     class Meta(BaseModel.Meta):
         managed = False

codex/models/fields.py

@@ -0,0 +1,81 @@
+"""Custom Django fields."""
+
+from decimal import ROUND_DOWN, Decimal
+from html import unescape
+
+from django.db.models.fields import (
+    CharField,
+    DecimalField,
+    PositiveSmallIntegerField,
+    SmallIntegerField,
+    TextField,
+)
+from nh3 import clean
+from typing_extensions import override
+
+
+class CleaningStringFieldMixin:
+    """Sanitizing Mixin for CharField & TextField."""
+
+    def get_prep_value(self, value):
+        """Truncate, sanitize and unescape."""
+        if value := super().get_prep_value(value):  # pyright: ignore[reportAttributeAccessIssue]
+            value = value[: self.max_length]  # pyright: ignore[reportAttributeAccessIssue]
+            value = clean(value)
+            value = unescape(value)
+        return value
+
+
+class CleaningCharField(CleaningStringFieldMixin, CharField):
+    """Sanitizing Truncating CharField."""
+
+
+class CleaningTextField(CleaningStringFieldMixin, TextField):
+    """Sanitizing Truncating TextField."""
+
+
+class CoercingSmallIntegerFieldMixin:
+    """Custom IntegerField Mixin that coerces values into a range."""
+
+    COERCE_MIN: int = 2**15 * -1
+    COERCE_MAX: int = 2**15 - 1
+
+    def get_prep_value(self, value):
+        """Coerce int into range before insertion."""
+        value = super().get_prep_value(value)  # pyright: ignore[reportAttributeAccessIssue]
+        if value is not None:
+            value = max(min(value, self.COERCE_MAX), self.COERCE_MIN)
+        return value
+
+
+class CoercingSmallIntegerField(CoercingSmallIntegerFieldMixin, SmallIntegerField):
+    """Custom SmallIntegerField."""
+
+
+class CoercingPositiveSmallIntegerField(
+    CoercingSmallIntegerFieldMixin, PositiveSmallIntegerField
+):
+    """Custom PositiveSmallIntegerField."""
+
+    COERCE_MIN: int = 0
+
+
+class CoercingDecimalField(DecimalField):
+    """Custom DecimalField."""
+
+    def __init__(self, *args, **kwargs):
+        """Init coercing values."""
+        super().__init__(*args, **kwargs)
+        self._quantize_str = Decimal(f"1e-{self.decimal_places}")
+        self._decimal_max = Decimal(10 ** (self.max_digits - 2) - 1)
+
+    @override
+    def get_prep_value(self, value):
+        """Coerce Decimal."""
+        prepped_value: Decimal | None = super().get_prep_value(value)
+        if prepped_value is not None:
+            prepped_value = prepped_value.quantize(
+                self._quantize_str, rounding=ROUND_DOWN
+            )
+            prepped_value = prepped_value.min(self._decimal_max)
+        return prepped_value

codex/models/functions.py

@@ -2,10 +2,13 @@
 
 from django.db.models.aggregates import Aggregate
 from django.db.models.expressions import Func
-from django.db.models.fields import CharField, FloatField, TextField
+from django.db.models.fields import CharField, FloatField
 from django.db.models.fields.json import JSONField
 from django.db.models.fields.related import OneToOneField
 from django.db.models.lookups import Lookup
+from typing_extensions import override
+
+from codex.models.fields import CleaningCharField, CleaningTextField
 
 
 class JsonGroupArray(Aggregate):
@@ -40,6 +43,7 @@ class FTS5Match(Lookup):
 
     lookup_name = "match"
 
+    @override
     def as_sql(self, compiler, connection):
         """Generate MATCH sql."""
         rhs, rhs_params = self.process_rhs(compiler, connection)
@@ -51,12 +55,14 @@ class FTS5Match(Lookup):
 
 
 @CharField.register_lookup
-@TextField.register_lookup
+@CleaningCharField.register_lookup
+@CleaningTextField.register_lookup
 class Like(Lookup):
     """SQL LIKE lookup."""
 
     lookup_name = "like"
 
+    @override
     def as_sql(self, compiler, connection):
         """Generate LIKE sql."""
         lhs, lhs_params = self.process_lhs(compiler, connection)