Ignore default clean method if error exists (#60) 🧕🏽

* Ignore default clean method if error exists

* updated documentation

* Dependencies 🫒

* Removed 3.8 python version from tests

---------

Co-authored-by: Jakub Dubec <[email protected]>

Author: Serbel97

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.0-rc.8 : 07.03.2023
+
+- **Changed**: Default clean method `Form.clean` is only called when there are no errors.
+
 ## 1.0.0-rc.7 : 24.11.2022
 
 CI/CD fixies and project settings. There was no application change.

django_api_forms/forms.py

@@ -142,13 +142,12 @@ def full_clean(self):
                 self.add_error((key, ), e)
             except (AttributeError, TypeError, ValueError):
                 self.add_error((key, ), ValidationError(_("Invalid value")))
-        try:
-            cleaned_data = self.clean()
-        except ValidationError as e:
-            self.add_error(('$body', ), e)
-        else:
-            if cleaned_data is not None:
-                self.cleaned_data = cleaned_data
+
+        if not self._errors:
+            try:
+                self.cleaned_data = self.clean()
+            except ValidationError as e:
+                self.add_error(('$body',), e)
 
     def clean(self):
         """

docs/tutorial.md

@@ -84,8 +84,8 @@ This process is much more simple than in classic Django form. It consists of:
    - calling `Form.add_error((field_name, ), error)` in case of failures in clean methods
    - if field is marked as dirty, normalized attribute is saved to `Form.clean_data` property
 2. Calling `Form.clean` method which returns final normalized values which will be presented in `Form.clean_data`
-(feel free to override it, by default does nothing, useful for conditional validation, you can still add errors u
-sing `Form.add_error()`)
+(feel free to override it, by default does nothing, useful for conditional validation, you can still add errors
+using `Form.add_error()`). `Form.clean` is only called when there are no errors from previous section.
 
 Normalized data are available in `Form.clean_data` property (keys suppose to correspond with values from `Form.dirty`).
 

tests/test_nested_forms.py

@@ -55,11 +55,6 @@ def test_invalid(self):
                     "message": "Enter a valid date/time.",
                     "path": ["bands", 1, "albums", 0, "metadata", "error_at"]
                 },
-                {
-                    "code": "time-traveling",
-                    "message": "Sounds like a bullshit",
-                    "path": ["bands", 1, "albums", 0, "$body"]
-                },
                 {
                     "code": "invalid",
                     "message": "Enter a valid email address.",

tests/test_validation.py

@@ -47,13 +47,6 @@ def test_invalid(self):
                         "metadata",
                         "error_at"
                     ]
-                },
-                {
-                    "code": "time-traveling",
-                    "message": "Sounds like a bullshit",
-                    "path": [
-                        "$body"
-                    ]
                 }
             ]
         }
@@ -119,3 +112,72 @@ def test_valid(self):
 
         self.assertTrue(form.is_valid())
         self.assertEqual(form.cleaned_data, expected)
+
+    def test_default_clean(self):
+        data = {
+            "title": "Unknown Pleasures",
+            "type": "vinyl",
+            "artist": {
+                "name": "Joy Division",
+                "genres": [
+                    "rock",
+                    "punk"
+                ],
+                "members": 4
+            },
+            "year": 1998,
+            "songs": [
+                {
+                    "title": "Disorder",
+                    "duration": "3:29"
+                },
+                {
+                    "title": "Day of the Lords",
+                    "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+0100",
+                "updated_at": "2019-10-21T18:57:03+0100"
+            }
+        }
+
+        rf = RequestFactory()
+
+        expected = {
+            "errors": [
+                {
+                    "code": "time-traveling",
+                    "message": "Sounds like a bullshit",
+                    "path": [
+                        "$body"
+                    ]
+                }
+            ]
+        }
+
+        request = rf.post('/foo/bar', data=data, content_type='application/json')
+
+        form = AlbumForm.create_from_request(request)
+
+        self.assertFalse(form.is_valid())
+        error = {
+            'errors': [item.to_dict() for item in form._errors]
+        }
+        self.assertEqual(error, expected)