Issue #5788: `datetime.timedelta` objects get a new `total_seconds()` method returning

the total number of seconds in the duration.  Patch by Brian Quinlan.

diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst
index 021f88b05a372835e159ea7df94bef3464228f89..bcc95309037661f009420bdfa39f9c469be6609e 100644 (file)
--- a/Doc/library/datetime.rst
+++ b/Doc/library/datetime.rst
@@ -269,12 +269,22 @@ comparison is ``==`` or ``!=``.  The latter cases return :const:`False` or
 efficient pickling, and in Boolean contexts, a :class:`timedelta` object is
 considered to be true if and only if it isn't equal to ``timedelta(0)``.
 
+Instance methods:
+
+.. method:: timedelta.total_seconds()
+
+   Return the total number of seconds contained in the duration. Equivalent to
+   ``td.microseconds / 1000000 + td.seconds + td.days * 24 * 3600``.
+
+
 Example usage:
 
     >>> from datetime import timedelta
     >>> year = timedelta(days=365)
     >>> another_year = timedelta(weeks=40, days=84, hours=23,
     ...                          minutes=50, seconds=600)  # adds up to 365 days
+    >>> year.total_seconds()
+    31536000.0
     >>> year == another_year
     True
     >>> ten_years = 10 * year

diff --git a/Lib/test/test_datetime.py b/Lib/test/test_datetime.py
index ad36398598c1526f4cb755d60ab0ac1ccac386c3..1fb3d1bf2009fc67206d9bc08a4d261b8dd2f343 100644 (file)
--- a/Lib/test/test_datetime.py
+++ b/Lib/test/test_datetime.py
@@ -266,6 +266,13 @@ class TestTimeDelta(HarmlessMixedComparison, unittest.TestCase):
         self.assertEqual(td.seconds, seconds)
         self.assertEqual(td.microseconds, us)
 
+    def test_total_seconds(self):
+        td = timedelta(days=365)
+        self.assertEqual(td.total_seconds(), 31536000.0)
+        for total_seconds in [123456.789012, -123456.789012, 0.123456, 0, 1e6]:
+            td = timedelta(seconds=total_seconds)
+            self.assertEqual(td.total_seconds(), total_seconds)
+
     def test_carries(self):
         t1 = timedelta(days=100,
                        weeks=-7,

diff --git a/Misc/NEWS b/Misc/NEWS
index b9a16ee1a32f57df3777b39ee06a7395232ebfeb..1c2f1611d7e904456ae0bd61206126d36a60f987 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -483,6 +483,10 @@ Core and Builtins
 Library
 -------
 
+- Issue #5788: `datetime.timedelta` objects get a new `total_seconds()`
+  method returning the total number of seconds in the duration.  Patch by
+  Brian Quinlan.
+
 - Issue #6615: logging: Used weakrefs in internal handler list.
 
 - Issue #1488943: difflib.Differ() doesn't always add hints for tab characters

diff --git a/Modules/datetimemodule.c b/Modules/datetimemodule.c
index fcbd2e9ad2af613bc5946aa805816b8b933ce014..181883661913fd1a47e4525ebf4b6b98d2eaf2ea 100644 (file)
--- a/Modules/datetimemodule.c
+++ b/Modules/datetimemodule.c
@@ -2088,6 +2088,14 @@ delta_getstate(PyDateTime_Delta *self)
                                    GET_TD_MICROSECONDS(self));
 }
 
+static PyObject *
+delta_total_seconds(PyObject *self)
+{
+       return PyFloat_FromDouble(GET_TD_MICROSECONDS(self) / 1000000.0 +
+                                 GET_TD_SECONDS(self) +
+                                 GET_TD_DAYS(self) * 24.0 * 3600.0);
+}
+
 static PyObject *
 delta_reduce(PyDateTime_Delta* self)
 {
@@ -2110,7 +2118,10 @@ static PyMemberDef delta_members[] = {
 };
 
 static PyMethodDef delta_methods[] = {
-       {"__reduce__", (PyCFunction)delta_reduce,     METH_NOARGS,
+       {"total_seconds", (PyCFunction)delta_total_seconds, METH_NOARGS,
+        PyDoc_STR("Total seconds in the duration.")},
+
+       {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
         PyDoc_STR("__reduce__() -> (cls, state)")},
 
        {NULL,  NULL},