Forms ValidationError и код ошибки

Question

В документации Django https://docs.djangoproject.com/en/dev/ref/forms/validation/#raising-validationerror сказал, что это хорошая практика для получения кода ошибки при сбое исключения ValidationError.

# Good 
ValidationError(_('Invalid value'), code='invalid') 

# Bad 
ValidationError(_('Invalid value')) 

У меня есть API в моем приложении, и я использую форму для проверки входных данных.
Если форма недействительна, я хочу получить эти коды ошибок (а не сообщения об ошибках).

Так что я смотрел на исходный код _clean_fields метода BaseForm:
https://github.com/django/django/blob/master/django/forms/forms.py#L278

except ValidationError as e: 
    self._errors[name] = self.error_class(e.messages) 
    if name in self.cleaned_data: 
     del self.cleaned_data[name] 

Как я понимаю, этот параметр (self.code) не передается в любом месте и не может быть получен после проверки формы.

Может кто-нибудь объяснить, в чем цель использования этого кода ошибки?

Answer 1

В Django 1.7, теперь вы можете получить исходные данные об ошибке из формы. Вы можете вызвать метод as_data() на ErrorList или ErrorDict. Например: my_form.errors.as_data(). Это в основном дает вам оригинальный объект ValidationError вместо самого сообщения. Вы можете получить доступ к объекту .code, например: my_form.errors["__all__"].as_data()[0].code.

Вы также можете сериализовать ошибки формы, отлично подходит для API:

>>> print(form.errors.as_json()) 
{"__all__": [ 
    {"message": "Your account has not been activated.", "code": "inactive"} 
]} 

Answer 2

Посмотрите на определение ValidationError в Джанго СРК, он используется как удобный способ передать дополнительный идентификатор (аналог e.errno в стандартном исключения питона), вы можете использовать его как это:

try: 
    ... 
    raise ValidationError(u'Oops', code=0x800) 
    ... 

except ValidationError as e: 
    print "Error code: ", e.code