djhtmx 1.2.6__py3-none-any.whl

djhtmx/__init__.py

@@ -0,0 +1,4 @@
+from .middleware import middleware
+
+__version__ = "1.2.6"
+__all__ = ("middleware",)

djhtmx/apps.py

@@ -0,0 +1,13 @@
+from django.apps import AppConfig
+from django.utils.module_loading import autodiscover_modules
+
+from .utils import autodiscover_htmx_modules
+
+
+class App(AppConfig):
+    name = "djhtmx"
+    verbose_name = "Django HTMX"
+
+    def ready(self):
+        autodiscover_modules("live")  # legacy
+        autodiscover_htmx_modules()

djhtmx/command_queue.py

@@ -0,0 +1,145 @@
+from typing import assert_never
+
+from django.db import models
+from django.db.models.signals import post_save, pre_delete
+
+from djhtmx.commands import PushURL, ReplaceURL
+
+from .component import (
+    BuildAndRender,
+    Command,
+    Destroy,
+    DispatchDOMEvent,
+    Emit,
+    Execute,
+    Focus,
+    Open,
+    Redirect,
+    Render,
+    Signal,
+    SkipRender,
+)
+from .introspection import get_related_fields
+from .utils import get_model_subscriptions
+
+
+class CommandQueue:
+    def __init__(self, commands: list[Command]):
+        self.processing_component_id: str = ""
+        self._commands = commands
+        self._destroyed_ids: set[str] = set()
+        self._optimize()
+
+        # subscribe to signals changes
+        post_save.connect(self._listen_to_post_save_and_pre_delete, weak=True)
+        pre_delete.connect(self._listen_to_post_save_and_pre_delete, weak=True)
+
+    def _listen_to_post_save_and_pre_delete(
+        self,
+        sender: type[models.Model],
+        instance: models.Model,
+        created: bool | None = None,
+        **kwargs,
+    ):
+        if created is None:
+            action = "deleted"
+        elif created:
+            action = "created"
+        else:
+            action = "updated"
+
+        signals = get_model_subscriptions(
+            instance, actions=(action, None)
+        ) | get_model_subscriptions(type(instance), actions=(action, None))
+
+        for field in get_related_fields(sender):
+            fk_id = getattr(instance, field.name)
+            signal = f"{field.related_model_name}.{fk_id}.{field.relation_name}"
+            signals.update((signal, f"{signal}.{action}"))
+
+        if signals:
+            self.extend([Signal({(signal, self.processing_component_id) for signal in signals})])
+
+    def extend(self, commands: list[Command]):
+        if commands:
+            self._commands.extend(commands)
+            self._optimize()
+
+    def append(self, command: Command):
+        self._commands.append(command)
+        self._optimize()
+
+    def pop(self) -> Command:
+        return self._commands.pop(0)
+
+    def __bool__(self):
+        return bool(self._commands)
+
+    def _optimize(self):
+        self._commands.sort(key=self._priority)
+        new_commands = []
+        for i, command in enumerate(self._commands):
+            match command:
+                case (
+                    Execute()
+                    | Signal()
+                    | Emit()
+                    | SkipRender()
+                    | Focus()
+                    | Redirect()
+                    | DispatchDOMEvent()
+                    | Open()
+                    | PushURL()
+                    | ReplaceURL()
+                ):
+                    new_commands.append(command)
+
+                case Destroy(component_id) as command:
+                    # Register destroyed ids
+                    self._destroyed_ids.add(component_id)
+                    new_commands.append(command)
+
+                case BuildAndRender(_, state, _) as command:
+                    # Remove BuildAndRender of destroyed ids
+                    if not (
+                        (component_id := state.get("id")) and component_id in self._destroyed_ids
+                    ):
+                        new_commands.append(command)
+
+                case Render(component) as command:
+                    # Remove Render of destroyed ids
+                    # Let the latest Render of the same component survive, kill the rest
+                    if component.id not in self._destroyed_ids and not any(
+                        isinstance(ahead_command, Render)
+                        and ahead_command.component.id == component.id
+                        and ahead_command.template is None
+                        for ahead_command in self._commands[i + 1 :]
+                    ):
+                        new_commands.append(command)
+
+        self._commands = new_commands
+
+    @staticmethod
+    def _priority(command: Command) -> tuple[int, str, int]:
+        match command:
+            case Execute():
+                return 0, "", 0
+            case Destroy(component_id):
+                return 1, component_id, 0
+            case Signal(_, timestamp):
+                return 2, "", timestamp
+            case Emit(_, timestamp):
+                return 3, "", timestamp
+            case SkipRender():
+                return 4, "", 0
+            case BuildAndRender(_, _, _, _, timestamp):
+                return 5, "", timestamp
+            case Render(component, template, _, _, _, timestamp):
+                if template:
+                    return 6, component.id, timestamp
+                else:
+                    return 7, component.id, timestamp
+            case Focus() | Redirect() | DispatchDOMEvent() | Open() | ReplaceURL() | PushURL():
+                return 8, "", 0
+            case _ as unreachable:
+                assert_never(unreachable)

djhtmx/commands.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import logging
+from collections.abc import Callable
+from dataclasses import dataclass
+from typing import Any, Literal
+
+from django.db import models
+from django.http import QueryDict
+from django.shortcuts import resolve_url
+from django.utils.safestring import SafeString
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass(slots=True)
+class SendHtml:
+    content: SafeString
+
+    # debug trace for troubleshooting
+    debug_trace: str | None = None
+
+
+@dataclass(slots=True)
+class PushURL:
+    url: str
+    command: Literal["push_url"] = "push_url"
+
+    @classmethod
+    def from_params(cls, params: QueryDict):
+        return cls("?" + params.urlencode())
+
+    @classmethod
+    def to(cls, to: Callable[..., Any] | models.Model | str, *args, **kwargs):
+        return cls(resolve_url(to, *args, **kwargs))
+
+
+@dataclass(slots=True)
+class ReplaceURL:
+    url: str
+    command: Literal["replace_url"] = "replace_url"
+
+    @classmethod
+    def from_params(cls, params: QueryDict):
+        return cls("?" + params.urlencode())
+
+    @classmethod
+    def to(cls, to: Callable[..., Any] | models.Model | str, *args, **kwargs):
+        return cls(resolve_url(to, *args, **kwargs))