Skip to content

Avoid Django's lazy() when creating validators because it is too slow #6644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Avoid Django's lazy() when creating validators because it is too slow #6644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 0 additions & 30 deletions rest_framework/compat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import sys

from django.conf import settings
from django.core import validators
from django.views.generic import View

try:
Expand Down Expand Up @@ -252,34 +251,5 @@ def md_filter_add_syntax_highlight(md):
INDENT_SEPARATORS = (',', ': ')


class CustomValidatorMessage:
"""
We need to avoid evaluation of `lazy` translated `message` in `django.core.validators.BaseValidator.__init__`.
https://github.com/django/django/blob/75ed5900321d170debef4ac452b8b3cf8a1c2384/django/core/validators.py#L297

Ref: https://github.com/encode/django-rest-framework/pull/5452
"""

def __init__(self, *args, **kwargs):
self.message = kwargs.pop('message', self.message)
super().__init__(*args, **kwargs)


class MinValueValidator(CustomValidatorMessage, validators.MinValueValidator):
pass


class MaxValueValidator(CustomValidatorMessage, validators.MaxValueValidator):
pass


class MinLengthValidator(CustomValidatorMessage, validators.MinLengthValidator):
pass


class MaxLengthValidator(CustomValidatorMessage, validators.MaxLengthValidator):
pass


# Version Constants.
PY36 = sys.version_info >= (3, 6)
113 changes: 55 additions & 58 deletions rest_framework/fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
from django.core.exceptions import ObjectDoesNotExist
from django.core.exceptions import ValidationError as DjangoValidationError
from django.core.validators import (
EmailValidator, RegexValidator, URLValidator, ip_address_validators
EmailValidator, MaxLengthValidator, MaxValueValidator, MinLengthValidator,
MinValueValidator, RegexValidator, URLValidator, ip_address_validators
)
from django.forms import FilePathField as DjangoFilePathField
from django.forms import ImageField as DjangoImageField
Expand All @@ -23,17 +24,13 @@
from django.utils.duration import duration_string
from django.utils.encoding import is_protected_type, smart_text
from django.utils.formats import localize_input, sanitize_separators
from django.utils.functional import lazy
from django.utils.ipv6 import clean_ipv6_address
from django.utils.timezone import utc
from django.utils.translation import gettext_lazy as _
from pytz.exceptions import InvalidTimeError

from rest_framework import ISO_8601
from rest_framework.compat import (
MaxLengthValidator, MaxValueValidator, MinLengthValidator,
MinValueValidator, ProhibitNullCharactersValidator
)
from rest_framework.compat import ProhibitNullCharactersValidator
from rest_framework.exceptions import ErrorDetail, ValidationError
from rest_framework.settings import api_settings
from rest_framework.utils import html, humanize_datetime, json, representation
Expand Down Expand Up @@ -744,14 +741,15 @@ def __init__(self, **kwargs):
self.min_length = kwargs.pop('min_length', None)
super().__init__(**kwargs)
if self.max_length is not None:
message = lazy(self.error_messages['max_length'].format, str)(max_length=self.max_length)
self.validators.append(
MaxLengthValidator(self.max_length, message=message))
self.validators.append(lambda value: MaxLengthValidator(
self.max_length,
message=self.error_messages['max_length'].format(max_length=self.max_length),
)(value))
if self.min_length is not None:
message = lazy(
self.error_messages['min_length'].format, str)(min_length=self.min_length)
self.validators.append(
MinLengthValidator(self.min_length, message=message))
self.validators.append(lambda value: MinLengthValidator(
self.min_length,
message=self.error_messages['min_length'].format(min_length=self.min_length),
)(value))

# ProhibitNullCharactersValidator is None on Django < 2.0
if ProhibitNullCharactersValidator is not None:
Expand Down Expand Up @@ -910,15 +908,15 @@ def __init__(self, **kwargs):
self.min_value = kwargs.pop('min_value', None)
super().__init__(**kwargs)
if self.max_value is not None:
message = lazy(
self.error_messages['max_value'].format, str)(max_value=self.max_value)
self.validators.append(
MaxValueValidator(self.max_value, message=message))
self.validators.append(lambda value: MaxValueValidator(
self.max_value,
message=self.error_messages['max_value'].format(max_value=self.max_value),
)(value))
if self.min_value is not None:
message = lazy(
self.error_messages['min_value'].format, str)(min_value=self.min_value)
self.validators.append(
MinValueValidator(self.min_value, message=message))
self.validators.append(lambda value: MinValueValidator(
self.min_value,
message=self.error_messages['min_value'].format(min_value=self.min_value),
)(value))

