Merge branch 'develop' into patch-signals-type-hint

Author: gazpachoking

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Keep GitHub Actions up to date with GitHub's Dependabot...
+# https://docs.github.com/en/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/keeping-your-actions-up-to-date-with-dependabot
+# https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#package-ecosystem
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    groups:
+      github-actions:
+        patterns:
+          - "*"  # Group all Actions updates into a single larger pull request
+    schedule:
+      interval: weekly

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.15.2
+  rev: v0.15.4
   hooks:
     # Run the linter.
     - id: ruff-check

pyproject.toml

@@ -59,23 +59,20 @@ dev = [
 [tool.ruff]
 line-length = 99
 lint.select = [
-  # Annotations
-  "ANN",
-  # flake8-bugbear
-  "B",
-  "D",
-  # pycodestyle
-  "E",
-  # Pyflakes
-  "F",
-  # isort
-  "I",
-  # Ruff specific
-  "RUF",
-  # flake8-simplify
-  "SIM",
-  # pyupgrade
-  "UP",
+  "ANN",  # annotations
+  "B",    # flake8-bugbear
+  "D",    # pydocstyle
+  "DTZ",  # flake8-datetimez
+  "E",    # pycodestyle
+  "F",    # Pyflakes
+  "FURB", # refurb
+  "I",    # isort
+  "PL",   # Pylint
+  "PYI",  # flake8-pyi
+  "RUF",  # Ruff-specific rules
+  "SIM",  # flake8-simplify
+  "SLOT", # flake8-slots
+  "UP",   # pyupgrade
 ]
 lint.ignore = [
   "D100", # undocumented-public-module
@@ -90,5 +87,6 @@ lint.ignore = [
   "D415", # Duplicate of D400
   "E501",
 ]
-lint.per-file-ignores."examples/**/*.py" = [ "ANN" ]
+lint.per-file-ignores."examples/**/*.py" = [ "ANN", "DTZ005", "PLC0415" ]
 lint.fixable = [ "ALL" ]
+lint.pylint.allow-magic-value-types = [ "int", "str" ]

src/datastar_py/__init__.py

@@ -15,7 +15,7 @@ def _read_signals(
 ) -> dict[str, Any] | None:
     if "Datastar-Request" not in headers:
         return None
-    if method == "GET":
+    if method in ("GET", "DELETE"):
         data = params.get("datastar")
     elif headers.get("Content-Type") == "application/json":
         data = body

src/datastar_py/attributes.py

@@ -127,13 +127,13 @@ def signals(
         :param expressions_: If True, the values of the signals will be evaluated as expressions
             rather than literals.
         """
-        signals = {**(signals_dict if signals_dict else {}), **signals}
+        signals = {**(signals_dict or {}), **signals}
         val = _js_object(signals) if expressions_ else json.dumps(signals)
         return SignalsAttr(value=val, alias=self._alias)
 
     def computed(self, computed_dict: Mapping | None = None, /, **computed: str) -> BaseAttr:
         """Create signals that are computed based on an expression."""
-        computed = {**(computed_dict if computed_dict else {}), **computed}
+        computed = {**(computed_dict or {}), **computed}
         first, *rest = (
             BaseAttr("computed", key=sig, value=expr, alias=self._alias)
             for sig, expr in computed.items()
@@ -152,16 +152,16 @@ def ignore(self) -> IgnoreAttr:
 
     def attr(self, attr_dict: Mapping | None = None, /, **attrs: str) -> BaseAttr:
         """Set the value of any HTML attributes to expressions, and keep them in sync."""
-        attrs = {**(attr_dict if attr_dict else {}), **attrs}
+        attrs = {**(attr_dict or {}), **attrs}
         return BaseAttr("attr", value=_js_object(attrs), alias=self._alias)
 
     def bind(self, signal_name: str) -> BaseAttr:
         """Set up two-way data binding between a signal and an element's value."""
-        return BaseAttr("bind", value=signal_name, alias=self._alias)
+        return BindAttr(value=signal_name, alias=self._alias)
 
     def class_(self, class_dict: Mapping | None = None, /, **classes: str) -> BaseAttr:
         """Add or removes classes to or from an element based on expressions."""
-        classes = {**(class_dict if class_dict else {}), **classes}
+        classes = {**(class_dict or {}), **classes}
         return BaseAttr("class", value=_js_object(classes), alias=self._alias)
 
     def init(self, expression: str) -> InitAttr:
@@ -216,7 +216,7 @@ def show(self, expression: str) -> BaseAttr:
 
     def style(self, style_dict: Mapping | None = None, /, **styles: str) -> BaseAttr:
         """Set the value of inline CSS styles on an element based on an expression, and keeps them in sync."""
-        styles = {**(style_dict if style_dict else {}), **styles}
+        styles = {**(style_dict or {}), **styles}
         return BaseAttr("style", value=_js_object(styles), alias=self._alias)
 
     def text(self, expression: str) -> BaseAttr:
@@ -432,6 +432,21 @@ def self(self) -> Self:
         return self
 
 
+class BindAttr(BaseAttr):
+    _attr = "bind"
+
+    def prop(self, prop: str) -> Self:
+        """Bind to a specified property."""
+        self._mods["prop"] = [prop]
+        return self
+
+    def event(self, event: str | Iterable[str]) -> Self:
+        """Only update the signal when the specified events are fired."""
+        events = [event] if isinstance(event, str) else list(event)
+        self._mods["event"] = events
+        return self
+
+
 class OnAttr(BaseAttr, TimingMod, DelayMod, ViewtransitionMod):
     _attr = "on"
 
@@ -459,6 +474,12 @@ def window(self) -> Self:
         self._mods["window"] = []
         return self
 
+    @property
+    def document(self) -> Self:
+        """Attach the event listener to the document element."""
+        self._mods["document"] = []
+        return self
+
     @property
     def outside(self) -> Self:
         """Trigger when the event is outside the element."""
@@ -633,7 +654,7 @@ def threshold(self, threshold: int) -> Self:
 class OnIntervalAttr(BaseAttr, ViewtransitionMod):
     _attr = "on-interval"
 
-    def duration(self, duration: int | float | str, *, leading: bool = False) -> Self:
+    def duration(self, duration: float | str, *, leading: bool = False) -> Self:
         """Set the interval duration."""
         self._mods["duration"] = [str(duration)]
         if leading:

src/datastar_py/litestar.py

@@ -46,6 +46,7 @@ def __init__(
             status_code = status_code or 204
             content = tuple()
         else:
+            status_code = status_code or 200
             headers = {**self.default_headers, **(headers or {})}
         if isinstance(content, DatastarEvent):
             content = (content,)

src/datastar_py/sse.py

@@ -5,8 +5,8 @@
 from itertools import chain
 from typing import Literal, Protocol, TypeAlias, overload, runtime_checkable
 
-import datastar_py.consts as consts
-from datastar_py.attributes import _escape, SignalValue
+from datastar_py import consts
+from datastar_py.attributes import SignalValue, _escape
 
 SSE_HEADERS: dict[str, str] = {
     "Cache-Control": "no-cache",
@@ -28,7 +28,7 @@ def __html__(self) -> str: ...
 
 
 class DatastarEvent(str):
-    pass
+    __slots__ = ()
 
 
 # 0..N datastar events
@@ -83,7 +83,7 @@ def patch_elements(
         retry_duration: int | None = None,
     ) -> DatastarEvent: ...
     @classmethod
-    def patch_elements(
+    def patch_elements(  # noqa: PLR0913 too many arguments
         cls,
         elements: str | _HtmlProvider | None = None,
         selector: str | None = None,