Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BaseField: the parameters required and nullable have counter-intuitive results #167

Open
vaughnkoch opened this issue Sep 18, 2022 · 2 comments

Comments

@vaughnkoch
Copy link

Hi, first off, thanks for writing and maintaining this library!

The code below shows a very basic jsonmodel with two different permutations of required and nullable for BaseField.

The two problems are:

  1. nullable is not properly enforced - even if a field is not required, it should be possible to deny null values. (required=false, nullable=False).
  2. It seems impossible to enforce the existence of a value, but still allow nulls. (required=True, nullable=True).

I looked through the documentation and examples, and couldn't find a way to achieve these two goals, although I could have missed something.

Example (tested with jsonmodels 2.5.1):

from jsonmodels import models, fields, errors, validators

# Problem 1: Nullable is not enforced
class Foo(models.Base):
    bar = fields.IntField(required=False, nullable=False)

Foo(bar=None)  # This should fail because nullable=False, but instead this passes validation.


# Problem 2: It's impossible to enforce { foo: null } as a valid value.
class Foo(models.Base):
    bar = fields.IntField(required=True, nullable=True)

Foo(bar=None)  # This fails validation with Field is required!, but should succeed because nullable=True.

Also, there doesn't appear to be much documentation on nullable.

@vaughnkoch
Copy link
Author

Just to add to this - if the jsonmodel is used to produce a jsonschema, and that schema is used to validate json, then nullable does have an effect: if nullable is False, null values in the json will throw an error. So it seems that this behavior is inconsistent between the jsonschema the jsonmodel creates and the jsonmodel's own expectations.

@beregond
Copy link
Collaborator

Hey, thanks @vaughnkoch - will dive into this problem during next days

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants