Browse Source
* 📝 Update docs to deprecate regex, recommend pattern * ♻️ Update examples to use new pattern instead of regex * 📝 Add new example with deprecated regex * ♻️ Add deprecation notes and warnings for regex * ✅ Add tests for regex deprecation * ✅ Update tests for compatibility with Pydantic v1pull/9795/head
Sebastián Ramírez
2 years ago
committed by
GitHub
GitHub
16 changed files with 497 additions and 31 deletions
@ -0,0 +1,17 @@ |
|||
from typing import Annotated |
|||
|
|||
from fastapi import FastAPI, Query |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.get("/items/") |
|||
async def read_items( |
|||
q: Annotated[ |
|||
str | None, Query(min_length=3, max_length=50, regex="^fixedquery$") |
|||
] = None |
|||
): |
|||
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]} |
|||
if q: |
|||
results.update({"q": q}) |
|||
return results |
|||
@ -0,0 +1,183 @@ |
|||
from typing import Annotated |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi import FastAPI, Form |
|||
from fastapi.testclient import TestClient |
|||
from fastapi.utils import match_pydantic_error_url |
|||
|
|||
from .utils import needs_py310 |
|||
|
|||
|
|||
def get_client(): |
|||
app = FastAPI() |
|||
with pytest.warns(DeprecationWarning): |
|||
|
|||
@app.post("/items/") |
|||
async def read_items( |
|||
q: Annotated[str | None, Form(regex="^fixedquery$")] = None |
|||
): |
|||
if q: |
|||
return f"Hello {q}" |
|||
else: |
|||
return "Hello World" |
|||
|
|||
client = TestClient(app) |
|||
return client |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_no_query(): |
|||
client = get_client() |
|||
response = client.post("/items/") |
|||
assert response.status_code == 200 |
|||
assert response.json() == "Hello World" |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_q_fixedquery(): |
|||
client = get_client() |
|||
response = client.post("/items/", data={"q": "fixedquery"}) |
|||
assert response.status_code == 200 |
|||
assert response.json() == "Hello fixedquery" |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_query_nonregexquery(): |
|||
client = get_client() |
|||
response = client.post("/items/", data={"q": "nonregexquery"}) |
|||
assert response.status_code == 422 |
|||
assert response.json() == IsDict( |
|||
{ |
|||
"detail": [ |
|||
{ |
|||
"type": "string_pattern_mismatch", |
|||
"loc": ["body", "q"], |
|||
"msg": "String should match pattern '^fixedquery$'", |
|||
"input": "nonregexquery", |
|||
"ctx": {"pattern": "^fixedquery$"}, |
|||
"url": match_pydantic_error_url("string_pattern_mismatch"), |
|||
} |
|||
] |
|||
} |
|||
) | IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"detail": [ |
|||
{ |
|||
"ctx": {"pattern": "^fixedquery$"}, |
|||
"loc": ["body", "q"], |
|||
"msg": 'string does not match regex "^fixedquery$"', |
|||
"type": "value_error.str.regex", |
|||
} |
|||
] |
|||
} |
|||
) |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_openapi_schema(): |
|||
client = get_client() |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
# insert_assert(response.json()) |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/items/": { |
|||
"post": { |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/x-www-form-urlencoded": { |
|||
"schema": IsDict( |
|||
{ |
|||
"allOf": [ |
|||
{ |
|||
"$ref": "#/components/schemas/Body_read_items_items__post" |
|||
} |
|||
], |
|||
"title": "Body", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"$ref": "#/components/schemas/Body_read_items_items__post" |
|||
} |
|||
) |
|||
} |
|||
} |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
} |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"Body_read_items_items__post": { |
|||
"properties": { |
|||
"q": IsDict( |
|||
{ |
|||
"anyOf": [ |
|||
{"type": "string", "pattern": "^fixedquery$"}, |
|||
{"type": "null"}, |
|||
], |
|||
"title": "Q", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"type": "string", "pattern": "^fixedquery$", "title": "Q"} |
|||
) |
|||
}, |
|||
"type": "object", |
|||
"title": "Body_read_items_items__post", |
|||
}, |
|||
"HTTPValidationError": { |
|||
"properties": { |
|||
"detail": { |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
"type": "array", |
|||
"title": "Detail", |
|||
} |
|||
}, |
|||
"type": "object", |
|||
"title": "HTTPValidationError", |
|||
}, |
|||
"ValidationError": { |
|||
"properties": { |
|||
"loc": { |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
"type": "array", |
|||
"title": "Location", |
|||
}, |
|||
"msg": {"type": "string", "title": "Message"}, |
|||
"type": {"type": "string", "title": "Error Type"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["loc", "msg", "type"], |
|||
"title": "ValidationError", |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -0,0 +1,166 @@ |
|||
from typing import Annotated |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi import FastAPI, Query |
|||
from fastapi.testclient import TestClient |
|||
from fastapi.utils import match_pydantic_error_url |
|||
|
|||
from .utils import needs_py310 |
|||
|
|||
|
|||
def get_client(): |
|||
app = FastAPI() |
|||
with pytest.warns(DeprecationWarning): |
|||
|
|||
@app.get("/items/") |
|||
async def read_items( |
|||
q: Annotated[str | None, Query(regex="^fixedquery$")] = None |
|||
): |
|||
if q: |
|||
return f"Hello {q}" |
|||
else: |
|||
return "Hello World" |
|||
|
|||
client = TestClient(app) |
|||
return client |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_query_params_str_validations_no_query(): |
|||
client = get_client() |
|||
response = client.get("/items/") |
|||
assert response.status_code == 200 |
|||
assert response.json() == "Hello World" |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_query_params_str_validations_q_fixedquery(): |
|||
client = get_client() |
|||
response = client.get("/items/", params={"q": "fixedquery"}) |
|||
assert response.status_code == 200 |
|||
assert response.json() == "Hello fixedquery" |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_query_params_str_validations_item_query_nonregexquery(): |
|||
client = get_client() |
|||
response = client.get("/items/", params={"q": "nonregexquery"}) |
|||
assert response.status_code == 422 |
|||
assert response.json() == IsDict( |
|||
{ |
|||
"detail": [ |
|||
{ |
|||
"type": "string_pattern_mismatch", |
|||
"loc": ["query", "q"], |
|||
"msg": "String should match pattern '^fixedquery$'", |
|||
"input": "nonregexquery", |
|||
"ctx": {"pattern": "^fixedquery$"}, |
|||
"url": match_pydantic_error_url("string_pattern_mismatch"), |
|||
} |
|||
] |
|||
} |
|||
) | IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"detail": [ |
|||
{ |
|||
"ctx": {"pattern": "^fixedquery$"}, |
|||
"loc": ["query", "q"], |
|||
"msg": 'string does not match regex "^fixedquery$"', |
|||
"type": "value_error.str.regex", |
|||
} |
|||
] |
|||
} |
|||
) |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_openapi_schema(): |
|||
client = get_client() |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
# insert_assert(response.json()) |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/items/": { |
|||
"get": { |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "q", |
|||
"in": "query", |
|||
"required": False, |
|||
"schema": IsDict( |
|||
{ |
|||
"anyOf": [ |
|||
{"type": "string", "pattern": "^fixedquery$"}, |
|||
{"type": "null"}, |
|||
], |
|||
"title": "Q", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "string", |
|||
"pattern": "^fixedquery$", |
|||
"title": "Q", |
|||
} |
|||
), |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
} |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"HTTPValidationError": { |
|||
"properties": { |
|||
"detail": { |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
"type": "array", |
|||
"title": "Detail", |
|||
} |
|||
}, |
|||
"type": "object", |
|||
"title": "HTTPValidationError", |
|||
}, |
|||
"ValidationError": { |
|||
"properties": { |
|||
"loc": { |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
"type": "array", |
|||
"title": "Location", |
|||
}, |
|||
"msg": {"type": "string", "title": "Message"}, |
|||
"type": {"type": "string", "title": "Error Type"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["loc", "msg", "type"], |
|||
"title": "ValidationError", |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
Loading…
Reference in new issue