summaryrefslogtreecommitdiff
path: root/src/mailman/utilities/datetime.py
diff options
context:
space:
mode:
authorBarry Warsaw2009-02-17 21:40:55 -0500
committerBarry Warsaw2009-02-17 21:40:55 -0500
commit1f4c4e107f24cbb36110e8cb88908b34bac74b01 (patch)
tree9879c2cc638b3c9517019af7b83388429274cf47 /src/mailman/utilities/datetime.py
parent9c28502b5d8b1fc2388354c19e81a18a0e3c0088 (diff)
downloadmailman-1f4c4e107f24cbb36110e8cb88908b34bac74b01.tar.gz
mailman-1f4c4e107f24cbb36110e8cb88908b34bac74b01.tar.zst
mailman-1f4c4e107f24cbb36110e8cb88908b34bac74b01.zip
Diffstat (limited to 'src/mailman/utilities/datetime.py')
-rw-r--r--src/mailman/utilities/datetime.py69
1 files changed, 69 insertions, 0 deletions
diff --git a/src/mailman/utilities/datetime.py b/src/mailman/utilities/datetime.py
new file mode 100644
index 000000000..764b2eecd
--- /dev/null
+++ b/src/mailman/utilities/datetime.py
@@ -0,0 +1,69 @@
+# Copyright (C) 2009 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
+
+"""Datetime utilities.
+
+Use these functions to produce variable times rather than the built-in
+datetime.datetime.now() and datetime.date.today(). These are better
+instrumented for testing purposes.
+"""
+
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+ ]
+
+
+import datetime
+
+
+
+class DateFactory:
+ """A factory for today() and now() that works with testing."""
+
+ # Set to True to produce predictable dates and times.
+ testing_mode = False
+ # The predictable time.
+ predictable_now = None
+ predictable_today = None
+
+ def now(self, tz=None):
+ return (self.predictable_now
+ if self.testing_mode
+ else datetime.datetime.now(tz))
+
+ def today(self):
+ return (self.predictable_today
+ if self.testing_mode
+ else datetime.date.today())
+
+ @classmethod
+ def reset(cls):
+ cls.predictable_now = datetime.datetime(2005, 8, 1, 7, 49, 23)
+ cls.predictable_today = cls.predictable_now.today()
+
+ @classmethod
+ def fast_forward(cls, days=1):
+ cls.predictable_today += datetime.timedelta(days=days)
+
+
+factory = DateFactory()
+factory.reset()
+today = factory.today
+now = factory.now