codex 1.4.1__py3-none-any.whl → 1.4.3__py3-none-any.whl

codex/views/session.py

@@ -1,6 +1,7 @@
 """Manage user sessions with appropriate defaults."""
 from abc import ABC, abstractmethod
 from copy import deepcopy
+from types import MappingProxyType
 
 from drf_spectacular.utils import extend_schema
 from rest_framework.generics import GenericAPIView
@@ -24,7 +25,7 @@ class SessionViewBaseBase(GenericAPIView, ABC):
         """Implement the session key string."""
         raise NotImplementedError
 
-    SESSION_DEFAULTS = {}
+    SESSION_DEFAULTS = MappingProxyType({})
 
     @classmethod
     def _get_source_values_or_set_defaults(cls, defaults_dict, source_dict, data):
@@ -64,60 +65,66 @@ class BrowserSessionViewBase(SessionViewBaseBase):
     SESSION_KEY = "browser"  # type: ignore
     CREATOR_PERSON_UI_FIELD = "creators"
     STORY_ARC_UI_FIELD = "story_arcs"
-    _DYNAMIC_FILTER_DEFAULTS = {
-        "age_rating": [],
-        "characters": [],
-        "country": [],
-        CREATOR_PERSON_UI_FIELD: [],
-        "community_rating": [],
-        "critical_rating": [],
-        "decade": [],
-        "file_type": [],
-        "genres": [],
-        "language": [],
-        "locations": [],
-        "original_format": [],
-        "q": "",
-        "read_ltr": [],
-        "series_groups": [],
-        STORY_ARC_UI_FIELD: [],
-        "tags": [],
-        "teams": [],
-        "year": [],
-    }
+    _DYNAMIC_FILTER_DEFAULTS = MappingProxyType(
+        {
+            "age_rating": [],
+            "characters": [],
+            "country": [],
+            CREATOR_PERSON_UI_FIELD: [],
+            "community_rating": [],
+            "critical_rating": [],
+            "decade": [],
+            "file_type": [],
+            "genres": [],
+            "language": [],
+            "locations": [],
+            "original_format": [],
+            "q": "",
+            "read_ltr": [],
+            "series_groups": [],
+            STORY_ARC_UI_FIELD: [],
+            "tags": [],
+            "teams": [],
+            "year": [],
+        }
+    )
     FILTER_ATTRIBUTES = frozenset(_DYNAMIC_FILTER_DEFAULTS.keys())
-    SESSION_DEFAULTS = {
-        "filters": {
-            "bookmark": DEFAULTS["bookmarkFilter"],
-            **_DYNAMIC_FILTER_DEFAULTS,
-        },
-        "order_by": DEFAULTS["orderBy"],
-        "order_reverse": False,
-        "q": DEFAULTS["q"],
-        "route": DEFAULTS["route"],
-        "show": DEFAULTS["show"],
-        "twenty_four_hour_time": False,
-        "top_group": DEFAULTS["topGroup"],
-    }
+    SESSION_DEFAULTS = MappingProxyType(
+        {
+            "filters": {
+                "bookmark": DEFAULTS["bookmarkFilter"],
+                **_DYNAMIC_FILTER_DEFAULTS,
+            },
+            "order_by": DEFAULTS["orderBy"],
+            "order_reverse": False,
+            "q": DEFAULTS["q"],
+            "route": DEFAULTS["route"],
+            "show": DEFAULTS["show"],
+            "twenty_four_hour_time": False,
+            "top_group": DEFAULTS["topGroup"],
+        }
+    )
 
 
 class ReaderSessionViewBase(SessionViewBaseBase):
     """Reader session base."""
 
     SESSION_KEY = "reader"  # type: ignore
-    SESSION_DEFAULTS = {
-        "fit_to": DEFAULTS["fitTo"],
-        "two_pages": False,
-        "read_in_reverse": False,
-        "read_rtl_in_reverse": False,
-        "vertical": False,
-    }
+    SESSION_DEFAULTS = MappingProxyType(
+        {
+            "fit_to": DEFAULTS["fitTo"],
+            "two_pages": False,
+            "read_in_reverse": False,
+            "read_rtl_in_reverse": False,
+            "vertical": False,
+        }
+    )
 
 
 class SessionViewBase(SessionViewBaseBase, ABC):
     """Session view for retrieving stored settings."""
 
-    permission_classes = [IsAuthenticatedOrEnabledNonUsers]
+    permission_classes = (IsAuthenticatedOrEnabledNonUsers,)
 
     @property
     @classmethod

codex/views/template.py

@@ -28,12 +28,12 @@ class SimpleAPIView(APIView):
 class CodexTemplateView(SimpleAPIView):
     """HTML Template View."""
 
-    renderer_classes = [TemplateHTMLRenderer]
+    renderer_classes = (TemplateHTMLRenderer,)
     content_type = "text/html"
 
 
 class CodexXMLTemplateView(SimpleAPIView):
     """XML Template View."""
 
-    renderer_classes = [TemplateXMLRenderer]
+    renderer_classes = (TemplateXMLRenderer,)
     content_type = "application/xml"

