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

Jump to bottom

CrudRouter custom status_code #151

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

CrudRouter custom status_code #151

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
21 changes: 16 additions & 5 deletions fastapi_crudrouter/core/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from abc import ABC, abstractmethod
from typing import Any, Callable, Generic, List, Optional, Type, Union

from fastapi import APIRouter, HTTPException
from fastapi import APIRouter, HTTPException, status
from fastapi.types import DecoratedCallable

from ._types import T, DEPENDENCIES
Expand Down Expand Up @@ -30,6 +30,11 @@ def __init__(
update_route: Union[bool, DEPENDENCIES] = True,
delete_one_route: Union[bool, DEPENDENCIES] = True,
delete_all_route: Union[bool, DEPENDENCIES] = True,
create_status_code: Optional[int] = status.HTTP_201_CREATED,
get_all_status_code: Optional[int] = status.HTTP_200_OK,
get_one_status_code: Optional[int] = status.HTTP_200_OK,
update_status_code: Optional[int] = status.HTTP_200_OK,
delete_status_code: Optional[int] = status.HTTP_200_OK,
**kwargs: Any,
) -> None:

Expand Down Expand Up @@ -61,16 +66,18 @@ def __init__(
response_model=Optional[List[self.schema]], # type: ignore
summary="Get All",
dependencies=get_all_route,
status_code=get_all_status_code,
)

if create_route:
self._add_api_route(
"",
self._create(),
methods=["POST"],
response_model=self.schema,
response_model=None if create_status_code == 204 else self.schema,
summary="Create One",
dependencies=create_route,
status_code=create_status_code,
)

if delete_all_route:
Expand All @@ -92,28 +99,31 @@ def __init__(
summary="Get One",
dependencies=get_one_route,
error_responses=[NOT_FOUND],
status_code=get_one_status_code,
)

if update_route:
self._add_api_route(
"/{item_id}",
self._update(),
methods=["PUT"],
response_model=self.schema,
response_model=None if update_status_code == 204 else self.schema,
summary="Update One",
dependencies=update_route,
error_responses=[NOT_FOUND],
status_code=update_status_code,
)

if delete_one_route:
self._add_api_route(
"/{item_id}",
self._delete_one(),
methods=["DELETE"],
response_model=self.schema,
response_model=None if delete_status_code == 204 else self.schema,
summary="Delete One",
dependencies=delete_one_route,
error_responses=[NOT_FOUND],
status_code=delete_status_code,
)

def _add_api_route(
Expand All @@ -122,6 +132,7 @@ def _add_api_route(
endpoint: Callable[..., Any],
dependencies: Union[bool, DEPENDENCIES],
error_responses: Optional[List[HTTPException]] = None,
status_code: Optional[int] = 200,
**kwargs: Any,
) -> None:
dependencies = [] if isinstance(dependencies, bool) else dependencies
Expand All @@ -132,7 +143,7 @@ def _add_api_route(
)

super().add_api_route(
path, endpoint, dependencies=dependencies, responses=responses, **kwargs
path, endpoint, dependencies=dependencies, responses=responses, status_code=status_code, **kwargs
)

def api_route(
Expand Down
25 changes: 21 additions & 4 deletions fastapi_crudrouter/core/sqlalchemy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from typing import Any, Callable, List, Type, Generator, Optional, Union

from fastapi import Depends, HTTPException
from fastapi import Depends, HTTPException, status

from . import CRUDGenerator, NOT_FOUND, _utils
from ._types import DEPENDENCIES, PAGINATION, PYDANTIC_SCHEMA as SCHEMA
Expand Down Expand Up @@ -39,6 +39,11 @@ def __init__(
update_route: Union[bool, DEPENDENCIES] = True,
delete_one_route: Union[bool, DEPENDENCIES] = True,
delete_all_route: Union[bool, DEPENDENCIES] = True,
create_status_code: Optional[int] = status.HTTP_201_CREATED,
get_all_status_code: Optional[int] = status.HTTP_200_OK,
get_one_status_code: Optional[int] = status.HTTP_200_OK,
update_status_code: Optional[int] = status.HTTP_200_OK,
delete_status_code: Optional[int] = status.HTTP_200_OK,
**kwargs: Any
) -> None:
assert (
Expand All @@ -49,6 +54,9 @@ def __init__(
self.db_func = db
self._pk: str = db_model.__table__.primary_key.columns.keys()[0]
self._pk_type: type = _utils.get_pk_type(schema, self._pk)
self.create_status_code = create_status_code
self.update_status_code = update_status_code
self.delete_status_code = delete_status_code

super().__init__(
schema=schema,
Expand All @@ -63,6 +71,11 @@ def __init__(
update_route=update_route,
delete_one_route=delete_one_route,
delete_all_route=delete_all_route,
create_status_code=create_status_code,
get_all_status_code=get_all_status_code,
get_one_status_code=get_one_status_code,
update_status_code=update_status_code,
delete_status_code=delete_status_code,
**kwargs
)

Expand Down Expand Up @@ -107,7 +120,9 @@ def route(
db.add(db_model)
db.commit()
db.refresh(db_model)
return db_model

if not self.create_status_code == status.HTTP_204_NO_CONTENT:
return db_model
except IntegrityError:
db.rollback()
raise HTTPException(422, "Key already exists") from None
Expand All @@ -130,7 +145,8 @@ def route(
db.commit()
db.refresh(db_model)

return db_model
if not self.update_status_code == status.HTTP_204_NO_CONTENT:
return db_model
except IntegrityError as e:
db.rollback()
self._raise(e)
Expand All @@ -154,6 +170,7 @@ def route(
db.delete(db_model)
db.commit()

return db_model
if not self.delete_status_code == status.HTTP_204_NO_CONTENT:
return db_model

return route