✨ Add support for FrozenSet in parameters (e.g. query) (#2938)

Co-authored-by: saborisov <borisov_s@tass.ru> Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
tiangolo · Aug 25, 2022 · ca2fae0 · ca2fae0
1 parent af3a6ef
commit ca2fae0
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 1 deletion.
diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py
@@ -34,6 +34,7 @@
 from pydantic.error_wrappers import ErrorWrapper
 from pydantic.errors import MissingError
 from pydantic.fields import (
+    SHAPE_FROZENSET,
     SHAPE_LIST,
     SHAPE_SEQUENCE,
     SHAPE_SET,
@@ -58,6 +59,7 @@
 sequence_shapes = {
     SHAPE_LIST,
     SHAPE_SET,
+    SHAPE_FROZENSET,
     SHAPE_TUPLE,
     SHAPE_SEQUENCE,
     SHAPE_TUPLE_ELLIPSIS,

diff --git a/tests/main.py b/tests/main.py
@@ -1,5 +1,5 @@
 import http
-from typing import Optional
+from typing import FrozenSet, Optional
 
 from fastapi import FastAPI, Path, Query
 
@@ -192,3 +192,8 @@ def get_query_param_required_type(query: int = Query()):
 @app.get("/enum-status-code", status_code=http.HTTPStatus.CREATED)
 def get_enum_status_code():
     return "foo bar"
+
+
+@app.get("/query/frozenset")
+def get_query_type_frozenset(query: FrozenSet[int] = Query(...)):
+    return ",".join(map(str, sorted(query)))
diff --git a/tests/test_application.py b/tests/test_application.py
@@ -1090,6 +1090,41 @@
                 "operationId": "get_enum_status_code_enum_status_code_get",
             }
         },
+        "/query/frozenset": {
+            "get": {
+                "summary": "Get Query Type Frozenset",
+                "operationId": "get_query_type_frozenset_query_frozenset_get",
+                "parameters": [
+                    {
+                        "required": True,
+                        "schema": {
+                            "title": "Query",
+                            "uniqueItems": True,
+                            "type": "array",
+                            "items": {"type": "integer"},
+                        },
+                        "name": "query",
+                        "in": "query",
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Successful Response",
+                        "content": {"application/json": {"schema": {}}},
+                    },
+                    "422": {
+                        "description": "Validation Error",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/HTTPValidationError"
+                                }
+                            }
+                        },
+                    },
+                },
+            }
+        },
     },
     "components": {
         "schemas": {

diff --git a/tests/test_query.py b/tests/test_query.py
@@ -53,6 +53,7 @@
         ("/query/param-required/int", 422, response_missing),
         ("/query/param-required/int?query=50", 200, "foo bar 50"),
         ("/query/param-required/int?query=foo", 422, response_not_valid_int),
+        ("/query/frozenset/?query=1&query=1&query=2", 200, "1,2"),
     ],
 )
 def test_get_path(path, expected_status, expected_response):