Merge "Deprecate strtime"

openstack · Jun 2, 2015 · f5aa17f · f5aa17f
2 parents e5349b9 + 4e01f29
commit f5aa17f
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/oslo_utils/timeutils.py b/oslo_utils/timeutils.py
@@ -80,8 +80,24 @@ def parse_isotime(timestr):
         raise ValueError(six.text_type(e))
 
 
+@removals.remove(
+    message="use either datetime.datetime.isoformat() "
+    "or datetime.datetime.strftime() instead",
+    version="1.6",
+    removal_version="?",
+    )
 def strtime(at=None, fmt=PERFECT_TIME_FORMAT):
-    """Returns formatted utcnow."""
+    """Returns formatted utcnow.
+
+    .. deprecated:: > 1.5.0
+       Use :func:`utcnow()`, :func:`datetime.datetime.isoformat`
+       or :func:`datetime.strftime` instead.
+
+       strtime() => utcnow().isoformat()
+       strtime(fmt=...) => utcnow().strftime(fmt)
+       strtime(at) => at.isoformat()
+       strtime(at, fmt) => at.strftime(fmt)
+    """
     if not at:
         at = utcnow()
     return at.strftime(fmt)