Skip to content

DurationField missing in SimpleMetadata.label_lookup #8700

New issue
New issue
Closed
Closed
DurationField missing in SimpleMetadata.label_lookup#8700
@smt-insens

Description

@smt-insens
smt-insens
opened on Oct 14, 2022

Discussed in #8696

Originally posted by smt-insens October 13, 2022

Context:

I made an HTTP OPTIONS request. In the response I have the type of each field. I have a duration field so I expected to see something like "duration" as type but instead I have "field".

Solution:

After investigation I found that DurationField is missing in SimpleMetadata.label_lookup

This is probably due to the fact DurationField was added to Django after the other fields. The person who added DurationField probably forgot to add it to the label_lookup.

The following line should be added to label_lookup: serializers.DurationField: 'duration',

django-rest-framework/rest_framework/metadata.py

Lines 36 to 58 in 20d347a

label_lookup = ClassLookupDict({
serializers.Field: 'field',
serializers.BooleanField: 'boolean',
serializers.CharField: 'string',
serializers.UUIDField: 'string',
serializers.URLField: 'url',
serializers.EmailField: 'email',
serializers.RegexField: 'regex',
serializers.SlugField: 'slug',
serializers.IntegerField: 'integer',
serializers.FloatField: 'float',
serializers.DecimalField: 'decimal',
serializers.DateField: 'date',
serializers.DateTimeField: 'datetime',
serializers.TimeField: 'time',
serializers.ChoiceField: 'choice',
serializers.MultipleChoiceField: 'multiple choice',
serializers.FileField: 'file upload',
serializers.ImageField: 'image upload',
serializers.ListField: 'list',
serializers.DictField: 'nested object',
serializers.Serializer: 'nested object',
})

django-rest-framework/rest_framework/fields.py

Lines 1320 to 1349 in 20d347a

class DurationField(Field):
default_error_messages = {
'invalid': _('Duration has wrong format. Use one of these formats instead: {format}.'),
'max_value': _('Ensure this value is less than or equal to {max_value}.'),
'min_value': _('Ensure this value is greater than or equal to {min_value}.'),
}
def __init__(self, **kwargs):
self.max_value = kwargs.pop('max_value', None)
self.min_value = kwargs.pop('min_value', None)
super().__init__(**kwargs)
if self.max_value is not None:
message = lazy_format(self.error_messages['max_value'], max_value=self.max_value)
self.validators.append(
MaxValueValidator(self.max_value, message=message))
if self.min_value is not None:
message = lazy_format(self.error_messages['min_value'], min_value=self.min_value)
self.validators.append(
MinValueValidator(self.min_value, message=message))
def to_internal_value(self, value):
if isinstance(value, datetime.timedelta):
return value
parsed = parse_duration(str(value))
if parsed is not None:
return parsed
self.fail('invalid', format='[DD] [HH:[MM:]]ss[.uuuuuu]')
def to_representation(self, value):
return duration_string(value)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions