chore: upgrade ruff and apply latest linting config (#4115)

Author: cofin

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ default_language_version:
   python: "3.12"
 repos:
   - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: v3.6.0
+    rev: v4.0.0
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
@@ -24,13 +24,13 @@ repos:
       - id: unasyncd
         additional_dependencies: ["ruff"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.8.1"
+    rev: "v0.11.5"
     hooks:
       - id: ruff
         args: ["--fix"]
       - id: ruff-format
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         exclude: "tests/openapi/typescript_converter/test_converter|README.md"

docs/_static/favicon.png

@@ -0,0 +1,49 @@
+function initDropdowns() {
+    const dropdownToggles = document.querySelectorAll(".st-dropdown-toggle")
+
+    const dropdowns = [...dropdownToggles].map(toggleEl => ({
+        toggleEl,
+        contentEL: toggleEl.parentElement.querySelector(".st-dropdown-menu")
+    }))
+
+    const close = (dropdown) => {
+        const {toggleEl, contentEL} = dropdown
+        toggleEl.setAttribute("aria-expanded", "false")
+        contentEL.classList.toggle("hidden", true)
+    }
+
+    const closeAll = () => dropdowns.forEach(close)
+
+    const open = (dropdown) => {
+        closeAll()
+        dropdown.toggleEl.setAttribute("aria-expanded", "true")
+        dropdown.contentEL.classList.toggle("hidden", false)
+        const boundaries = [dropdown.contentEL, ...dropdownToggles]
+        const clickOutsideListener = (event) => {
+            const target = event.target
+            if (!target) return
+
+            if (!boundaries.some(b => b.contains(target))) {
+                closeAll()
+                document.removeEventListener("click", clickOutsideListener)
+            }
+
+        }
+        document.addEventListener("click", clickOutsideListener)
+    }
+
+
+    dropdowns.forEach(dropdown => {
+        dropdown.toggleEl.addEventListener("click", () => {
+            if (dropdown.toggleEl.getAttribute("aria-expanded") === "true") {
+                close(dropdown)
+            } else {
+                open(dropdown)
+            }
+        })
+    })
+}
+
+window.addEventListener("DOMContentLoaded", () => {
+    initDropdowns()
+})

docs/_static/favicon.svg

@@ -80,7 +80,7 @@ def create_string_constrained_field_schema(
         schema.max_length = kwarg_definition.max_length
     if kwarg_definition.pattern:
         schema.pattern = (
-            kwarg_definition.pattern.pattern  # type: ignore[attr-defined]
+            kwarg_definition.pattern.pattern
             if isinstance(kwarg_definition.pattern, Pattern)  # type: ignore[unreachable]
             else kwarg_definition.pattern
         )

docs/_static/litestar-sphinx-theme.css

@@ -499,7 +499,7 @@ def for_constrained_field(self, field: FieldDefinition) -> Schema:
         Returns:
             A schema instance.
         """
-        kwarg_definition = cast(Union[ParameterKwarg, BodyKwarg], field.kwarg_definition)
+        kwarg_definition = cast("Union[ParameterKwarg, BodyKwarg]", field.kwarg_definition)
         if any(is_class_and_subclass(field.annotation, t) for t in (int, float, Decimal)):
             return create_numerical_constrained_field_schema(field.annotation, kwarg_definition)
         if any(is_class_and_subclass(field.annotation, t) for t in (str, bytes)):
@@ -518,7 +518,7 @@ def for_collection_constrained_field(self, field_definition: FieldDefinition) ->
             A schema instance.
         """
         schema = Schema(type=OpenAPIType.ARRAY)
-        kwarg_definition = cast(Union[ParameterKwarg, BodyKwarg], field_definition.kwarg_definition)
+        kwarg_definition = cast("Union[ParameterKwarg, BodyKwarg]", field_definition.kwarg_definition)
         if kwarg_definition.min_items:
             schema.min_items = kwarg_definition.min_items
         if kwarg_definition.max_items:

docs/_static/litestar-theme.js

@@ -158,9 +158,9 @@ def _build_error_message(cls, keys: Sequence[str], exc_msg: str, connection: ASG
                 message["source"] = ParamType.PATH
 
             elif key in cls._fields and isinstance(cls._fields[key].kwarg_definition, ParameterKwarg):
-                if cast(ParameterKwarg, cls._fields[key].kwarg_definition).cookie:
+                if cast("ParameterKwarg", cls._fields[key].kwarg_definition).cookie:
                     message["source"] = ParamType.COOKIE
-                elif cast(ParameterKwarg, cls._fields[key].kwarg_definition).header:
+                elif cast("ParameterKwarg", cls._fields[key].kwarg_definition).header:
                     message["source"] = ParamType.HEADER
                 else:
                     message["source"] = ParamType.QUERY

docs/_static/logo-dark.png

@@ -360,7 +360,7 @@ def _handle_http_route(self, route: HTTPRoute) -> None:
             else:
                 handler_info.append("[yellow]sync[/yellow]")
 
-            handler_info.append(f'[cyan]{", ".join(sorted(handler.http_methods))}[/cyan]')
+            handler_info.append(f"[cyan]{', '.join(sorted(handler.http_methods))}[/cyan]")
 
             if len(handler.paths) > 1:
                 for path in handler.paths:

docs/_static/logo-light.png

@@ -5,7 +5,7 @@
 from litestar.utils import warn_deprecation
 
 if TYPE_CHECKING:
-    from litestar_htmx._utils import (  # noqa: TC004
+    from litestar_htmx._utils import (
         HTMXHeaders,
         get_headers,
         get_location_headers,

litestar/_openapi/schema_generation/constrained_fields.py

@@ -5,7 +5,7 @@
 from litestar.utils import warn_deprecation
 
 if TYPE_CHECKING:
-    from litestar_htmx import (  # noqa: TC004
+    from litestar_htmx import (
         HTMXDetails,
         HTMXRequest,
     )

litestar/_openapi/schema_generation/schema.py

@@ -5,7 +5,7 @@
 from litestar.utils import warn_deprecation
 
 if TYPE_CHECKING:
-    from litestar_htmx import (  # noqa: TC004
+    from litestar_htmx import (
         ClientRedirect,
         ClientRefresh,
         HTMXTemplate,

litestar/_signature/model.py

@@ -5,7 +5,7 @@
 from litestar.utils import warn_deprecation
 
 if TYPE_CHECKING:
-    from litestar_htmx import HtmxHeaderType, LocationType, TriggerEventType  # noqa: TC004
+    from litestar_htmx import HtmxHeaderType, LocationType, TriggerEventType
 __all__ = (
     "HtmxHeaderType",
     "LocationType",

litestar/cli/commands/core.py

@@ -206,7 +206,7 @@ def from_environment(cls, minijinja_environment: Environment) -> MiniJinjaTempla
 @pass_state
 def _minijinja_from_state(func: Callable, state: StateProtocol, *args: Any, **kwargs: Any) -> str:  # pragma: no cover
     template_context = {"request": state.lookup("request"), "csrf_input": state.lookup("csrf_input")}
-    return cast(str, func(template_context, *args, **kwargs))
+    return cast("str", func(template_context, *args, **kwargs))
 
 
 def __getattr__(name: str) -> Any:

litestar/contrib/htmx/_utils.py

@@ -51,7 +51,7 @@ def _parse_piccolo_type(column: Column, extra: dict[str, Any]) -> FieldDefinitio
         if is_optional:
             meta = Meta(extra=extra)
             warnings.warn(
-                f"Dropping max_length constraint for column {column!r} because the " "column is optional",
+                f"Dropping max_length constraint for column {column!r} because the column is optional",
                 category=LitestarWarning,
                 stacklevel=2,
             )

litestar/contrib/htmx/request.py

@@ -43,10 +43,10 @@ def _encode_headers(headers: Iterable[tuple[str, str]]) -> "RawHeadersList":
     return [(key.lower().encode("latin-1"), value.encode("latin-1")) for key, value in headers]
 
 
-class Headers(CIMultiDictProxy[str], MultiMixin[str]):
+class Headers(CIMultiDictProxy[str], MultiMixin[str]):  # pyright: ignore
     """An immutable, case-insensitive multi dict for HTTP headers."""
 
-    def __init__(self, headers: Optional[Union[Mapping[str, str], "RawHeaders", MultiMapping]] = None) -> None:
+    def __init__(self, headers: Optional[Union[Mapping[str, str], "RawHeaders", MultiMapping]] = None) -> None:  # pyright: ignore
         """Initialize ``Headers``.
 
         Args:

litestar/contrib/htmx/response.py

@@ -42,17 +42,17 @@ def multi_items(self) -> Generator[tuple[str, T], None, None]:
                 yield key, value
 
 
-class MultiDict(BaseMultiDict[T], MultiMixin[T], Generic[T]):
+class MultiDict(BaseMultiDict[T], MultiMixin[T], Generic[T]):  # pyright: ignore
     """MultiDict, using :class:`MultiDict <multidict.MultiDictProxy>`."""
 
-    def __init__(self, args: MultiMapping | Mapping[str, T] | Iterable[tuple[str, T]] | None = None) -> None:
+    def __init__(self, args: MultiMapping | Mapping[str, T] | Iterable[tuple[str, T]] | None = None) -> None:  # pyright: ignore
         """Initialize ``MultiDict`` from a`MultiMapping``,
         :class:`Mapping <typing.Mapping>` or an iterable of tuples.
 
         Args:
             args: Mapping-like structure to create the ``MultiDict`` from
         """
-        super().__init__(args or {})
+        super().__init__(args or {})  # pyright: ignore
 
     def immutable(self) -> ImmutableMultiDict[T]:
         """Create an.
@@ -69,17 +69,17 @@ def copy(self) -> Self:
         return type(self)(list(self.multi_items()))
 
 
-class ImmutableMultiDict(MultiDictProxy[T], MultiMixin[T], Generic[T]):
+class ImmutableMultiDict(MultiDictProxy[T], MultiMixin[T], Generic[T]):  # pyright: ignore
     """Immutable MultiDict, using class:`MultiDictProxy <multidict.MultiDictProxy>`."""
 
-    def __init__(self, args: MultiMapping | Mapping[str, Any] | Iterable[tuple[str, Any]] | None = None) -> None:
+    def __init__(self, args: MultiMapping | Mapping[str, Any] | Iterable[tuple[str, Any]] | None = None) -> None:  # pyright: ignore
         """Initialize ``ImmutableMultiDict`` from a `MultiMapping``,
         :class:`Mapping <typing.Mapping>` or an iterable of tuples.
 
         Args:
             args: Mapping-like structure to create the ``ImmutableMultiDict`` from
         """
-        super().__init__(BaseMultiDict(args or {}))
+        super().__init__(BaseMultiDict(args or {}))  # pyright: ignore
 
     def mutable_copy(self) -> MultiDict[T]:
         """Create a mutable copy as a :class:`MultiDict`
@@ -112,10 +112,10 @@ def from_form_data(cls, form_data: dict[str, list[str] | str | UploadFile]) -> F
         items = []
         for k, v in form_data.items():
             if not isinstance(v, list):
-                items.append((k, v))
+                items.append((k, v))  # pyright: ignore
             else:
                 for sv in v:
-                    items.append((k, sv))
+                    items.append((k, sv))  # pyright: ignore
         return cls(items)
 
     async def close(self) -> None:

litestar/contrib/htmx/types.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import abc
-import io
 import os
 import os.path
 import pathlib
@@ -29,6 +28,7 @@
 )
 
 if TYPE_CHECKING:
+    import io
     from collections.abc import AsyncGenerator, Awaitable, Mapping
 
     from fsspec import AbstractFileSystem as FsspecFileSystem
@@ -294,7 +294,7 @@ async def iter(
             end: Offset to stop reading at (inclusive)
         """
 
-        fh = cast(io.BytesIO, await sync_to_thread(self.wrapped_fs.open, str(path), mode="rb"))
+        fh = cast("io.BytesIO", await sync_to_thread(self.wrapped_fs.open, str(path), mode="rb"))
         try:
             if start != 0:
                 await sync_to_thread(fh.seek, start)
@@ -358,7 +358,7 @@ async def read_bytes(
             end: Offset to stop reading at (inclusive)
         """
         return cast(
-            bytes,
+            "bytes",
             await self.wrapped_fs._cat_file(
                 str(path),
                 start=start or None,
@@ -425,7 +425,7 @@ def maybe_wrap_fsspec_file_system(file_system: AnyFileSystem) -> BaseFileSystem:
         from fsspec import AbstractFileSystem
         from fsspec.asyn import AsyncFileSystem
     except ImportError:
-        return cast(BaseFileSystem, file_system)
+        return cast("BaseFileSystem", file_system)
 
     if isinstance(file_system, AsyncFileSystem):
         return FsspecAsyncWrapper(file_system)

litestar/contrib/minijinja.py

@@ -8,7 +8,6 @@
 from litestar.di import Provide
 from litestar.dto import DTOData
 from litestar.exceptions import ImproperlyConfiguredException, LitestarException
-from litestar.router import Router
 from litestar.serialization import default_deserializer, default_serializer
 from litestar.types import (
     Dependencies,
@@ -36,6 +35,7 @@
     from litestar.app import Litestar
     from litestar.connection import ASGIConnection
     from litestar.dto import AbstractDTO
+    from litestar.router import Router
     from litestar.routes import BaseRoute
     from litestar.types import AsyncAnyCallable
     from litestar.types.callable_types import AnyCallable, AsyncGuard
@@ -207,7 +207,7 @@ def _get_merge_opts(self, others: tuple[Router, ...]) -> dict[str, Any]:
             # whereas '.dto' on the handler is the fully resolved dto. The dto config on
             # the handler is stored under '._dto', so we have to do this little workaround
             if other is not self:
-                other = cast(Router, other)  # mypy cannot narrow with the 'is not self' check
+                other = cast("Router", other)  # mypy cannot narrow with the 'is not self' check
                 merge_opts["dto"] = value_or_default(merge_opts.get("dto", Empty), other.dto)
                 merge_opts["return_dto"] = value_or_default(merge_opts.get("return_dto", Empty), other.return_dto)
 

litestar/contrib/piccolo.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from collections.abc import Awaitable, Iterable, Mapping, Sequence
 from enum import Enum
 from typing import TYPE_CHECKING, AnyStr, Callable, TypedDict, cast
 
@@ -60,6 +59,7 @@
 from litestar.utils.warnings import warn_implicit_sync_to_thread, warn_sync_to_thread_with_async_callable
 
 if TYPE_CHECKING:
+    from collections.abc import Awaitable, Iterable, Mapping, Sequence
     from typing import Any
 
     from litestar import Litestar, Router
@@ -593,7 +593,11 @@ def _validate_handler_function(self) -> None:
             raise ImproperlyConfiguredException("'data' kwarg is unsupported for 'GET' request handlers")
 
         if self.http_methods == {HttpMethod.HEAD} and not self.parsed_fn_signature.return_type.is_subclass_of(
-            (NoneType, File, ASGIFileResponse)
+            (
+                NoneType,
+                File,
+                ASGIFileResponse,
+            )
         ):
             field_definition = self.parsed_fn_signature.return_type
             if not (
@@ -792,7 +796,7 @@ async def to_response(self, data: Any, request: Request) -> ASGIApp:
             data = return_dto_type(request).data_to_encodable_type(data)
 
         handler = cast(
-            Callable[..., Awaitable[ASGIApp]],
+            "Callable[..., Awaitable[ASGIApp]]",
             self._response_type_handler if isinstance(data, Response) else self._default_response_handler,
         )
 

litestar/datastructures/headers.py

@@ -230,7 +230,7 @@ def on_registration(self, route: BaseRoute, app: Litestar) -> None:
         # be a reference to the unbound method. The bound method is patched in later
         # after the controller has been initialized. This is a workaround that should
         # go away with v3.0's static handlers
-        stream_fn = cast(Callable[..., AsyncGenerator[Any, Any]], self.fn)
+        stream_fn = cast("Callable[..., AsyncGenerator[Any, Any]]", self.fn)
 
         # construct a fake signature for the kwargs modelling, using the generator
         # function passed to the handler as a base, to include all the dependencies,

litestar/datastructures/multi_dicts.py

@@ -323,10 +323,10 @@ def get(self, type_: type[PluginT] | str) -> PluginT:
                     else plugin.__class__.__qualname__
                 )
                 if type_ in {_name, _qualname}:
-                    return cast(PluginT, plugin)
+                    return cast("PluginT", plugin)
             raise KeyError(f"No plugin of type {type_!r} registered")
         try:
-            return cast(PluginT, self._plugins_by_type[type_])  # type: ignore[index]
+            return cast("PluginT", self._plugins_by_type[type_])  # type: ignore[index]
         except KeyError as e:
             raise KeyError(f"No plugin of type {type_.__name__!r} registered") from e
 

litestar/file_system.py

@@ -22,5 +22,5 @@ def get_typed_init(self, type_: Any) -> tuple[Signature, dict[str, Any]]:
             inspect.Parameter(name=field_name, kind=inspect.Parameter.KEYWORD_ONLY, annotation=Any)
             for field_name in model_fields
         ]
-        type_hints = {field_name: Any for field_name in model_fields}
+        type_hints = dict.fromkeys(model_fields, Any)
         return Signature(parameters), type_hints