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

Jump to bottom

datetime, date and time: strftime method takes different keyword argument: fmt (pure) or format (C) #85432

Closed
asottile mannequin opened this issue Jul 9, 2020 · 6 comments
Closed

datetime, date and time: strftime method takes different keyword argument: fmt (pure) or format (C) #85432

asottile mannequin opened this issue Jul 9, 2020 · 6 comments
Labels
3.9 3.10 3.11 extension-modules C modules in the Modules dir stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error

Comments

@asottile
Copy link
Mannequin

asottile mannequin commented Jul 9, 2020 •
edited by bedevere-bot

BPO 41260
Nosy @srittau, @abalkin, @asottile, @pganssle, @ZackerySpytz, @AlexWaygood
PRs
  • bpo-41260: C impl of datetime.date.strftime() takes different keyword arg #21712
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = None
created_at = <Date 2020-07-09.17:01:48.789>
labels = ['type-bug', '3.9', '3.10', '3.11', 'extension-modules', 'library']
title = 'datetime, date and time: strftime method takes different keyword argument: fmt (pure) or format (C)'
updated_at = <Date 2021-11-16.19:27:41.778>
user = 'https://github.com/asottile'

    bugs.python.org fields:

    activity = <Date 2021-11-16.19:27:41.778>
actor = 'AlexWaygood'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Extension Modules', 'Library (Lib)']
creation = <Date 2020-07-09.17:01:48.789>
creator = 'Anthony Sottile'
dependencies = []
files = []
hgrepos = []
issue_num = 41260
keywords = ['patch']
message_count = 6.0
messages = ['373407', '373421', '373424', '406418', '406421', '406424']
nosy_count = 6.0
nosy_names = ['srittau', 'belopolsky', 'Anthony Sottile', 'p-ganssle', 'ZackerySpytz', 'AlexWaygood']
pr_nums = ['21712']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue41260'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    Linked PRs
    @asottile
    Copy link
    Mannequin Author

    asottile mannequin commented Jul 9, 2020

    C:

    cpython/Modules/_datetimemodule.c

    Line 3183 in 8b33961

    static char *keywords[] = {"format", NULL};

    pure python:

    cpython/Lib/datetime.py

    Line 927 in 8b33961

    def strftime(self, fmt):

    this makes it difficult to properly type in mypy:

    https://github.com/python/typeshed/blob/209b6bb127f61fe173a60776e23883ac450cf1c8/stdlib/2and3/datetime.pyi#L55

    and calling with .strftime(fmt=...) or .strftime(format=...) is inconsistent

    (that said, it should _probably_ be a positional-only argument)

    @asottile asottile mannequin added 3.10 extension-modules C modules in the Modules dir stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error labels Jul 9, 2020
    @pganssle
    Copy link
    Member

    pganssle commented Jul 9, 2020

    I think a positional-only argument would be the best option if we could do it, but it would be a backwards-incompatible change and it's probably not worth the hassle.

    If anyone is using the keyword argument, they're probably using format= rather than fmt=, since it's pretty rare for anyone to use the pure python version of datetime. PyPy uses it, but I think they tend to aim for consistency with the C API of CPython, and it seems like they already patch s/fmt/format/ themselves: https://foss.heptapod.net/pypy/pypy/-/blob/branch/default/lib_pypy/datetime.py#L781

    If anyone wants to make a PR I think we can fix this for 3.10, though unfortunately because it is an API change it can't be backported. I think in typeshed they can safely change from fmt to format even today (which would almost certainly be more accurate to end user use cases).

    @asottile
    Copy link
    Mannequin Author

    asottile mannequin commented Jul 9, 2020

    awesome, I'm going to work through this with someone in my discord as a demo / mentorship opportunity -- hope that's ok!

    @pganssle
    Copy link
    Member

    pganssle commented Nov 16, 2021

    Updating this issue to cover the problem in date, time and datetime.

    @pganssle pganssle changed the title datetime: strftime method takes different keyword argument: fmt (pure) or format (C) datetime, date and time: strftime method takes different keyword argument: fmt (pure) or format (C) Nov 16, 2021
    @pganssle pganssle changed the title datetime: strftime method takes different keyword argument: fmt (pure) or format (C) datetime, date and time: strftime method takes different keyword argument: fmt (pure) or format (C) Nov 16, 2021
    @srittau
    Copy link
    Mannequin

    srittau mannequin commented Nov 16, 2021

    Ref python/typeshed#6317 for a discussion about this in typeshed.

    @AlexWaygood
    Copy link
    Member

    AlexWaygood commented Nov 16, 2021

    In addition to date.strftime and time.strftime, there is also a discrepancy in datetime.fromtimestamp. In the C implementation, the first parameter is called "timestamp"; in the pure-Python implementation, the first parameter is called "t".

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    AlexWaygood added a commit to AlexWaygood/cpython that referenced this issue Dec 4, 2022
    @AlexWaygood
    pythongh-85432: harmonise parameter names between C and pure-Python i…
    7b4de3b 
    …mplementations of `datetime.time.strftime`, `datetime.datetime.fromtimestamp`
    AlexWaygood added a commit to AlexWaygood/cpython that referenced this issue Dec 4, 2022
    @AlexWaygood
    pythongh-85432: harmonise parameter names between C and pure-Python i…
    bcb065d 
    …mplementations of `datetime.time.strftime`, `datetime.datetime.fromtimestamp`
    @AlexWaygood AlexWaygood mentioned this issue Dec 4, 2022
    Merged
    hauntsaninja pushed a commit that referenced this issue Dec 22, 2022
    @AlexWaygood
    gh-85432: Harmonise parameter names between C and pure-Python impleme…
    9cdb642 
    …ntations of `datetime.time.strftime`, `datetime.datetime.fromtimestamp` (#99993)
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.9 3.10 3.11 extension-modules C modules in the Modules dir stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error
    Projects
    Date and time issues
    Status: Done
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @iritkatriel @pganssle @AlexWaygood