mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-10-30 23:47:53 +03:00
ad0fea04de
* Add support for ipaddress objects in JSONEncoder
* Update tests/test_encoders.py
* Update assertions to be more explicit
---------
Co-authored-by: Asif Saif Uddin {"Auvi":"অভি"} <auvipy@gmail.com>
Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
89 lines
3.1 KiB
Python
89 lines
3.1 KiB
Python
"""
|
|
Helper classes for parsers.
|
|
"""
|
|
|
|
import contextlib
|
|
import datetime
|
|
import decimal
|
|
import ipaddress
|
|
import json # noqa
|
|
import uuid
|
|
|
|
from django.db.models.query import QuerySet
|
|
from django.utils import timezone
|
|
from django.utils.encoding import force_str
|
|
from django.utils.functional import Promise
|
|
|
|
from rest_framework.compat import coreapi
|
|
|
|
|
|
class JSONEncoder(json.JSONEncoder):
|
|
"""
|
|
JSONEncoder subclass that knows how to encode date/time/timedelta,
|
|
decimal types, generators and other basic python objects.
|
|
"""
|
|
def default(self, obj):
|
|
# For Date Time string spec, see ECMA 262
|
|
# https://ecma-international.org/ecma-262/5.1/#sec-15.9.1.15
|
|
if isinstance(obj, Promise):
|
|
return force_str(obj)
|
|
elif isinstance(obj, datetime.datetime):
|
|
representation = obj.isoformat()
|
|
if representation.endswith('+00:00'):
|
|
representation = representation[:-6] + 'Z'
|
|
return representation
|
|
elif isinstance(obj, datetime.date):
|
|
return obj.isoformat()
|
|
elif isinstance(obj, datetime.time):
|
|
if timezone and timezone.is_aware(obj):
|
|
raise ValueError("JSON can't represent timezone-aware times.")
|
|
representation = obj.isoformat()
|
|
return representation
|
|
elif isinstance(obj, datetime.timedelta):
|
|
return str(obj.total_seconds())
|
|
elif isinstance(obj, decimal.Decimal):
|
|
# Serializers will coerce decimals to strings by default.
|
|
return float(obj)
|
|
elif isinstance(obj, uuid.UUID):
|
|
return str(obj)
|
|
elif isinstance(obj, (
|
|
ipaddress.IPv4Address,
|
|
ipaddress.IPv6Address,
|
|
ipaddress.IPv4Network,
|
|
ipaddress.IPv6Network,
|
|
ipaddress.IPv4Interface,
|
|
ipaddress.IPv6Interface)
|
|
):
|
|
return str(obj)
|
|
elif isinstance(obj, QuerySet):
|
|
return tuple(obj)
|
|
elif isinstance(obj, bytes):
|
|
# Best-effort for binary blobs. See #4187.
|
|
return obj.decode()
|
|
elif hasattr(obj, 'tolist'):
|
|
# Numpy arrays and array scalars.
|
|
return obj.tolist()
|
|
elif (coreapi is not None) and isinstance(obj, (coreapi.Document, coreapi.Error)):
|
|
raise RuntimeError(
|
|
'Cannot return a coreapi object from a JSON view. '
|
|
'You should be using a schema renderer instead for this view.'
|
|
)
|
|
elif hasattr(obj, '__getitem__'):
|
|
cls = (list if isinstance(obj, (list, tuple)) else dict)
|
|
with contextlib.suppress(Exception):
|
|
return cls(obj)
|
|
elif hasattr(obj, '__iter__'):
|
|
return tuple(item for item in obj)
|
|
return super().default(obj)
|
|
|
|
|
|
class CustomScalar:
|
|
"""
|
|
CustomScalar that knows how to encode timedelta that renderer
|
|
can understand.
|
|
"""
|
|
@classmethod
|
|
def represent_timedelta(cls, dumper, data):
|
|
value = str(data.total_seconds())
|
|
return dumper.represent_scalar('tag:yaml.org,2002:str', value)
|