Renderers¶
-
class
djburger.renderers.
BSON
(flat=True, **kwargs)[source]¶ Render into BSON format by BSON package
Returns: rendered response. Return type: django.http.HttpResponse
-
class
djburger.renderers.
Base
(renderer, content_name, request_name=None, names=None, content=None, flat=False, **kwargs)[source]¶ Wrapper for using any function as renderer.
Parameters: - renderer (callable) – function for rendering.
- content_name (str) – keyword of data argument for renderer.
- request_name (str) – keyword of Request argument for renderer.
- names (dict) – dict of names. Keys: * data (default: “data”): name for data into content. * errors (default: “errors”): name for errors into content. * validator (default: None): name for validator into content. If not setted, validator will not be passed into content.
- content (dict) – default params for content.
- flat (bool) – if True content contains only data or errors.
- **kwargs – some kwargs which will be passed to renderer.
Returns: rendered response.
Return type: django.http.HttpResponse
-
class
djburger.renderers.
BaseWithHTTP
(renderer, content_name, request_name=None, names=None, content=None, flat=False, **kwargs)[source]¶ Base class wrapped by HttpResponse
Parameters: **kwargs – all kwargs of djburger.renderers.Base. -
set_http_kwargs
(**kwargs)[source]¶ Set kwargs for HttpResponse
Parameters: **kwargs – all kwargs of HttpResponse. Returns: self. Allow use chain. Return type: BaseWithHTTP
-
-
class
djburger.renderers.
Exception
(exception=<class 'djburger.mocks.ValidationError'>)[source]¶ Raise Exception
We are recommend use this renderer as postrenderer. Raised exception can be handled by decorators or loggers.
Parameters: exception – exception for raising.
-
class
djburger.renderers.
HTTP
(status_code=200, **kwargs)[source]¶ Render data by HttpResponse.
data can be only str or bytes type.
-
class
djburger.renderers.
RESTFramework
(renderer, flat=True, **kwargs)[source]¶ Wrapper for renderers from Django REST Framework
-
class
djburger.renderers.
Redirect
(url=None)[source]¶ Redirect to URL
URL can be passed by initialization or as data (str).
Parameters: url – url for redirect. Returns: rendered redirect response. Return type: django.http.HttpResponseRedirect
-
class
djburger.renderers.
Tablib
(ext, headers=None, **kwargs)[source]¶ Render into multiple formats by tablib
Parameters: - ext – extension for rendering by Tablib.
- headers – table headers.
Returns: rendered response.
Return type: django.http.HttpResponse
-
djburger.renderers.
Template
= <functools.partial object>¶ Serializer based on Django Templates