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.

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

Jump to bottom

Fix inaccuracies in RFC3339 method docs #186

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Fix inaccuracies in RFC3339 method docs #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
🚀 Changelog
============

0.6.12 (2024-11-08)
-------------------

- Fixed ``format_rfc3339()`` docstrings that incorrectly included a ``T`` separator.
Clarified that ``T`` can be added by using the ``format_common_iso()`` method instead. (#185)

0.6.11 (2024-11-04)
-------------------

Expand Down
7 changes: 5 additions & 2 deletions docs/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,10 +691,13 @@ to this format, respectively:

>>> d = OffsetDateTime(2023, 12, 28, 11, 30, offset=+5)
>>> d.format_rfc3339()
'2023-12-28T11:30:00+05:00'
>>> OffsetDateTime.parse_rfc3339('2021-07-13 09:45:00Z')
'2023-12-28 11:30:00+05:00'
>>> OffsetDateTime.parse_rfc3339('2021-07-13_09:45:00Z')
OffsetDateTime(2021-07-13 09:45:00Z)

The RFC3339 formatter uses a space separator by default.
If you prefer the ``T`` separator, use ``format_common_iso()`` instead.

RFC 2822
~~~~~~~~

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ maintainers = [
{name = "Arie Bovenberg", email = "a.c.bovenberg@gmail.com"},
]
readme = "README.md"
version = "0.6.11"
version = "0.6.12"
description = "Modern datetime library for Python"
requires-python = ">=3.9"
classifiers = [
Expand Down
25 changes: 18 additions & 7 deletions pysrc/whenever/_pywhenever.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
# - It saves some overhead
from __future__ import annotations

__version__ = "0.6.11"
__version__ = "0.6.12"

import enum
import re
Expand Down Expand Up @@ -3090,14 +3090,16 @@ def parse_rfc2822(cls, s: str, /) -> Instant:
return cls._from_py_unchecked(parsed, 0)

def format_rfc3339(self) -> str:
"""Format as an RFC 3339 string
"""Format as an RFC 3339 string ``YYYY-MM-DD HH:MM:SSZ``

If you prefer the ``T`` separator, use `format_common_iso()` instead.

The inverse of the ``parse_rfc3339()`` method.

Example
-------
>>> Instant.from_utc(2020, 8, 15, hour=23, minute=12).format_rfc3339()
"2020-08-15T23:12:00Z"
"2020-08-15 23:12:00Z"
"""
return (
self._py_dt.isoformat(sep=" ")[:-6]
Expand All @@ -3113,7 +3115,7 @@ def parse_rfc3339(cls, s: str, /) -> Instant:

Example
-------
>>> Instant.parse_rfc3339("2020-08-15T23:12:00Z")
>>> Instant.parse_rfc3339("2020-08-15 23:12:00Z")
Instant(2020-08-15 23:12:00Z)
>>>
>>> # also valid:
Expand Down Expand Up @@ -3647,14 +3649,23 @@ def parse_rfc2822(cls, s: str, /) -> OffsetDateTime:
return cls._from_py_unchecked(parsed, 0)

def format_rfc3339(self) -> str:
"""Format as an RFC 3339 string
"""Format as an RFC 3339 string ``YYYY-MM-DD HH:MM:SS±HH:MM``

If you prefer the ``T`` separator, use ``format_common_iso()`` instead.

The inverse of the ``parse_rfc3339()`` method.

Example
-------
>>> OffsetDateTime(2020, 8, 15, hour=23, minute=12, offset=hours(4)).format_rfc3339()
"2020-08-15T23:12:00+04:00"
"2020-08-15 23:12:00+04:00"

Note
----
The RFC3339 format does not allow for second-level precision of the UTC offset.
This should not be a problem in practice, unless you're dealing with
pre-1950s timezones.
The ``format_common_iso()`` does support this precision.
"""
py_isofmt = self._py_dt.isoformat(" ")
return (
Expand All @@ -3671,7 +3682,7 @@ def parse_rfc3339(cls, s: str, /) -> OffsetDateTime:

Example
-------
>>> OffsetDateTime.parse_rfc3339("2020-08-15T23:12:00+02:00")
>>> OffsetDateTime.parse_rfc3339("2020-08-15 23:12:00+02:00")
OffsetDateTime(2020-08-15 23:12:00+02:00)
>>> # also valid:
>>> OffsetDateTime.parse_rfc3339("2020-08-15T23:12:00Z")
Expand Down