Rev 2427: Make timestamps use existing format_date; document that function more in http://sourcefrog.net/bzr/gmtime

[Martin Pool]

At http://sourcefrog.net/bzr/gmtime

------------------------------------------------------------
revno: 2427
revision-id: mbp at sourcefrog.net-20070419080319-amc7f3frr64lxolq
parent: mbp at sourcefrog.net-20070419071716-tcuv5i38vhci6fuf
committer: Martin Pool <mbp at sourcefrog.net>
branch nick: gmtime
timestamp: Thu 2007-04-19 18:03:19 +1000
message:
  Make timestamps use existing format_date; document that function more
modified:
  bzrlib/osutils.py              osutils.py-20050309040759-eeaff12fbf77ac86
  bzrlib/timestamp.py            timestamp.py-20070306142322-ttbb9oulf3jotljd-1
=== modified file 'bzrlib/osutils.py'
--- a/bzrlib/osutils.py	2007-04-16 21:12:29 +0000
+++ b/bzrlib/osutils.py	2007-04-19 08:03:19 +0000
@@ -606,12 +606,18 @@
     return offset.days * 86400 + offset.seconds
 
     
-def format_date(t, offset=0, timezone='original', date_fmt=None, 
+def format_date(t, offset=0, timezone='original', date_fmt=None,
                 show_offset=True):
-    ## TODO: Perhaps a global option to use either universal or local time?
-    ## Or perhaps just let people set $TZ?
-    assert isinstance(t, float)
-    
+    """Return a formatted date string.
+
+    :param t: Seconds since the epoch.
+    :param offset: Timezone offset in seconds east of utc.
+    :param timezone: How to display the time: 'utc', 'original' for the
+         timezone specified by offset, or 'local' for the process's current
+         timezone.
+    :param show_offset: Whether to append the timezone.
+    :param date_fmt: strftime format.
+    """
     if timezone == 'utc':
         tt = time.gmtime(t)
         offset = 0

=== modified file 'bzrlib/timestamp.py'
--- a/bzrlib/timestamp.py	2007-04-19 07:17:16 +0000
+++ b/bzrlib/timestamp.py	2007-04-19 08:03:19 +0000
@@ -17,6 +17,8 @@
 import calendar
 import time
 
+from bzrlib import osutils
+
 
 def format_highres_date(t, offset=0):
     """Format a date, such that it includes higher precision in the
@@ -138,9 +140,8 @@
         from warnings import warn
         warn("gmtime of negative time (%s, %s) may not work on Windows" %
                 (secs, offset))
-    tm = time.gmtime(secs+offset)
-    time_str = time.strftime('%Y-%m-%d %H:%M:%S', tm)
-    return '%s %+03d%02d' % (time_str, offset/3600, abs(offset/60) % 60)
+    return osutils.format_date(secs, offset=offset,
+            date_fmt='%Y-%m-%d %H:%M:%S')
 
 
 def parse_patch_date(date_str):