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-99032: datetime docs: Encoding is no longer relevant #93365

Merged
merged 3 commits into from
Apr 24, 2023

Conversation

wjandrea
Copy link
Contributor

@wjandrea wjandrea commented May 30, 2022

The .strftime() methods return a Unicode string as of Python 3.0.


For reference, under the hood, the .strftime() methods use time.strftime(), whose return value is defined here for the current tip of the main branch and here for 3.0.


Please check my work before merging to make sure I've understood what the docs are saying. I'm also not super familiar with C or RST, but I'm quite sure I've understood them correctly.

Backports should be made to all current versions.


BTW, encoding isn't mentioned in the time docs, so no changes required there I don't think.

The `.strftime()` methods return a Unicode string as of Python 3.0.
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 30, 2022
@merwok
Copy link
Member

merwok commented Sep 29, 2022

Could you create a ticket to describe the issue and make it easier to track the fixes? Thanks

Copy link
Contributor

@nanjekyejoannah nanjekyejoannah left a comment

Choose a reason for hiding this comment

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

I agree, maybe we need an issue to track this.

@wjandrea
Copy link
Contributor Author

wjandrea commented Oct 14, 2022

@merwok @nanjekyejoannah I could open an issue, sure, I'm just not sure what to say beyond what I've written here. Maybe,

The docs say that strftime() will return an encoded string (i.e. bytes), but actually it returns a Unicode string as of Python 3.0 (i.e. str).

Actually, now that I think about it again, maybe it'd be better to change the warning from "may contain Unicode characters encoded ..." to "may contain non-ASCII characters." Say the word and I'll open an issue so we can discuss that.

@merwok
Copy link
Member

merwok commented Oct 14, 2022

That’s just the process we follow to keep things manageable 🙂
A bug report doesn’t have to be very long, if the title is clear and the description tells clearly what the problem is, then we can apply labels to categorize the problem, note all versions that need a fix, people get notified about it, etc.
The issue describes the problem and the PR discussion can focus on the solution. That’s all!

Full details here: https://devguide.python.org/triage/issue-tracker/

@Jason-Y-Z
Copy link
Contributor

Thanks for the PR. I think you will need to include the issue number in your PR title :)

@AlexWaygood AlexWaygood changed the title docs: datetime: Encoding is no longer relevant gh-99033: datetime docs: Encoding is no longer relevant Nov 3, 2022
@AlexWaygood AlexWaygood changed the title gh-99033: datetime docs: Encoding is no longer relevant gh-99032: datetime docs: Encoding is no longer relevant Nov 3, 2022
@hugovk hugovk removed the needs backport to 3.10 only security fixes label Apr 7, 2023
Doc/library/datetime.rst Outdated Show resolved Hide resolved
@bedevere-bot
Copy link

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

@abalkin abalkin left a comment

Choose a reason for hiding this comment

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

LGTM

@pganssle pganssle merged commit 2aa22f7 into python:main Apr 24, 2023
@miss-islington
Copy link
Contributor

Thanks @wjandrea for the PR, and @pganssle for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 24, 2023
…GH-93365)

This removes a section of the `strftime` and `strptime` documentation that refers to a bygone era when `strftime` would return an encoded byte string.

---------

(cherry picked from commit 2aa22f7)

Co-authored-by: William Andrea <[email protected]>
Co-authored-by: Paul Ganssle <[email protected]>
@bedevere-bot
Copy link

GH-103788 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Apr 24, 2023
@wjandrea wjandrea deleted the patch-2 branch April 24, 2023 19:00
carljm added a commit to carljm/cpython that referenced this pull request Apr 24, 2023
* main: (53 commits)
  pythongh-102498 Clean up unused variables and imports in the email module  (python#102482)
  pythongh-99184: Bypass instance attribute access in `repr` of `weakref.ref` (python#99244)
  pythongh-99032: datetime docs: Encoding is no longer relevant (python#93365)
  pythongh-94300: Update datetime.strptime documentation (python#95318)
  pythongh-103776: Remove explicit uses of $(SHELL) from Makefile (pythonGH-103778)
  pythongh-87092: fix a few cases of incorrect error handling in compiler (python#103456)
  pythonGH-103727: Avoid advancing tokenizer too far in f-string mode (pythonGH-103775)
  Revert "Add tests for empty range equality (python#103751)" (python#103770)
  pythongh-94518: Port 23-argument `_posixsubprocess.fork_exec` to Argument Clinic (python#94519)
  pythonGH-65022: Fix description of copyreg.pickle function (python#102656)
  pythongh-103323: Get the "Current" Thread State from a Thread-Local Variable (pythongh-103324)
  pythongh-91687: modernize dataclass example typing (python#103773)
  pythongh-103746: Test `types.UnionType` and `Literal` types together (python#103747)
  pythongh-103765: Fix 'Warning: py:class reference target not found: ModuleSpec' (pythonGH-103769)
  pythongh-87452: Improve the Popen.returncode docs
  Removed unnecessary escaping of asterisks (python#103714)
  pythonGH-102973: Slim down Fedora packages in the dev container (python#103283)
  pythongh-103091: Add PyUnstable_Type_AssignVersionTag (python#103095)
  Add tests for empty range equality (python#103751)
  pythongh-103712: Increase the length of the type name in AttributeError messages (python#103713)
  ...
carljm added a commit to carljm/cpython that referenced this pull request Apr 24, 2023
* superopt: (82 commits)
  pythongh-101517: fix line number propagation in code generated for except* (python#103550)
  pythongh-103780: Use patch instead of mock in asyncio unix events test (python#103782)
  pythongh-102498 Clean up unused variables and imports in the email module  (python#102482)
  pythongh-99184: Bypass instance attribute access in `repr` of `weakref.ref` (python#99244)
  pythongh-99032: datetime docs: Encoding is no longer relevant (python#93365)
  pythongh-94300: Update datetime.strptime documentation (python#95318)
  pythongh-103776: Remove explicit uses of $(SHELL) from Makefile (pythonGH-103778)
  pythongh-87092: fix a few cases of incorrect error handling in compiler (python#103456)
  pythonGH-103727: Avoid advancing tokenizer too far in f-string mode (pythonGH-103775)
  Revert "Add tests for empty range equality (python#103751)" (python#103770)
  pythongh-94518: Port 23-argument `_posixsubprocess.fork_exec` to Argument Clinic (python#94519)
  pythonGH-65022: Fix description of copyreg.pickle function (python#102656)
  pythongh-103323: Get the "Current" Thread State from a Thread-Local Variable (pythongh-103324)
  pythongh-91687: modernize dataclass example typing (python#103773)
  pythongh-103746: Test `types.UnionType` and `Literal` types together (python#103747)
  pythongh-103765: Fix 'Warning: py:class reference target not found: ModuleSpec' (pythonGH-103769)
  pythongh-87452: Improve the Popen.returncode docs
  Removed unnecessary escaping of asterisks (python#103714)
  pythonGH-102973: Slim down Fedora packages in the dev container (python#103283)
  pythongh-103091: Add PyUnstable_Type_AssignVersionTag (python#103095)
  ...
JelleZijlstra pushed a commit that referenced this pull request Apr 29, 2023
) (#103788)

This removes a section of the `strftime` and `strptime` documentation that refers to a bygone era when `strftime` would return an encoded byte string.

---------

(cherry picked from commit 2aa22f7)

Co-authored-by: William Andrea <[email protected]>
Co-authored-by: Paul Ganssle <[email protected]>
Co-authored-by: Łukasz Langa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.