babel/old/mirror: babel/dates.py comparison

comparison babel/dates.py @ 396:45a5b2266001

Doc improvements for the new `format_timedelta` function.

author	cmlenz
date	Tue, 15 Jul 2008 12:53:52 +0000
parents	dd0df1242ae3
children	ff9a6a37eb72

comparison

equal deleted inserted replaced

-:98f06b9c44a7
+:45a5b2266001
 * ``LC_TIME``,
 * ``LC_ALL``, and
 * ``LANG``
 """
+from __future__ import division
 from datetime import date, datetime, time, timedelta, tzinfo
 import re
 from babel.core import default_locale, get_global, Locale
 from babel.util import UTC
-__all__ = ['format_date', 'format_datetime', 'format_time',
+__all__ = ['format_date', 'format_datetime', 'format_time', 'format_timedelta',
 'get_timezone_name', 'parse_date', 'parse_datetime', 'parse_time']
 __docformat__ = 'restructuredtext en'
 LC_TIME = default_locale('LC_TIME')
 ('hour',   3600),
 ('minute', 60),
 ('second', 1)
 )
-def format_timedelta(delta, granularity='second', threshold=.9, locale=LC_TIME):
+def format_timedelta(delta, granularity='second', threshold=.85, locale=LC_TIME):
 """Return a time delta according to the rules of the given locale.
 >>> format_timedelta(timedelta(weeks=12), locale='en_US')
 u'3 months'
 >>> format_timedelta(timedelta(seconds=1), locale='es')
 u'1 segundo'
->>> format_timedelta(timedelta(seconds=1), locale='en_US')
-u'1 second'
+The granularity parameter can be provided to alter the lowest unit
+presented, which defaults to a second.
+>>> format_timedelta(timedelta(hours=3), granularity='day',
+...                  locale='en_US')
+u'0 days'
+The threshold parameter can be used to determine at which value the
+presentation switches to the next higher unit. A higher threshold factor
+means the presentation will switch later. For example:
+>>> format_timedelta(timedelta(hours=23), threshold=0.9, locale='en_US')
+u'1 day'
+>>> format_timedelta(timedelta(hours=23), threshold=1.1, locale='en_US')
+u'23 hours'
 :param delta: a ``timedelta`` object representing the time difference to
-format
+format, or the delta in seconds as an `int` value
+:param granularity: determines the smallest unit that should be displayed,
-"""
+the value can be one of "year", "month", "week", "day",
+"hour", "minute" or "second"
+:param threshold: factor that determines at which point the presentation
+switches to the next higher unit
+:param locale: a `Locale` object or a locale identifier
+:rtype: `unicode`
+"""
+if isinstance(delta, timedelta):
+seconds = int((delta.days * 86400) + delta.seconds)
+else:
+seconds = delta
 locale = Locale.parse(locale)
-seconds = int((delta.days * 86400) + delta.seconds)
+for unit, secs_per_unit in TIMEDELTA_UNITS:
-for unit, limit in TIMEDELTA_UNITS:
+value = abs(seconds) / secs_per_unit
-r = float(abs(seconds)) / float(limit)
+if value >= threshold or unit == granularity:
-if r >= threshold or unit == granularity:
+value = int(round(value))
-r = int(round(r))
+plural_form = locale.plural_form(value)
-plural_form = locale.plural_form(r)
 pattern = locale._data['unit_patterns'][unit][plural_form]
-return pattern.replace('{0}', str(r))
+return pattern.replace('{0}', str(value))
-return ''
+return u''
 def parse_date(string, locale=LC_TIME):
 """Parse a date from a string.
 This function uses the date format for the locale as a hint to determine
 def format_day_of_year(self, num):
 return self.format(self.get_day_of_year(), num)
 def format_day_of_week_in_month(self):
-return '%d' % ((self.value.day - 1) / 7 + 1)
+return '%d' % ((self.value.day - 1) // 7 + 1)
 def format_period(self, char):
 period = {0: 'am', 1: 'pm'}[int(self.value.hour >= 12)]
 return get_period_names(locale=self.locale)[period]
 day_of_week = self.value.weekday()
 first_day = (day_of_week - self.locale.first_week_day -
 day_of_period + 1) % 7
 if first_day < 0:
 first_day += 7
-week_number = (day_of_period + first_day - 1) / 7
+week_number = (day_of_period + first_day - 1) // 7
 if 7 - first_day >= self.locale.min_week_days:
 week_number += 1
 return week_number

Mercurial > babel > old > mirror

comparison babel/dates.py @ 396:45a5b2266001