Initial implementation of ConstrainedDate, condate #3740

hottwaj · 2022-01-27T13:58:06Z

Change Summary

Initial implementation of ConstrainedDate, condate, with tests and docs

ConstrainedDate piggybacks off ConstrainedNumberMeta and number_size_validator to implement the gt/ge/lt/le logic
Perhaps those should be renamed to hint that they are not just applicable to numbers?
if accepted, more doc changes will be needed to highlight that date validation can be constrained
also if accepted suggest similar classes for datetime, time may be needed?

Many thanks for great library!

(p.s. I replaced date with datetime.date throughout types.py to avoid inevitable confusion that otherwise arises between datetime module vs datetime class)

Related issue number

fix #3739

Checklist

Unit tests for the changes exist
[?] Tests pass on CI and coverage remains at 100%
Documentation reflects the changes where applicable
changes/<pull request or issue id>-<github username>.md file added describing change
(see changes/README.md for details)
My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

hottwaj · 2022-01-27T14:11:10Z

seems like using ConstrainedNumberMeta as metaclass for ConstrainedDate has broken the tests relating to Hypothesis strategies (_hypothesis_plugin.py)

Would appreciate some guidance on whether this approach makes sense and how to add necessary changes to _hypothesis_plugin.py

… not working

samuelcolvin · 2022-04-02T14:15:35Z

seems like using ConstrainedNumberMeta as metaclass for ConstrainedDate has broken the tests relating to Hypothesis strategies (_hypothesis_plugin.py)

Would appreciate some guidance on whether this approach makes sense and how to add necessary changes to _hypothesis_plugin.py

@Zac-HD any ideas?

Zac-HD

Suggested fix below, though I haven't tested it. I'd also recommend renaming the class ConstrainedScalarMeta, because a date (or datetime) is definitely not a number.

pydantic/_hypothesis_plugin.py

Co-authored-by: Zac Hatfield-Dodds <zac.hatfield.dodds@gmail.com>

Zac-HD · 2022-04-04T18:00:44Z

Unsubscribing because this looks like standard "read CI logs and fix errors" territory; ping me again if you have a Hypothesis question.

hottwaj · 2022-04-11T14:35:19Z

Thanks for the help and changes, I've now got initial version working and all tests pass.

Some follow up questions for @samuelcolvin

I agree with Zac-HD's suggestion to rename ConstrainedNumberMeta to ConstrainedScalarMeta - but I have not implemented this yet as it'll make more widespread changes. at the moment it is fairly straightforward to review the changes. let me know if you'd like me to go ahead with that rename?
more docs changes are needed to highlight that date validation can be constrained. I can add these as long as your are happy with basic implementation
should I add similar classes for datetime.datetime, and maybe even datetime.time? might be overkill?

Thanks!

hottwaj · 2022-04-12T08:32:45Z

please review

samuelcolvin

Looking good, some things to change.

samuelcolvin · 2022-08-08T13:06:44Z

docs/usage/types.md

+### Arguments to `condate`
+The following arguments are available when using the `condate` type function
+
+- `strict_formats: List[str] = None`: list of datetime.datetime.strpformat style date formats that will be accepted


Let's remove this, it's not supported in V2 so it'll be confusing if we add it now in V1.

(the bounds constraints are already implemented in V2).

samuelcolvin · 2022-08-08T13:07:33Z

pydantic/types.py

@@ -1087,32 +1090,78 @@ def to(self, unit: str) -> float:
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DATE TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 if TYPE_CHECKING:
-    PastDate = date
-    FutureDate = date
+    PastDate = datetime.date


Best to revert these changes.

samuelcolvin · 2022-08-08T13:09:08Z

tests/test_condate.py

@@ -0,0 +1,75 @@
+from datetime import date, datetime


can you move this into test_datetime_parse.py, We could do with rearranging tests, putting some tests in this file will cause more confusion.

samuelcolvin · 2022-08-08T13:09:53Z

pydantic/types.py

+        update_not_none(field_schema, exclusiveMinimum=cls.gt, exclusiveMaximum=cls.lt, minimum=cls.ge, maximum=cls.le)
+
+    @classmethod
+    def strict_date_validator(cls, value: Any) -> datetime.date:


as per my above comment, remove this.

samuelcolvin · 2022-08-08T13:10:16Z

please update.

samuelcolvin · 2022-08-08T13:10:43Z

you'll also need to rebase or merge master to get all a green tick.

hottwaj · 2022-08-11T12:01:31Z

Hopefully that covers everything you mentioned :)

Sorry if some of this overlaps with changes already envisioned for V2

And thanks for the great work!

samuelcolvin

Looking good but a few more things to fix.

changes/3740-hottwaj.md

pydantic/types.py

docs/usage/types.md

pydantic/_hypothesis_plugin.py

… schema_json, add hypothesis test, etc

tests/test_schema.py

hottwaj · 2022-08-11T19:07:59Z

Hopefully nearly there now :)

samuelcolvin · 2022-08-12T14:29:54Z

this is great, thank you so much.

Initial implmenetation of ConstrainedDate, condate, with tests and docs

a983c54

hottwaj added 2 commits January 27, 2022 14:38

