Merge branch 'main' into feat/sse-ping-interval

Author: TanayK07

.github/workflows/cherry-pick-v2.yaml

@@ -371,3 +371,9 @@
         Add a new attribute :attr:`~litestar.middleware.ASGIMiddleware.should_bypass_for_scope`;
         A callable which takes in a :class:`~litestar.types.Scope` and returns a boolean
         to indicate whether to bypass the middleware for the current request.
+
+    .. change:: Fix KeyError when ClassVar exists on msgspec Struct
+        :type: bugfix
+        :pr: 4665
+
+        Fix a bug in :class:`MsgspecDTO` where a KeyError was raised if a :class:`msgspec.Struct` contained a :class:`~typing.ClassVar`. ClassVars are now correctly skipped when generating field definitions.

docs/release-notes/changelog.rst

@@ -371,6 +371,11 @@ async def _extract_multipart(
 
     for name, tp in field_definition.get_type_hints().items():
         value = form_values.get(name)
+        if value == "" and is_optional_union(tp):
+            inner: Any = make_non_optional_union(tp)
+            if isinstance(inner, type) and issubclass(inner, UploadFile):
+                form_values[name] = None  # pyright: ignore
+                continue
         if (
             value is not None
             and not isinstance(value, list)

litestar/_kwargs/extractors.py

@@ -398,15 +398,16 @@ def priority(self) -> tuple[int, int]:
         # Use fixed point values with two decimals to avoid problems
         # when comparing float values
         quality = 100
-        if "q" in self.params:
+        qparam = self.params.get("q")
+        if qparam is not None:
             with suppress(ValueError):
-                quality = int(100 * float(self.params["q"]))
+                quality = int(100 * float(qparam))
 
         if self.maintype == "*":
             specificity = 0
         elif self.subtype == "*":
             specificity = 1
-        elif not self.params or ("q" in self.params and len(self.params) == 1):
+        elif not self.params or (qparam is not None and len(self.params) == 1):
             # no params or 'q' is the only one which we ignore
             specificity = 2
         else:

litestar/datastructures/headers.py

@@ -48,6 +48,8 @@ def generate_field_definitions(cls, model_type: type[Struct]) -> Generator[DTOFi
         property_fields = cls.get_property_fields(model_type)
 
         for key, field_definition in cls.get_model_type_hints(model_type).items():
+            if key not in inspect_fields:
+                continue
             kwarg_definition, extra = kwarg_definition_from_field(inspect_fields[key])
             field_definition = dataclasses.replace(field_definition, kwarg_definition=kwarg_definition)
             field_definition.extra.update(extra)

litestar/dto/msgspec_dto.py

@@ -146,7 +146,7 @@ dev = [
   "psutil>=5.9.8",
   "hypercorn>=0.16.0",
   "daphne>=4.0.0",
-  "opentelemetry-sdk<1.40.0",
+  "opentelemetry-sdk",
   "httpx-sse",
   "structlog",
 ]

pyproject.toml

@@ -2,7 +2,7 @@
 
 import itertools
 from dataclasses import replace
-from typing import TYPE_CHECKING, Annotated
+from typing import TYPE_CHECKING, Annotated, ClassVar
 from unittest.mock import ANY
 
 import pytest
@@ -216,3 +216,15 @@ def handler_3(data: Model3) -> None:
         "required": ["foo", "regular_field"],
         "title": "Model3",
     }
+
+
+def test_msgspec_dto_with_classvar() -> None:
+    class ModelWithClassVar(Struct):
+        regular_field: str
+        class_field: ClassVar[str] = "a string in the class"
+
+    field_defs = list(MsgspecDTO.generate_field_definitions(ModelWithClassVar))
+
+    # Only the regular field should be included, not the ClassVar
+    assert len(field_defs) == 1
+    assert field_defs[0].name == "regular_field"

tests/unit/test_contrib/test_msgspec.py

@@ -31,7 +31,7 @@ def resource() -> Resource:
 
 @pytest.fixture(scope="session")
 def reader() -> InMemoryMetricReader:
-    aggregation_last_value = {Counter: ExplicitBucketHistogramAggregation()}
+    aggregation_last_value = {Counter: ExplicitBucketHistogramAggregation(boundaries=[])}
     return InMemoryMetricReader(preferred_aggregation=aggregation_last_value)  # type: ignore[arg-type]
 
 
@@ -104,7 +104,7 @@ def handler() -> dict:
         resource_metrics = metric_data.resource_metrics[0]
         assert resource_metrics.scope_metrics
 
-        scope_metrics = resource_metrics.scope_metrics[0]
+        scope_metrics = next(sm for sm in resource_metrics.scope_metrics if sm.scope.name != "opentelemetry-sdk")
         assert scope_metrics.metrics
 
         request_metric = scope_metrics.metrics[0]

tests/unit/test_contrib/test_opentelemetry.py

@@ -358,7 +358,6 @@ def test_etag_to_header_weak() -> None:
     (
         ("text/plain", ["text/plain"], "text/plain"),
         ("text/plain", [MediaType.TEXT], MediaType.TEXT),
-        ("text/plain", ["text/plain"], "text/plain"),
         ("text/plain", ["text/html"], None),
         ("text/*", ["text/html"], "text/html"),
         ("*/*", ["text/html"], "text/html"),
@@ -368,6 +367,7 @@ def test_etag_to_header_weak() -> None:
         ("text/plain", ["text/*"], "text/plain"),
         ("text/html", ["*/*"], "text/html"),
         ("text/plain;q=0.8,text/html", ["text/plain", "text/html"], "text/html"),
+        ("text/plain;q=ab,text/html", ["text/plain", "text/html"], "text/plain"),
         ("text/*,text/html", ["text/plain", "text/html"], "text/html"),
     ),
 )

tests/unit/test_datastructures/test_headers.py

@@ -652,3 +652,39 @@ async def consistency_handler(request: Request) -> str:
 
         # Results should be identical
         assert response_url.text == response_multipart.text
+
+
+# https://github.com/litestar-org/litestar/issues/4647
+def test_optional_upload_file_without_file_submitted() -> None:
+    """Optional[UploadFile] in a dataclass should be None when no file is submitted via multipart."""
+
+    @dataclass
+    class UploadForm:
+        file: Optional[UploadFile] = None
+
+    @post("/", signature_namespace={"UploadForm": UploadForm, "UploadFile": UploadFile})
+    async def handler(
+        data: Annotated[UploadForm, Body(media_type=RequestEncodingType.MULTI_PART)],
+    ) -> str:
+        return "none" if data.file is None else "file"
+
+    with create_test_client([handler]) as client:
+        # Simulate browser submitting form without selecting a file (sends filename="" with empty body)
+        response = client.post(
+            "/",
+            content=(
+                b"--testboundary\r\n"
+                b'Content-Disposition: form-data; name="file"; filename=""\r\n'
+                b"Content-Type: application/octet-stream\r\n\r\n"
+                b"\r\n"
+                b"--testboundary--\r\n"
+            ),
+            headers={"Content-Type": "multipart/form-data; boundary=testboundary"},
+        )
+        assert response.status_code == HTTP_201_CREATED
+        assert response.text == "none"
+
+        # Submitting with an actual file should still work
+        response = client.post("/", files={"file": ("test.txt", b"hello", "text/plain")})
+        assert response.status_code == HTTP_201_CREATED
+        assert response.text == "file"