Skip to content
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

Add parser support to Operation and Router classes #1392

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add parser support to Operation and Router classes #1392

Show file tree
Hide file tree
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
15 changes: 14 additions & 1 deletion ninja/operation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
from ninja.throttling import BaseThrottle
from ninja.types import DictStrAny
from ninja.utils import check_csrf, is_async_callable
from ninja.parser import Parser


if TYPE_CHECKING:
from ninja import NinjaAPI, Router # pragma: no cover
Expand Down Expand Up @@ -60,6 +62,7 @@ def __init__(
include_in_schema: bool = True,
url_name: Optional[str] = None,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> None:
self.is_async = False
self.path: str = path
Expand All @@ -72,7 +75,9 @@ def __init__(
self.auth_param: Optional[Union[Sequence[Callable], Callable, object]] = auth
self.auth_callbacks: Sequence[Callable] = []
self._set_auth(auth)


self.parser = parser or Parser()

if isinstance(throttle, BaseThrottle):
throttle = [throttle]
self.throttle_param = throttle
Expand Down Expand Up @@ -116,6 +121,12 @@ def __init__(
callback(self)

def run(self, request: HttpRequest, **kw: Any) -> HttpResponseBase:
if request.body:
try:
self.parser.parse_body(request)
except Exception as e:
return self.api.on_exception(request, e)

error = self._run_checks(request)
if error:
return error
Expand Down Expand Up @@ -411,6 +422,7 @@ def add_operation(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> Operation:
if url_name:
self.url_name = url_name
Expand Down Expand Up @@ -439,6 +451,7 @@ def add_operation(
include_in_schema=include_in_schema,
url_name=url_name,
openapi_extra=openapi_extra,
parser=parser,
)

self.operations.append(operation)
Expand Down
15 changes: 15 additions & 0 deletions ninja/router.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from ninja.errors import ConfigError
from ninja.operation import PathView
from ninja.throttling import BaseThrottle
from ninja.parser import Parser
from ninja.types import TCallable
from ninja.utils import normalize_path, replace_path_param_notation

Expand Down Expand Up @@ -71,6 +72,7 @@ def get(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> Callable[[TCallable], TCallable]:
return self.api_operation(
["GET"],
Expand All @@ -90,6 +92,7 @@ def get(
url_name=url_name,
include_in_schema=include_in_schema,
openapi_extra=openapi_extra,
parser=parser,
)

def post(
Expand All @@ -111,6 +114,7 @@ def post(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> Callable[[TCallable], TCallable]:
return self.api_operation(
["POST"],
Expand All @@ -130,6 +134,7 @@ def post(
url_name=url_name,
include_in_schema=include_in_schema,
openapi_extra=openapi_extra,
parser=parser,
)

def delete(
Expand All @@ -151,6 +156,7 @@ def delete(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> Callable[[TCallable], TCallable]:
return self.api_operation(
["DELETE"],
Expand All @@ -170,6 +176,7 @@ def delete(
url_name=url_name,
include_in_schema=include_in_schema,
openapi_extra=openapi_extra,
parser=parser,
)

def patch(
Expand All @@ -191,6 +198,7 @@ def patch(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> Callable[[TCallable], TCallable]:
return self.api_operation(
["PATCH"],
Expand All @@ -210,6 +218,7 @@ def patch(
url_name=url_name,
include_in_schema=include_in_schema,
openapi_extra=openapi_extra,
parser=parser,
)

def put(
Expand All @@ -231,6 +240,7 @@ def put(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> Callable[[TCallable], TCallable]:
return self.api_operation(
["PUT"],
Expand All @@ -250,6 +260,7 @@ def put(
url_name=url_name,
include_in_schema=include_in_schema,
openapi_extra=openapi_extra,
parser=parser,
)

def api_operation(
Expand All @@ -272,6 +283,7 @@ def api_operation(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> Callable[[TCallable], TCallable]:
def decorator(view_func: TCallable) -> TCallable:
self.add_api_operation(
Expand All @@ -293,6 +305,7 @@ def decorator(view_func: TCallable) -> TCallable:
url_name=url_name,
include_in_schema=include_in_schema,
openapi_extra=openapi_extra,
parser=parser,
)
return view_func

Expand All @@ -319,6 +332,7 @@ def add_api_operation(
url_name: Optional[str] = None,
include_in_schema: bool = True,
openapi_extra: Optional[Dict[str, Any]] = None,
parser: Optional[Parser] = None,
) -> None:
if path not in self.path_operations:
path_view = PathView()
Expand Down Expand Up @@ -352,6 +366,7 @@ def add_api_operation(
url_name=url_name,
include_in_schema=include_in_schema,
openapi_extra=openapi_extra,
parser=parser,
)
if self.api:
path_view.set_api_instance(self.api, self)
Expand Down