codex 1.4.0a0__py3-none-any.whl → 1.4.1__py3-none-any.whl

codex/logger/loggerd.py

@@ -41,7 +41,7 @@ class CodexLogQueueListener(QueueListener):
     _LOG_FMT = "{asctime} {levelname:7} {message}"
     _DEBUG_LOG_FMT = "{asctime} {levelname:7} {name:25} {message}"
     _DATEFMT = "%Y-%m-%d %H:%M:%S %Z"
-    _FORMATTER_KWARGS = {"style": "{", "datefmt": _DATEFMT}
+    _FORMATTER_STYLE = "{"
     _LOG_PATH = LOG_DIR / "codex.log"
     _LOG_MAX_BYTES = 10 * 1024 * 1024
 
@@ -54,7 +54,9 @@ class CodexLogQueueListener(QueueListener):
             handler = RotatingFileHandler(
                 cls._LOG_PATH, maxBytes=cls._LOG_MAX_BYTES, backupCount=30, delay=True
             )
-            formatter = logging.Formatter(fmt, **cls._FORMATTER_KWARGS)
+            formatter = logging.Formatter(
+                fmt, style=cls._FORMATTER_STYLE, datefmt=cls._DATEFMT
+            )
             handler.setFormatter(formatter)
         except Exception as exc:
             print("ERROR creating file logging handler", exc)
@@ -66,7 +68,9 @@ class CodexLogQueueListener(QueueListener):
         handler = None
         try:
             handler = logging.StreamHandler()
-            formatter = ColorFormatter(fmt, **cls._FORMATTER_KWARGS)
+            formatter = ColorFormatter(
+                fmt, style=cls._FORMATTER_STYLE, datefmt=cls._DATEFMT
+            )
             handler.setFormatter(formatter)
         except Exception as exc:
             print("ERROR creating console logging handler", exc)

codex/logger/logging.py

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

codex/migrations/0024_comic_gtin_comic_story_arc_number.py

