Implements `excludes` #137

calve · 2015-08-19T21:59:16Z

As suggested in #132.

nicolaiarocci · 2015-08-20T08:13:40Z

Excellent.

funkyfuture · 2015-08-20T16:52:59Z

cerberus/cerberus.py

@@ -758,6 +758,17 @@ def _validate_valueschema(self, schema, field, value):
                if len(validator.errors):
                    self._error(field, validator.errors)

+    def _validate_excludes(self, exclude, field, value):
+        targets = []
+        if isinstance(exclude, list):


please test for isinstance(exclude, Sequence) and not isinstance(exclude, _str_types)

funkyfuture · 2015-08-20T17:05:32Z

please also add a check to SchemaError.validate for the excludes-rule. please look at #135 for the scheme i used to refactor schema-errors.

otherwise, lgtm. and i'm even baffled that required is dismissed correctly without extra effort. 8-)

funkyfuture · 2015-08-20T17:11:41Z

docs/usage.rst

+    ...           'that_field': {'type': 'dict',
+    ...                          'excludes': 'this_field'}}
+    >>> v.validate({'this_field': {}, 'that_field': {}}, schema)
+    ... False


that has to be

False

also true for all following output of returned objects. with leading dots it's interpreted as statement, not as expected result.

calve · 2015-08-21T09:22:22Z

Thank you very much for the review. I considered your observations and pushed the appropriate changes.

However, I am not quite sure what you mean by

add a check to SchemaError.validate

I added a test for the error string. Please elaborate if this was not what you meant.

funkyfuture · 2015-08-21T09:47:12Z

ah, sorry. i meant DefinitionSchema.validate; ensure that the defintion for an excludes-constraint is either a Hashable or a (non-string-)sequence of Hashables to avoid runtime-errors on validation.

funkyfuture · 2015-08-21T09:53:07Z

though i don't see a use-case for it, you might add handling of the rule for unknown fields for the sake of completeness. that would let any arbritary field exclude one or more defined fields.

funkyfuture · 2015-08-21T09:56:04Z

cerberus/cerberus.py

@@ -758,6 +758,16 @@ def _validate_valueschema(self, schema, field, value):
                if len(validator.errors):
                    self._error(field, validator.errors)

+    def _validate_excludes(self, excludes, field, value):
+        if isinstance(excludes, _str_type):


should test for Hashable as any hashable object can be a mapping's key.

nicolaiarocci · 2015-08-25T07:33:15Z

Could you please rebase this one of top of current master? Thanks!

Also pass flake8 test

They were interpreted as statement, not expected result

Namelly : - be consistent : name parameter `excludes` instead of `exclude` - if `excludes` is a string, simply wrap it in a list - test if `excludes` is a string with `_str_type`

Also tests

calve · 2015-08-25T09:15:08Z

Rebased.

Running tox test suite, those two errors are raised;

Document: usage
---------------
**********************************************************************
File "usage.rst", line 654, in default
Failed example:
    v.validate({'this_field': {}}, schema)
Expected:
    True
Got:
    False
**********************************************************************
File "usage.rst", line 656, in default
Failed example:
    v.validate({'that_field': {}}, schema)
Expected:
    True
Got:
    False
**********************************************************************

which are not consistent with the results expected by the test suite. Any idea how to fix those ?

funkyfuture · 2015-08-25T12:14:09Z

in such cases i adapt the doctests as unittests to investigate.

nicolaiarocci · 2015-08-25T13:00:49Z

For line 654:

>>> v.errors
{'that_field': 'required field'}

nicolaiarocci · 2015-08-25T13:12:04Z

The unittest succeeds because assertSuccess passes update=True to the validate method. If update is False, then it will fail (as it happens to be in the doctest).

calve · 2015-08-25T13:14:36Z

It looks like when both fields are required, the validatiion always fails. That makes sence, but the following test case should fails.

def test_required_excludes(self):
    schema = {'this_field': {'type': 'dict',
                             'excludes': 'that_field',
                             'required': True},
              'that_field': {'type': 'dict',
                             'excludes': 'this_field',
                             'required': True}}
    document1 = {'this_field': {}}
    document2 = {'that_field': {}}
    document3 = {'that_field': {}, 'this_field': {}}
    self.assertSuccess(document1, schema)
    self.assertSuccess(document2, schema)
    self.assertFail({}, schema)
    self.assertFail(document3, schema)

in particular the following lines :

    self.assertSuccess(document1, schema)
    self.assertSuccess(document2, schema)

Actually, the test suite still succeed if I changed those assertSuccess for assertFail

nicolaiarocci · 2015-08-25T13:15:07Z

Yup see my comment on assertSuccess above

calve · 2015-08-25T13:19:13Z

This makes sense. Do you have a suggestion about it ?

I am about to patch the assertSuccess method to accept an update parameter.

nicolaiarocci · 2015-08-25T13:24:32Z

Patching assertSuccess is probably a good thing. You will also want to edit/change the usage.rst example.

