Support assert statements inside validators by abdusco · Pull Request #653 · pydantic/pydantic

abdusco · 2019-07-11T10:38:20Z

Change Summary

This PR adds support for assert statements inside validators (related: #654). This means we can use:

class CreateJob(BaseModel):
    name: str
    interval: int

    @validator('interval')
    def parse_interval(cls, v: int):
        assert v > 60, 'Interval must be longer than 60 seconds'
        return timedelta(seconds=v)

to raise validation errors.

I've updated docs, but haven't been able to build it on Windows. I'm getting this error:

(venv) D:\Development\oss\pydantic>make docs
make -C docs html
make[1]: Entering directory 'D:/Development/oss/pydantic/docs'
rm -rf _build
./schema_mapping.py
env: 'python3': Permission denied
make[1]: *** [Makefile:17: html] Error 126
make[1]: Leaving directory 'D:/Development/oss/pydantic/docs'
make: *** [Makefile:97: docs] Error 2

Checklist

Unit tests for the changes exist
Tests pass on CI and coverage remains at 100%
Documentation reflects the changes where applicable
HISTORY.rst has been updated
- if this is the first change since a release, please add a new section
- include the issue number or this pull request number #<number>
- include your github username @<whomever>

codecov · 2019-07-11T10:44:10Z

Codecov Report

Merging #653 into master will decrease coverage by 0.07%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #653      +/-   ##
==========================================
- Coverage     100%   99.92%   -0.08%     
==========================================
  Files          15       15              
  Lines        2720     2725       +5     
  Branches      534      536       +2     
==========================================
+ Hits         2720     2723       +3     
- Misses          0        2       +2

samuelcolvin · 2019-07-11T10:44:17Z

Please create an issue to discuss this first. Such big changes can't just be implemented directly as a PR.

abdusco · 2019-07-11T10:48:03Z

Ah sorry, good idea :)

tiangolo

I like this! 🎉

I would suggest adding a section in the docs explaining how to use it and adding a small caveat about @dmontagu 's comment: #654 (comment)

abdusco · 2019-07-19T18:28:38Z

@tiangolo Updated docs with a warning

samuelcolvin · 2019-07-20T10:02:27Z

Away from my computer, so ignore this if it's covered in the code.

If pytest is giving you trouble, add a simple python test like the mypy external tests and add it to make.

samuelcolvin

LGTM, but please add a section to HISTORY.rst and also add a raw python test called perhaps tests/assert_test.py that tests an assert statement passing and failing and adding it to the make tests recipe.

samuelcolvin · 2019-08-05T11:12:28Z

any chance we could get this fixed? I would like to get everything currently pending on the next release so I can work exclusively on v1.

samuelcolvin · 2019-08-06T15:14:43Z

This is missed release v0.32, let's now include it in v1. That wasn't my original plan, but probably makes sense since it's quite a big conceptual change (even if it's backwards compatible).

samuelcolvin · 2019-08-06T15:22:19Z

please can you rebase and move the history change to changes/ as per #719.

dmontagu · 2019-08-11T03:20:55Z

I think I've addressed the outstanding issues in https://github.com/dmontagu/pydantic/tree/assert_statement_support

I opened a PR against @abdusco 's branch (though it involved a rebase against master which I guess might cause issues). @samuelcolvin let me know if you want me to just make a separate PR.

samuelcolvin · 2019-08-11T13:20:28Z

@dmontagu as a collaborator, you can probably push directly to @abdusco's branch.

Can you try that, if you can't, I'll do it.

dmontagu · 2019-08-11T19:46:10Z

+        fail_test(test_name, ['ValidationError was not raised'])
+
+
+def fail_test(test_name: str, description: List[str]):


I added a little bit of pretty error reporting to make it easier for contributors to realize what is going wrong if this test is failing. @samuelcolvin Let me know if you take any issue with the style here.

samuelcolvin

otherwise LGTM.

dmontagu · 2019-08-14T05:28:51Z

Just realized I never pushed the fixes to the abdusco remote 🤦‍♂️. Sorry for the delay.

abdusco mentioned this pull request Jul 11, 2019

Support assert statements inside validators #654

Closed

tiangolo reviewed Jul 13, 2019

View reviewed changes

dmontagu reviewed Jul 19, 2019

View reviewed changes

Comment thread tests/test_validators.py Outdated

dmontagu reviewed Jul 19, 2019

View reviewed changes

Comment thread docs/index.rst Outdated

abdusco commented Jul 19, 2019

View reviewed changes

Comment thread pydantic/error_wrappers.py

abdusco commented Jul 19, 2019

View reviewed changes

Comment thread pydantic/error_wrappers.py Outdated

dmontagu reviewed Jul 19, 2019

View reviewed changes

Comment thread tests/test_validators.py Outdated

dmontagu reviewed Jul 19, 2019

View reviewed changes

Comment thread pydantic/error_wrappers.py Outdated

samuelcolvin reviewed Jul 23, 2019

View reviewed changes

samuelcolvin added this to the Version 1 milestone Aug 6, 2019

abdusco and others added 10 commits August 10, 2019 18:38

Support assert statements inside validators

13b9c0f

Add a validator example that uses assert

90868c2

Add warning about consequences of using -O optimization flag

276ad8b

Fix a typo

fec6f70

Fix incomplete validator

3349917

Extend exception name generation

fd4f5e6

Improve tests

d4399b7

Clarify pytest behaviour

c78f10c

handle assertion error name, fix build

123e09c

Address feedback

642cf87

dmontagu reviewed Aug 11, 2019

View reviewed changes

Comment thread tests/try_assert.py

dmontagu reviewed Aug 11, 2019

View reviewed changes

Comment thread Makefile

docs cleanup

2ed678e

samuelcolvin reviewed Aug 12, 2019

View reviewed changes

Comment thread Makefile

Comment thread docs/index.rst Outdated

Comment thread tests/try_assert.py Outdated

Comment thread tests/try_assert.py

Incorporate feedback

fbba394

fix quotes

dc39c43

samuelcolvin merged commit f41d5dc into pydantic:master Aug 15, 2019

alexdrydew pushed a commit to alexdrydew/pydantic that referenced this pull request Dec 23, 2023

specific TZ offset constraints (pydantic#653)

3d3cb7f

		fail_test(test_name, ['ValidationError was not raised'])


		def fail_test(test_name: str, description: List[str]):

Uh oh!

Conversation

abdusco commented Jul 11, 2019 • edited by dmontagu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Summary

Checklist

Uh oh!

codecov Bot commented Jul 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

samuelcolvin commented Jul 11, 2019

Uh oh!

abdusco commented Jul 11, 2019

Uh oh!

tiangolo left a comment

Choose a reason for hiding this comment

Uh oh!

abdusco commented Jul 19, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samuelcolvin commented Jul 20, 2019

Uh oh!

samuelcolvin left a comment

Choose a reason for hiding this comment

Uh oh!

samuelcolvin commented Aug 5, 2019

Uh oh!

samuelcolvin commented Aug 6, 2019

Uh oh!

samuelcolvin commented Aug 6, 2019

Uh oh!

dmontagu commented Aug 11, 2019

Uh oh!

samuelcolvin commented Aug 11, 2019

Uh oh!

dmontagu Aug 11, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

samuelcolvin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmontagu commented Aug 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

abdusco commented Jul 11, 2019 •

edited by dmontagu

Loading

codecov Bot commented Jul 11, 2019 •

edited

Loading