Attempt at fixing hypothesis tests for ConstrainedDate. Suspect still…

55d1dd7

… not working

removed forgotten breakpoint() :(

ae439d8

Zac-HD reviewed Apr 2, 2022

View reviewed changes

pydantic/_hypothesis_plugin.py Outdated Show resolved Hide resolved

suggested changes to pydantic/_hypothesis_plugin.py for condate etc

abef332

Co-authored-by: Zac Hatfield-Dodds <zac.hatfield.dodds@gmail.com>

- fixed import for hypothesis tests

809ca98

hottwaj force-pushed the add-condate branch from 0a4f1ea to 809ca98 Compare April 11, 2022 13:15

hottwaj added 2 commits April 11, 2022 15:09

- linting fixes only

929136d

- more fixes for linting

423f54c

github-actions bot added the ready for review label Apr 12, 2022

github-actions bot assigned PrettyWood and samuelcolvin Apr 12, 2022

samuelcolvin reviewed Aug 8, 2022

View reviewed changes

github-actions bot added awaiting author revision and removed ready for review labels Aug 8, 2022

github-actions bot assigned hottwaj and unassigned samuelcolvin and PrettyWood Aug 8, 2022

hottwaj added 4 commits August 11, 2022 11:58

changes following review by samuelcolvin 2022-08-08. Will rebase next

fffa87d

- added changes to changes file

b5fcca0

Merge branch 'master' into add-condate

c94ccc5

fixed changes file filename to PR pydantic#3740

80ff40f

samuelcolvin reviewed Aug 11, 2022

View reviewed changes

changes/3740-hottwaj.md Outdated Show resolved Hide resolved

pydantic/types.py Outdated Show resolved Hide resolved

pydantic/types.py Show resolved Hide resolved

docs/usage/types.md Outdated Show resolved Hide resolved

pydantic/_hypothesis_plugin.py Show resolved Hide resolved

hottwaj added 2 commits August 11, 2022 13:47

additional changes requested by samuelcolvin 2022-08-11: add test for…

12cdf9d

… schema_json, add hypothesis test, etc

make test_json_schema compare to a dictionary rather than json string

3c3bdd3

samuelcolvin reviewed Aug 11, 2022

View reviewed changes

tests/test_schema.py Outdated Show resolved Hide resolved

added test_date_constrained_types to test_schema

7e5e2b7

rewrite tests

8862871

samuelcolvin changed the title ~~Initial implementation of ConstrainedDate, condate. Implements #3739~~ Initial implementation of ConstrainedDate, condate Aug 12, 2022

samuelcolvin enabled auto-merge (squash) August 12, 2022 14:29

samuelcolvin merged commit cdd091c into pydantic:master Aug 12, 2022

the-matt-morris mentioned this pull request Aug 13, 2022

Constrained date types #4330

Closed

14 tasks

samuelcolvin mentioned this pull request Feb 2, 2023

Metaclass conflict while importing pydantic under freezegun.freeze_time #4983

Closed

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial implementation of ConstrainedDate, condate #3740

Initial implementation of ConstrainedDate, condate #3740

hottwaj commented Jan 27, 2022 •

edited by samuelcolvin

hottwaj commented Jan 27, 2022

samuelcolvin commented Apr 2, 2022

Zac-HD left a comment

Zac-HD commented Apr 4, 2022

hottwaj commented Apr 11, 2022

hottwaj commented Apr 12, 2022

samuelcolvin left a comment

samuelcolvin Aug 8, 2022

samuelcolvin Aug 8, 2022

samuelcolvin Aug 8, 2022

samuelcolvin Aug 8, 2022

samuelcolvin commented Aug 8, 2022

samuelcolvin commented Aug 8, 2022

hottwaj commented Aug 11, 2022

samuelcolvin left a comment

hottwaj commented Aug 11, 2022

samuelcolvin commented Aug 12, 2022

Initial implementation of ConstrainedDate, condate #3740

Initial implementation of ConstrainedDate, condate #3740

Conversation

hottwaj commented Jan 27, 2022 • edited by samuelcolvin

Change Summary

Related issue number

Checklist

hottwaj commented Jan 27, 2022

samuelcolvin commented Apr 2, 2022

Zac-HD left a comment

Choose a reason for hiding this comment

Zac-HD commented Apr 4, 2022

hottwaj commented Apr 11, 2022

hottwaj commented Apr 12, 2022

samuelcolvin left a comment

Choose a reason for hiding this comment

samuelcolvin Aug 8, 2022

Choose a reason for hiding this comment

samuelcolvin Aug 8, 2022

Choose a reason for hiding this comment

samuelcolvin Aug 8, 2022

Choose a reason for hiding this comment

samuelcolvin Aug 8, 2022

Choose a reason for hiding this comment

samuelcolvin commented Aug 8, 2022

samuelcolvin commented Aug 8, 2022

hottwaj commented Aug 11, 2022

samuelcolvin left a comment

Choose a reason for hiding this comment

hottwaj commented Aug 11, 2022

samuelcolvin commented Aug 12, 2022

hottwaj commented Jan 27, 2022 •

edited by samuelcolvin