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

codex/views/reader/page.py

@@ -14,7 +14,8 @@ from codex.librarian.mp_queue import LIBRARIAN_QUEUE
 from codex.logger.logging import get_logger
 from codex.models.comic import Comic, FileType
 from codex.settings.settings import FALSY
-from codex.views.bookmark import BookmarkBaseView
+from codex.views.auth import AuthFilterAPIView
+from codex.views.bookmark import BookmarkAuthMixin
 from codex.views.util import chunker
 
 LOG = get_logger(__name__)
@@ -31,23 +32,23 @@ class IgnoreClientContentNegotiation(BaseContentNegotiation):
         """Select the first parser in the `.parser_classes` list."""
         return next(iter(parsers))
 
-    def select_renderer(  # type: ignore
+    def select_renderer(
         self,
         request,  # noqa: ARG002
         renderers,
-        _format_suffix="",
+        format_suffix="",  # noqa: ARG002, F841, RUF100
     ):
         """Select the first renderer in the `.renderer_classes` list."""
         renderer = next(iter(renderers))
         return (renderer, renderer.media_type)
 
 
-class ReaderPageView(BookmarkBaseView):
+class ReaderPageView(BookmarkAuthMixin, AuthFilterAPIView):
     """Display a comic page from the archive itself."""
 
     X_MOZ_PRE_HEADERS = frozenset({"prefetch", "preload", "prerender", "subresource"})
     content_type = "image/jpeg"
-    content_negotiation_class = IgnoreClientContentNegotiation  # type: ignore
+    content_negotiation_class = IgnoreClientContentNegotiation  # type: ignore[reportAssignmentType]
 
     def _update_bookmark(self):
         """Update the bookmark if the bookmark param was passed."""
@@ -59,31 +60,35 @@ class ReaderPageView(BookmarkBaseView):
             return
 
         auth_filter = self.get_bookmark_auth_filter()
-        pk = self.kwargs.get("pk")
-        comic_filter = {"pk": pk}
+        comic_pks = (self.kwargs.get("pk"),)
         page = self.kwargs.get("page")
         updates = {"page": page}
 
-        task = BookmarkUpdateTask(auth_filter, comic_filter, updates)
+        task = BookmarkUpdateTask(auth_filter, comic_pks, updates)
         LIBRARIAN_QUEUE.put(task)
 
     def _get_page_image(self):
         """Get the image data and content type."""
+        # Get comic - Distinct is important
         group_acl_filter = self.get_group_acl_filter(Comic, self.request.user)
+        qs = Comic.objects.filter(group_acl_filter).only("path", "file_type").distinct()
         pk = self.kwargs.get("pk")
-        comic = Comic.objects.filter(group_acl_filter).only("path").get(pk=pk)
+        comic = qs.get(pk=pk)
+
+        # page_image
         page = self.kwargs.get("page")
         to_pixmap = self.request.GET.get("pixmap", "").lower() not in FALSY
-        if comic.file_type == FileType.PDF.value and not to_pixmap:
-            content_type = _PDF_MIME_TYPE
-        else:
-            content_type = self.content_type
-
         with Comicbox(comic.path) as cb:
             page_image = cb.get_page_by_index(page, to_pixmap=to_pixmap)
         if not page_image:
             page_image = b""
 
+        # content type
+        if comic.file_type == FileType.PDF.value and not to_pixmap:
+            content_type = _PDF_MIME_TYPE
+        else:
+            content_type = self.content_type
+
         return page_image, content_type
 
     @extend_schema(

codex/views/reader/params.py

@@ -3,12 +3,12 @@
 from types import MappingProxyType
 from typing import Any
 
-from codex.choices import mapping_to_dict
 from codex.logger.logging import get_logger
 from codex.models import Comic
 from codex.serializers.reader import (
     ReaderViewInputSerializer,
 )
+from codex.util import mapping_to_dict
 from codex.views.const import FOLDER_GROUP, GROUP_RELATION, STORY_ARC_GROUP
 from codex.views.session import SessionView
 from codex.views.util import reparse_json_query_params
@@ -121,9 +121,9 @@ class ReaderParamsView(SessionView):
                 serializer = self.input_serializer_class(data=data)
                 serializer.is_valid(raise_exception=True)
 
-                params: dict = mapping_to_dict(_DEFAULT_PARAMS)  # type: ignore
+                params: dict[str, Any] = mapping_to_dict(_DEFAULT_PARAMS)  # type: ignore[reportAssignmentType]
                 if serializer.validated_data:
-                    params.update(serializer.validated_data)  # type: ignore
+                    params.update(serializer.validated_data)
                 self._ensure_arc_contains_comic(params)
                 self._ensure_arc(params)
 

codex/views/reader/reader.py

@@ -58,7 +58,7 @@ class ReaderView(ReaderArcsView):
             task = LazyImportComicsTask(frozenset(import_pks))
             LIBRARIAN_QUEUE.put(task)
 
-    def get_object(self):  # type: ignore
+    def get_object(self):
         """Get the previous and next comics in a group or story arc."""
         # Books
         books = self.get_book_collection()
@@ -82,13 +82,13 @@ class ReaderView(ReaderArcsView):
 
         arc = self.params.get("arc", {})
         if not arc.get("group"):
-            arc["group"] = current.arc_group  # type: ignore
+            arc["group"] = current.arc_group
         if not arc.get("pks"):
-            arc["pks"] = (current.arc_pk,)  # type: ignore
-        arc["index"] = current.arc_index  # type:ignore
-        arc["count"] = current.arc_count  # type: ignore
+            arc["pks"] = (current.arc_pk,)
+        arc["index"] = current.arc_index
+        arc["count"] = current.arc_count
 
-        close_route = self.get_last_route()
+        close_route = self.get_last_route(name=True)
 
         return {
             "books": books,

codex/views/reader/settings.py

@@ -7,6 +7,6 @@ from codex.views.settings import SettingsView
 class ReaderSettingsView(SettingsView):
     """Get Reader Settings."""
 
-    serializer_class = ReaderSettingsSerializer  # type: ignore
+    serializer_class = ReaderSettingsSerializer
 
     SESSION_KEY = "reader"

codex/views/session.py

@@ -3,12 +3,17 @@
 from abc import ABC
 from copy import deepcopy
 from types import MappingProxyType
+from typing import TYPE_CHECKING
 
-from codex.choices import BROWSER_DEFAULTS, READER_DEFAULTS, mapping_to_dict
+from codex.choices import BROWSER_DEFAULTS, READER_DEFAULTS
 from codex.logger.logging import get_logger
+from codex.util import mapping_to_dict
 from codex.views.auth import AuthFilterGenericAPIView
 from codex.views.util import pop_name
 
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
 LOG = get_logger(__name__)
 
 CONTRIBUTOR_PERSON_UI_FIELD = "contributors"
@@ -77,13 +82,15 @@ class SessionView(AuthFilterGenericAPIView, ABC):
             default = self.SESSION_DEFAULTS[session_key][key]
         return session.get(key, default)
 
-    def get_last_route(self, name=True):
+    def get_last_route(self, name: bool):
         """Get the last route from the breadcrumbs."""
         breadcrumbs = self.get_from_session(
             "breadcrumbs", session_key=self.BROWSER_SESSION_KEY
         )
         if not breadcrumbs:
-            default_breadcrumbs: tuple[dict] = BROWSER_DEFAULTS["breadcrumbs"]  # type: ignore
+            default_breadcrumbs: tuple[
+                Mapping[str, str | tuple[int, ...] | int], ...
+            ] = BROWSER_DEFAULTS["breadcrumbs"]  # type: ignore[reportAssignmentType]
             breadcrumbs = default_breadcrumbs
         last_route = breadcrumbs[-1]
         if not name:

codex/views/settings.py

@@ -29,7 +29,7 @@ class SettingsView(SessionView, ABC):
         serializer = self.input_serializer_class(data=data)
         serializer.is_valid(raise_exception=True)
         validated_data = serializer.validated_data
-        only = validated_data.get("only") if validated_data else None  # type: ignore
+        only = validated_data.get("only") if validated_data else None
         params = self.load_params_from_session(only=only)
         params = self.validate_settings_get(validated_data, params)
         serializer = self.get_serializer(params)
@@ -38,7 +38,7 @@ class SettingsView(SessionView, ABC):
     @extend_schema(responses=None)
     def patch(self, *args, **kwargs):
         """Update session settings."""
-        data = self.request.data  # type: ignore
+        data = self.request.data
         serializer = self.get_serializer(data=data)
         serializer.is_valid(raise_exception=True)
         params = self.load_params_from_session()

codex/views/timezone.py

@@ -28,11 +28,11 @@ class TimezoneView(AuthGenericAPIView):
     @extend_schema(request=input_serializer_class)
     def put(self, *args, **kwargs):
         """Get the user info for the current user."""
-        data = self.request.data  # type: ignore
+        data = self.request.data
         serializer = self.input_serializer_class(data=data)
         serializer.is_valid(raise_exception=True)
         try:
-            timezone = serializer.validated_data.get("timezone")  # type: ignore
+            timezone = serializer.validated_data.get("timezone")
             self._save_timezone(timezone)
         except Exception as exc:
             reason = f"update user timezone {exc}"

codex/views/util.py

@@ -5,6 +5,7 @@ from collections.abc import Mapping
 from contextlib import suppress
 from dataclasses import asdict, dataclass
 from json.decoder import JSONDecodeError
+from typing import Any
 from urllib.parse import unquote_plus
 
 from djangorestframework_camel_case.settings import api_settings
@@ -43,7 +44,7 @@ class Route(dict):
     dict = asdict
 
 
-def reparse_json_query_params(query_params, keys) -> dict:
+def reparse_json_query_params(query_params, keys) -> dict[str, Any]:
     """Reparse JSON encoded query_params."""
     # It is an unbelievable amount of trouble to try to parse axios native bracket
     # encoded complex objects in python
@@ -57,7 +58,7 @@ def reparse_json_query_params(query_params, keys) -> dict:
             parsed_value = value
 
         parsed_dict[key] = parsed_value
-    return dict(underscoreize(parsed_dict, **api_settings.JSON_UNDERSCOREIZE))  # type:ignore
+    return dict(underscoreize(parsed_dict, **api_settings.JSON_UNDERSCOREIZE))  # type:ignore[reportReturnType]
 
 
 def pop_name(kwargs: Mapping):
@@ -67,11 +68,11 @@ def pop_name(kwargs: Mapping):
     return kwargs
 
 
-async def chunker(open_file, chunk_size=DEFAULT_CHUNK_SIZE):
+def chunker(open_file, chunk_size=DEFAULT_CHUNK_SIZE):
     """Asynchronous iterator for serving files."""
-    while True:
-        chunk = open_file.read(chunk_size)
-        if not chunk:
-            open_file.close()
-            break
-        yield chunk
+    with open_file:
+        while True:
+            if chunk := open_file.read(chunk_size):
+                yield chunk
+            else:
+                break

codex/views/version.py

@@ -15,7 +15,7 @@ class VersionView(AuthGenericAPIView):
 
     serializer_class = VersionsSerializer
 
-    def get_object(self) -> dict[str, str]:  # type: ignore
+    def get_object(self) -> dict[str, str]:
         """Get the versions."""
         ts = Timestamp.objects.get(key=Timestamp.TimestampChoices.CODEX_VERSION.value)
         if ts.version:

{codex-1.7.1.dist-info → codex-1.7.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.7.1
+Version: 1.7.3
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -20,10 +20,11 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Multimedia :: Graphics :: Viewers
-Requires-Dist: Pillow (>=10.0.0,<11.0.0)
+Requires-Dist: Pillow (>=11.0.0,<12.0.0)
 Requires-Dist: aioprocessing (>=2.0.1,<3.0.0)
 Requires-Dist: ansicolors (>=1.1,<2.0)
 Requires-Dist: bidict (>=0.23.1,<0.24.0)
@@ -52,6 +53,7 @@ Requires-Dist: versio (>=0.5.0,<0.6.0)
 Requires-Dist: watchdog (>=5.0.2,<6.0.0)
 Requires-Dist: websocket_client (>=1.2,<2.0)
 Requires-Dist: whitenoise[brotli] (>=6.0,<7.0)
+Requires-Dist: zipstream-ng (>=1.8.0,<2.0.0)
 Project-URL: Documentation, https://github.com/ajslater/codex
 Project-URL: Docker Image, https://hub.docker.com/r/ajslater/codex
 Project-URL: News, https://github.com/ajslater/codex/blob/main/NEWS.md
@@ -142,8 +144,6 @@ before installing Codex.
 
 ...and Ubuntu, Mint, MX, Window Subsystem for Linux, and others.
 
-<!-- eslint-skip -->
-
 ```sh
 apt install build-essential libimagequant0 libjpeg-turbo8 libopenjp2-7 libssl libyaml-0-2 libtiff6 libwebp7 python3-dev python3-pip mupdf sqlite3 unrar zlib1g
 ```
@@ -153,16 +153,12 @@ and versions of your distribution. If the package versions listed in the example
 above are not available, try searching for ones that are with `apt-cache` or
 `aptitude`.
 
-<!-- eslint-skip -->
-
 ```sh
 apt-cache search libjpeg-turbo
 ```
 
 ###### <a href="alpine">Alpine</a> Dependencies
 
-<!-- eslint-skip -->
-
 ```sh
 apk add bsd-compat-headers build-base jpeg-dev libffi-dev libwebp openssl-dev sqlite yaml-dev zlib-dev
 ```
@@ -179,8 +175,6 @@ Unrar as packaged for Alpine Linux v3.14 seems to work on Alpine v3.15+
 
 Using [Homebrew](https://brew.sh/):
 
-<!-- eslint-skip -->
-
 ```sh
 brew install jpeg libffi libyaml libzip openssl python sqlite unrar webp
 ```
@@ -198,8 +192,6 @@ Dependencies Installation Document</a>.
 Once you have installed codex, the codex binary should be on your path. To start
 codex, run:
 
-<!-- eslint-skip -->
-
 ```sh
 codex
 ```
@@ -245,16 +237,12 @@ If you forget all your superuser passwords, you may restore the original default
 admin account by running codex with the `CODEX_RESET_ADMIN` environment variable
 set.
 
-<!-- eslint-skip -->
-
 ```sh
 CODEX_RESET_ADMIN=1 codex
 ```
 
 or, if using Docker:
 
-<!-- eslint-skip -->
-
 ```sh
 docker run -e CODEX_RESET_ADMIN=1 -v host-parent-dir/config:/config ajslater/codex
 ```
@@ -314,8 +302,6 @@ a default one to that directory on startup.
 
 The default values for the config options are:
 
-<!-- eslint-skip -->
-
 ```toml
 bind = ["0.0.0.0:9810"]
 quick_bind = ["0.0.0.0:9810"]
@@ -373,8 +359,6 @@ to 2 queries per second.
 
 Here's an example nginx config with a subpath named '/codex'.
 
-<!-- eslint-skip -->
-
 ```nginx
 # HTTP
 proxy_set_header   Host $http_host;
@@ -399,8 +383,6 @@ proxy_set_header Connection "Upgrade" location /codex {
 
 Specify a reverse proxy sub path (if you have one) in `config/hypercorn.toml`
 
-<!-- eslint-skip -->
-
 ```toml
 root_path = "/codex"
 ```
@@ -472,11 +454,17 @@ authentication. In that case the OPDS url will look like:
 
 #### Supported OPDS Specifications
 
+##### OPDS v1
+
 - [OPDS 1.2](https://specs.opds.io/opds-1.2.html)
 - [OPDS-PSE 1.2](https://github.com/anansi-project/opds-pse/blob/master/v1.2.md)
 - [OPDS Authentication 1.0](https://drafts.opds.io/authentication-for-opds-1.0.html)
 - [OpenSearch 1.1](https://github.com/dewitt/opensearch)
+
+##### OPDS v2
+
 - [OPDS 2.0 (draft)](https://drafts.opds.io/opds-2.0.html)
+- [OPDS 2.0 Progression (proposal)](https://github.com/opds-community/drafts/discussions/67)
 
 ## <a name="troubleshooting">🩺 Troubleshooting</a>
 
@@ -489,9 +477,7 @@ You can change how much codex logs by setting the `LOGLEVEL` environment
 variable. By default this level is `INFO`. To see more verbose messages, run
 codex like:
 
-<!-- eslint-skip -->
-
-```bash
+```sh
 LOGLEVEL=DEBUG codex
 ```
 
@@ -511,8 +497,6 @@ If the database becomes corrupt, Codex includes a facility to rebuild the
 database. Place a file named `rebuild_db` in your Codex config directory like
 so:
 
-<!-- eslint-skip -->
-
 ```sh
 touch config/rebuild_db
 ```
@@ -525,6 +509,18 @@ rebuild it. The database lives in the config directory as the file
 original database at `config/backups/codex.sqlite3.before-rebuild`. Codex will
 remove the `rebuild_db` file.
 
+### Warnings to Ignore
+
+#### StreamingHttpResponse Iterator Warning
+
+```pycon
+packages/django/http/response.py:517: Warning: StreamingHttpResponse must consume synchronous iterators in order to serve them asynchronously. Use an asynchronous iterator instead.
+```
+
+This is a known warning and does not represent anything bad happening. It's an
+artifact of the Django framework slowly supporting asynchronous server endpoints
+and unfortunately isn't practical to remove yet.
+
 ## <a name="alternatives-to-codex">📚Alternatives</a>
 
 - [Kavita](https://www.kavitareader.com/) has light metadata filtering/editing,