feat: add PastDate and FutureDate types #2425

Kludex · 2021-02-28T18:59:49Z

Change Summary

Add PastDate and FutureDate types.

Related issue number

closes #769

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)

codecov · 2021-02-28T19:01:51Z

Codecov Report

Merging #2425 (016b585) into master (7b7e705) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 016b585 differs from pull request most recent head 1a79b61. Consider uploading reports for the commit 1a79b61 to get more accurate results

@@            Coverage Diff            @@
##            master     #2425   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           25        25           
  Lines         5109      5141   +32     
  Branches      1050      1052    +2     
=========================================
+ Hits          5109      5141   +32

Impacted Files	Coverage Δ
pydantic/__init__.py	`100.00% <ø> (ø)`
pydantic/errors.py	`100.00% <100.00%> (ø)`
pydantic/types.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aca18a9...1a79b61. Read the comment docs.

Kludex · 2021-02-28T20:27:36Z

@samuelcolvin Do I need to add it to the schema_mapping.py? Just to confirm.

EDIT: nvm.

pydantic/types.py

Kludex · 2021-03-04T03:02:57Z

@PrettyWood Do you have more comments?

Thank you for the previous one btw :)

PrettyWood

Otherwise looks good :)

tests/test_types.py

pydantic/types.py

PrettyWood · 2021-03-15T18:23:56Z

pydantic/types.py

+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DATE TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+class PastDate(date):


I reckon you should add

if TYPE_CHECKING: PastDate = date FutureDate = date

and add two lines in tests/mypy/modules/success.py in PydanticTypes class

What's the purpose of the PydanticTypes?

Addressed, btw :)

Just a dumb model with most custom pydantic types to ensure mypy is happy 😊

Kludex · 2021-03-15T19:20:46Z

FastAPI test failing due to:

E   ImportError: cannot import name 'RowProxy' from 'sqlalchemy.engine.result' (/opt/hostedtoolcache/Python/3.7.10/x64/lib/python3.7/site-packages/sqlalchemy/engine/result.py)

🤔

PrettyWood

LGTM ! Thanks for making the changes.

Note: the CI error with fastapi has nothing to do with your PR don't worry ;)

PrettyWood · 2021-04-05T13:56:33Z

@Kludex you can rebase on master to have the new CI running :)

Kludex · 2021-04-05T19:20:34Z

@Kludex you can rebase on master to have the new CI running :)

Done :) Thank you!

PrettyWood

Perfect thanks

samuelcolvin · 2021-05-09T09:01:04Z

pydantic/errors.py

    'DecimalWholeDigitsError',
    'DateTimeError',
    'DateError',
+    '_DateValueError',


Suggested change

'_DateValueError',

samuelcolvin · 2021-05-09T09:08:20Z

pydantic/errors.py

+
+class DateNotInThePastError(_DateValueError):
+    code = 'date.not_in_the_past'
+    msg_template = 'date "{date}" is not in the past'


As per #1421, we generally don't include the invalid value in error contexts. In v2 we will always include it.

For now in this case, to keep things simple and consistent with other errors, I think we should remove this and replace it with just date is not in the past.

Do I still pass the value to the error?

class _DateValueError(PydanticValueError): def __init__(self, *, date: date) -> None: super().__init__(date=str(date))

samuelcolvin · 2021-05-09T09:09:34Z

tests/test_types.py

+        (datetime.today() + timedelta(1), str(date.today() + timedelta(1))),
+    ),
+)
+def test_past_date_validation_fails(value, expected):


the second argument will not be required after the change requested above, but note for future reference: the second argument is not "expected" rather date_str or similar.

Based on this comment, I'll assume the answer for my previous question is "no".

Also, thanks! :)

samuelcolvin · 2021-05-09T09:12:06Z

tests/test_types.py

+        (date.today(), str(date.today())),
+        (date.today() - timedelta(1), str(date.today() - timedelta(1))),
+        (datetime.today(), str(date.today())),
+        (datetime.today() - timedelta(1), str(date.today() - timedelta(1))),


Please include one explicit case '2064-06-01' or something so we have a hardcoded case.

If pydantic is still alive in 2064, and anyone is still alive to use it, they can fix the test then. 😨

samuelcolvin · 2021-05-09T09:12:46Z

please update.

Kludex · 2021-05-24T10:29:41Z

@samuelcolvin Changes applied.

PrettyWood · 2021-05-24T11:49:56Z

pydantic/errors.py

+class _DateValueError(PydanticValueError):
+    def __init__(self) -> None:
+        super().__init__()


You probably don't need this anymore and can make DateNotInThePastError and DateNotInTheFutureError inherit from PydanticValueError