Save a set of required fields, and ensure at least one of them is present in the end

calve · 2015-08-25T16:35:02Z

Please have a look at the latest commit : running assertSuccess with update=False raised errors concerning mutually excluded and required fields (in the test_required_excludes function).

required fields were not properly dismissed, which should be fixed now.

calve · 2015-08-26T10:55:46Z

Thanks for the review once again. I applied your suggestions.

funkyfuture · 2015-08-26T15:39:08Z

cerberus/cerberus.py

@@ -818,6 +830,28 @@ def _validate_valueschema(self, schema, field, value):
                if len(validator.errors):
                    self._error(field, validator.errors)

+    def _validate_excludes(self, excludes, field, value):


one thing i missed, within their functional grouped sections methods are sorted alphabetically. thus, this should be moved to line 578.

Keep definition validation method sorted alphabetically

nicolaiarocci · 2015-08-27T07:50:51Z

Thanks!

nicolaiarocci · 2015-08-27T07:52:07Z

PS: feel free to PR to replace your nickname if so you wish (could not get a hold of your name from the logs). Or I can edit it for you :)

funkyfuture · 2015-08-27T10:19:47Z

great, thank you!

calve · 2015-08-28T13:06:26Z

Thanks for all the reviews and the approval.

calve force-pushed the master branch from 82ed508 to b096d35 Compare August 19, 2015 22:10

funkyfuture reviewed Aug 20, 2015
View reviewed changes

funkyfuture reviewed Aug 21, 2015
View reviewed changes

calve force-pushed the master branch from 5b44b3b to ec5073e Compare August 21, 2015 09:56

calve added 10 commits August 25, 2015 09:44

Implements excludes

e384a6b

Factorise _validate_excludes

7f26878

Also pass flake8 test

Remove leading dots in the documentation

2cbae0d

They were interpreted as statement, not expected result

Fix style after review

b163076

Namelly : - be consistent : name parameter `excludes` instead of `exclude` - if `excludes` is a string, simply wrap it in a list - test if `excludes` is a string with `_str_type`

Better error string for excludes

7d397e9

Also tests

Fix flake8 errors

0db343e

Test for Hashable

6d56b64

Constraint excludes to Hashable

a32942e

Add indice to format string to pass py26

2d84d1d

Fix documentation

6dfca7d

calve force-pushed the master branch from 2fcf26f to 6dfca7d Compare August 25, 2015 07:54

calve added 2 commits August 25, 2015 17:02

Allow assertSuccess to take the update parameter

5746872

Fix mutually required fields

7504fc8

Save a set of required fields, and ensure at least one of them is present in the end

calve force-pushed the master branch 2 times, most recently from 0aa7aac to 7504fc8 Compare August 25, 2015 16:19

Fix attribute naming after suggestions

9c4f92e

funkyfuture reviewed Aug 26, 2015
View reviewed changes

Sort validations method alphabetically

fa7b7b4

Keep definition validation method sorted alphabetically

nicolaiarocci merged commit fa7b7b4 into pyeve:master Aug 27, 2015

nicolaiarocci added a commit that referenced this pull request Aug 27, 2015

Chagenlog update for #137: 'excludes' rule.

eb37ffa

funkyfuture mentioned this pull request Aug 27, 2015

Proposal: add exclusion-checks #84

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implements `excludes` #137

Implements `excludes` #137

calve commented Aug 19, 2015

nicolaiarocci commented Aug 20, 2015

funkyfuture Aug 20, 2015

funkyfuture commented Aug 20, 2015

funkyfuture Aug 20, 2015

calve commented Aug 21, 2015

funkyfuture commented Aug 21, 2015

funkyfuture commented Aug 21, 2015

funkyfuture Aug 21, 2015

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

funkyfuture commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

calve commented Aug 26, 2015

funkyfuture Aug 26, 2015

nicolaiarocci commented Aug 27, 2015

nicolaiarocci commented Aug 27, 2015

funkyfuture commented Aug 27, 2015

calve commented Aug 28, 2015

Implements excludes #137

Implements excludes #137

Conversation

calve commented Aug 19, 2015

nicolaiarocci commented Aug 20, 2015

funkyfuture Aug 20, 2015

Choose a reason for hiding this comment

funkyfuture commented Aug 20, 2015

funkyfuture Aug 20, 2015

Choose a reason for hiding this comment

calve commented Aug 21, 2015

funkyfuture commented Aug 21, 2015

funkyfuture commented Aug 21, 2015

funkyfuture Aug 21, 2015

Choose a reason for hiding this comment

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

funkyfuture commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

nicolaiarocci commented Aug 25, 2015

calve commented Aug 25, 2015

calve commented Aug 26, 2015

funkyfuture Aug 26, 2015

Choose a reason for hiding this comment

nicolaiarocci commented Aug 27, 2015

nicolaiarocci commented Aug 27, 2015

funkyfuture commented Aug 27, 2015

calve commented Aug 28, 2015

Implements `excludes` #137

Implements `excludes` #137