mirror of
https://github.com/peeringdb/peeringdb.git
synced 2024-05-11 05:55:09 +00:00
c21130eed9
* module docstrings * db schema graph * dev docs first pass * dev docs pass 2 * add generated notification to top of generated docs files * linting * regen docs Co-authored-by: Stefan Pratter <stefan@20c.com> Co-authored-by: Sunshine Buchholz <sunshine@20c.com>
104 lines
2.6 KiB
Python
104 lines
2.6 KiB
Python
"""
|
|
REST API renderer.
|
|
|
|
Ensure valid json output of the REST API.
|
|
"""
|
|
|
|
import json
|
|
|
|
from rest_framework import renderers
|
|
from rest_framework.utils import encoders
|
|
|
|
|
|
class JSONEncoder(encoders.JSONEncoder):
|
|
"""
|
|
Define json encoder to be able to encode
|
|
datatime and django countryfields.
|
|
|
|
Make the munge renderer use this encoder to encode json. This approach
|
|
may need to be tidied up a bit.
|
|
"""
|
|
|
|
def default(self, obj):
|
|
"""Default JSON serializer."""
|
|
import datetime
|
|
|
|
import django_countries.fields
|
|
|
|
if isinstance(obj, datetime.datetime):
|
|
return obj.isoformat()
|
|
|
|
if isinstance(obj, django_countries.fields.Country):
|
|
return str(obj)
|
|
|
|
return encoders.JSONEncoder.default(self, obj)
|
|
|
|
|
|
class MungeRenderer(renderers.BaseRenderer):
|
|
media_type = "text/plain"
|
|
format = "txt"
|
|
charset = "utf-8"
|
|
|
|
def render(self, data, media_type=None, renderer_context=None):
|
|
# TODO use munge:
|
|
indent = None
|
|
if "request" in renderer_context:
|
|
request = renderer_context.get("request")
|
|
if "pretty" in request.GET:
|
|
indent = 2
|
|
return json.dumps(data, cls=JSONEncoder, indent=indent)
|
|
|
|
|
|
class MetaJSONRenderer(MungeRenderer):
|
|
"""
|
|
Renderer which serializes to JSON.
|
|
Does *not* apply JSON's character escaping for non-ascii characters.
|
|
"""
|
|
|
|
ensure_ascii = False
|
|
|
|
media_type = "application/json"
|
|
format = "json"
|
|
|
|
def render(self, data, accepted_media_type=None, renderer_context=None):
|
|
"""
|
|
Tweak output rendering and pass to parent.
|
|
"""
|
|
|
|
if data is None:
|
|
return bytes()
|
|
|
|
result = {}
|
|
|
|
if "__meta" in data:
|
|
meta = data.pop("__meta")
|
|
else:
|
|
meta = dict()
|
|
|
|
if "request" in renderer_context:
|
|
request = renderer_context.get("request")
|
|
meta.update(getattr(request, "meta_response", {}))
|
|
|
|
res = renderer_context["response"]
|
|
if res.status_code < 400:
|
|
if "results" in data:
|
|
result["data"] = data.pop("results")
|
|
elif data:
|
|
if isinstance(data, dict):
|
|
result["data"] = [data]
|
|
else:
|
|
result["data"] = [r for r in data if r is not None]
|
|
else:
|
|
result["data"] = []
|
|
|
|
elif res.status_code < 500:
|
|
meta["error"] = data.pop("detail", res.reason_phrase)
|
|
|
|
result.update(**data)
|
|
|
|
result["meta"] = meta
|
|
|
|
return super(self.__class__, self).render(
|
|
result, accepted_media_type, renderer_context
|
|
)
|