@@ -0,0 +1,24 @@
+"""Generated by Django 4.2.1 on 2023-05-10 22:44."""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Add fields."""
+
+    dependencies = [
+        ("codex", "0023_rename_credit_creator_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="comic",
+            name="gtin",
+            field=models.CharField(db_index=True, default="", max_length=32),
+        ),
+        migrations.AddField(
+            model_name="comic",
+            name="story_arc_number",
+            field=models.PositiveSmallIntegerField(db_index=True, null=True),
+        ),
+    ]

codex/migrations/0025_add_story_arc_number.py

@@ -0,0 +1,83 @@
+"""Generated by Django 4.2.1 on 2023-05-17 19:22."""
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def _create_story_arc_numbers(apps, _schema_editor):
+    comic_model = apps.get_model("codex", "comic")
+    san_model = apps.get_model("codex", "StoryArcNumber")
+    num_sans = 0
+
+    comics = comic_model.objects.exclude(story_arcs=None)
+    print()
+    print(f"Comics with story arcs: {comics.count()}")
+    # Create a StoryArcNumber for each comic
+    for comic in comics:
+        sans = set()
+        first_done = False
+        for sa in comic.story_arcs.all():
+            number = None if first_done else comic.story_arc_number
+            kwargs = {"story_arc": sa, "number": number}
+            san, created = san_model.objects.get_or_create(defaults=kwargs, **kwargs)
+            num_sans += int(created)
+            sans.add(san)
+            first_done = True
+        comic.story_arc_numbers.add(*sans)
+        comic.save()
+
+    num_sas = apps.get_model("codex", "StoryArc").objects.count()
+    print(f"Created {num_sans} StoryArcNumbers for {num_sas} StoryArcs")
+
+
+class Migration(migrations.Migration):
+    """Run Migrations."""
+
+    dependencies = [
+        ("codex", "0024_comic_gtin_comic_story_arc_number"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="StoryArcNumber",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("number", models.PositiveIntegerField(default=None, null=True)),
+                (
+                    "story_arc",
+                    models.ForeignKey(
+                        db_index=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="codex.storyarc",
+                    ),
+                ),
+            ],
+        ),
+        migrations.AlterUniqueTogether(
+            name="storyarcnumber",
+            unique_together={("story_arc", "number")},
+        ),
+        migrations.AddField(
+            model_name="comic",
+            name="story_arc_numbers",
+            field=models.ManyToManyField(to="codex.storyarcnumber"),
+        ),
+        migrations.RunPython(_create_story_arc_numbers),
+        migrations.RemoveField(
+            model_name="comic",
+            name="story_arc_number",
+        ),
+        migrations.RemoveField(
+            model_name="comic",
+            name="story_arcs",
+        ),
+    ]

codex/models.py

@@ -199,10 +199,22 @@ class SeriesGroup(NamedModel):
     """A series group the series is part of."""
 
 
-class StoryArc(NamedModel):
+class StoryArc(NamedModel, BrowserGroupModel):
     """A story arc the comic is part of."""
 
 
+class StoryArcNumber(BaseModel):
+    """A story arc number the comic represents."""
+
+    story_arc = ForeignKey(StoryArc, db_index=True, on_delete=CASCADE)
+    number = PositiveIntegerField(null=True, default=None)
+
+    class Meta:
+        """Declare constraints and indexes."""
+
+        unique_together = ("story_arc", "number")
+
+
 class Location(NamedModel):
     """A location that appears in the comic."""
 
@@ -343,13 +355,15 @@ class Comic(WatchedPath):
     read_ltr = BooleanField(db_index=True, default=True)
     scan_info = CharField(max_length=MAX_NAME_LEN, default="")
     web = URLField(default="")
+    gtin = CharField(db_index=True, max_length=MAX_FIELD_LEN, default="")
+
     # ManyToMany
     characters = ManyToManyField(Character)
     creators = ManyToManyField(Creator)
     genres = ManyToManyField(Genre)
     locations = ManyToManyField(Location)
     series_groups = ManyToManyField(SeriesGroup)
-    story_arcs = ManyToManyField(StoryArc)
+    story_arc_numbers = ManyToManyField(StoryArcNumber)
     tags = ManyToManyField(Tag)
     teams = ManyToManyField(Team)
     # Ignore these, they seem useless:
@@ -465,18 +479,14 @@ class Comic(WatchedPath):
         return title
 
     @classmethod
-    def get_filename(cls, obj, issue_max=None):
+    def get_filename(cls, obj):
         """Get the fileaname from dict."""
-        fn = cls.get_title(obj, issue_max=issue_max)
-        ft = obj.file_type or "cbz"
-        fn += "." + ft.lower()
-        return fn
+        path = Path(obj.path)
+        return path.stem + path.suffix
 
-    def filename(self, issue_max=None):
+    def filename(self):
         """Create a filename for download."""
-        self.series_name = self.series.name
-        self.volume_name = self.volume.name
-        return self.get_filename(self, issue_max)
+        return self.get_filename(self)
 
     def __str__(self):
         """Most common text representation for logging."""

codex/search/backend.py

@@ -155,7 +155,7 @@ class CodexSearchBackend(WhooshSearchBackend, WorkerBaseMixin):
         "genres",
         "locations",
         "series_groups",
-        "story_arcs",
+        "story_arc_numbers__story_arc",
         "tags",
         "teams",
         "creators__person",

codex/search/indexes.py

@@ -21,7 +21,7 @@ class ComicIndex(ModelSearchIndex, Indexable):
     locations = CharField(model_attr="locations__name", null=True)
     series_groups = CharField(model_attr="series_groups__name", null=True)
     story_arcs = CharField(
-        model_attr="story_arcs__name",
+        model_attr="story_arc_numbers__story_arc__name",
         null=True,
     )
     tags = CharField(model_attr="tags__name", null=True)

codex/serializers/browser.py

@@ -162,6 +162,7 @@ class BrowserSettingsSerializer(Serializer):
     twenty_four_hour_time = BooleanField(required=False)
     top_group = ChoiceField(choices=tuple(CHOICES["topGroup"].keys()), required=False)
     opds_metadata = BooleanField(required=False)
+    limit = IntegerField(required=False)
 
 
 class BrowserCardSerializer(BrowserAggregateSerializerMixin):

codex/serializers/metadata.py

@@ -2,7 +2,7 @@
 from rest_framework.serializers import CharField, IntegerField
 
 from codex.serializers.mixins import BrowserAggregateSerializerMixin
-from codex.serializers.models import ComicSerializer
+from codex.serializers.models import ComicSerializer, StoryArcSerializer
 
 
 class MetadataSerializer(BrowserAggregateSerializerMixin, ComicSerializer):
@@ -12,3 +12,7 @@ class MetadataSerializer(BrowserAggregateSerializerMixin, ComicSerializer):
     parent_folder_pk = IntegerField(read_only=True, required=False)
     series_volume_count = IntegerField(read_only=True)
     volume_issue_count = IntegerField(read_only=True)
+    story_arcs = StoryArcSerializer(
+        many=True,
+        allow_null=True,
+    )

codex/serializers/models.py

@@ -24,6 +24,7 @@ from codex.models import (
     Series,
     SeriesGroup,
     StoryArc,
+    StoryArcNumber,
     Tag,
     Team,
     Volume,
@@ -233,6 +234,20 @@ class StoryArcSerializer(NamedModelSerializer):
         model = StoryArc
 
 
+class StoryArcNumberSerializer(Serializer):
+    """StoryArc model."""
+
+    story_arc = StoryArcSerializer()
+    number = IntegerField(read_only=True, allow_null=True)
+
+    class Meta(NamedModelMeta):
+        """Configure model."""
+
+        model = StoryArcNumber
+        fields = ("pk", "story_arc", "number")
+        depth = 1
+
+
 class TagSerializer(NamedModelSerializer):
     """Tag model."""
 
@@ -276,7 +291,7 @@ class ComicSerializer(ModelSerializer):
     genres = GenreSerializer(many=True, allow_null=True)
     locations = LocationSerializer(many=True, allow_null=True)
     series_groups = SeriesGroupSerializer(many=True, allow_null=True)
-    story_arcs = StoryArcSerializer(
+    story_arc_numbers = StoryArcNumberSerializer(
         many=True,
         allow_null=True,
     )

codex/serializers/opds/v1.py

@@ -60,6 +60,7 @@ class OPDS1TemplateSerializer(Serializer):
     """OPDS Browser Template Serializer."""
 
     opds_ns = CharField(read_only=True)
+    is_acquisition = BooleanField(read_only=True)
     id_tag = CharField(read_only=True)
     title = CharField(read_only=True)
     updated = DateTimeField(read_only=True, default_timezone=UTC_TZ)

codex/serializers/opds/v2.py

@@ -1,4 +1,6 @@
 """OPDS 2 Serializers."""
+from typing import Optional
+
 from rest_framework.fields import (
     BooleanField,
     CharField,
@@ -59,7 +61,7 @@ class OPDS2LinkSerializer(Serializer):
     children = CharListField(read_only=True, required=False)
     properties = OPDS2LinkPropertiesSerializer(read_only=True, required=False)
 
-    def get_rel(self, obj):
+    def get_rel(self, obj) -> Optional[str]:
         """Allow for CharField or CharListField types."""
         rel = obj.get("rel")
         if not isinstance(rel, (list, str)):
@@ -118,7 +120,8 @@ class OPDS2PublicationMetadataSerializer(OPDS2MetadataSerializer):
     https://readium.org/webpub-manifest/schema/metadata.schema.json
     """
 
