django-rest-framework/rest_framework/fields.py

1043 lines
35 KiB
Python
Raw Normal View History

2013-04-25 15:47:34 +04:00
"""
Serializer fields perform validation on incoming data.
They are very similar to Django's form fields.
"""
2012-11-22 03:20:49 +04:00
from __future__ import unicode_literals
import copy
import datetime
import inspect
2012-11-20 18:38:50 +04:00
import re
import warnings
2013-06-06 11:56:39 +04:00
from decimal import Decimal, DecimalException
from django import forms
from django.core import validators
2012-12-31 12:53:40 +04:00
from django.core.exceptions import ValidationError
from django.conf import settings
from django.db.models.fields import BLANK_CHOICE_DASH
from django.http import QueryDict
2012-10-19 02:48:52 +04:00
from django.forms import widgets
from django.utils import six, timezone
2012-11-22 03:20:49 +04:00
from django.utils.encoding import is_protected_type
from django.utils.translation import ugettext_lazy as _
from django.utils.datastructures import SortedDict
2013-09-25 13:30:04 +04:00
from django.utils.dateparse import parse_date, parse_datetime, parse_time
2013-03-06 16:19:39 +04:00
from rest_framework import ISO_8601
2013-06-06 11:56:39 +04:00
from rest_framework.compat import (
BytesIO, smart_text,
2013-06-06 11:56:39 +04:00
force_text, is_non_str_iterable
)
from rest_framework.settings import api_settings
def is_simple_callable(obj):
"""
True if the object is a callable that takes no arguments.
"""
function = inspect.isfunction(obj)
method = inspect.ismethod(obj)
if not (function or method):
return False
args, _, _, defaults = inspect.getargspec(obj)
len_args = len(args) if function else len(args) - 1
len_defaults = len(defaults) if defaults else 0
return len_args <= len_defaults
2013-05-25 02:44:23 +04:00
def get_component(obj, attr_name):
"""
Given an object, and an attribute name,
return that attribute on the object.
"""
if isinstance(obj, dict):
val = obj.get(attr_name)
else:
val = getattr(obj, attr_name)
if is_simple_callable(val):
return val()
return val
2013-03-06 16:19:39 +04:00
def readable_datetime_formats(formats):
2014-08-19 16:54:52 +04:00
format = ', '.join(formats).replace(
ISO_8601,
'YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z]'
)
2013-03-06 16:19:39 +04:00
return humanize_strptime(format)
def readable_date_formats(formats):
format = ', '.join(formats).replace(ISO_8601, 'YYYY[-MM[-DD]]')
return humanize_strptime(format)
def readable_time_formats(formats):
format = ', '.join(formats).replace(ISO_8601, 'hh:mm[:ss[.uuuuuu]]')
return humanize_strptime(format)
def humanize_strptime(format_string):
# Note that we're missing some of the locale specific mappings that
# don't really make sense.
mapping = {
"%Y": "YYYY",
"%y": "YY",
"%m": "MM",
"%b": "[Jan-Dec]",
"%B": "[January-December]",
"%d": "DD",
"%H": "hh",
"%I": "hh", # Requires '%p' to differentiate from '%H'.
"%M": "mm",
"%S": "ss",
"%f": "uuuuuu",
"%a": "[Mon-Sun]",
"%A": "[Monday-Sunday]",
"%p": "[AM|PM]",
"%z": "[+HHMM|-HHMM]"
}
for key, val in mapping.items():
format_string = format_string.replace(key, val)
return format_string
def strip_multiple_choice_msg(help_text):
"""
Remove the 'Hold down "control" ...' message that is Django enforces in
select multiple fields on ModelForms. (Required for 1.5 and earlier)
See https://code.djangoproject.com/ticket/9321
"""
multiple_choice_msg = _(' Hold down "Control", or "Command" on a Mac, to select more than one.')
multiple_choice_msg = force_text(multiple_choice_msg)
return help_text.replace(multiple_choice_msg, '')
class Field(object):
read_only = True
creation_counter = 0
empty = ''
2012-10-04 18:01:44 +04:00
type_name = None
partial = False
2013-01-31 00:33:50 +04:00
use_files = False
form_field_class = forms.CharField
2013-05-25 02:44:23 +04:00
type_label = 'field'
widget = None
def __init__(self, source=None, label=None, help_text=None):
self.parent = None
self.creation_counter = Field.creation_counter
Field.creation_counter += 1
self.source = source
2012-10-04 16:28:14 +04:00
if label is not None:
self.label = smart_text(label)
else:
self.label = None
if help_text is not None:
self.help_text = strip_multiple_choice_msg(smart_text(help_text))
else:
self.help_text = None
self._errors = []
self._value = None
self._name = None
@property
def errors(self):
return self._errors
def widget_html(self):
if not self.widget:
return ''
attrs = {}
if 'id' not in self.widget.attrs:
attrs['id'] = self._name
return self.widget.render(self._name, self._value, attrs=attrs)
def label_tag(self):
return '<label for="%s">%s:</label>' % (self._name, self.label)
2012-10-04 16:28:14 +04:00
def initialize(self, parent, field_name):
2012-10-04 16:28:14 +04:00
"""
Called to set up a field prior to field_to_native or field_from_native.
parent - The parent serializer.
2014-04-08 01:27:59 +04:00
field_name - The name of the field being initialized.
2012-10-04 16:28:14 +04:00
"""
self.parent = parent
self.root = parent.root or parent
self.context = self.root.context
self.partial = self.root.partial
if self.partial:
self.required = False
2012-10-04 16:28:14 +04:00
def field_from_native(self, data, files, field_name, into):
2012-10-04 16:28:14 +04:00
"""
Given a dictionary and a field name, updates the dictionary `into`,
with the field and it's deserialized value.
"""
return
def field_to_native(self, obj, field_name):
"""
2014-06-17 03:13:02 +04:00
Given an object and a field name, returns the value that should be
2012-10-04 16:28:14 +04:00
serialized for that field.
"""
if obj is None:
return self.empty
if self.source == '*':
return self.to_native(obj)
2013-02-13 02:59:01 +04:00
source = self.source or field_name
value = obj
for component in source.split('.'):
value = get_component(value, component)
if value is None:
break
2012-10-04 16:28:14 +04:00
return self.to_native(value)
def to_native(self, value):
"""
Converts the field's value into it's simple representation.
"""
if is_simple_callable(value):
value = value()
if is_protected_type(value):
return value
elif (is_non_str_iterable(value) and
not isinstance(value, (dict, six.string_types))):
2012-10-04 16:28:14 +04:00
return [self.to_native(item) for item in value]
elif isinstance(value, dict):
# Make sure we preserve field ordering, if it exists
ret = SortedDict()
for key, val in value.items():
ret[key] = self.to_native(val)
return ret
return force_text(value)
2012-10-04 16:28:14 +04:00
def attributes(self):
"""
Returns a dictionary of attributes to be used when serializing to xml.
"""
2012-10-04 18:01:44 +04:00
if self.type_name:
2012-10-04 16:28:14 +04:00
return {'type': self.type_name}
return {}
2013-05-25 02:44:23 +04:00
def metadata(self):
metadata = SortedDict()
metadata['type'] = self.type_label
metadata['required'] = getattr(self, 'required', False)
optional_attrs = ['read_only', 'label', 'help_text',
'min_length', 'max_length']
for attr in optional_attrs:
2013-05-25 02:44:23 +04:00
value = getattr(self, attr, None)
if value is not None and value != '':
metadata[attr] = force_text(value, strings_only=True)
return metadata
2012-10-04 16:28:14 +04:00
class WritableField(Field):
"""
Base for read/write fields.
"""
write_only = False
2012-10-04 16:28:14 +04:00
default_validators = []
default_error_messages = {
'required': _('This field is required.'),
'invalid': _('Invalid value.'),
}
2012-10-19 02:48:52 +04:00
widget = widgets.TextInput
2012-10-21 20:41:05 +04:00
default = None
2012-10-04 16:28:14 +04:00
def __init__(self, source=None, label=None, help_text=None,
read_only=False, write_only=False, required=None,
2012-10-19 02:48:52 +04:00
validators=[], error_messages=None, widget=None,
default=None, blank=None):
2012-10-19 02:48:52 +04:00
super(WritableField, self).__init__(source=source, label=label, help_text=help_text)
2012-10-19 02:48:52 +04:00
2012-10-29 00:21:45 +04:00
self.read_only = read_only
self.write_only = write_only
assert not (read_only and write_only), "Cannot set read_only=True and write_only=True"
2012-09-25 16:20:12 +04:00
if required is None:
2012-10-29 00:21:45 +04:00
self.required = not(read_only)
2012-09-25 16:20:12 +04:00
else:
assert not (read_only and required), "Cannot set required=True and read_only=True"
2012-09-25 16:20:12 +04:00
self.required = required
messages = {}
for c in reversed(self.__class__.__mro__):
messages.update(getattr(c, 'default_error_messages', {}))
messages.update(error_messages or {})
self.error_messages = messages
self.validators = self.default_validators + validators
self.default = default if default is not None else self.default
2014-04-27 04:54:47 +04:00
# Widgets are only used for HTML forms.
2012-10-19 02:48:52 +04:00
widget = widget or self.widget
if isinstance(widget, type):
widget = widget()
self.widget = widget
2013-06-06 11:56:39 +04:00
def __deepcopy__(self, memo):
result = copy.copy(self)
memo[id(self)] = result
result.validators = self.validators[:]
return result
def get_default_value(self):
if is_simple_callable(self.default):
return self.default()
return self.default
def validate(self, value):
if value in validators.EMPTY_VALUES and self.required:
2012-09-25 16:20:12 +04:00
raise ValidationError(self.error_messages['required'])
def run_validators(self, value):
if value in validators.EMPTY_VALUES:
return
errors = []
for v in self.validators:
try:
v(value)
except ValidationError as e:
if hasattr(e, 'code') and e.code in self.error_messages:
message = self.error_messages[e.code]
if e.params:
message = message % e.params
errors.append(message)
else:
errors.extend(e.messages)
if errors:
raise ValidationError(errors)
def field_to_native(self, obj, field_name):
if self.write_only:
return None
return super(WritableField, self).field_to_native(obj, field_name)
def field_from_native(self, data, files, field_name, into):
"""
Given a dictionary and a field name, updates the dictionary `into`,
with the field and it's deserialized value.
"""
2012-10-29 00:21:45 +04:00
if self.read_only:
return
try:
data = data or {}
2013-01-31 00:33:50 +04:00
if self.use_files:
2013-01-03 10:28:17 +04:00
files = files or {}
try:
native = files[field_name]
except KeyError:
native = data[field_name]
else:
native = data[field_name]
except KeyError:
if self.default is not None and not self.partial:
2013-01-04 02:06:55 +04:00
# Note: partial updates shouldn't set defaults
native = self.get_default_value()
2012-10-19 02:48:52 +04:00
else:
if self.required:
2012-10-19 02:48:52 +04:00
raise ValidationError(self.error_messages['required'])
return
value = self.from_native(native)
if self.source == '*':
if value:
into.update(value)
else:
self.validate(value)
self.run_validators(value)
into[self.source or field_name] = value
def from_native(self, value):
"""
Reverts a simple representation back to the field's value.
"""
return value
2012-10-04 16:28:14 +04:00
class ModelField(WritableField):
"""
2012-10-30 03:30:52 +04:00
A generic field that can be used against an arbitrary model field.
2012-10-04 16:28:14 +04:00
"""
def __init__(self, *args, **kwargs):
try:
self.model_field = kwargs.pop('model_field')
except KeyError:
2012-10-04 16:28:14 +04:00
raise ValueError("ModelField requires 'model_field' kwarg")
self.min_length = kwargs.pop('min_length',
2013-06-12 02:10:25 +04:00
getattr(self.model_field, 'min_length', None))
self.max_length = kwargs.pop('max_length',
2013-06-12 02:10:25 +04:00
getattr(self.model_field, 'max_length', None))
self.min_value = kwargs.pop('min_value',
2013-06-12 02:10:25 +04:00
getattr(self.model_field, 'min_value', None))
self.max_value = kwargs.pop('max_value',
2013-06-12 02:10:25 +04:00
getattr(self.model_field, 'max_value', None))
2012-10-04 16:28:14 +04:00
super(ModelField, self).__init__(*args, **kwargs)
if self.min_length is not None:
self.validators.append(validators.MinLengthValidator(self.min_length))
if self.max_length is not None:
self.validators.append(validators.MaxLengthValidator(self.max_length))
if self.min_value is not None:
self.validators.append(validators.MinValueValidator(self.min_value))
if self.max_value is not None:
self.validators.append(validators.MaxValueValidator(self.max_value))
2012-10-04 16:28:14 +04:00
def from_native(self, value):
2012-11-06 15:01:53 +04:00
rel = getattr(self.model_field, "rel", None)
if rel is not None:
return rel.to._meta.get_field(rel.field_name).to_python(value)
2012-11-06 15:01:53 +04:00
else:
2012-10-04 16:28:14 +04:00
return self.model_field.to_python(value)
2012-10-04 16:28:14 +04:00
def field_to_native(self, obj, field_name):
value = self.model_field._get_val_from_obj(obj)
if is_protected_type(value):
return value
return self.model_field.value_to_string(obj)
def attributes(self):
2012-10-04 16:28:14 +04:00
return {
"type": self.model_field.get_internal_type()
}
2014-08-19 16:54:52 +04:00
# Typed Fields
2012-10-04 16:28:14 +04:00
class BooleanField(WritableField):
type_name = 'BooleanField'
2013-05-25 02:44:23 +04:00
type_label = 'boolean'
form_field_class = forms.BooleanField
2012-10-19 02:48:52 +04:00
widget = widgets.CheckboxInput
default_error_messages = {
2012-11-22 03:20:49 +04:00
'invalid': _("'%s' value must be either True or False."),
}
2012-10-19 02:48:52 +04:00
empty = False
2012-10-21 20:41:05 +04:00
def field_from_native(self, data, files, field_name, into):
# HTML checkboxes do not explicitly represent unchecked as `False`
# we deal with that here...
if isinstance(data, QueryDict) and self.default is None:
self.default = False
return super(BooleanField, self).field_from_native(
data, files, field_name, into
)
def from_native(self, value):
if value in ('true', 't', 'True', '1'):
return True
if value in ('false', 'f', 'False', '0'):
return False
2012-10-19 02:48:52 +04:00
return bool(value)
2012-10-04 16:28:14 +04:00
class CharField(WritableField):
type_name = 'CharField'
2013-05-25 02:44:23 +04:00
type_label = 'string'
form_field_class = forms.CharField
2012-10-04 16:28:14 +04:00
2014-01-05 17:58:46 +04:00
def __init__(self, max_length=None, min_length=None, allow_none=False, *args, **kwargs):
self.max_length, self.min_length = max_length, min_length
2014-01-05 17:58:46 +04:00
self.allow_none = allow_none
super(CharField, self).__init__(*args, **kwargs)
if min_length is not None:
self.validators.append(validators.MinLengthValidator(min_length))
if max_length is not None:
self.validators.append(validators.MaxLengthValidator(max_length))
def from_native(self, value):
if isinstance(value, six.string_types):
return value
if value is None:
if not self.allow_none:
return ''
else:
# Return None explicitly because smart_text(None) == 'None'. See #1834 for details
return None
2012-11-22 03:20:49 +04:00
return smart_text(value)
class URLField(CharField):
type_name = 'URLField'
2013-05-25 02:44:23 +04:00
type_label = 'url'
def __init__(self, **kwargs):
2014-08-19 16:54:52 +04:00
if 'validators' not in kwargs:
kwargs['validators'] = [validators.URLValidator()]
super(URLField, self).__init__(**kwargs)
class SlugField(CharField):
type_name = 'SlugField'
2013-05-25 02:44:23 +04:00
type_label = 'slug'
form_field_class = forms.SlugField
2013-05-25 02:44:23 +04:00
default_error_messages = {
'invalid': _("Enter a valid 'slug' consisting of letters, numbers,"
" underscores or hyphens."),
}
default_validators = [validators.validate_slug]
2013-05-25 02:44:23 +04:00
def __init__(self, *args, **kwargs):
super(SlugField, self).__init__(*args, **kwargs)
2013-05-25 02:44:23 +04:00
2012-10-19 02:48:52 +04:00
class ChoiceField(WritableField):
type_name = 'ChoiceField'
2014-06-05 14:49:02 +04:00
type_label = 'choice'
form_field_class = forms.ChoiceField
2012-10-19 02:48:52 +04:00
widget = widgets.Select
default_error_messages = {
2013-01-30 16:41:26 +04:00
'invalid_choice': _('Select a valid choice. %(value)s is not one of '
'the available choices.'),
2012-10-19 02:48:52 +04:00
}
def __init__(self, choices=(), blank_display_value=None, *args, **kwargs):
self.empty = kwargs.pop('empty', '')
2012-10-19 02:48:52 +04:00
super(ChoiceField, self).__init__(*args, **kwargs)
self.choices = choices
if not self.required:
if blank_display_value is None:
blank_choice = BLANK_CHOICE_DASH
else:
blank_choice = [('', blank_display_value)]
self.choices = blank_choice + self.choices
2012-10-19 02:48:52 +04:00
def _get_choices(self):
return self._choices
def _set_choices(self, value):
# Setting choices also sets the choices on the widget.
# choices can be any iterable, but we call list() on it because
# it will be consumed more than once.
self._choices = self.widget.choices = list(value)
choices = property(_get_choices, _set_choices)
def metadata(self):
data = super(ChoiceField, self).metadata()
data['choices'] = [{'value': v, 'display_name': n} for v, n in self.choices]
return data
2012-10-19 02:48:52 +04:00
def validate(self, value):
"""
Validates that the input is in self.choices.
"""
super(ChoiceField, self).validate(value)
if value and not self.valid_value(value):
raise ValidationError(self.error_messages['invalid_choice'] % {'value': value})
def valid_value(self, value):
"""
Check to see if the provided value is a valid choice.
"""
for k, v in self.choices:
if isinstance(v, (list, tuple)):
# This is an optgroup, so look inside the group for options
for k2, v2 in v:
if value == smart_text(k2) or value == k2:
2012-10-19 02:48:52 +04:00
return True
else:
if value == smart_text(k) or value == k:
2012-10-19 02:48:52 +04:00
return True
return False
def from_native(self, value):
value = super(ChoiceField, self).from_native(value)
if value == self.empty or value in validators.EMPTY_VALUES:
return self.empty
return value
2012-10-19 02:48:52 +04:00
class EmailField(CharField):
2012-10-04 16:28:14 +04:00
type_name = 'EmailField'
2013-05-25 02:44:23 +04:00
type_label = 'email'
form_field_class = forms.EmailField
2012-10-04 16:28:14 +04:00
default_error_messages = {
'invalid': _('Enter a valid email address.'),
}
default_validators = [validators.validate_email]
def from_native(self, value):
2012-10-29 18:10:38 +04:00
ret = super(EmailField, self).from_native(value)
if ret is None:
return None
return ret.strip()
2012-11-20 18:38:50 +04:00
class RegexField(CharField):
type_name = 'RegexField'
2013-05-25 02:44:23 +04:00
type_label = 'regex'
form_field_class = forms.RegexField
2012-11-20 18:38:50 +04:00
def __init__(self, regex, max_length=None, min_length=None, *args, **kwargs):
super(RegexField, self).__init__(max_length, min_length, *args, **kwargs)
self.regex = regex
def _get_regex(self):
return self._regex
def _set_regex(self, regex):
2012-11-22 03:20:49 +04:00
if isinstance(regex, six.string_types):
2012-11-20 18:38:50 +04:00
regex = re.compile(regex)
self._regex = regex
if hasattr(self, '_regex_validator') and self._regex_validator in self.validators:
self.validators.remove(self._regex_validator)
self._regex_validator = validators.RegexValidator(regex=regex)
self.validators.append(self._regex_validator)
regex = property(_get_regex, _set_regex)
2012-10-04 16:28:14 +04:00
class DateField(WritableField):
type_name = 'DateField'
2013-05-25 02:44:23 +04:00
type_label = 'date'
widget = widgets.DateInput
form_field_class = forms.DateField
2012-10-04 16:28:14 +04:00
default_error_messages = {
'invalid': _("Date has wrong format. Use one of these formats instead: %s"),
}
empty = None
2013-03-01 19:59:47 +04:00
input_formats = api_settings.DATE_INPUT_FORMATS
format = api_settings.DATE_FORMAT
2013-03-06 16:19:39 +04:00
def __init__(self, input_formats=None, format=None, *args, **kwargs):
2013-03-01 19:59:47 +04:00
self.input_formats = input_formats if input_formats is not None else self.input_formats
2013-03-06 16:19:39 +04:00
self.format = format if format is not None else self.format
super(DateField, self).__init__(*args, **kwargs)
def from_native(self, value):
2012-10-29 18:10:38 +04:00
if value in validators.EMPTY_VALUES:
return None
if isinstance(value, datetime.datetime):
if timezone and settings.USE_TZ and timezone.is_aware(value):
# Convert aware datetimes to the default time zone
# before casting them to dates (#17742).
default_timezone = timezone.get_default_timezone()
value = timezone.make_naive(value, default_timezone)
return value.date()
if isinstance(value, datetime.date):
return value
for format in self.input_formats:
2013-03-06 16:19:39 +04:00
if format.lower() == ISO_8601:
2013-03-01 19:24:25 +04:00
try:
parsed = parse_date(value)
except (ValueError, TypeError):
pass
else:
if parsed is not None:
return parsed
else:
2013-03-01 19:24:25 +04:00
try:
parsed = datetime.datetime.strptime(value, format)
except (ValueError, TypeError):
pass
else:
return parsed.date()
2013-03-06 16:19:39 +04:00
msg = self.error_messages['invalid'] % readable_date_formats(self.input_formats)
raise ValidationError(msg)
def to_native(self, value):
if value is None or self.format is None:
return value
2013-03-05 21:50:28 +04:00
if isinstance(value, datetime.datetime):
value = value.date()
2013-03-06 16:19:39 +04:00
if self.format.lower() == ISO_8601:
2013-03-01 19:24:25 +04:00
return value.isoformat()
2013-03-06 16:19:39 +04:00
return value.strftime(self.format)
2012-10-04 16:28:14 +04:00
class DateTimeField(WritableField):
type_name = 'DateTimeField'
2013-05-25 02:44:23 +04:00
type_label = 'datetime'
widget = widgets.DateTimeInput
form_field_class = forms.DateTimeField
2012-10-04 16:28:14 +04:00
default_error_messages = {
'invalid': _("Datetime has wrong format. Use one of these formats instead: %s"),
}
empty = None
2013-03-01 19:59:47 +04:00
input_formats = api_settings.DATETIME_INPUT_FORMATS
format = api_settings.DATETIME_FORMAT
2013-03-06 16:19:39 +04:00
def __init__(self, input_formats=None, format=None, *args, **kwargs):
2013-03-01 19:59:47 +04:00
self.input_formats = input_formats if input_formats is not None else self.input_formats
2013-03-06 16:19:39 +04:00
self.format = format if format is not None else self.format
super(DateTimeField, self).__init__(*args, **kwargs)
def from_native(self, value):
2012-10-29 18:10:38 +04:00
if value in validators.EMPTY_VALUES:
return None
if isinstance(value, datetime.datetime):
return value
if isinstance(value, datetime.date):
value = datetime.datetime(value.year, value.month, value.day)
if settings.USE_TZ:
# For backwards compatibility, interpret naive datetimes in
# local time. This won't work during DST change, but we can't
# do much about it, so we let the exceptions percolate up the
# call stack.
2012-11-22 03:20:49 +04:00
warnings.warn("DateTimeField received a naive datetime (%s)"
" while time zone support is active." % value,
RuntimeWarning)
default_timezone = timezone.get_default_timezone()
value = timezone.make_aware(value, default_timezone)
return value
for format in self.input_formats:
2013-03-06 16:19:39 +04:00
if format.lower() == ISO_8601:
2013-03-01 19:24:25 +04:00
try:
parsed = parse_datetime(value)
except (ValueError, TypeError):
pass
else:
if parsed is not None:
return parsed
else:
2013-03-01 19:24:25 +04:00
try:
parsed = datetime.datetime.strptime(value, format)
except (ValueError, TypeError):
pass
else:
return parsed
2013-03-06 16:19:39 +04:00
msg = self.error_messages['invalid'] % readable_datetime_formats(self.input_formats)
raise ValidationError(msg)
def to_native(self, value):
if value is None or self.format is None:
return value
2013-03-06 16:19:39 +04:00
if self.format.lower() == ISO_8601:
ret = value.isoformat()
if ret.endswith('+00:00'):
ret = ret[:-6] + 'Z'
return ret
2013-03-06 16:19:39 +04:00
return value.strftime(self.format)
2013-02-15 00:19:51 +04:00
class TimeField(WritableField):
type_name = 'TimeField'
2013-05-25 02:44:23 +04:00
type_label = 'time'
2013-02-15 00:19:51 +04:00
widget = widgets.TimeInput
form_field_class = forms.TimeField
default_error_messages = {
'invalid': _("Time has wrong format. Use one of these formats instead: %s"),
2013-02-15 00:19:51 +04:00
}
empty = None
2013-03-01 19:59:47 +04:00
input_formats = api_settings.TIME_INPUT_FORMATS
format = api_settings.TIME_FORMAT
2013-02-15 00:19:51 +04:00
2013-03-06 16:19:39 +04:00
def __init__(self, input_formats=None, format=None, *args, **kwargs):
2013-03-01 19:59:47 +04:00
self.input_formats = input_formats if input_formats is not None else self.input_formats
2013-03-06 16:19:39 +04:00
self.format = format if format is not None else self.format
super(TimeField, self).__init__(*args, **kwargs)
2013-02-15 00:19:51 +04:00
def from_native(self, value):
if value in validators.EMPTY_VALUES:
return None
if isinstance(value, datetime.time):
return value
for format in self.input_formats:
2013-03-06 16:19:39 +04:00
if format.lower() == ISO_8601:
2013-03-01 19:24:25 +04:00
try:
parsed = parse_time(value)
except (ValueError, TypeError):
pass
else:
if parsed is not None:
return parsed
else:
2013-03-01 19:24:25 +04:00
try:
parsed = datetime.datetime.strptime(value, format)
except (ValueError, TypeError):
pass
else:
return parsed.time()
2013-03-06 16:19:39 +04:00
msg = self.error_messages['invalid'] % readable_time_formats(self.input_formats)
raise ValidationError(msg)
2013-02-15 00:19:51 +04:00
def to_native(self, value):
if value is None or self.format is None:
return value
2013-03-05 21:50:28 +04:00
if isinstance(value, datetime.datetime):
value = value.time()
2013-03-06 16:19:39 +04:00
if self.format.lower() == ISO_8601:
2013-03-01 19:24:25 +04:00
return value.isoformat()
2013-03-06 16:19:39 +04:00
return value.strftime(self.format)
2013-02-15 00:19:51 +04:00
2012-10-04 16:28:14 +04:00
class IntegerField(WritableField):
type_name = 'IntegerField'
2013-05-25 02:44:23 +04:00
type_label = 'integer'
form_field_class = forms.IntegerField
empty = 0
2012-10-04 16:28:14 +04:00
default_error_messages = {
'invalid': _('Enter a whole number.'),
'max_value': _('Ensure this value is less than or equal to %(limit_value)s.'),
'min_value': _('Ensure this value is greater than or equal to %(limit_value)s.'),
}
def __init__(self, max_value=None, min_value=None, *args, **kwargs):
self.max_value, self.min_value = max_value, min_value
super(IntegerField, self).__init__(*args, **kwargs)
if max_value is not None:
self.validators.append(validators.MaxValueValidator(max_value))
if min_value is not None:
self.validators.append(validators.MinValueValidator(min_value))
def from_native(self, value):
if value in validators.EMPTY_VALUES:
return None
2012-10-29 18:10:38 +04:00
try:
value = int(str(value))
except (ValueError, TypeError):
raise ValidationError(self.error_messages['invalid'])
return value
2012-10-04 16:28:14 +04:00
class FloatField(WritableField):
type_name = 'FloatField'
2013-05-25 02:44:23 +04:00
type_label = 'float'
form_field_class = forms.FloatField
empty = 0
2012-10-04 16:28:14 +04:00
default_error_messages = {
'invalid': _("'%s' value must be a float."),
}
def from_native(self, value):
2012-10-29 18:10:38 +04:00
if value in validators.EMPTY_VALUES:
return None
try:
return float(value)
except (TypeError, ValueError):
msg = self.error_messages['invalid'] % value
raise ValidationError(msg)
2013-04-15 14:40:18 +04:00
class DecimalField(WritableField):
type_name = 'DecimalField'
2013-05-25 02:44:23 +04:00
type_label = 'decimal'
2013-04-15 14:40:18 +04:00
form_field_class = forms.DecimalField
empty = Decimal('0')
2013-04-15 14:40:18 +04:00
default_error_messages = {
'invalid': _('Enter a number.'),
'max_value': _('Ensure this value is less than or equal to %(limit_value)s.'),
'min_value': _('Ensure this value is greater than or equal to %(limit_value)s.'),
'max_digits': _('Ensure that there are no more than %s digits in total.'),
'max_decimal_places': _('Ensure that there are no more than %s decimal places.'),
'max_whole_digits': _('Ensure that there are no more than %s digits before the decimal point.')
}
def __init__(self, max_value=None, min_value=None, max_digits=None, decimal_places=None, *args, **kwargs):
self.max_value, self.min_value = max_value, min_value
self.max_digits, self.decimal_places = max_digits, decimal_places
2013-04-15 17:15:55 +04:00
super(DecimalField, self).__init__(*args, **kwargs)
2013-04-15 14:40:18 +04:00
if max_value is not None:
self.validators.append(validators.MaxValueValidator(max_value))
if min_value is not None:
self.validators.append(validators.MinValueValidator(min_value))
def from_native(self, value):
"""
Validates that the input is a decimal number. Returns a Decimal
instance. Returns None for empty values. Ensures that there are no more
than max_digits in the number, and no more than decimal_places digits
after the decimal point.
"""
if value in validators.EMPTY_VALUES:
return None
value = smart_text(value).strip()
try:
value = Decimal(value)
except DecimalException:
raise ValidationError(self.error_messages['invalid'])
return value
def validate(self, value):
super(DecimalField, self).validate(value)
if value in validators.EMPTY_VALUES:
return
# Check for NaN, Inf and -Inf values. We can't compare directly for NaN,
# since it is never equal to itself. However, NaN is the only value that
# isn't equal to itself, so we can use this to identify NaN
if value != value or value == Decimal("Inf") or value == Decimal("-Inf"):
raise ValidationError(self.error_messages['invalid'])
sign, digittuple, exponent = value.as_tuple()
decimals = abs(exponent)
# digittuple doesn't include any leading zeros.
digits = len(digittuple)
if decimals > digits:
# We have leading zeros up to or past the decimal point. Count
# everything past the decimal point as a digit. We do not count
# 0 before the decimal point as a digit since that would mean
# we would not allow max_digits = decimal_places.
digits = decimals
whole_digits = digits - decimals
if self.max_digits is not None and digits > self.max_digits:
raise ValidationError(self.error_messages['max_digits'] % self.max_digits)
if self.decimal_places is not None and decimals > self.decimal_places:
raise ValidationError(self.error_messages['max_decimal_places'] % self.decimal_places)
if self.max_digits is not None and self.decimal_places is not None and whole_digits > (self.max_digits - self.decimal_places):
raise ValidationError(self.error_messages['max_whole_digits'] % (self.max_digits - self.decimal_places))
return value
class FileField(WritableField):
2013-01-31 00:33:50 +04:00
use_files = True
type_name = 'FileField'
2013-05-25 02:44:23 +04:00
type_label = 'file upload'
form_field_class = forms.FileField
widget = widgets.FileInput
default_error_messages = {
'invalid': _("No file was submitted. Check the encoding type on the form."),
'missing': _("No file was submitted."),
'empty': _("The submitted file is empty."),
'max_length': _('Ensure this filename has at most %(max)d characters (it has %(length)d).'),
'contradiction': _('Please either submit a file or check the clear checkbox, not both.')
}
def __init__(self, *args, **kwargs):
self.max_length = kwargs.pop('max_length', None)
self.allow_empty_file = kwargs.pop('allow_empty_file', False)
super(FileField, self).__init__(*args, **kwargs)
def from_native(self, data):
if data in validators.EMPTY_VALUES:
return None
# UploadedFile objects should have name and size attributes.
try:
file_name = data.name
file_size = data.size
except AttributeError:
raise ValidationError(self.error_messages['invalid'])
if self.max_length is not None and len(file_name) > self.max_length:
error_values = {'max': self.max_length, 'length': len(file_name)}
raise ValidationError(self.error_messages['max_length'] % error_values)
if not file_name:
raise ValidationError(self.error_messages['invalid'])
if not self.allow_empty_file and not file_size:
raise ValidationError(self.error_messages['empty'])
return data
def to_native(self, value):
return value.name
class ImageField(FileField):
2013-01-31 00:33:50 +04:00
use_files = True
2013-05-25 02:44:23 +04:00
type_name = 'ImageField'
type_label = 'image upload'
form_field_class = forms.ImageField
default_error_messages = {
2013-01-30 16:41:26 +04:00
'invalid_image': _("Upload a valid image. The file you uploaded was "
"either not an image or a corrupted image."),
}
def from_native(self, data):
"""
Checks that the file-upload field data contains a valid image (GIF, JPG,
PNG, possibly others -- whatever the Python Imaging Library supports).
"""
f = super(ImageField, self).from_native(data)
if f is None:
return None
2013-08-14 03:48:49 +04:00
from rest_framework.compat import Image
assert Image is not None, 'Either Pillow or PIL must be installed for ImageField support.'
# We need to get a file object for PIL. We might have a path or we might
# have to read the data into memory.
if hasattr(data, 'temporary_file_path'):
file = data.temporary_file_path()
else:
if hasattr(data, 'read'):
file = BytesIO(data.read())
else:
file = BytesIO(data['content'])
try:
# load() could spot a truncated JPEG, but it loads the entire
# image in memory, which is a DoS vector. See #3848 and #18520.
# verify() must be called immediately after the constructor.
Image.open(file).verify()
except ImportError:
# Under PyPy, it is possible to import PIL. However, the underlying
# _imaging C module isn't available, so an ImportError will be
# raised. Catch and re-raise.
raise
except Exception: # Python Imaging Library doesn't recognize it as an image
raise ValidationError(self.error_messages['invalid_image'])
if hasattr(f, 'seek') and callable(f.seek):
f.seek(0)
return f
2012-11-19 21:22:17 +04:00
class SerializerMethodField(Field):
"""
A field that gets its value by calling a method on the serializer it's attached to.
"""
def __init__(self, method_name, *args, **kwargs):
2012-11-19 21:22:17 +04:00
self.method_name = method_name
super(SerializerMethodField, self).__init__(*args, **kwargs)
2012-11-19 21:22:17 +04:00
def field_to_native(self, obj, field_name):
value = getattr(self.parent, self.method_name)(obj)
return self.to_native(value)