15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Module: Date utilities
19
# Author: William Grant
18
'''Utilities for making nice, human readable dates.'''
24
seconds_per_day = 86400 # 60 * 60 * 24
26
timezone_offset = time.altzone
28
timezone_offset = time.timezone
30
def make_date_nice(seconds_since_epoch):
31
"""Given a number of seconds elapsed since the epoch,
23
def get_datetime(datetime_or_seconds):
24
'''Return the given datetime, or convert the given seconds since epoch.'''
25
if type(datetime_or_seconds) is datetime.datetime:
26
return datetime_or_seconds
27
return datetime.datetime.fromtimestamp(datetime_or_seconds)
29
def make_date_nice(datetime_or_seconds):
30
"""Generate a full human-readable representation of a date and time.
32
Given a datetime or number of seconds elapsed since the epoch,
32
33
generates a string representing the date/time in human-readable form.
33
34
"ddd mmm dd, yyyy h:m a"
35
#return time.ctime(seconds_since_epoch)
36
return time.strftime("%a %b %d %Y, %I:%M %p",
37
time.localtime(seconds_since_epoch))
39
def make_date_nice_short(seconds_since_epoch):
40
"""Given a number of seconds elapsed since the epoch,
36
dt = get_datetime(datetime_or_seconds)
37
return dt.strftime("%a %b %d %Y, %I:%M %p")
39
def make_date_nice_short(datetime_or_seconds):
40
"""Generate a very compact human-readable representation of a date.
42
Given a datetime or number of seconds elapsed since the epoch,
41
43
generates a string representing the date in human-readable form.
42
44
Does not include the time.
43
This function generates a very compact representation."""
47
dt = get_datetime(datetime_or_seconds)
48
now = datetime.datetime.now()
44
50
# Use a "naturalisation" algorithm.
45
days_ago = (int(time.time() - timezone_offset) / seconds_per_day
46
- int(seconds_since_epoch - timezone_offset) / seconds_per_day)
48
54
# Dates today or yesterday, return "today" or "yesterday".
54
return str(days_ago) + " days ago"
55
# Dates in the last 5 days, return "n days ago".
60
# Dates in the last 5 days, return "n days ago".
61
return str(delta.days) + " days ago"
56
62
# Other dates, return a short date format.
57
63
# If within the same year, omit the year (mmm dd)
58
if time.localtime(seconds_since_epoch).tm_year==time.localtime().tm_year:
59
return time.strftime("%b %d", time.localtime(seconds_since_epoch))
64
if dt.year == now.year:
65
return dt.strftime("%b %d")
60
66
# Else, include the year (mmm dd, yyyy)
62
return time.strftime("%b %d, %Y", time.localtime(seconds_since_epoch))
68
return dt.strftime("%b %d, %Y")
70
def format_datetime_for_paragraph(datetime_or_seconds):
71
"""Generate a compact representation of a datetime for use in a paragraph.
73
Given a datetime or number of seconds elapsed since the epoch, generates
74
a compact string representing the date and time in human-readable form.
76
Unlike make_date_nice_short, the time will always be included.
78
Also unlike make_date_nice_short, it is suitable for use in the middle of
79
a block of prose and properly handles timestamps in the future nicely.
82
dt = get_datetime(datetime_or_seconds)
83
now = datetime.datetime.now()
87
# If the date is earlier than now, we want to either say something like
88
# '5 days ago' or '25 seconds ago', 'yesterday at 08:54' or
89
# 'on 2009-03-26 at 20:09'.
91
# If the time is within one hour of now, we show it nicely in either
94
if abs(delta).days == 0 and abs(delta).seconds <= 1:
97
if abs(delta).days == 0 and abs(delta).seconds < 60*60:
98
if abs(delta) == delta:
106
# Show the number of minutes unless we are within two minutes.
107
if abs(delta).seconds >= 120:
108
return (prefix + '%d minutes' + suffix) % (abs(delta).seconds / 60)
110
return (prefix + '%d seconds' + suffix) % (abs(delta).seconds)
113
if dt.date() == now.date():
115
return dt.strftime('today at %I:%M %p')
116
elif dt.date() == now.date() - datetime.timedelta(days=1):
118
return dt.strftime('yesterday at %I:%M %p')
120
if dt.date() == now.date():
122
return dt.strftime('today at %I:%M %p')
123
elif dt.date() == now.date() + datetime.timedelta(days=1):
125
return dt.strftime('tomorrow at %I:%M %p')
127
return dt.strftime('on %Y-%m-%d at %I:%M %p')