feat: Add django support

.github/workflows/test.yaml

@@ -49,7 +49,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip setuptools setuptools_scm
-        python -m pip install .[full,test]
+        python -m pip install .[full,test,django]
 
     - name: Test with pytest
       run: |

.pre-commit-config.yaml

@@ -39,6 +39,7 @@ repos:
         additional_dependencies:
           - types-cachetools
           - typeguard
+          - django
 
   - repo: https://github.com/compilerla/conventional-pre-commit
     rev: v3.2.0

ludic/base.py

@@ -24,6 +24,9 @@ def __init__(self, *children: Any, **attrs: Any) -> None:
     def __str__(self) -> str:
         return self.to_html()
 
+    def __bytes__(self) -> bytes:
+        return self.to_html().encode("utf-8")
+
     def __format__(self, _: str) -> str:
         return self.formatter.append(self)
 

ludic/catalog/messages.py

@@ -45,9 +45,10 @@ def render(self) -> div:
             return div(
                 self.children[0],
                 div(*self.children[1:], classes=["content"]),
+                **self.attrs,
             )
         else:
-            return div(div(*self.children, classes=["content"]))
+            return div(div(*self.children, classes=["content"]), **self.attrs)
 
 
 class MessageSuccess(Message):

ludic/contrib/django/__init__.py

@@ -0,0 +1,2 @@
+from .middlewares import LudicMiddleware as LudicMiddleware
+from .responses import LudicResponse as LudicResponse

ludic/contrib/django/middlewares.py

@@ -0,0 +1,28 @@
+from collections.abc import Callable
+
+from django.http import HttpRequest, HttpResponse
+
+from ludic.base import BaseElement
+
+
+class LudicMiddleware:
+    """Ludic middleware for Django to clean up the cache for f-strings.
+
+    Usage:
+
+        # somewhere in django settings.py
+
+        MIDDLEWARES = [
+            "...",
+            "ludic.contrib.django.LudicMiddleware",
+        ]
+    """
+
+    def __init__(self, get_response: Callable[[HttpRequest], HttpResponse]) -> None:
+        self.get_response = get_response
+
+    def __call__(self, request: HttpRequest) -> HttpResponse:
+        with BaseElement.formatter:
+            response: HttpResponse = self.get_response(request)
+
+        return response

ludic/contrib/django/responses.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+from django.http import HttpResponse
+
+from ludic.types import AnyChildren
+
+
+class LudicResponse(HttpResponse):
+    """Class representing Ludic response for Django View.
+
+    Usage:
+
+        from django.http import HttpRequest
+
+        from ludic.html import p
+        from ludic.contrib.django import LudicResponse
+
+        def index(request: HttpRequest) -> LudicResponse:
+            return LudicResponse(p("Hello, World!"))
+
+    """
+
+    def __init__(self, content: AnyChildren = "", *args: Any, **kwargs: Any) -> None:
+        super().__init__(str(content), *args, **kwargs)

pyproject.toml

@@ -34,9 +34,13 @@ full = [
     "typeguard>=4.1.5",
     "pygments",
 ]
+django = [
+    "django",
+]
 dev = [
     "mypy",
     "types-pygments",
+    "django-stubs",
 ]
 test = [
     "pytest",

tests/contrib/test_django.py

@@ -0,0 +1,32 @@
+import os
+
+from django.http import HttpRequest
+
+from ludic.base import BaseElement
+from ludic.contrib.django import LudicMiddleware, LudicResponse
+from ludic.html import p
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.contrib")
+
+
+def test_django_response() -> None:
+    assert LudicResponse(p("test")).content == b"<p>test</p>"
+
+
+def test_django_middleware() -> None:
+    get_response_called = False
+
+    def get_response(_: HttpRequest) -> LudicResponse:
+        nonlocal get_response_called
+        get_response_called = True
+
+        assert len(BaseElement.formatter.get()) == 0
+        response = LudicResponse(f"{p("does not clean up cache")}")
+        assert len(BaseElement.formatter.get()) == 1
+        return response
+
+    middleware = LudicMiddleware(get_response)
+    middleware(HttpRequest())
+
+    assert get_response_called
+    assert len(BaseElement.formatter.get()) == 0

tests/test_elements.py

@@ -2,6 +2,11 @@
 from ludic.styles import CSSProperties
 
 
+def test_str_and_bytes() -> None:
+    assert str(html.a("str")) == "<a>str</a>"
+    assert bytes(html.p("str")) == b"<p>str</p>"
+
+
 def test_empty_element() -> None:
     dom = html.div()
     assert dom.to_html() == "<div></div>"
@@ -155,7 +160,7 @@ def test_repr_and_str_and_to_string() -> None:
 
 
 def test_data_attributes() -> None:
-    dom = html.div("content", data_foo="1", data_bar="test")  # type: ignore
+    dom = html.div("content", data_foo="1", data_bar="test")  # type: ignore[call-arg]
 
     assert dom.attrs == {"data_foo": "1", "data_bar": "test"}
     assert dom.to_html() == '<div data-foo="1" data-bar="test">content</div>'
@@ -165,7 +170,7 @@ def test_htmx_attributes() -> None:
     assert html.button(
         "Get Info!",
         hx_get="/info", hx_on__before_request="alert('Making a request!')",
-    ).to_html() == (  # type: ignore
+    ).to_html() == (  # type: ignore[call-arg]
         '<button hx-get="/info" hx-on--before-request="alert(\'Making a request!\')">'
             "Get Info!"
         "</button>"