Skip to main content

Never liked DRF plain old errors? Forget that and accept RFC 7807 - Problem Details!

Project description

DRF Problems PyPI version

TL;DR

This library implements RFC 7807 in our favorite Django REST Framework! Or, in layman terms, it introduces "Problem Details" in the HTTP APIs.

Table of Contents

Features

  • Handles exception to return response with Problem Details model.
  • Added permission mixins and base class to store exception to raise by the view on failure of permission.
  • Added view mixin which throws exception of failed permission.
  • These permissions are compatible with composable permissions introduced in DRF 3.9.0!
  • Has problem description endpoint to understand about the problem with the given code.
  • Has sample permissions which checks for minimum API version.

Pre-Requisites

  • Django >= 2.0 (Tested with 2.2)
  • djangorestframework >= 3.0.0 (Tested with 3.9.0)

Installation

Install the library as you would for any django library.

  • Install using pip. pip install drf-problems
  • Add 'drf_problems' to your INSTALLED_APPS setting.
INSTALLED_APPS = (
    ...
    'drf_problems',
)
  • DRF's default exception handler needs to be replaced. In your settings.py, update:
REST_FRAMEWORK = {
    ...
    'EXCEPTION_HANDLER': 'drf_problems.exceptions.exception_handler',
  • To use the problem description url, you need to update your urls.py:
urlpatterns = [
    ...
    path('', include('drf_problems.urls'))
]

Usage

With exceptions

In your exception class, define default_code with the error code string which is used in the type URI. To set custom title, define title with the human-readable summary of the problem type. To set description, define description with a long paragraph describing the problem.

Finally, make sure to register your exception with drf_problems.utils.register_exception function or drf_problems.utils.register decorator. Here's a sample exception class:

from drf_problems.utils import register_exception, register

@register # Either use this decorator
class InvalidVersionRequestedException(exceptions.NotAcceptable):
    default_code = 'invalid_version'
    title = 'Invalid API version'
    default_detail = 'Provided API version is invalid.')
    description = 'Malformed or unsupported version string is provided with the request.'

register_exception(InvalidVersionRequestedException) # Or this method directly.

With permissions

Use either drf_problems.permissions.ProblemPermissionMixin mixin class with your existing permissions, or extend directly from drf_problems.permissions.BaseProblemPermission. Define exception_class in the permissions to the desired exception class. For flexibility, you can even set exception instance by setting exception attribute on the permission object.

Here's a sample permissions class:

from drf_problems.permissions import BaseProblemPermission

class MinimumVersionRequiredPermission(BaseProblemPermission):
    exception_class = InvalidVersionRequestedException

With Views

Note: The permissions wouldn't throw the desired exception from the view, until the view is extended from the drf_problems.mixins.AllowPermissionWithExceptionViewMixin mixin. So, remember to update your views too, for which permissions are updated!

Resources

Roadmap

  • Add tests with some sample views using exceptions and permissions.
  • Document the code better.

Contributing

Contributions are very welcome, of any kind - whether finding new issues or any ideas for enhancements or a pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

drf-problems-1.0.2.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

drf_problems-1.0.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file drf-problems-1.0.2.tar.gz.

File metadata

  • Download URL: drf-problems-1.0.2.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for drf-problems-1.0.2.tar.gz
Algorithm Hash digest
SHA256 3b3f72073fff4fd524374c6cb74686ca55a8f5b0a00a683a65c66ab5a18fdd3b
MD5 d4a1ef102ebb2e346bffc8460eb9fd3b
BLAKE2b-256 5259ee0be9cda3d34d2dd5fd66a7be1151076861ec24766413822e1b880f7d93

See more details on using hashes here.

File details

Details for the file drf_problems-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: drf_problems-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for drf_problems-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fee447694e0e0cccc8279d9434180977fc86c8dd20cd14b8212ec27f3e3ed1c3
MD5 b46f1324719e71701762a5fde0757641
BLAKE2b-256 5d01a4e185e76adfe4a50357ec29eb83d3db6a02ad8d53a99f1c0a450bb25ecc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page