Support optional lists (#237)

* fix: Support for Optional[list] in pydantic schemas

* fix: linting rules

Author: Qblack

flask_openapi3/request.py

@@ -93,6 +93,9 @@ def _validate_query(query: Type[BaseModel], func_kwargs: dict):
         model_field_schema = model_properties.get(model_field_value.alias or model_field_key)
         if model_field_schema.get("type") == "array":
             key, value = _get_list_value(query, request_args, model_field_key, model_field_value)
+        # To handle Optional[list]
+        elif any(m.get("type") == "array" for m in model_field_schema.get("anyOf", [])):
+            key, value = _get_list_value(query, request_args, model_field_key, model_field_value)
         else:
             key, value = _get_value(query, request_args, model_field_key, model_field_value)
         if value is not None and value != []:

tests/test_request.py

@@ -38,6 +38,11 @@ class BookQuery(BaseModel):
     book_type: Optional[TypeEnum] = None
 
 
+class BookQueryFilter(BaseModel):
+    age: list[int]
+    fields: Optional[list[str]] = None
+
+
 class BookBody(BaseModel):
     age: int
 
@@ -71,6 +76,13 @@ def api_query(query: BookQuery):
     return {"code": 0, "message": "ok"}
 
 
+@app.get("/filter-query")
+@decorator
+def api_filter_query(query: BookQueryFilter):
+    print(query)
+    return {"fields": query.fields, "message": "ok"}
+
+
 @app.post("/form")
 def api_form(form: BookForm):
     print(form)
@@ -111,6 +123,27 @@ def test_query(client):
     assert r.status_code == 200
 
 
+def test_query_list(client):
+    r = client.get("/filter-query?age=1&fields=name&fields=age")
+    print(r.json)
+    assert r.status_code == 200
+    assert r.json["fields"] == ["name", "age"]
+
+
+def test_query_list_no_fields(client):
+    r = client.get("/filter-query?age=1")
+    print(r.json)
+    assert r.status_code == 200
+    assert r.json["fields"] is None
+
+
+def test_query_list_single_field(client):
+    r = client.get("/filter-query?age=1&fields=age")
+    print(r.json)
+    assert r.status_code == 200
+    assert r.json["fields"] == ["age"]
+
+
 def test_form(client):
     from io import BytesIO