djburger 0.7.1

Installation

pip install djburger

sudo pip install -e git+https://github.com/orsinium/djburger.git#egg=djburger

-e git+https://github.com/orsinium/djburger.git#egg=djburger

Components

Main components:

1. Validators (djburger.v). Can be used as prev and postv.

   1. Bases (djburger.v.b).

   2. Constructors (djburger.v.c).

   3. Wrappers (djburger.v.w)

2. Controllers (djburger.c). Can be used as c.

3. Renderer (djburger.r). Can be used as prer, postr and r.

Some additional components:

1. djburger.exceptions – useful exceptions.

Interfaces

1. Decorator. Any decorator which can wrap Django view

2. Validator. Have same interfaces as Django Forms, but get request by initialization:

   1. .__init__()

      • request – Request object

      • data – data from user (prev) or controller (postv)

      • **kwargs – any keyword arguments for validator

   2. .is_valid() – return True if data is valid False otherwise.

   3. .errors – errors if data is invalid.

   4. .cleaned_data – cleaned data if input data is valid.

3. Controller. Any callable object. Kwargs:

   1. request – Request object.

   2. data – validated request data. 3 **kwargs – kwargs from url.

4. Renderer. Any callable object. Kwargs:

   1. request – Request object.

   2. data – validated controller data (only for r).

   3. validator – validator which not be passed (only for prer and postr).

   4. status_code – HTTP status code if validator raise djburger.e.StatusCodeError.

Usage example

View definition:

import djburger

class ExampleView(djburger.ViewBase):
    rules = {
        'get': djburger.rule(
            c=lambda request, data, **kwargs: 'Hello, World!',
            postv=djburger.v.c.IsStrValidator,
            postr=djburger.s.ExceptionSerializer,
            r=djburger.r.Template(template_name='index.html'),
        ),
    }

External libraries support

• Django REST Framework

  • djburger.v.b.RESTFramework

  • djburger.v.w.RESTFramework

  • djburger.r.RESTFramework

• Marshmallow

  • djburger.v.b.Marshmallow

  • djburger.v.w.Marshmallow

• PySchemes

  • djburger.v.c.PySchemes

  • djburger.v.w.PySchemes

• PyYAML

  • djburger.r.YAML

• Tablib

  • djburger.r.Tablib

• BSON

  • djburger.p.BSON

  • djburger.r.BSON