onadata.libs.renderers package¶

Submodules¶

onadata.libs.renderers.renderers module¶

class onadata.libs.renderers.renderers.CSVRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = 'utf-8'¶

format = 'csv'¶

media_type = 'text/csv'¶

class onadata.libs.renderers.renderers.CSVZIPRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = None¶

format = 'csvzip'¶

media_type = 'application/octet-stream'¶

render(data, accepted_media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.DebugToolbarRenderer¶

Bases: rest_framework.renderers.TemplateHTMLRenderer

charset = 'utf-8'¶

format = 'debug'¶

media_type = 'text/html'¶

render(data, accepted_media_type=None, renderer_context=None)¶

template_name = 'debug.html'¶

class onadata.libs.renderers.renderers.DecimalEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, encoding='utf-8', default=None)¶

Bases: rest_framework.utils.encoders.JSONEncoder

default(obj)¶

class onadata.libs.renderers.renderers.DecimalJSONRenderer¶

Bases: rest_framework.renderers.JSONRenderer

Extends the default json renderer to handle Decimal(‘NaN’) values

encoder_class¶

alias of DecimalEncoder

class onadata.libs.renderers.renderers.GeoJsonRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = 'utf-8'¶

format = 'geojson'¶

media_type = 'application/json'¶

render(data, media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.GoogleSheetsRenderer¶

Bases: onadata.libs.renderers.renderers.XLSRenderer

format = 'gsheets'¶

class onadata.libs.renderers.renderers.KMLRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = 'utf-8'¶

format = 'kml'¶

media_type = 'application/xml'¶

render(data, accepted_media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.MediaFileContentNegotiation¶

Bases: rest_framework.negotiation.DefaultContentNegotiation

filter_renderers(renderers, format)¶

If there is a ‘.json’ style format suffix, filter the renderers so that we only negotiation against those that accept that format. If there is no renderer available, we use MediaFileRenderer.

class onadata.libs.renderers.renderers.MediaFileRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = None¶

format = None¶

media_type = '*/*'¶

render(data, accepted_media_type=None, renderer_context=None)¶

render_style = 'binary'¶

class onadata.libs.renderers.renderers.OSMExportRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = 'utf-8'¶

format = 'osm'¶

media_type = 'text/xml'¶

class onadata.libs.renderers.renderers.OSMRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = 'utf-8'¶

format = 'osm'¶

media_type = 'text/xml'¶

render(data, media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.SAVZIPRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = None¶

format = 'savzip'¶

media_type = 'application/octet-stream'¶

render(data, accepted_media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.StaticXMLRenderer¶

Bases: rest_framework.renderers.StaticHTMLRenderer

format = 'xml'¶

media_type = 'text/xml'¶

class onadata.libs.renderers.renderers.SurveyRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = 'utf-8'¶

format = 'xml'¶

media_type = 'application/xml'¶

render(data, accepted_media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.TemplateXMLRenderer¶

Bases: rest_framework.renderers.TemplateHTMLRenderer

format = 'xml'¶

media_type = 'text/xml'¶

render(data, accepted_media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.XFormListRenderer¶

Bases: rest_framework.renderers.BaseRenderer

Renderer which serializes to XML.

charset = 'utf-8'¶

element_node = 'xform'¶

format = 'xml'¶

media_type = 'text/xml'¶

render(data, accepted_media_type=None, renderer_context=None)¶

Renders obj into serialized XML.

root_node = 'xforms'¶

xmlns = 'http://openrosa.org/xforms/xformsList'¶

class onadata.libs.renderers.renderers.XFormManifestRenderer¶

Bases: onadata.libs.renderers.renderers.XFormListRenderer

element_node = 'mediaFile'¶

root_node = 'manifest'¶

xmlns = 'http://openrosa.org/xforms/xformsManifest'¶

class onadata.libs.renderers.renderers.XLSRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = None¶

format = 'xls'¶

media_type = 'application/vnd.openxmlformats'¶

render(data, accepted_media_type=None, renderer_context=None)¶

class onadata.libs.renderers.renderers.XLSXRenderer¶

Bases: onadata.libs.renderers.renderers.XLSRenderer

format = 'xlsx'¶

class onadata.libs.renderers.renderers.ZipRenderer¶

Bases: rest_framework.renderers.BaseRenderer

charset = None¶

format = 'zip'¶

media_type = 'application/octet-stream'¶

render(data, accepted_media_type=None, renderer_context=None)¶

Module contents¶