AnyField introduced 🎅

Sibyx · Dec 20, 2019 · 1915fe0 · 1915fe0
1 parent fcbee11
commit 1915fe0
Show file tree

Hide file tree

Showing 8 changed files with 89 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.5.3 : 19.12.2019
+
+- **Feature**: Introduced generic `AnyField`
+
 ## 0.5.2 : 19.12.2019
 
 - **Fix**: Skip processing of the `FormField` if value is not required and empty

diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ python setup.py install
   "title": "Unknown Pleasures",
   "type": "vinyl",
   "artist": {
-    "name": "Joy division",
+    "name": "Joy Division",
     "genres": [
       "rock",
       "punk"
@@ -67,14 +67,31 @@ python setup.py install
     },
     {
       "title": "Day of the Lords",
-      "duration": "4:48"
+      "duration": "4:48",
+      "metadata": {
+        "_section": {
+          "type": "ID3v2",
+          "offset": 0,
+          "byteLength": 2048
+        },
+        "header": {
+          "majorVersion": 3,
+          "minorRevision": 0,
+          "flagsOctet": 0,
+          "unsynchronisationFlag": false,
+          "extendedHeaderFlag": false,
+          "experimentalIndicatorFlag": false,
+          "size": 2038
+        }
+      }
     }
   ],
   "metadata": {
-    "created_at": "2019-10-21T18:57:03+00:00",
-    "updated_at": "2019-10-21T18:57:03+00:00"
+    "created_at": "2019-10-21T18:57:03+0100",
+    "updated_at": "2019-10-21T18:57:03+0100"
   }
 }
+
 ```
 
 **DjangoRequestFormatter equivalent + validation**
@@ -85,7 +102,7 @@ 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.fields import FieldList, FormField, FormFieldList, DictionaryField, EnumField, AnyField
 from django_request_formatter.forms import Form
 
 
@@ -103,6 +120,7 @@ class ArtistForm(Form):
 class SongForm(Form):
     title = fields.CharField(required=True, max_length=100)
     duration = fields.DurationField(required=False)
+    metadata = AnyField(required=False)
 
 
 class AlbumForm(Form):
@@ -124,6 +142,7 @@ class AlbumForm(Form):
         return self.cleaned_data
 
 
+
 """
 Django view example
 """

diff --git a/django_request_formatter/__version__.py b/django_request_formatter/__version__.py
@@ -1 +1 @@
-__version__ = '0.5.2'
+__version__ = '0.5.3'
diff --git a/django_request_formatter/fields.py b/django_request_formatter/fields.py
@@ -139,3 +139,8 @@ def to_python(self, value) -> dict:
             raise ValidationError(errors)
 
         return result
+
+
+class AnyField(Field):
+    def to_python(self, value) -> typing.Union[typing.Dict, typing.List]:
+        return value
diff --git a/tests/data/invalid.json b/tests/data/invalid.json
@@ -16,7 +16,23 @@
     },
     {
       "title": "Day of the Lords",
-      "duration": "4:48"
+      "duration": "4:48",
+      "metadata": {
+        "_section": {
+          "type": "ID3v2",
+          "offset": 0,
+          "byteLength": 2048
+        },
+        "header": {
+          "majorVersion": 3,
+          "minorRevision": 0,
+          "flagsOctet": 0,
+          "unsynchronisationFlag": false,
+          "extendedHeaderFlag": false,
+          "experimentalIndicatorFlag": false,
+          "size": 2038
+        }
+      }
     }
   ],
   "metadata": {

diff --git a/tests/data/valid.json b/tests/data/valid.json
@@ -17,7 +17,23 @@
     },
     {
       "title": "Day of the Lords",
-      "duration": "4:48"
+      "duration": "4:48",
+      "metadata": {
+        "_section": {
+          "type": "ID3v2",
+          "offset": 0,
+          "byteLength": 2048
+        },
+        "header": {
+          "majorVersion": 3,
+          "minorRevision": 0,
+          "flagsOctet": 0,
+          "unsynchronisationFlag": false,
+          "extendedHeaderFlag": false,
+          "experimentalIndicatorFlag": false,
+          "size": 2038
+        }
+      }
     }
   ],
   "metadata": {

diff --git a/tests/test_valid.py b/tests/test_valid.py
@@ -21,11 +21,28 @@ def test_valid(rf: RequestFactory):
         'songs': [
             {
                 'title': "Disorder",
-                'duration': datetime.timedelta(seconds=209)
+                'duration': datetime.timedelta(seconds=209),
+                'metadata': None  # FIXME: this not suppose to be he
             },
             {
                 'title': "Day of the Lords",
-                'duration': datetime.timedelta(seconds=288)
+                'duration': datetime.timedelta(seconds=288),
+                'metadata': {
+                    '_section': {
+                        "type": "ID3v2",
+                        "offset": 0,
+                        "byteLength": 2048
+                    },
+                    'header': {
+                        "majorVersion": 3,
+                        "minorRevision": 0,
+                        "flagsOctet": 0,
+                        "unsynchronisationFlag": False,
+                        "extendedHeaderFlag": False,
+                        "experimentalIndicatorFlag": False,
+                        "size": 2038
+                    }
+                }
             }
         ],
         'metadata': {

diff --git a/tests/testapp/forms.py b/tests/testapp/forms.py
@@ -3,7 +3,7 @@
 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.fields import FieldList, FormField, FormFieldList, DictionaryField, EnumField, AnyField
 from django_request_formatter.forms import Form
 
 
@@ -21,6 +21,7 @@ class ArtistForm(Form):
 class SongForm(Form):
     title = fields.CharField(required=True, max_length=100)
     duration = fields.DurationField(required=False)
+    metadata = AnyField(required=False)
 
 
 class AlbumForm(Form):