def to_internal_value(self, data):
if isinstance(data, str) and len(data) > self.MAX_STRING_LENGTH:
Expand Down Expand Up @@ -948,17 +946,15 @@ def __init__(self, **kwargs):
self.min_value = kwargs.pop('min_value', None)
super().__init__(**kwargs)
if self.max_value is not None:
message = lazy(
self.error_messages['max_value'].format,
str)(max_value=self.max_value)
self.validators.append(
MaxValueValidator(self.max_value, message=message))
self.validators.append(lambda value: MaxValueValidator(
self.max_value,
message=self.error_messages['max_value'].format(max_value=self.max_value),
)(value))
if self.min_value is not None:
message = lazy(
self.error_messages['min_value'].format,
str)(min_value=self.min_value)
self.validators.append(
MinValueValidator(self.min_value, message=message))
self.validators.append(lambda value: MinValueValidator(
self.min_value,
message=self.error_messages['min_value'].format(min_value=self.min_value),
)(value))

def to_internal_value(self, data):

Expand Down Expand Up @@ -1007,16 +1003,15 @@ def __init__(self, max_digits, decimal_places, coerce_to_string=None, max_value=
super().__init__(**kwargs)

if self.max_value is not None:
message = lazy(
self.error_messages['max_value'].format,
str)(max_value=self.max_value)
self.validators.append(
MaxValueValidator(self.max_value, message=message))
self.validators.append(lambda value: MaxValueValidator(
self.max_value,
message=self.error_messages['max_value'].format(max_value=self.max_value),
)(value))
if self.min_value is not None:
message = lazy(
self.error_messages['min_value'].format, str)(min_value=self.min_value)
self.validators.append(
MinValueValidator(self.min_value, message=message))
self.validators.append(lambda value: MinValueValidator(
self.min_value,
message=self.error_messages['min_value'].format(min_value=self.min_value),
)(value))

if rounding is not None:
valid_roundings = [v for k, v in vars(decimal).items() if k.startswith('ROUND_')]
Expand Down Expand Up @@ -1352,17 +1347,15 @@ def __init__(self, **kwargs):
self.min_value = kwargs.pop('min_value', None)
super().__init__(**kwargs)
if self.max_value is not None:
message = lazy(
self.error_messages['max_value'].format,
str)(max_value=self.max_value)
self.validators.append(
MaxValueValidator(self.max_value, message=message))
self.validators.append(lambda value: MaxValueValidator(
self.max_value,
message=self.error_messages['max_value'].format(max_value=self.max_value),
)(value))
if self.min_value is not None:
message = lazy(
self.error_messages['min_value'].format,
str)(min_value=self.min_value)
self.validators.append(
MinValueValidator(self.min_value, message=message))
self.validators.append(lambda value: MinValueValidator(
self.min_value,
message=self.error_messages['min_value'].format(min_value=self.min_value),
)(value))

def to_internal_value(self, value):
if isinstance(value, datetime.timedelta):
Expand Down Expand Up @@ -1605,11 +1598,15 @@ def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.child.bind(field_name='', parent=self)
if self.max_length is not None:
message = self.error_messages['max_length'].format(max_length=self.max_length)
self.validators.append(MaxLengthValidator(self.max_length, message=message))
self.validators.append(lambda value: MaxLengthValidator(
self.max_length,
message=self.error_messages['max_length'].format(max_length=self.max_length),
)(value))
if self.min_length is not None:
message = self.error_messages['min_length'].format(min_length=self.min_length)
self.validators.append(MinLengthValidator(self.min_length, message=message))
self.validators.append(lambda value: MinLengthValidator(
self.min_length,
message=self.error_messages['min_length'].format(min_length=self.min_length),
)(value))

def get_value(self, dictionary):
if self.field_name not in dictionary:
Expand Down Expand Up @@ -1876,10 +1873,10 @@ def __init__(self, model_field, **kwargs):
max_length = kwargs.pop('max_length', None)
super().__init__(**kwargs)
if max_length is not None:
message = lazy(
self.error_messages['max_length'].format, str)(max_length=self.max_length)
self.validators.append(
MaxLengthValidator(self.max_length, message=message))
self.validators.append(lambda value: MaxLengthValidator(
self.max_length,
message=self.error_messages['max_length'].format(max_length=self.max_length),
)(value))

def to_internal_value(self, data):
rel = self.model_field.remote_field
Expand Down
14 changes: 14 additions & 0 deletions tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,20 @@ def pytest_configure(config):
settings.STATIC_ROOT = os.path.join(os.path.dirname(rest_framework.__file__), 'static-root')
settings.STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'

# Test that serializer fields can be created before django is set-up.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this regression test in order to alert someone who looks at the weird lambdas and tries to remove them. I thought it better than to add a comment each time.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be moved to tests.importable. Basically, it's a fake app that ensures parts of DRF can be imported before Django is fully setup. The tests just ensure that the various imports have occurred in the app __init__.

# This is not an ideal place for a test, but what can you do.
# See issue #3354.
from rest_framework.serializers import (
CharField, DecimalField, DurationField, FloatField, IntegerField,
ListField,
)
CharField(min_length=1, max_length=2)
IntegerField(min_value=1, max_value=2)
FloatField(min_value=1, max_value=2)
DecimalField(max_digits=10, decimal_places=1, min_value=1, max_value=2)
DurationField(min_value=1, max_value=2)
ListField(min_length=1, max_length=2)

django.setup()

if config.getoption('--staticfiles'):
Expand Down