Merge branch 'main' into add-zizmor

provinzkraut · web-flow · commit e5643beb365f · 2026-01-07T11:37:03.000+01:00
diff --git a/.github/workflows/cherry-pick-v2.yaml b/.github/workflows/cherry-pick-v2.yaml
@@ -18,7 +18,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,7 +14,7 @@ jobs:
   validate:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/setup-python@v6
         with:
@@ -25,7 +25,7 @@ jobs:
 
       - name: Load cached Pre-Commit Dependencies
         id: cached-pre-commit-dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: ~/.cache/pre-commit/
           key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
@@ -36,7 +36,7 @@ jobs:
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/setup-python@v6
         with:
@@ -53,7 +53,7 @@ jobs:
   pyright:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/setup-python@v6
         with:
@@ -70,7 +70,7 @@ jobs:
   slotscheck:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/setup-python@v6
         with:
@@ -117,7 +117,7 @@ jobs:
         typing-extensions: ["4.12.1", "4.13.1", "latest"]
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up python
         uses: actions/setup-python@v6
@@ -153,7 +153,7 @@ jobs:
         uvicorn-version: ["uvicorn<0.27.0", "uvicorn>=0.27.0"]
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up python 3.11
         uses: actions/setup-python@v6
@@ -200,7 +200,7 @@ jobs:
       security-events: write
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Initialize CodeQL Without Dependencies
         uses: github/codeql-action/init@v4
@@ -217,7 +217,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Install Build Dependencies
         run: sudo apt-get install build-essential libpq-dev python3-dev -y
@@ -246,7 +246,7 @@ jobs:
           echo "${{ github.event.number }}" > .pr_number
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: docs-preview
           path: |
@@ -261,7 +261,7 @@ jobs:
       python_version: "3.12"
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Python
         uses: actions/setup-python@v6
@@ -288,7 +288,7 @@ jobs:
       python_version: "3.12"
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Install Build Dependencies
         run: sudo apt-get install build-essential libpq-dev python3-dev -y
@@ -317,7 +317,7 @@ jobs:
       - name: Rename coverage file
         run: mv .coverage* .coverage.pydantic_v1
 
-      - uses: actions/upload-artifact@v5
+      - uses: actions/upload-artifact@v6
         with:
           name: coverage-data-pydantic_v1-${{ inputs.python-version }}
           path: .coverage.pydantic_v1
@@ -329,13 +329,13 @@ jobs:
       - test
       - test_pydantic_1_app
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 
       - name: Download Artifacts
-        uses: actions/download-artifact@v6
+        uses: actions/download-artifact@v7
         with:
           pattern: coverage-data*
           merge-multiple: true
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -9,7 +9,7 @@ jobs:
       security-events: write
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           ref: "main"
       - name: Initialize CodeQL With Dependencies
diff --git a/.github/workflows/docs-preview.yml b/.github/workflows/docs-preview.yml
@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Download artifact
         uses: dawidd6/action-download-artifact@v11
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -29,7 +29,7 @@ jobs:
       contents: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/setup-python@v6
         with:
diff --git a/.github/workflows/notify-released-issues.yml b/.github/workflows/notify-released-issues.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Python
         uses: actions/setup-python@v6
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -15,7 +15,7 @@ jobs:
     environment: release
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - uses: actions/setup-python@v6
         with:
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -31,7 +31,7 @@ jobs:
         shell: bash
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up python ${{ inputs.python-version }}
         uses: actions/setup-python@v6
@@ -77,7 +77,7 @@ jobs:
         if: inputs.coverage
         run: mv .coverage .coverage.${{ inputs.python-version }}
 
-      - uses: actions/upload-artifact@v5
+      - uses: actions/upload-artifact@v6
         if: inputs.coverage
         with:
           name: coverage-data-${{ inputs.python-version }}
diff --git a/docs/examples/openapi/plugins/redoc_config.py b/docs/examples/openapi/plugins/redoc_config.py
@@ -1,3 +1,8 @@
 from litestar.openapi.plugins import RedocRenderPlugin
 
-redoc_plugin = RedocRenderPlugin(version="next", google_fonts=True, path="/redoc")
+redoc_plugin = RedocRenderPlugin(
+    version="latest",
+    google_fonts=True,
+    path="/redoc",
+    js_url="https://cdn.company.internal/redoc/custom-redoc.js",
+)
diff --git a/docs/usage/middleware/builtin-middleware.rst b/docs/usage/middleware/builtin-middleware.rst
@@ -165,10 +165,10 @@ list of domains to :class:`~litestar.app.Litestar`:
 Compression
 -----------
 
-HTML responses can optionally be compressed. Litestar has built in support for gzip, brotli, and zstd. Gzip support is provided
-through the built-in Starlette classes. Brotli support can be added by installing the ``brotli`` extra, and Zstd support by installing the ``zstd`` extra.
+HTTP responses can optionally be compressed. Litestar has support for gzip, brotli, and zstd.
+Gzip is supported by Litestar out of the box, while Brotli support can be added by installing the ``brotli`` extra, and Zstd support can be added by installing the ``zstd`` extra.
 
-You can enable either backend by passing an instance of
+You can enable any one of these backends by passing an instance of
 :class:`~litestar.config.compression.CompressionConfig` to ``compression_config`` of
 :class:`~litestar.app.Litestar`.
 
@@ -182,9 +182,9 @@ You can configure the following additional gzip-specific values:
 
 
 * ``minimum_size``: the minimum threshold for response size to enable compression. Smaller responses will not be
-    compressed. Defaults is ``500``, i.e. half a kilobyte.
+    compressed. Default is ``500``, i.e. half a kilobyte.
 * ``gzip_compress_level``: a range between 0-9, see the `official python docs <https://docs.python.org/3/library/gzip.html>`_.
-    Defaults to ``9`` , which is the maximum value.
+    Defaults to ``9``, which is the maximum value.
 
 .. code-block:: python
 
@@ -232,16 +232,15 @@ You can configure the following additional brotli-specific values:
 Zstd
 ^^^^^^
 
-The `Zstd <https://pypi.org/project/zstd>`_ package is required to run this middleware. It is available as an extra for Litestar via the ``zstd`` extra: (``pip install 'litestar[zstd]'``).
+The `zstandard <https://pypi.org/project/zstandard>`_ package is required to run this middleware. It is available as an extra for Litestar via the ``zstd`` extra: (``pip install 'litestar[zstd]'``).
 
 You can enable zstd compression of responses by passing an instance of
 :class:`~litestar.config.compression.CompressionConfig` with the ``backend`` parameter set to ``"zstd"``.
 
 You can configure the following additional zstd-specific values:
 
-* ``minimum_size``: the minimum threshold for response size to enable compression. Smaller responses will not be
-    compressed. Default is 500, i.e. half a kilobyte.
-* ``zstd_level``: Range [0-22], Controls the compression level. Higher values increase compression ratio but are slower. Default is 3.
+* ``minimum_size``: the minimum threshold for response size to enable compression. Smaller responses will not be compressed. Default is 500, i.e. half a kilobyte.
+* ``zstd_compress_level``: Range [0-22], Controls the compression level. Higher values increase compression ratio but are slower. Default is 3.
 * ``zstd_gzip_fallback``: Boolean indicating whether to fall back to gzip if Zstd is not supported. Default is True.
 
 .. code-block:: python
diff --git a/docs/usage/openapi/ui_plugins.rst b/docs/usage/openapi/ui_plugins.rst
@@ -119,6 +119,12 @@ Here's some example plugin configurations:
         .. literalinclude:: /examples/openapi/plugins/redoc_config.py
             :language: python
 
+        .. tip::
+
+           Setting ``js_url`` lets you point the ReDoc bundle to any CDN or internal host. In ``redoc_config.py``
+           we override it to ``https://cdn.company.internal/redoc/custom-redoc.js``. When provided, ``js_url`` takes
+           precedence over ``version``.
+
     .. tab-item:: stoplight
         :sync: stoplight
 
