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

gh-41431: Add datetime.time.strptime() and datetime.date.strptime() #120752

Merged
merged 19 commits into from
Sep 25, 2024

Conversation

nineteendo
Copy link
Contributor

@nineteendo nineteendo commented Jun 19, 2024

@nineteendo nineteendo changed the title gh-41431: Add datetime.time.strptime and datetime.date.strptime gh-41431: Add datetime.time.strptime() and datetime.date.strptime() Jun 19, 2024
Lib/_strptime.py Outdated Show resolved Hide resolved
@nineteendo nineteendo marked this pull request as ready for review June 19, 2024 20:36
@nineteendo

This comment was marked as resolved.

time tuple. See also :ref:`strftime-strptime-behavior` and
:meth:`date.fromisoformat`.

.. note
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it fine to have this note twice in the documentation?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think documentation experts will know better than me, but I think there's a way to define a substitution for this, like this:

|format-note|

.. |format-note| replace::
    If *format* specifies a day of month without a year a :exc:`DeprecationWarning` is emitted. This is to avoid a quadrenial leap year bug in code seeking to parse only a month and day, as the default year used when unspecified in the format is not a leap year. Such *format* values may raise an error in Python 3.15. The workaround is to always include a year in your *format*. If parsing *date_string* values that do not have a year, explicitly add a year that is a leap year before parsing:
    .. doctest::
        
        >> from datetime import date
        >> date_string = "02/29"
        >> when = date.strptime(f"{date_string};1984", "%m/%d;%Y")  # Avoids leap year bug.
        >> when.strftime("%B %d") # doctest: +SKIP
        'February 29'

.. versionadded:: 3.14

Then you put |format-note| in the other place as well.

Two other options:

  1. move this to a small fragment file (seems like overkill), and use an ..include directive with it.
  2. put the note in one place, then link to it in the other place (e.g. "See the note on :func:datetime.strptime").

I don't think there's a simple way to do it with a parameter, though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just wondering if it was a problem it was mentioned twice. Do I link to datetime.strptime or is this fine?

@vstinner
Copy link
Member

@vstinner, would you like to review this? (You requested changes on the old pull request)

I skip my turn :-)

Copy link
Contributor

@picnixz picnixz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I had a pending review that I forgot to send. Here are some comments!

Modules/_datetimemodule.c Outdated Show resolved Hide resolved
Doc/library/datetime.rst Show resolved Hide resolved
Doc/library/datetime.rst Outdated Show resolved Hide resolved
Doc/library/datetime.rst Outdated Show resolved Hide resolved
Doc/library/datetime.rst Show resolved Hide resolved
Doc/library/datetime.rst Outdated Show resolved Hide resolved
Lib/_pydatetime.py Outdated Show resolved Hide resolved
Lib/_pydatetime.py Outdated Show resolved Hide resolved
Lib/_strptime.py Outdated Show resolved Hide resolved
Modules/_datetimemodule.c Outdated Show resolved Hide resolved
Copy link
Member

@pganssle pganssle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great so far! I have some suggestions here mostly about the tests.

I'm also working on some hypothesis based tests for this, because there are a couple of properties that we can easily and usefully test here, specifically:

  1. dt == dt.strptime(dt.strftime(format), format) == dt
  2. my_datetime.strftime(format_with_just_dates).date() == my_datetime.date().strftime(format_with_just_dates)
  3. my_datetime.strftime(format_with_just_times).time() == my_datetime.time().strftime(format_with_just_times)

I think the key will just be getting a good hypothesis strategy that generates the format strings.

Lib/test/datetimetester.py Outdated Show resolved Hide resolved
Lib/test/datetimetester.py Outdated Show resolved Hide resolved
Lib/_strptime.py Show resolved Hide resolved
Lib/test/datetimetester.py Show resolved Hide resolved
Lib/test/datetimetester.py Show resolved Hide resolved
@bedevere-app
Copy link

bedevere-app bot commented Sep 24, 2024

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Copy link
Member

@pganssle pganssle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, looks good to me! Glad to finally have this done!

@pganssle pganssle merged commit 9968caa into python:main Sep 25, 2024
38 of 39 checks passed
@pganssle
Copy link
Member

Thanks @nineteendo! Really great work on this one. Thanks for your patience waiting for reviews and your quick response when the reviews came!

emilyemorehouse added a commit to lysnikolaou/cpython that referenced this pull request Sep 26, 2024
* main: (69 commits)
  Add "annotate" SET_FUNCTION_ATTRIBUTE bit to dis. (python#124566)
  pythongh-124412: Add helpers for converting annotations to source format (python#124551)
  pythongh-119180: Disallow instantiation of ConstEvaluator objects (python#124561)
  For-else deserves its own section in the tutorial (python#123946)
  Add 3.13 as a version option to the crash issue template (python#124560)
  pythongh-123242: Note that type.__annotations__ may not exist (python#124557)
  pythongh-119180: Make FORWARDREF format look at __annotations__ first (python#124479)
  pythonGH-58058: Add quick reference for `ArgumentParser` to argparse docs (pythongh-124227)
  pythongh-41431: Add `datetime.time.strptime()` and `datetime.date.strptime()` (python#120752)
  pythongh-102450: Add ISO-8601 alternative for midnight to `fromisoformat()` calls. (python#105856)
  pythongh-124370: Add "howto" for free-threaded Python (python#124371)
  pythongh-121277: Allow `.. versionadded:: next` in docs (pythonGH-121278)
  pythongh-119400:  make_ssl_certs: update reference test data automatically, pass in expiration dates as parameters python#119400  (pythonGH-119401)
  pythongh-119180: Avoid going through AST and eval() when possible in annotationlib (python#124337)
  pythongh-124448: Update Windows builds to use Tcl/Tk 8.6.15 (pythonGH-124449)
  pythongh-123884 Tee of tee was not producing n independent iterators (pythongh-124490)
  pythongh-124378: Update test_ttk for Tcl/Tk 8.6.15 (pythonGH-124542)
  pythongh-124513: Check args in framelocalsproxy_new() (python#124515)
  pythongh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (python#124480)
  Doc: Use ``major.minor`` for documentation distribution archive filenames (python#124489)
  ...
@nineteendo nineteendo deleted the add-datetime.strptime branch September 26, 2024 06:11
@nineteendo
Copy link
Contributor Author

Can you close the issue?

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

Successfully merging this pull request may close these issues.

4 participants