simple_django_api package

Subpackages

• simple_django_api.jwt package
  • Submodules
  • simple_django_api.jwt.auth module
  • simple_django_api.jwt.consts module
  • simple_django_api.jwt.middleware module
  • simple_django_api.jwt.settings module
  • Module contents

Submodules

simple_django_api.compat module

simple_django_api.consts module

simple_django_api.exceptions module

exception simple_django_api.exceptions.APIError(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: Exception

logging_level = 40

status_code = 500

exception simple_django_api.exceptions.Forbidden(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: simple_django_api.exceptions.APIError

logging_level = 30

status_code = 403

exception simple_django_api.exceptions.InternalError(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: simple_django_api.exceptions.APIError

logging_level = 40

status_code = 500

exception simple_django_api.exceptions.InvalidRequestBody(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: simple_django_api.exceptions.APIError

status_code = 400

exception simple_django_api.exceptions.NotFound(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: simple_django_api.exceptions.APIError

logging_level = 30

status_code = 404

exception simple_django_api.exceptions.ParamsError(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: simple_django_api.exceptions.APIError

logging_level = 30

status_code = 400

exception simple_django_api.exceptions.Unauthorized(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: simple_django_api.exceptions.APIError

logging_level = 30

status_code = 401

exception simple_django_api.exceptions.ValidationError(*, user_hint='', logging_hint='', status_code=None, logging_level=None)

Bases: simple_django_api.exceptions.ParamsError

messages = 'bad request'

simple_django_api.permissions module

You can writer permission in two ways:

class LoginRequired:
    def __init__(self, view_cls):
        self.view_cls = view_cls

    def __call__(self, request, **kwargs):
        if not request.user.is_authenticated:
            raise exceptions.Unauthorized()

def login_required(view):
    def inner(request, **kwargs):
        if not request.user.is_authenticated:
            raise exceptions.Unauthorized()

    return inner

class simple_django_api.permissions.BasePermission(view_cls)

Bases: abc.ABC

class simple_django_api.permissions.LoginRequired(view_cls)

Bases: simple_django_api.permissions.BasePermission

class simple_django_api.permissions.SuperUserRequired(view_cls)

Bases: simple_django_api.permissions.BasePermission

simple_django_api.permissions.login_required(view_cls)

simple_django_api.request module

simple_django_api.response module

simple_django_api.views module

Module contents

Top-level package for simple-django-api.