Process EnumFields even if their are not marked as required 🧈

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.1 : 19.12.2019
+
+- **Fix**: Process `EnumField` even if it's not marked as required
+
 ## 0.5.0 : 16.12.2019
 
 - **Change**: Use native `django.form.fields` if possible

README.md

@@ -50,6 +50,7 @@ python setup.py install
 ```json
 {
   "title": "Unknown Pleasures",
+  "type": "vinyl",
   "artist": {
     "name": "Joy division",
     "genres": [
@@ -79,11 +80,19 @@ python setup.py install
 **DjangoRequestFormatter equivalent + validation**
 
 ```python
-from django_request_formatter.fields import FieldList, FormField, FormFieldList, DictionaryField
-from django_request_formatter.forms import Form
+from enum import Enum
+
 from django.core.exceptions import ValidationError
 from django.forms import fields
 
+from django_request_formatter.fields import FieldList, FormField, FormFieldList, DictionaryField, EnumField
+from django_request_formatter.forms import Form
+
+
+class AlbumType(Enum):
+    CD = 'cd'
+    VINYL = 'vinyl'
+
 
 class ArtistForm(Form):
     name = fields.CharField(required=True, max_length=100)
@@ -101,16 +110,19 @@ class AlbumForm(Form):
     year = fields.IntegerField()
     artist = FormField(form=ArtistForm)
     songs = FormFieldList(form=SongForm)
+    type = EnumField(enum=AlbumType, required=True)
     metadata = DictionaryField(fields.DateTimeField())
 
     def clean_year(self):
         if self.cleaned_data['year'] == 1992:
-            raise ValidationError("Year 1992 is forbidden!")
+            raise ValidationError("Year 1992 is forbidden!", 'forbidden-value')
         return self.cleaned_data['year']
 
     def clean(self):
-        if (self.cleaned_data['year'] == "1998") and (self.cleaned_data['artist'] == "Nirvana"):
-            raise ValidationError("Sounds like a bullshit")
+        if (self.cleaned_data['year'] == 1998) and (self.cleaned_data['artist']['name'] == "Nirvana"):
+            raise ValidationError("Sounds like a bullshit", code='time-traveling')
+        return self.cleaned_data
+
 
 """
 Django view example

django_request_formatter/__version__.py

@@ -1 +1 @@
-__version__ = '0.5.0'
+__version__ = '0.5.1'

django_request_formatter/fields.py

@@ -23,7 +23,7 @@ def __init__(self, field, **kwargs):
 
         super().__init__(**kwargs)
 
-    def to_python(self, value):
+    def to_python(self, value) -> typing.List:
         if not isinstance(value, list):
             raise ValidationError(self.error_messages['not_list'], code='not_list')
 
@@ -53,6 +53,10 @@ def __init__(self, form: typing.Type, **kwargs):
 
         super().__init__(**kwargs)
 
+    @property
+    def form(self):
+        return self._form
+
     def to_python(self, value) -> dict:
         form = self._form(value)
         if form.is_valid():
@@ -99,12 +103,13 @@ def __init__(self, enum: typing.Type, **kwargs):
 
         super().__init__(**kwargs)
 
-    def to_python(self, value):
-        if self.required and value is not None:
+    def to_python(self, value) -> typing.Union[typing.Type[Enum], None]:
+        if value is not None:
             try:
                 return self.enum(value)
             except ValueError:
                 raise ValidationError(f"Invalid enum value {value} passed to {type(self.enum)}")
+        return None
 
 
 class DictionaryField(Field):

tests/data/invalid.json

@@ -1,5 +1,6 @@
 {
   "title": "Unknown Pleasures",
+  "type": "vinyl",
   "artist": {
     "name": "Nirvana",
     "genres": [

tests/data/valid.json

@@ -1,5 +1,6 @@
 {
   "title": "Unknown Pleasures",
+  "type": "vinyl",
   "artist": {
     "name": "Joy Division",
     "genres": [

tests/test_valid.py

@@ -3,7 +3,7 @@
 
 from django.test import RequestFactory
 
-from tests.testapp.forms import AlbumForm
+from tests.testapp.forms import AlbumForm, AlbumType
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
@@ -12,6 +12,7 @@ def test_valid(rf: RequestFactory):
     expected = {
         'title': "Unknown Pleasures",
         'year': 1979,
+        'type': AlbumType.VINYL,
         'artist': {
             'name': "Joy Division",
             'genres': ['rock', 'punk'],

tests/testapp/forms.py

@@ -1,10 +1,17 @@
+from enum import Enum
+
 from django.core.exceptions import ValidationError
 from django.forms import fields
 
-from django_request_formatter.fields import FieldList, FormField, FormFieldList, DictionaryField
+from django_request_formatter.fields import FieldList, FormField, FormFieldList, DictionaryField, EnumField
 from django_request_formatter.forms import Form
 
 
+class AlbumType(Enum):
+    CD = 'cd'
+    VINYL = 'vinyl'
+
+
 class ArtistForm(Form):
     name = fields.CharField(required=True, max_length=100)
     genres = FieldList(field=fields.CharField(max_length=30))
@@ -21,11 +28,12 @@ class AlbumForm(Form):
     year = fields.IntegerField()
     artist = FormField(form=ArtistForm)
     songs = FormFieldList(form=SongForm)
+    type = EnumField(enum=AlbumType, required=True)
     metadata = DictionaryField(fields.DateTimeField())
 
     def clean_year(self):
         if self.cleaned_data['year'] == 1992:
-            raise ValidationError("Year 1992 is forbidden!")
+            raise ValidationError("Year 1992 is forbidden!", 'forbidden-value')
         return self.cleaned_data['year']
 
     def clean(self):

tests/testapp/models.py

@@ -0,0 +1,25 @@
+import datetime
+from dataclasses import dataclass, field
+from typing import List, Dict
+
+
+@dataclass
+class Artist:
+    name: str = ""
+    members: int = 0
+    genres: List[str] = field(default_factory=list)
+
+
+@dataclass
+class Song:
+    title: str = ""
+    duration: datetime.timedelta = None
+
+
+@dataclass
+class Album:
+    title: str = ""
+    year: int = 0
+    artist: Artist = Artist()
+    songs: List[Song] = field(default_factory=list)
+    metadata: Dict = field(default_factory=dict)