codex/websockets/listener.py

@@ -1,5 +1,6 @@
 """Listens to the Broadcast Queue and sends its messages to channels."""
 from queue import Empty
+from types import MappingProxyType
 
 from channels.exceptions import InvalidChannelLayerError
 from channels.layers import get_channel_layer
@@ -12,13 +13,15 @@ from codex.websockets.consumers import ChannelGroups
 class BroadcastListener(LoggerBaseMixin):
     """Listens to the Broadcast Queue and sends its messages to channels."""
 
-    _WS_DISCONNECT_EVENT = {
-        "group": ChannelGroups.ALL.name,
-        "message": {
-            "type": "websocket_disconnect",
-            "code": CloseReason.NORMAL_CLOSURE.value,
-        },
-    }
+    _WS_DISCONNECT_EVENT = MappingProxyType(
+        {
+            "group": ChannelGroups.ALL.name,
+            "message": {
+                "type": "websocket_disconnect",
+                "code": CloseReason.NORMAL_CLOSURE.value,
+            },
+        }
+    )
 
     def __init__(self, queue, log_queue):
         """Initialize."""

{codex-1.4.1.dist-info → codex-1.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.4.1
+Version: 1.4.3
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -23,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Multimedia :: Graphics :: Viewers
-Requires-Dist: Pillow (>=9.1.0,<10.0.0)
+Requires-Dist: Pillow (>=10.0.0,<11.0.0)
 Requires-Dist: aioprocessing (>=2.0.1,<3.0.0)
 Requires-Dist: ansicolors (>=1.1,<2.0)
 Requires-Dist: case-converter (>=1.1.0,<2.0.0)
@@ -33,7 +33,7 @@ Requires-Dist: django (>=4.2,<5.0)
 Requires-Dist: django-cors-headers (>=4.0,<5.0)
 Requires-Dist: django-haystack (>=3.2.1,<4.0.0)
 Requires-Dist: django-rest-registration (>=0.8.0,<0.9.0)
-Requires-Dist: django-vite (==2.1.1)
+Requires-Dist: django-vite (>=2.1.3,<3.0.0)
 Requires-Dist: djangorestframework (>=3.11,<4.0)
 Requires-Dist: djangorestframework-camel-case (>=1.3.0,<2.0.0)
 Requires-Dist: drf-spectacular (>=0.26.0,<0.27.0)
@@ -234,7 +234,7 @@ CODEX_RESET_ADMIN=1 codex
 or, if using Docker:
 
 ```sh
-docker run -e CODEX_RESET_ADMIN=1 -v <host path to config>/config:/config ajslater/codex
+docker run -e CODEX_RESET_ADMIN=1 -v host-parent-dir/config:/config ajslater/codex
 ```
 
 ### Private Libraries
@@ -307,29 +307,25 @@ index, a Django cache and comic book cover thumbnails.
 Here's an example nginx config with a subpath named '/codex'.
 
 ```nginx
-    # HTTP
-    proxy_set_header  Host              $http_host;
-    proxy_set_header  X-Forwarded-For   $proxy_add_x_forwarded_for;
-    proxy_set_header  X-Forwarded-Host  $server_name;
-    proxy_set_header  X-Forwarded-Port  $server_port;
-    proxy_set_header  X-Forwarded-Proto $scheme;
-    proxy_set_header  X-Real-IP         $remote_addr;
-    proxy_set_header  X-Scheme          $scheme;
-
-    # Websockets
-    proxy_http_version 1.1;
-    proxy_set_header Upgrade $http_upgrade;
-    proxy_set_header Connection "Upgrade"
-
-    # This example uses a docker container named 'codex' at sub-path /codex
-    # Use a valid IP or resolvable host name for other configurations.
-    location /codex {
-        proxy_pass  http://codex:9810;
-        # Codex reads http basic authentication.
-        # If the nginx credentials are different than codex credentials use this line to
-        #   not forward the authorization.
-        proxy_set_header Authorization "";
-    }
+# HTTP
+proxy_set_header   Host $http_host;
+proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
+proxy_set_header   X-Forwarded-Host $server_name;
+proxy_set_header   X-Forwarded-Port $server_port;
+proxy_set_header   X-Forwarded-Proto $scheme;
+proxy_set_header   X-Real-IP $remote_addr;
+proxy_set_header   X-Scheme $scheme;
+# Websockets
+proxy_http_version 1.1;
+proxy_set_header   Upgrade $http_upgrade;
+
+proxy_set_header Connection "Upgrade" location /codex {
+  proxy_pass       http://codex:9810;
+  # Codex reads http basic authentication.
+  # If the nginx credentials are different than codex credentials use this line to
+  #   not forward the authorization.
+  proxy_set_header Authorization "";
+}
 ```
 
 Specify a reverse proxy sub path (if you have one) in `config/hypercorn.toml`
@@ -445,7 +441,7 @@ database. Place a file named `rebuild_db` in your Codex config directory like
 so:
 
 ```sh
-  touch config/rebuild_db
+touch config/rebuild_db
 ```
 
 Shut down and restart Codex.