diff --git a/litestar/_asgi/routing_trie/traversal.py b/litestar/_asgi/routing_trie/traversal.py
@@ -84,7 +84,7 @@ def parse_node_handlers(
         try:
             return node.asgi_handlers[method]
         except KeyError as e:
-            raise MethodNotAllowedException(headers={"allowed": ", ".join(node.asgi_handlers.keys())}) from e
+            raise MethodNotAllowedException(headers={"allow": ", ".join(node.asgi_handlers.keys())}) from e
     return node.asgi_handlers["websocket"]
 
 
diff --git a/litestar/config/compression.py b/litestar/config/compression.py
@@ -24,7 +24,7 @@ class CompressionConfig:
     backend: Literal["gzip", "brotli", "zstd"] | str
     """The backend to use.
 
-    If the value given is `gzip` or `brotli`, then the builtin gzip and brotli compression is used.
+    If the value given is `gzip`, `brotli` or `zstd`, then the corresponding compression algorithm will be used.
     """
     minimum_size: int = field(default=500)
     """Minimum response size (bytes) to enable compression, affects all backends."""
diff --git a/litestar/contrib/opentelemetry/config.py b/litestar/contrib/opentelemetry/config.py
@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, Literal
 
 from litestar.contrib.opentelemetry._utils import get_route_details_from_scope
 from litestar.contrib.opentelemetry.middleware import (
@@ -77,6 +77,8 @@ class OpenTelemetryConfig:
     OpenTelemetry supports excluding urls by passing an env in the format '{exclude_urls_env_key}_EXCLUDED_URLS'. With
     the default being ``LITESTAR_EXCLUDED_URLS``.
     """
+    exclude_spans: list[Literal["receive", "send"]] | None = None
+    """Optionally exclude HTTP send and/or receive spans from the trace."""
     scopes: Scopes | None = field(default=None)
     """ASGI scopes processed by the middleware, if None both ``http`` and ``websocket`` will be processed."""
     middleware_class: type[OpenTelemetryInstrumentationMiddleware] = field(
diff --git a/litestar/contrib/opentelemetry/middleware.py b/litestar/contrib/opentelemetry/middleware.py
@@ -38,6 +38,7 @@ def __init__(self, app: ASGIApp, config: OpenTelemetryConfig) -> None:
             client_response_hook=config.client_response_hook_handler,  # type: ignore[arg-type]
             default_span_details=config.scope_span_details_extractor,
             excluded_urls=get_excluded_urls(config.exclude_urls_env_key),
+            exclude_spans=config.exclude_spans,
             meter=config.meter,
             meter_provider=config.meter_provider,
             server_request_hook=config.server_request_hook_handler,
diff --git a/litestar/exceptions/responses/_debug_response.py b/litestar/exceptions/responses/_debug_response.py
@@ -151,12 +151,16 @@ def create_html_response_content(exc: Exception, request: Request, line_limit: i
     scripts = (tpl_dir / "scripts.js").read_text()
     styles = (tpl_dir / "styles.css").read_text()
     body_tpl = (tpl_dir / "body.html").read_text()
+
+    plain_text_traceback = create_plain_text_response_content(exc)
+
     return body_tpl.format(
         scripts=scripts,
         styles=styles,
         error=f"<span>{escape(exc.__class__.__name__)}</span> on {request.method} {escape(request.url.path)}",
         error_description=escape(str(exc)),
         exception_data="".join(exception_data),
+        plain_text_traceback=escape(plain_text_traceback),
     )
 
 
diff --git a/litestar/exceptions/responses/templates/body.html b/litestar/exceptions/responses/templates/body.html
@@ -11,7 +11,18 @@
   <body>
     <h4>{error}</h4>
     <h3><span>{error_description}</span></h3>
-    {exception_data}
+    <div class="traceback-controls">
+      <button id="copyBtn" onclick="copyTraceback()">
+        Copy traceback to clipboard
+      </button>
+      <button id="toggleView" onclick="toggleTracebackView()">
+        Plaintext view
+      </button>
+    </div>
+    <div id="browserTraceback">{exception_data}</div>
+    <div id="pastebinTraceback" style="display: none">
+      <textarea id="traceback_area" readonly rows="30">{plain_text_traceback}</textarea>
+    </div>
     <script type="text/javascript">
       // prettier-ignore
       {scripts} // NOSONAR
diff --git a/litestar/exceptions/responses/templates/scripts.js b/litestar/exceptions/responses/templates/scripts.js
@@ -25,3 +25,33 @@ const nonCollapsedSnippets = document.querySelectorAll(
 for (const snippet of nonCollapsedSnippets) {
   snippet.style.height = `${snippet.scrollHeight}px`;
 }
+
+function toggleTracebackView() {
+  const browser = document.getElementById("browserTraceback");
+  const pastebin = document.getElementById("pastebinTraceback");
+  const toggleBtn = document.getElementById("toggleView");
+
+  if (pastebin.style.display === "none") {
+    browser.style.display = "none";
+    pastebin.style.display = "block";
+    toggleBtn.textContent = "Interactive view";
+  } else {
+    browser.style.display = "block";
+    pastebin.style.display = "none";
+    toggleBtn.textContent = "Plaintext view";
+  }
+}
+
+async function copyTraceback() {
+  const textarea = document.getElementById("traceback_area");
+  const copyBtn = document.getElementById("copyBtn");
+  try {
+    await navigator.clipboard.writeText(textarea.value);
+    const original = copyBtn.textContent;
+    copyBtn.textContent = "Copied!";
+    setTimeout(() => (copyBtn.textContent = original), 2000);
+  } catch (err) {
+    textarea.select();
+    document.execCommand("copy");
+  }
+}
diff --git a/litestar/exceptions/responses/templates/styles.css b/litestar/exceptions/responses/templates/styles.css
diff --git a/litestar/middleware/compression/zstd_facade.py b/litestar/middleware/compression/zstd_facade.py
diff --git a/litestar/openapi/plugins.py b/litestar/openapi/plugins.py
diff --git a/litestar/plugins/pydantic/dto.py b/litestar/plugins/pydantic/dto.py
diff --git a/tests/e2e/test_routing/test_path_resolution.py b/tests/e2e/test_routing/test_path_resolution.py
diff --git a/tests/unit/test_exceptions.py b/tests/unit/test_exceptions.py
diff --git a/tests/unit/test_openapi/test_endpoints.py b/tests/unit/test_openapi/test_endpoints.py
diff --git a/tests/unit/test_plugins/test_pydantic/test_computed_optional_field.py b/tests/unit/test_plugins/test_pydantic/test_computed_optional_field.py
