]> granicus.if.org Git - python/commitdiff
#9430: document timedelta str() and repr().
authorGeorg Brandl <georg@python.org>
Sat, 31 Jul 2010 11:40:07 +0000 (11:40 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 31 Jul 2010 11:40:07 +0000 (11:40 +0000)
Doc/library/datetime.rst

index f626e357c433198d8f99e941479f9b7c17cabcbd..22c82e812797068bb83b9e36a8ffb5cf7fa12cbc 100644 (file)
@@ -265,6 +265,14 @@ Supported operations:
 | ``abs(t)``                     | equivalent to +\ *t* when ``t.days >= 0``, and|
 |                                | to -*t* when ``t.days < 0``. (2)              |
 +--------------------------------+-----------------------------------------------+
+| ``str(t)``                     | Returns a string in the form                  |
+|                                | ``[D day[s], ][H]H:MM:SS[.UUUUUU]``, where D  |
+|                                | is negative for negative ``t``. (5)           |
++--------------------------------+-----------------------------------------------+
+| ``repr(t)``                    | Returns a string in the form                  |
+|                                | ``datetime.timedelta(D[, S[, U]])``, where D  |
+|                                | is negative for negative ``t``. (5)           |
++--------------------------------+-----------------------------------------------+
 
 Notes:
 
@@ -280,6 +288,16 @@ Notes:
 (4)
    -*timedelta.max* is not representable as a :class:`timedelta` object.
 
+(5)
+  String representations of :class:`timedelta` objects are normalized
+  similarly to their internal representation.  This leads to somewhat
+  unusual results for negative timedeltas.  For example:
+
+  >>> timedelta(hours=-5)
+  datetime.timedelta(-1, 68400)
+  >>> print(_)
+  -1 day, 19:00:00
+
 In addition to the operations listed above :class:`timedelta` objects support
 certain additions and subtractions with :class:`date` and :class:`datetime`
 objects (see below).