Kludex · 2021-06-01T20:07:39Z

Thanks @PrettyWood 😗

PrettyWood · 2021-06-04T17:47:55Z

@Kludex Can you just rebase/merge with master for the CI to run again properly? I reckon this PR can be merged now :)

tests/test_types.py

PrettyWood · 2021-06-04T21:30:36Z

Thanks!

feat: add PastDate and FutureDate types

1a13475

Kludex marked this pull request as draft February 28, 2021 18:59

Kludex added 2 commits February 28, 2021 20:03

add changes file

5ac92f8

add tests

7ca9773

Kludex marked this pull request as ready for review February 28, 2021 20:28

PrettyWood reviewed Mar 3, 2021

View reviewed changes

pydantic/types.py Outdated Show resolved Hide resolved

Kludex added 2 commits March 4, 2021 03:53

fix: json schema

a591308

fix: black format

820431e

PrettyWood reviewed Mar 4, 2021

View reviewed changes

tests/test_types.py Outdated Show resolved Hide resolved

less code duplicated

be2cf4c

StephenBrown2 reviewed Mar 8, 2021

View reviewed changes

pydantic/types.py Outdated Show resolved Hide resolved

PrettyWood requested changes Mar 15, 2021

View reviewed changes

PrettyWood added the awaiting author revision awaiting changes from the PR author label Mar 15, 2021

Kludex added 3 commits March 15, 2021 20:04

add dates on success.py

c224f7a

merge master

a7b1799

fix past and future dates

016b585

PrettyWood approved these changes Mar 15, 2021

View reviewed changes

PrettyWood added ready for review and removed awaiting author revision awaiting changes from the PR author labels Mar 15, 2021

PrettyWood added awaiting author revision awaiting changes from the PR author and removed ready for review labels Apr 5, 2021

Merge remote-tracking branch 'origin/master' into feat/date-past-future

087bc01

PrettyWood approved these changes Apr 5, 2021

View reviewed changes

PrettyWood removed the awaiting author revision awaiting changes from the PR author label Apr 5, 2021

PrettyWood added the ready for review label Apr 5, 2021

samuelcolvin reviewed May 9, 2021

View reviewed changes

github-actions bot added awaiting author revision awaiting changes from the PR author and removed ready for review labels May 9, 2021

github-actions bot assigned Kludex May 9, 2021

samuelcolvin mentioned this pull request May 9, 2021

Validation: preserve invalid data #1421

Closed

Kludex added 3 commits May 24, 2021 03:06

Merge branch 'samuelcolvin:master' into feat/date-past-future

9f44de1

♻️ Apply Samuel's comments

82e18a1

🚨 Satisfy flake8

c8310d9

PrettyWood reviewed May 24, 2021

View reviewed changes

🔥 Remove _DateValueError

98ac3ba

PrettyWood added ready for review and removed awaiting author revision awaiting changes from the PR author labels Jun 1, 2021

PrettyWood approved these changes Jun 1, 2021

View reviewed changes

Merge remote-tracking branch 'origin/master' into feat/date-past-future

997ed34

PrettyWood reviewed Jun 4, 2021

View reviewed changes

tests/test_types.py Show resolved Hide resolved

test: add last explicit case

1a79b61

PrettyWood merged commit a4cb4ee into pydantic:master Jun 4, 2021

PrettyWood mentioned this pull request Jun 4, 2021

Add value to ctx in EnumMemberError. #2852

Closed

5 tasks

		# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DATE TYPES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


		class PastDate(date):

Uh oh!

feat: add PastDate and FutureDate types #2425

feat: add PastDate and FutureDate types #2425

Uh oh!

Conversation

Kludex commented Feb 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Summary

Related issue number

Checklist

Uh oh!

codecov bot commented Feb 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Kludex commented Feb 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Kludex commented Mar 4, 2021

Uh oh!

PrettyWood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kludex commented Mar 15, 2021

Uh oh!

PrettyWood left a comment

Choose a reason for hiding this comment

Uh oh!

PrettyWood commented Apr 5, 2021

Uh oh!

Kludex commented Apr 5, 2021

Uh oh!

PrettyWood left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samuelcolvin commented May 9, 2021

Uh oh!

Kludex commented May 24, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kludex commented Jun 1, 2021

Uh oh!

PrettyWood commented Jun 4, 2021

Uh oh!

Uh oh!

PrettyWood commented Jun 4, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Kludex commented Feb 28, 2021 •

edited

Loading

codecov bot commented Feb 28, 2021 •

edited

Loading

Kludex commented Feb 28, 2021 •

edited

Loading