Index: django/newforms/fields.py =================================================================== --- django/newforms/fields.py (revision 6094) +++ django/newforms/fields.py (working copy) @@ -6,7 +6,7 @@ import re import time -from django.utils.translation import ugettext +from django.utils.translation import ugettext_lazy from django.utils.encoding import StrAndUnicode, smart_unicode from util import ErrorList, ValidationError @@ -44,11 +44,16 @@ class Field(object): widget = TextInput # Default widget to use when rendering this type of Field. hidden_widget = HiddenInput # Default widget to use when rendering this as "hidden". + default_error_messages = { + 'required': ugettext_lazy(u'This field is required.'), + 'invalid': ugettext_lazy(u'Enter a valid value.'), + } # Tracks each time a Field instance is created. Used to retain order. creation_counter = 0 - def __init__(self, required=True, widget=None, label=None, initial=None, help_text=None): + def __init__(self, required=True, widget=None, label=None, initial=None, + help_text=None, error_messages=None): # required -- Boolean that specifies whether the field is required. # True by default. # widget -- A Widget class, or instance of a Widget class, that should @@ -81,6 +86,20 @@ self.creation_counter = Field.creation_counter Field.creation_counter += 1 + self.error_messages = self._build_error_messages(error_messages) + + def _build_error_messages(self, extra_error_messages): + error_messages = {} + def get_default_error_messages(klass): + for base_class in klass.__bases__: + get_default_error_messages(base_class) + if hasattr(klass, 'default_error_messages'): + error_messages.update(klass.default_error_messages) + get_default_error_messages(self.__class__) + if extra_error_messages: + error_messages.update(extra_error_messages) + return error_messages + def clean(self, value): """ Validates the given value and returns its "cleaned" value as an @@ -89,7 +108,7 @@ Raises ValidationError for any errors. """ if self.required and value in EMPTY_VALUES: - raise ValidationError(ugettext(u'This field is required.')) + raise ValidationError(self.error_messages['required']) return value def widget_attrs(self, widget): @@ -101,6 +120,11 @@ return {} class CharField(Field): + default_error_messages = { + 'max_length': ugettext_lazy(u'Ensure this value has at most %(max)d characters (it has %(length)d).'), + 'min_length': ugettext_lazy(u'Ensure this value has at least %(min)d characters (it has %(length)d).'), + } + def __init__(self, max_length=None, min_length=None, *args, **kwargs): self.max_length, self.min_length = max_length, min_length super(CharField, self).__init__(*args, **kwargs) @@ -113,9 +137,9 @@ value = smart_unicode(value) value_length = len(value) if self.max_length is not None and value_length > self.max_length: - raise ValidationError(ugettext(u'Ensure this value has at most %(max)d characters (it has %(length)d).') % {'max': self.max_length, 'length': value_length}) + raise ValidationError(self.error_messages['max_length'] % {'max': self.max_length, 'length': value_length}) if self.min_length is not None and value_length < self.min_length: - raise ValidationError(ugettext(u'Ensure this value has at least %(min)d characters (it has %(length)d).') % {'min': self.min_length, 'length': value_length}) + raise ValidationError(self.error_messages['min_length'] % {'min': self.min_length, 'length': value_length}) return value def widget_attrs(self, widget): @@ -124,6 +148,12 @@ return {'maxlength': str(self.max_length)} class IntegerField(Field): + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a whole number.'), + 'max_value': ugettext_lazy(u'Ensure this value is less than or equal to %s.'), + 'min_value': ugettext_lazy(u'Ensure this value is greater than or equal to %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) @@ -139,14 +169,20 @@ try: value = int(value) except (ValueError, TypeError): - raise ValidationError(ugettext(u'Enter a whole number.')) + raise ValidationError(self.error_messages['invalid']) if self.max_value is not None and value > self.max_value: - raise ValidationError(ugettext(u'Ensure this value is less than or equal to %s.') % self.max_value) + raise ValidationError(self.error_messages['max_value'] % self.max_value) if self.min_value is not None and value < self.min_value: - raise ValidationError(ugettext(u'Ensure this value is greater than or equal to %s.') % self.min_value) + raise ValidationError(self.error_messages['min_value'] % self.min_value) return value class FloatField(Field): + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a number.'), + 'max_value': ugettext_lazy(u'Ensure this value is less than or equal to %s.'), + 'min_value': ugettext_lazy(u'Ensure this value is greater than or equal to %s.'), + } + def __init__(self, max_value=None, min_value=None, *args, **kwargs): self.max_value, self.min_value = max_value, min_value Field.__init__(self, *args, **kwargs) @@ -162,14 +198,23 @@ try: value = float(value) except (ValueError, TypeError): - raise ValidationError(ugettext('Enter a number.')) + raise ValidationError(self.error_messages['invalid']) if self.max_value is not None and value > self.max_value: - raise ValidationError(ugettext('Ensure this value is less than or equal to %s.') % self.max_value) + raise ValidationError(self.error_messages['max_value'] % self.max_value) if self.min_value is not None and value < self.min_value: - raise ValidationError(ugettext('Ensure this value is greater than or equal to %s.') % self.min_value) + raise ValidationError(self.error_messages['min_value'] % self.min_value) return value class DecimalField(Field): + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a number.'), + 'max_value': ugettext_lazy(u'Ensure this value is less than or equal to %s.'), + 'min_value': ugettext_lazy(u'Ensure this value is greater than or equal to %s.'), + 'max_digits': ugettext_lazy('Ensure that there are no more than %s digits in total.'), + 'max_decimal_places': ugettext_lazy('Ensure that there are no more than %s decimal places.'), + 'max_whole_digits': ugettext_lazy('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 @@ -189,20 +234,20 @@ try: value = Decimal(value) except DecimalException: - raise ValidationError(ugettext('Enter a number.')) + raise ValidationError(self.error_messages['invalid']) pieces = str(value).lstrip("-").split('.') decimals = (len(pieces) == 2) and len(pieces[1]) or 0 digits = len(pieces[0]) if self.max_value is not None and value > self.max_value: - raise ValidationError(ugettext('Ensure this value is less than or equal to %s.') % self.max_value) + raise ValidationError(self.error_messages['max_value'] % self.max_value) if self.min_value is not None and value < self.min_value: - raise ValidationError(ugettext('Ensure this value is greater than or equal to %s.') % self.min_value) + raise ValidationError(self.error_messages['min_value'] % self.min_value) if self.max_digits is not None and (digits + decimals) > self.max_digits: - raise ValidationError(ugettext('Ensure that there are no more than %s digits in total.') % 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(ugettext('Ensure that there are no more than %s decimal places.') % 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 digits > (self.max_digits - self.decimal_places): - raise ValidationError(ugettext('Ensure that there are no more than %s digits before the decimal point.') % (self.max_digits - self.decimal_places)) + raise ValidationError(self.error_messages['max_whole_digits'] % (self.max_digits - self.decimal_places)) return value DEFAULT_DATE_INPUT_FORMATS = ( @@ -214,6 +259,10 @@ ) class DateField(Field): + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a valid date.'), + } + def __init__(self, input_formats=None, *args, **kwargs): super(DateField, self).__init__(*args, **kwargs) self.input_formats = input_formats or DEFAULT_DATE_INPUT_FORMATS @@ -235,7 +284,7 @@ return datetime.date(*time.strptime(value, format)[:3]) except ValueError: continue - raise ValidationError(ugettext(u'Enter a valid date.')) + raise ValidationError(self.error_messages['invalid']) DEFAULT_TIME_INPUT_FORMATS = ( '%H:%M:%S', # '14:30:59' @@ -243,6 +292,10 @@ ) class TimeField(Field): + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a valid time.') + } + def __init__(self, input_formats=None, *args, **kwargs): super(TimeField, self).__init__(*args, **kwargs) self.input_formats = input_formats or DEFAULT_TIME_INPUT_FORMATS @@ -262,7 +315,7 @@ return datetime.time(*time.strptime(value, format)[3:6]) except ValueError: continue - raise ValidationError(ugettext(u'Enter a valid time.')) + raise ValidationError(self.error_messages['invalid']) DEFAULT_DATETIME_INPUT_FORMATS = ( '%Y-%m-%d %H:%M:%S', # '2006-10-25 14:30:59' @@ -277,6 +330,10 @@ ) class DateTimeField(Field): + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a valid date/time.'), + } + def __init__(self, input_formats=None, *args, **kwargs): super(DateTimeField, self).__init__(*args, **kwargs) self.input_formats = input_formats or DEFAULT_DATETIME_INPUT_FORMATS @@ -298,7 +355,7 @@ return datetime.datetime(*time.strptime(value, format)[:6]) except ValueError: continue - raise ValidationError(ugettext(u'Enter a valid date/time.')) + raise ValidationError(self.error_messages['invalid']) class RegexField(CharField): def __init__(self, regex, max_length=None, min_length=None, error_message=None, *args, **kwargs): @@ -307,11 +364,15 @@ error_message is an optional error message to use, if 'Enter a valid value' is too generic for you. """ + # error_message is just kept for backwards compatibility: + if error_message: + error_messages = kwargs.get('error_messages') or {} + error_messages['invalid'] = error_message + kwargs['error_messages'] = error_messages super(RegexField, self).__init__(max_length, min_length, *args, **kwargs) if isinstance(regex, basestring): regex = re.compile(regex) self.regex = regex - self.error_message = error_message or ugettext(u'Enter a valid value.') def clean(self, value): """ @@ -322,7 +383,7 @@ if value == u'': return value if not self.regex.search(value): - raise ValidationError(self.error_message) + raise ValidationError(self.error_messages['invalid']) return value email_re = re.compile( @@ -331,9 +392,9 @@ r')@(?:[A-Z0-9-]+\.)+[A-Z]{2,6}$', re.IGNORECASE) # domain class EmailField(RegexField): - def __init__(self, max_length=None, min_length=None, *args, **kwargs): - RegexField.__init__(self, email_re, max_length, min_length, - ugettext(u'Enter a valid e-mail address.'), *args, **kwargs) + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a valid e-mail address.'), + } url_re = re.compile( r'^https?://' # http:// or https:// @@ -363,6 +424,12 @@ class FileField(Field): widget = FileInput + default_error_messages = { + 'invalid': ugettext_lazy(u"No file was submitted. Check the encoding type on the form."), + 'missing': ugettext_lazy(u"No file was submitted."), + 'empty': ugettext_lazy(u"The submitted file is empty."), + } + def __init__(self, *args, **kwargs): super(FileField, self).__init__(*args, **kwargs) @@ -373,14 +440,18 @@ try: f = UploadedFile(data['filename'], data['content']) except TypeError: - raise ValidationError(ugettext(u"No file was submitted. Check the encoding type on the form.")) + raise ValidationError(self.error_messages['invalid']) except KeyError: - raise ValidationError(ugettext(u"No file was submitted.")) + raise ValidationError(self.error_messages['missing']) if not f.content: - raise ValidationError(ugettext(u"The submitted file is empty.")) + raise ValidationError(self.error_messages['empty']) return f class ImageField(FileField): + default_error_messages = { + 'invalid_image': ugettext_lazy(u"Upload a valid image. The file you uploaded was either not an image or a corrupted image."), + } + def clean(self, data): """ Checks that the file-upload field data contains a valid image (GIF, JPG, @@ -394,13 +465,18 @@ try: Image.open(StringIO(f.content)) except IOError: # Python Imaging Library doesn't recognize it as an image - raise ValidationError(ugettext(u"Upload a valid image. The file you uploaded was either not an image or a corrupted image.")) + raise ValidationError(self.error_messages['invalid_image']) return f class URLField(RegexField): + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a valid URL.'), + 'invalid_link': ugettext_lazy(u'This URL appears to be a broken link.'), + } + def __init__(self, max_length=None, min_length=None, verify_exists=False, validator_user_agent=URL_VALIDATOR_USER_AGENT, *args, **kwargs): - super(URLField, self).__init__(url_re, max_length, min_length, ugettext(u'Enter a valid URL.'), *args, **kwargs) + super(URLField, self).__init__(url_re, max_length, min_length, ugettext_lazy(u'Enter a valid URL.'), *args, **kwargs) self.verify_exists = verify_exists self.user_agent = validator_user_agent @@ -422,9 +498,9 @@ req = urllib2.Request(value, None, headers) u = urllib2.urlopen(req) except ValueError: - raise ValidationError(ugettext(u'Enter a valid URL.')) + raise ValidationError(self.error_messages['invalid']) except: # urllib2.URLError, httplib.InvalidURL, etc. - raise ValidationError(ugettext(u'This URL appears to be a broken link.')) + raise ValidationError(self.error_messages['invalid_link']) return value class BooleanField(Field): @@ -447,9 +523,14 @@ class ChoiceField(Field): widget = Select + default_error_messages = { + 'invalid_choice': ugettext_lazy(u'Select a valid choice. That choice is not one of the available choices.'), + } - def __init__(self, choices=(), required=True, widget=None, label=None, initial=None, help_text=None): - super(ChoiceField, self).__init__(required, widget, label, initial, help_text) + def __init__(self, choices=(), required=True, widget=None, label=None, + initial=None, help_text=None, *args, **kwargs): + super(ChoiceField, self).__init__(required, widget, label, initial, + help_text, *args, **kwargs) self.choices = choices def _get_choices(self): @@ -475,29 +556,32 @@ return value valid_values = set([smart_unicode(k) for k, v in self.choices]) if value not in valid_values: - raise ValidationError(ugettext(u'Select a valid choice. That choice is not one of the available choices.')) + raise ValidationError(self.error_messages['invalid_choice'] % {'value': value}) return value class MultipleChoiceField(ChoiceField): hidden_widget = MultipleHiddenInput widget = SelectMultiple + default_error_messages = { + 'invalid_choice': ugettext_lazy(u'Select a valid choice. %(value)s is not one of the available choices.') + } def clean(self, value): """ Validates that the input is a list or tuple. """ if self.required and not value: - raise ValidationError(ugettext(u'This field is required.')) + raise ValidationError(ugettext_lazy(u'This field is required.')) elif not self.required and not value: return [] if not isinstance(value, (list, tuple)): - raise ValidationError(ugettext(u'Enter a list of values.')) + raise ValidationError(ugettext_lazy(u'Enter a list of values.')) new_value = [smart_unicode(val) for val in value] # Validate that each value in the value list is in self.choices. valid_values = set([smart_unicode(k) for k, v in self.choices]) for val in new_value: if val not in valid_values: - raise ValidationError(ugettext(u'Select a valid choice. %s is not one of the available choices.') % val) + raise ValidationError(self.error_messages['invalid_choice'] % {'value': val}) return new_value class ComboField(Field): @@ -540,6 +624,9 @@ You'll probably want to use this with MultiWidget. """ + default_error_messages = { + 'invalid': ugettext_lazy(u'Enter a list of values.'), + } def __init__(self, fields=(), *args, **kwargs): super(MultiValueField, self).__init__(*args, **kwargs) # Set 'required' to False on the individual fields, because the @@ -563,18 +650,18 @@ if not value or isinstance(value, (list, tuple)): if not value or not [v for v in value if v not in EMPTY_VALUES]: if self.required: - raise ValidationError(ugettext(u'This field is required.')) + raise ValidationError(self.error_messages['required']) else: return self.compress([]) else: - raise ValidationError(ugettext(u'Enter a list of values.')) + raise ValidationError(self.error_messages['invalid']) for i, field in enumerate(self.fields): try: field_value = value[i] except IndexError: field_value = None if self.required and field_value in EMPTY_VALUES: - raise ValidationError(ugettext(u'This field is required.')) + raise ValidationError(self.error_messages['required']) try: clean_data.append(field.clean(field_value)) except ValidationError, e: @@ -598,6 +685,10 @@ raise NotImplementedError('Subclasses must implement this method.') class SplitDateTimeField(MultiValueField): + default_error_messages = { + 'invalid_date': ugettext_lazy(u'Enter a valid date.'), + 'invalid_time': ugettext_lazy(u'Enter a valid time.'), + } def __init__(self, *args, **kwargs): fields = (DateField(), TimeField()) super(SplitDateTimeField, self).__init__(fields, *args, **kwargs) @@ -607,8 +698,8 @@ # Raise a validation error if time or date is empty # (possible if SplitDateTimeField has required=False). if data_list[0] in EMPTY_VALUES: - raise ValidationError(ugettext(u'Enter a valid date.')) + raise ValidationError(self.error_messages['invalid_date']) if data_list[1] in EMPTY_VALUES: - raise ValidationError(ugettext(u'Enter a valid time.')) + raise ValidationError(self.error_messages['invalid_time']) return datetime.datetime.combine(*data_list) return None Index: django/newforms/util.py =================================================================== --- django/newforms/util.py (revision 6094) +++ django/newforms/util.py (working copy) @@ -1,5 +1,5 @@ from django.utils.html import escape -from django.utils.encoding import smart_unicode, StrAndUnicode +from django.utils.encoding import smart_unicode, force_unicode, StrAndUnicode def flatatt(attrs): """ @@ -47,7 +47,6 @@ if isinstance(message, list): self.messages = ErrorList([smart_unicode(msg) for msg in message]) else: - assert isinstance(message, basestring), ("%s should be a basestring" % repr(message)) message = smart_unicode(message) self.messages = ErrorList([message]) @@ -56,4 +55,5 @@ # instance would result in this: # AttributeError: ValidationError instance has no attribute 'args' # See http://www.python.org/doc/current/tut/node10.html#handling - return repr(self.messages) + # We also force any lazy messages to unicode. + return repr([force_unicode(message) for message in self.messages]) Index: django/utils/translation/__init__.py =================================================================== --- django/utils/translation/__init__.py (revision 6094) +++ django/utils/translation/__init__.py (working copy) @@ -8,7 +8,7 @@ 'get_language', 'get_language_bidi', 'get_date_formats', 'get_partial_date_formats', 'check_for_language', 'to_locale', 'get_language_from_request', 'install', 'templatize', 'ugettext', - 'ungettext', 'deactivate_all'] + 'ugettext_lazy', 'ungettext', 'deactivate_all'] # Here be dragons, so a short explanation of the logic won't hurt: # We are trying to solve two problems: (1) access settings, in particular