-    # type = CharField(read_only=True, required=False) # TODO @type
+    # possibly change to @ on output if this is really needed
+    # @type = CharField(read_only=True, required=False)
     publisher = CharField(read_only=True, required=False)
     imprint = CharField(read_only=True, required=False)
     language = CharField(read_only=True, required=False)

codex/serializers/reader.py

@@ -25,27 +25,66 @@ class ReaderSettingsSerializer(Serializer):
     vertical = BooleanField(allow_null=True, required=False)
 
 
+class ReaderArcSerializer(Serializer):
+    """A group of comics or a story arc."""
+
+    group = CharField(read_only=True)
+    pk = IntegerField(read_only=True)
+    name = CharField(read_only=True)
+
+
 class ReaderComicSerializer(Serializer):
-    """Components for constructing the title."""
+    """Prev, Next and Current Comic info."""
 
     pk = IntegerField(read_only=True)
-    file_type = CharField(read_only=True)
-    issue = DecimalField(
-        max_digits=None, decimal_places=3, read_only=True, coerce_to_string=False
-    )
-    issue_suffix = CharField(read_only=True)
-    issue_count = IntegerField(read_only=True)
+    settings = ReaderSettingsSerializer(read_only=True)
     max_page = IntegerField(read_only=True)
-    series_name = CharField(read_only=True)
-    volume_name = CharField(read_only=True)
-    series_index = IntegerField(read_only=True)
     read_ltr = BooleanField(allow_null=True, read_only=True)
