Skip to content

Added methods to easily add custom errors. #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Added methods to easily add custom errors. #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 94 additions & 47 deletions aiohttp_deps/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,26 @@ def __init__(
self.type_initialized = False
self.type_cache: "Union[pydantic.TypeAdapter[Any], None]" = None

def on_validate_error(
self,
param_info: ParamInfo,
request: web.Request,
err: pydantic.ValidationError,
) -> Any:
"""Method to handle validation errors."""
header_name = self.alias or param_info.name
errors = err.errors(include_url=False)
for error in errors:
error["loc"] = (
"header",
header_name,
) + error["loc"]
error.pop("input", None) # type: ignore
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err

def __call__(
self,
param_info: ParamInfo = Depends(),
Expand Down Expand Up @@ -75,17 +95,7 @@ def __call__(
try:
return self.type_cache.validate_python(value)
except pydantic.ValidationError as err:
errors = err.errors(include_url=False)
for error in errors:
error["loc"] = (
"header",
header_name,
) + error["loc"]
error.pop("input", None) # type: ignore
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err
return self.on_validate_error(param_info, request, err)


class Json:
Expand All @@ -100,6 +110,22 @@ def __init__(self) -> None:
self.type_initialized = False
self.type_cache: "Union[pydantic.TypeAdapter[Any], None]" = None

def on_validate_error(
self,
param_info: ParamInfo,
request: web.Request,
err: pydantic.ValidationError,
) -> Any:
"""Method to handle validation errors."""
errors = err.errors(include_url=False)
for error in errors:
error["loc"] = ("body",) + error["loc"]
error.pop("input", None) # type: ignore
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err

async def __call__(
self,
param_info: ParamInfo = Depends(),
Expand Down Expand Up @@ -135,14 +161,7 @@ async def __call__(
try:
return self.type_cache.validate_python(body)
except pydantic.ValidationError as err:
errors = err.errors(include_url=False)
for error in errors:
error["loc"] = ("body",) + error["loc"]
error.pop("input", None) # type: ignore
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err
return self.on_validate_error(param_info, request, err)


class Query:
Expand Down Expand Up @@ -173,6 +192,26 @@ def __init__(
self.type_initialized = False
self.type_cache: "Union[pydantic.TypeAdapter[Any], None]" = None

def on_validate_error(
self,
param_info: ParamInfo,
request: web.Request,
err: pydantic.ValidationError,
) -> Any:
"""Method to handle validation errors."""
param_name = self.alias or param_info.name
errors = err.errors(include_url=False)
for error in errors:
error["loc"] = (
"query",
param_name,
) + error["loc"]
error.pop("input", None) # type: ignore
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err

def __call__(
self,
param_info: ParamInfo = Depends(),
Expand Down Expand Up @@ -213,17 +252,7 @@ def __call__(
try:
return self.type_cache.validate_python(value)
except pydantic.ValidationError as err:
errors = err.errors(include_url=False)
for error in errors:
error["loc"] = (
"query",
param_name,
) + error["loc"]
error.pop("input", None) # type: ignore
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err
return self.on_validate_error(param_info, request, err)


class Form:
Expand All @@ -240,6 +269,22 @@ def __init__(self) -> None:
self.type_initialized = False
self.type_cache: "Union[pydantic.TypeAdapter[Any], None]" = None

def on_validate_error(
self,
param_info: ParamInfo,
request: web.Request,
err: pydantic.ValidationError,
) -> Any:
"""Method to handle validation errors."""
errors = err.errors(include_url=False)
for error in errors:
error.pop("input", None) # type: ignore
error["loc"] = ("form",) + error["loc"]
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err

async def __call__(
self,
param_info: ParamInfo = Depends(),
Expand Down Expand Up @@ -272,14 +317,7 @@ async def __call__(
try:
return self.type_cache.validate_python(form_data)
except pydantic.ValidationError as err:
errors = err.errors(include_url=False)
for error in errors:
error.pop("input", None) # type: ignore
error["loc"] = ("form",) + error["loc"]
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err
return self.on_validate_error(param_info, request, err)


class Path:
Expand All @@ -304,6 +342,22 @@ def __init__(
self.type_initialized = False
self.type_cache: "Union[pydantic.TypeAdapter[Any], None]" = None

def on_validate_error(
self,
param_info: ParamInfo,
request: web.Request,
err: pydantic.ValidationError,
) -> Any:
"""Method to handle validation errors."""
errors = err.errors(include_url=False)
for error in errors:
error.pop("input", None) # type: ignore
error["loc"] = ("path",) + error["loc"]
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err

def __call__(
self,
param_info: ParamInfo = Depends(),
Expand Down Expand Up @@ -336,14 +390,7 @@ def __call__(
try:
return self.type_cache.validate_python(matched_data)
except pydantic.ValidationError as err:
errors = err.errors(include_url=False)
for error in errors:
error.pop("input", None) # type: ignore
error["loc"] = ("path",) + error["loc"]
raise web.HTTPBadRequest(
headers={"Content-Type": "application/json"},
text=json.dumps(errors),
) from err
return self.on_validate_error(param_info, request, err)


class ExtraOpenAPI:
Expand Down Expand Up @@ -375,6 +422,6 @@ def __call__(self) -> None:
"""
This method is called when dependency is resolved.

It's empty, becuase it's used by the swagger function and
It's empty, becuase it's used only by the `setup_swagger` function and
there is no actual dependency.
"""
Loading