Skip to content

bpo-22377: Fixes documentation for %Z in datetime #16507

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.

Sign up for GitHub

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

Merged
miss-islington merged 5 commits into from
Nov 26, 2019
Merged

bpo-22377: Fixes documentation for %Z in datetime #16507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08c3a1a
bpo-22377: Fixes documentation for %Z in datetime
karlcow Oct 1, 2019
19083a2
📜🤖 Added by blurb_it.
blurb-it[bot] Oct 1, 2019
408f1b7
Update Misc/NEWS.d/next/Documentation/2019-10-01-10-53-46.bpo-22377.5…
karlcow Oct 1, 2019
82890ac
bpo-22377: Adds ValueError information for %Z in datetime
karlcow Oct 4, 2019
9bd9242
Minor tweaks to %Z documentation.
pganssle Nov 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions Doc/library/datetime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2362,7 +2362,7 @@ requires, and these work on all platforms with a standard C implementation.
| | string if the object is | +063415, | |
| | naive). | -030712.345216 | |
+-----------+--------------------------------+------------------------+-------+
| ``%Z`` | Time zone name (empty string | (empty), UTC, EST, CST | |
| ``%Z`` | Time zone name (empty string | (empty), UTC, GMT | \(6) |
| | if the object is naive). | | |
+-----------+--------------------------------+------------------------+-------+
| ``%j`` | Day of the year as a | 001, 002, ..., 366 | \(9) |
Expand Down Expand Up @@ -2533,9 +2533,18 @@ Notes:
In addition, providing ``'Z'`` is identical to ``'+00:00'``.

``%Z``
If :meth:`tzname` returns ``None``, ``%Z`` is replaced by an empty
string. Otherwise ``%Z`` is replaced by the returned value, which must
be a string.
In :meth:`strftime`, ``%Z`` is replaced by an empty string if
:meth:`tzname` returns ``None``; otherwise ``%Z`` is replaced by the
returned value, which must be a string.

:meth:`strptime` only accepts certain values for ``%Z``:

1. any value in ``time.tzname`` for your machine's locale
2. the hard-coded values ``UTC`` and ``GMT``

So someone living in Japan may have ``JST``, ``UTC``, and ``GMT`` as
valid values, but probably not ``EST``. It will raise ``ValueError`` for
invalid values.

.. versionchanged:: 3.2
When the ``%z`` directive is provided to the :meth:`strptime` method, an
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2019-10-01-10-53-46.bpo-22377.5ni-iC.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Improves documentation of the values that :meth:`datetime.datetime.strptime` accepts for ``%Z``.
Patch by Karl Dubost.