https://github.com/python/cpython/commit/d2d886215cf694d5f3e7f0cbd76507a96bac322b
commit: d2d886215cf694d5f3e7f0cbd76507a96bac322b
branch: main
author: David Lowry-Duda <da...@lowryduda.com>
committer: pganssle <1377457+pgans...@users.noreply.github.com>
date: 2025-03-24T11:33:16-04:00
summary:
gh-115684: Clarify datetime `replace` documentation (#116519)
* Clarify datetime `replace` documentation
In #115684, HopedForLuck noted that `datetime.date.replace()`
documentation was confusing because it looked like it would be changing
immutable objects.
This documentation change specifies that the `replace()` methods in
`datetime` return new objects. This uses similar wording to the
documentation for `datetime.combine()`, which specifies that a new
datetime is returned. This is also similar to wording for
`string.replace()`, except `string.replace()` emphasizes that a "copy"
is returned.
Resolves #115684.
* Include reviewer comments
Thanks Privat33r-dev for the comments!
---------
Co-authored-by: Paul Ganssle <1377457+pgans...@users.noreply.github.com>
files:
M Doc/library/datetime.rst
diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst
index 1af7d6be750102..1ce2013f05da2e 100644
--- a/Doc/library/datetime.rst
+++ b/Doc/library/datetime.rst
@@ -699,8 +699,8 @@ Instance methods:
.. method:: date.replace(year=self.year, month=self.month, day=self.day)
- Return a date with the same value, except for those parameters given new
- values by whichever keyword arguments are specified.
+ Return a new :class:`date` object with the same values, but with specified
+ parameters updated.
Example::
@@ -709,8 +709,8 @@ Instance methods:
>>> d.replace(day=26)
datetime.date(2002, 12, 26)
- :class:`date` objects are also supported by generic function
- :func:`copy.replace`.
+ The generic function :func:`copy.replace` also supports :class:`date`
+ objects.
.. method:: date.timetuple()
@@ -1348,10 +1348,10 @@ Instance methods:
hour=self.hour, minute=self.minute, second=self.second,
microsecond=self.microsecond, \
tzinfo=self.tzinfo, *, fold=0)
- Return a datetime with the same attributes, except for those attributes
given
- new values by whichever keyword arguments are specified. Note that
- ``tzinfo=None`` can be specified to create a naive datetime from an aware
- datetime with no conversion of date and time data.
+ Return a new :class:`datetime` object with the same attributes, but with
+ specified parameters updated. Note that ``tzinfo=None`` can be specified to
+ create a naive datetime from an aware datetime with no conversion of date
+ and time data.
:class:`.datetime` objects are also supported by generic function
:func:`copy.replace`.
@@ -1942,10 +1942,10 @@ Instance methods:
.. method:: time.replace(hour=self.hour, minute=self.minute,
second=self.second, \
microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)
- Return a :class:`.time` with the same value, except for those attributes
given
- new values by whichever keyword arguments are specified. Note that
- ``tzinfo=None`` can be specified to create a naive :class:`.time` from an
- aware :class:`.time`, without conversion of the time data.
+ Return a new :class:`.time` with the same values, but with specified
+ parameters updated. Note that ``tzinfo=None`` can be specified to create a
+ naive :class:`.time` from an aware :class:`.time`, without conversion of the
+ time data.
:class:`.time` objects are also supported by generic function
:func:`copy.replace`.
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