-    settings = ReaderSettingsSerializer(read_only=True)
-    filename = CharField(read_only=True)
 
 
-class ReaderInfoSerializer(Serializer):
-    """Information about the series this comic belongs to."""
+class ReaderCurrentArcSerializer(Serializer):
+    """Information about the current Arc."""
+
+    group = CharField(read_only=True)
+    pk = IntegerField(read_only=True)
+    index = IntegerField(read_only=True)
+    count = IntegerField(read_only=True, required=False)
+
+
+class ReaderCurrentComicSerializer(ReaderComicSerializer):
+    """Current comic only Serializer."""
+
+    # For title
+    series_name = CharField(read_only=True, required=False)
+    volume_name = CharField(read_only=True, required=False)
+    issue = DecimalField(
+        max_digits=None,
+        decimal_places=3,
+        read_only=True,
+        coerce_to_string=False,
+        required=False,
+    )
+    issue_suffix = CharField(read_only=True, required=False)
+    issue_count = IntegerField(
+        read_only=True,
+        required=False,
+    )
+
+    file_type = CharField(read_only=True, required=False)
+    filename = CharField(read_only=True, required=False)
+
+
+class ReaderBooksSerializer(Serializer):
+    """All comics relevant to the reader."""
+
+    current = ReaderCurrentComicSerializer(read_only=True)
+    prev_book = ReaderComicSerializer(read_only=True, required=False)
+    next_book = ReaderComicSerializer(read_only=True, required=False)
+
+
+class ReaderComicsSerializer(Serializer):
+    """Books and arcs."""
 
-    books = ReaderComicSerializer(many=True, read_only=True)
-    series_count = IntegerField(read_only=True)
+    books = ReaderBooksSerializer(read_only=True)
+    arcs = ReaderArcSerializer(many=True, read_only=True)
+    arc = ReaderCurrentArcSerializer(read_only=True)

codex/settings/settings.py

@@ -181,7 +181,7 @@ PORT = int(HYPERCORN_CONFIG.bind[0].split(":")[1])
 
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/dev/howto/static-files/
-# WHITENOISE_KEEP_ONLY_HASHED_FILES is not usable with vite chunking
+# WHITENOISE_KEEP_ONLY_HASHED_FILES is still not usable with vite chunking
 WHITENOISE_STATIC_PREFIX = "static/"
 WHITENOISE_IMMUTABLE_FILE_TEST = immutable_file_test
 STATIC_ROOT = CODEX_PATH / "static_root"