babel/old/babel-test: babel/dates.py annotate

annotate babel/dates.py @ 511:f2098e9c05b4 stable-0.9.x

Fix bad check in format_time (closes #257), reported with patch and tests by jomae

author	fschwarz
date	Fri, 04 Mar 2011 22:34:14 +0000
parents	3295127550fe
children	790d49d8ba30

rev	line source
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	1 # -- coding: utf-8 --
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	2 #
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	3 # Copyright (C) 2007 Edgewall Software
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	4 # All rights reserved.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	5 #
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	6 # This software is licensed as described in the file COPYING, which
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	7 # you should have received as part of this distribution. The terms
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	8 # are also available at http://babel.edgewall.org/wiki/License.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	9 #
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	10 # This software consists of voluntary contributions made by many
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	11 # individuals. For the exact contribution history, see the revision
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	12 # history and logs, available at http://babel.edgewall.org/log/.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	13
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	14 """Locale dependent formatting and parsing of dates and times.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	15
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	16 The default locale for the functions in this module is determined by the
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	17 following environment variables, in that order:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	18
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	19 * ``LC_TIME``,
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	20 * ``LC_ALL``, and
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	21 * ``LANG``
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	22 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	23
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	24 from datetime import date, datetime, time, timedelta, tzinfo
38 a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	25 import re
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	26
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	27 from babel.core import default_locale, get_global, Locale
39 3b314a78015d Move function for determining the system default locale to `babel.core`, and make it available as a class method on `Locale`. cmlenz parents: 38 diff changeset	28 from babel.util import UTC
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	29
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	30 __all__ = ['format_date', 'format_datetime', 'format_time',
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	31 'get_timezone_name', 'parse_date', 'parse_datetime', 'parse_time']
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	32 __docformat__ = 'restructuredtext en'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	33
72 4dcdb1d367ec More explicit module-level function names in `babel.core`. Added `Locale.negotiate` class method. cmlenz parents: 46 diff changeset	34 LC_TIME = default_locale('LC_TIME')
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	35
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	36 # Aliases for use in scopes where the modules are shadowed by local variables
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	37 date_ = date
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	38 datetime_ = datetime
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	39 time_ = time
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	40
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	41 def get_period_names(locale=LC_TIME):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	42 """Return the names for day periods (AM/PM) used by the locale.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	43
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	44 >>> get_period_names(locale='en_US')['am']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	45 u'AM'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	46
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	47 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	48 :return: the dictionary of period names
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	49 :rtype: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	50 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	51 return Locale.parse(locale).periods
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	52
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	53 def get_day_names(width='wide', context='format', locale=LC_TIME):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	54 """Return the day names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	55
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	56 >>> get_day_names('wide', locale='en_US')[1]
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	57 u'Tuesday'
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	58 >>> get_day_names('abbreviated', locale='es')[1]
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	59 u'mar'
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	60 >>> get_day_names('narrow', context='stand-alone', locale='de_DE')[1]
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	61 u'D'
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	62
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	63 :param width: the width to use, one of "wide", "abbreviated", or "narrow"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	64 :param context: the context, either "format" or "stand-alone"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	65 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	66 :return: the dictionary of day names
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	67 :rtype: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	68 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	69 return Locale.parse(locale).days[context][width]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	70
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	71 def get_month_names(width='wide', context='format', locale=LC_TIME):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	72 """Return the month names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	73
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	74 >>> get_month_names('wide', locale='en_US')[1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	75 u'January'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	76 >>> get_month_names('abbreviated', locale='es')[1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	77 u'ene'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	78 >>> get_month_names('narrow', context='stand-alone', locale='de_DE')[1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	79 u'J'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	80
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	81 :param width: the width to use, one of "wide", "abbreviated", or "narrow"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	82 :param context: the context, either "format" or "stand-alone"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	83 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	84 :return: the dictionary of month names
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	85 :rtype: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	86 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	87 return Locale.parse(locale).months[context][width]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	88
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	89 def get_quarter_names(width='wide', context='format', locale=LC_TIME):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	90 """Return the quarter names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	91
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	92 >>> get_quarter_names('wide', locale='en_US')[1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	93 u'1st quarter'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	94 >>> get_quarter_names('abbreviated', locale='de_DE')[1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	95 u'Q1'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	96
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	97 :param width: the width to use, one of "wide", "abbreviated", or "narrow"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	98 :param context: the context, either "format" or "stand-alone"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	99 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	100 :return: the dictionary of quarter names
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	101 :rtype: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	102 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	103 return Locale.parse(locale).quarters[context][width]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	104
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	105 def get_era_names(width='wide', locale=LC_TIME):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	106 """Return the era names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	107
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	108 >>> get_era_names('wide', locale='en_US')[1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	109 u'Anno Domini'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	110 >>> get_era_names('abbreviated', locale='de_DE')[1]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	111 u'n. Chr.'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	112
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	113 :param width: the width to use, either "wide", "abbreviated", or "narrow"
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	114 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	115 :return: the dictionary of era names
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	116 :rtype: `dict`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	117 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	118 return Locale.parse(locale).eras[width]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	119
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	120 def get_date_format(format='medium', locale=LC_TIME):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	121 """Return the date formatting patterns used by the locale for the specified
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	122 format.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	123
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	124 >>> get_date_format(locale='en_US')
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 8 diff changeset	125 <DateTimePattern u'MMM d, yyyy'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	126 >>> get_date_format('full', locale='de_DE')
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 8 diff changeset	127 <DateTimePattern u'EEEE, d. MMMM yyyy'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	128
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	129 :param format: the format to use, one of "full", "long", "medium", or
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	130 "short"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	131 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	132 :return: the date format pattern
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	133 :rtype: `DateTimePattern`
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	134 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	135 return Locale.parse(locale).date_formats[format]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	136
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	137 def get_datetime_format(format='medium', locale=LC_TIME):
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	138 """Return the datetime formatting patterns used by the locale for the
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	139 specified format.
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	140
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	141 >>> get_datetime_format(locale='en_US')
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	142 u'{1} {0}'
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	143
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	144 :param format: the format to use, one of "full", "long", "medium", or
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	145 "short"
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	146 :param locale: the `Locale` object, or a locale string
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	147 :return: the datetime format pattern
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	148 :rtype: `unicode`
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	149 """
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	150 patterns = Locale.parse(locale).datetime_formats
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	151 if format not in patterns:
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	152 format = None
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	153 return patterns[format]
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	154
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	155 def get_time_format(format='medium', locale=LC_TIME):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	156 """Return the time formatting patterns used by the locale for the specified
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	157 format.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	158
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	159 >>> get_time_format(locale='en_US')
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 8 diff changeset	160 <DateTimePattern u'h:mm:ss a'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	161 >>> get_time_format('full', locale='de_DE')
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	162 <DateTimePattern u'HH:mm:ss v'>
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	163
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	164 :param format: the format to use, one of "full", "long", "medium", or
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	165 "short"
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	166 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	167 :return: the time format pattern
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	168 :rtype: `DateTimePattern`
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	169 """
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	170 return Locale.parse(locale).time_formats[format]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	171
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	172 def get_timezone_gmt(datetime=None, width='long', locale=LC_TIME):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	173 """Return the timezone associated with the given `datetime` object formatted
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	174 as string indicating the offset from GMT.
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	175
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	176 >>> dt = datetime(2007, 4, 1, 15, 30)
247 f3fbecf951b0 `get_timezone_gmt()` wasn't getting the locale passed in all cases, which led to test errors when the default locale wasn't configured via environment variables. cmlenz parents: 242 diff changeset	177 >>> get_timezone_gmt(dt, locale='en')
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	178 u'GMT+00:00'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	179
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	180 >>> from pytz import timezone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	181 >>> tz = timezone('America/Los_Angeles')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	182 >>> dt = datetime(2007, 4, 1, 15, 30, tzinfo=tz)
247 f3fbecf951b0 `get_timezone_gmt()` wasn't getting the locale passed in all cases, which led to test errors when the default locale wasn't configured via environment variables. cmlenz parents: 242 diff changeset	183 >>> get_timezone_gmt(dt, locale='en')
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	184 u'GMT-08:00'
247 f3fbecf951b0 `get_timezone_gmt()` wasn't getting the locale passed in all cases, which led to test errors when the default locale wasn't configured via environment variables. cmlenz parents: 242 diff changeset	185 >>> get_timezone_gmt(dt, 'short', locale='en')
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	186 u'-0800'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	187
379 1c0915da48c6 Ported [407:415/trunk] back to 0.9.x branch. cmlenz parents: 349 diff changeset	188 The long format depends on the locale, for example in France the acronym
1c0915da48c6 Ported [407:415/trunk] back to 0.9.x branch. cmlenz parents: 349 diff changeset	189 UTC string is used instead of GMT:
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	190
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	191 >>> get_timezone_gmt(dt, 'long', locale='fr_FR')
379 1c0915da48c6 Ported [407:415/trunk] back to 0.9.x branch. cmlenz parents: 349 diff changeset	192 u'UTC-08:00'
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	193
247 f3fbecf951b0 `get_timezone_gmt()` wasn't getting the locale passed in all cases, which led to test errors when the default locale wasn't configured via environment variables. cmlenz parents: 242 diff changeset	194 :param datetime: the ``datetime`` object; if `None`, the current date and
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	195 time in UTC is used
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	196 :param width: either "long" or "short"
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	197 :param locale: the `Locale` object, or a locale string
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	198 :return: the GMT offset representation of the timezone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	199 :rtype: `unicode`
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	200 :since: version 0.9
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	201 """
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	202 if datetime is None:
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	203 datetime = datetime_.utcnow()
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	204 elif isinstance(datetime, (int, long)):
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	205 datetime = datetime_.utcfromtimestamp(datetime).time()
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	206 if datetime.tzinfo is None:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	207 datetime = datetime.replace(tzinfo=UTC)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	208 locale = Locale.parse(locale)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	209
456 c139e487a885 Backport r500 to 0.9.x stable branch. cmlenz parents: 397 diff changeset	210 offset = datetime.tzinfo.utcoffset(datetime)
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	211 seconds = offset.days * 24 * 60 * 60 + offset.seconds
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	212 hours, seconds = divmod(seconds, 3600)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	213 if width == 'short':
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	214 pattern = u'%+03d%02d'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	215 else:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	216 pattern = locale.zone_formats['gmt'] % '%+03d:%02d'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	217 return pattern % (hours, seconds // 60)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	218
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	219 def get_timezone_location(dt_or_tzinfo=None, locale=LC_TIME):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	220 """Return a representation of the given timezone using "location format".
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	221
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	222 The result depends on both the local display name of the country and the
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	223 city assocaited with the time zone:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	224
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	225 >>> from pytz import timezone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	226 >>> tz = timezone('America/St_Johns')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	227 >>> get_timezone_location(tz, locale='de_DE')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	228 u"Kanada (St. John's)"
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	229 >>> tz = timezone('America/Mexico_City')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	230 >>> get_timezone_location(tz, locale='de_DE')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	231 u'Mexiko (Mexiko-Stadt)'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	232
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	233 If the timezone is associated with a country that uses only a single
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	234 timezone, just the localized country name is returned:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	235
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	236 >>> tz = timezone('Europe/Berlin')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	237 >>> get_timezone_name(tz, locale='de_DE')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	238 u'Deutschland'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	239
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	240 :param dt_or_tzinfo: the ``datetime`` or ``tzinfo`` object that determines
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	241 the timezone; if `None`, the current date and time in
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	242 UTC is assumed
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	243 :param locale: the `Locale` object, or a locale string
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	244 :return: the localized timezone name using location format
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	245 :rtype: `unicode`
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	246 :since: version 0.9
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	247 """
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	248 if dt_or_tzinfo is None or isinstance(dt_or_tzinfo, (int, long)):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	249 dt = None
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	250 tzinfo = UTC
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	251 elif isinstance(dt_or_tzinfo, (datetime, time)):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	252 dt = dt_or_tzinfo
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	253 if dt.tzinfo is not None:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	254 tzinfo = dt.tzinfo
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	255 else:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	256 tzinfo = UTC
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	257 else:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	258 dt = None
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	259 tzinfo = dt_or_tzinfo
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	260 locale = Locale.parse(locale)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	261
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	262 if hasattr(tzinfo, 'zone'):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	263 zone = tzinfo.zone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	264 else:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	265 zone = tzinfo.tzname(dt or datetime.utcnow())
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	266
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	267 # Get the canonical time-zone code
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	268 zone = get_global('zone_aliases').get(zone, zone)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	269
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	270 info = locale.time_zones.get(zone, {})
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	271
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	272 # Otherwise, if there is only one timezone for the country, return the
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	273 # localized country name
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	274 region_format = locale.zone_formats['region']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	275 territory = get_global('zone_territories').get(zone)
254 04936a6812af Fail more gracefully when formatting the timezone for an unknown/invalid territory. cmlenz parents: 253 diff changeset	276 if territory not in locale.territories:
04936a6812af Fail more gracefully when formatting the timezone for an unknown/invalid territory. cmlenz parents: 253 diff changeset	277 territory = 'ZZ' # invalid/unknown
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	278 territory_name = locale.territories[territory]
254 04936a6812af Fail more gracefully when formatting the timezone for an unknown/invalid territory. cmlenz parents: 253 diff changeset	279 if territory and len(get_global('territory_zones').get(territory, [])) == 1:
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	280 return region_format % (territory_name)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	281
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	282 # Otherwise, include the city in the output
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	283 fallback_format = locale.zone_formats['fallback']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	284 if 'city' in info:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	285 city_name = info['city']
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	286 else:
346 faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	287 metazone = get_global('meta_zones').get(zone)
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	288 metazone_info = locale.meta_zones.get(metazone, {})
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	289 if 'city' in metazone_info:
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	290 city_name = metainfo['city']
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	291 elif '/' in zone:
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	292 city_name = zone.split('/', 1)[1].replace('_', ' ')
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	293 else:
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	294 city_name = zone.replace('_', ' ')
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	295
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	296 return region_format % (fallback_format % {
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	297 '0': city_name,
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	298 '1': territory_name
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	299 })
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	300
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	301 def get_timezone_name(dt_or_tzinfo=None, width='long', uncommon=False,
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	302 locale=LC_TIME):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	303 r"""Return the localized display name for the given timezone. The timezone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	304 may be specified using a ``datetime`` or `tzinfo` object.
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	305
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	306 >>> from pytz import timezone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	307 >>> dt = time(15, 30, tzinfo=timezone('America/Los_Angeles'))
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	308 >>> get_timezone_name(dt, locale='en_US')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	309 u'Pacific Standard Time'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	310 >>> get_timezone_name(dt, width='short', locale='en_US')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	311 u'PST'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	312
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	313 If this function gets passed only a `tzinfo` object and no concrete
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	314 `datetime`, the returned display name is indenpendent of daylight savings
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	315 time. This can be used for example for selecting timezones, or to set the
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	316 time of events that recur across DST changes:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	317
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	318 >>> tz = timezone('America/Los_Angeles')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	319 >>> get_timezone_name(tz, locale='en_US')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	320 u'Pacific Time'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	321 >>> get_timezone_name(tz, 'short', locale='en_US')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	322 u'PT'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	323
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	324 If no localized display name for the timezone is available, and the timezone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	325 is associated with a country that uses only a single timezone, the name of
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	326 that country is returned, formatted according to the locale:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	327
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	328 >>> tz = timezone('Europe/Berlin')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	329 >>> get_timezone_name(tz, locale='de_DE')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	330 u'Deutschland'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	331 >>> get_timezone_name(tz, locale='pt_BR')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	332 u'Hor\xe1rio Alemanha'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	333
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	334 On the other hand, if the country uses multiple timezones, the city is also
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	335 included in the representation:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	336
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	337 >>> tz = timezone('America/St_Johns')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	338 >>> get_timezone_name(tz, locale='de_DE')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	339 u"Kanada (St. John's)"
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	340
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	341 The `uncommon` parameter can be set to `True` to enable the use of timezone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	342 representations that are not commonly used by the requested locale. For
464 5fb3585d2a6e Merged revisions 493-494 via svnmerge from jruigrok parents: 456 diff changeset	343 example, while in French the central European timezone is usually
346 faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	344 abbreviated as "HEC", in Canadian French, this abbreviation is not in
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	345 common use, so a generic name would be chosen by default:
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	346
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	347 >>> tz = timezone('Europe/Paris')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	348 >>> get_timezone_name(tz, 'short', locale='fr_CA')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	349 u'France'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	350 >>> get_timezone_name(tz, 'short', uncommon=True, locale='fr_CA')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	351 u'HEC'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	352
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	353 :param dt_or_tzinfo: the ``datetime`` or ``tzinfo`` object that determines
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	354 the timezone; if a ``tzinfo`` object is used, the
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	355 resulting display name will be generic, i.e.
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	356 independent of daylight savings time; if `None`, the
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	357 current date in UTC is assumed
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	358 :param width: either "long" or "short"
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	359 :param uncommon: whether even uncommon timezone abbreviations should be used
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	360 :param locale: the `Locale` object, or a locale string
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	361 :return: the timezone display name
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	362 :rtype: `unicode`
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	363 :since: version 0.9
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	364 :see: `LDML Appendix J: Time Zone Display Names
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	365 <http://www.unicode.org/reports/tr35/#Time_Zone_Fallback>`_
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	366 """
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	367 if dt_or_tzinfo is None or isinstance(dt_or_tzinfo, (int, long)):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	368 dt = None
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	369 tzinfo = UTC
256 25c7ccf96f3b Fix typo in [271] that slipped into the check-in. cmlenz parents: 255 diff changeset	370 elif isinstance(dt_or_tzinfo, (datetime, time)):
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	371 dt = dt_or_tzinfo
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	372 if dt.tzinfo is not None:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	373 tzinfo = dt.tzinfo
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	374 else:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	375 tzinfo = UTC
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	376 else:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	377 dt = None
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	378 tzinfo = dt_or_tzinfo
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	379 locale = Locale.parse(locale)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	380
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	381 if hasattr(tzinfo, 'zone'):
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	382 zone = tzinfo.zone
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	383 else:
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	384 zone = tzinfo.tzname(dt)
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	385
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	386 # Get the canonical time-zone code
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	387 zone = get_global('zone_aliases').get(zone, zone)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	388
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	389 info = locale.time_zones.get(zone, {})
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	390 # Try explicitly translated zone names first
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	391 if width in info:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	392 if dt is None:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	393 field = 'generic'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	394 else:
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	395 dst = tzinfo.dst(dt)
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	396 if dst is None:
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	397 field = 'generic'
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	398 elif dst == 0:
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	399 field = 'standard'
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	400 else:
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	401 field = 'daylight'
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	402 if field in info[width]:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	403 return info[width][field]
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	404
346 faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	405 metazone = get_global('meta_zones').get(zone)
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	406 if metazone:
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	407 metazone_info = locale.meta_zones.get(metazone, {})
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	408 if width in metazone_info and (uncommon or metazone_info.get('common')):
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	409 if dt is None:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	410 field = 'generic'
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	411 else:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	412 field = tzinfo.dst(dt) and 'daylight' or 'standard'
346 faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	413 if field in metazone_info[width]:
faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	414 return metazone_info[width][field]
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	415
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	416 # If we have a concrete datetime, we assume that the result can't be
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	417 # independent of daylight savings time, so we return the GMT offset
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	418 if dt is not None:
253 ba30864779cc Fix for `get_timezone_name` when falling back to GMT display. cmlenz parents: 247 diff changeset	419 return get_timezone_gmt(dt, width=width, locale=locale)
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	420
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	421 return get_timezone_location(dt_or_tzinfo, locale=locale)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	422
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	423 def format_date(date=None, format='medium', locale=LC_TIME):
101 1312ad6b624d Add wrapper class bundling the various formatting functions bound to a specific locale and time-zone. cmlenz parents: 72 diff changeset	424 """Return a date formatted according to the given pattern.
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	425
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	426 >>> d = date(2007, 04, 01)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	427 >>> format_date(d, locale='en_US')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	428 u'Apr 1, 2007'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	429 >>> format_date(d, format='full', locale='de_DE')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	430 u'Sonntag, 1. April 2007'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	431
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	432 If you don't want to use the locale default formats, you can specify a
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	433 custom date pattern:
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	434
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	435 >>> format_date(d, "EEE, MMM d, ''yy", locale='en')
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	436 u"Sun, Apr 1, '07"
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	437
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	438 :param date: the ``date`` or ``datetime`` object; if `None`, the current
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	439 date is used
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	440 :param format: one of "full", "long", "medium", or "short", or a custom
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	441 date/time pattern
19 c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	442 :param locale: a `Locale` object or a locale identifier
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	443 :rtype: `unicode`
19 c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	444
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	445 :note: If the pattern contains time fields, an `AttributeError` will be
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	446 raised when trying to apply the formatting. This is also true if
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	447 the value of ``date`` parameter is actually a ``datetime`` object,
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	448 as this function automatically converts that to a ``date``.
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	449 """
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	450 if date is None:
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	451 date = date_.today()
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	452 elif isinstance(date, datetime):
18 77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area. cmlenz parents: 16 diff changeset	453 date = date.date()
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	454
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	455 locale = Locale.parse(locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	456 if format in ('full', 'long', 'medium', 'short'):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	457 format = get_date_format(format, locale=locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	458 pattern = parse_pattern(format)
503 3295127550fe Merged revisions 554 via svnmerge from jruigrok parents: 464 diff changeset	459 return pattern.apply(date, locale)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	460
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	461 def format_datetime(datetime=None, format='medium', tzinfo=None,
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	462 locale=LC_TIME):
101 1312ad6b624d Add wrapper class bundling the various formatting functions bound to a specific locale and time-zone. cmlenz parents: 72 diff changeset	463 """Return a date formatted according to the given pattern.
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	464
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	465 >>> dt = datetime(2007, 04, 01, 15, 30)
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	466 >>> format_datetime(dt, locale='en_US')
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	467 u'Apr 1, 2007 3:30:00 PM'
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	468
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	469 For any pattern requiring the display of the time-zone, the third-party
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	470 ``pytz`` package is needed to explicitly specify the time-zone:
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	471
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	472 >>> from pytz import timezone
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	473 >>> format_datetime(dt, 'full', tzinfo=timezone('Europe/Paris'),
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	474 ... locale='fr_FR')
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	475 u'dimanche 1 avril 2007 17:30:00 HEC'
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	476 >>> format_datetime(dt, "yyyy.MM.dd G 'at' HH:mm:ss zzz",
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	477 ... tzinfo=timezone('US/Eastern'), locale='en')
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	478 u'2007.04.01 AD at 11:30:00 EDT'
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	479
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	480 :param datetime: the `datetime` object; if `None`, the current date and
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	481 time is used
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	482 :param format: one of "full", "long", "medium", or "short", or a custom
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	483 date/time pattern
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	484 :param tzinfo: the timezone to apply to the time for display
19 c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	485 :param locale: a `Locale` object or a locale identifier
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	486 :rtype: `unicode`
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	487 """
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	488 if datetime is None:
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	489 datetime = datetime_.utcnow()
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	490 elif isinstance(datetime, (int, long)):
379 1c0915da48c6 Ported [407:415/trunk] back to 0.9.x branch. cmlenz parents: 349 diff changeset	491 datetime = datetime_.utcfromtimestamp(datetime)
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	492 elif isinstance(datetime, time):
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	493 datetime = datetime_.combine(date.today(), datetime)
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	494 if datetime.tzinfo is None:
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	495 datetime = datetime.replace(tzinfo=UTC)
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	496 if tzinfo is not None:
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	497 datetime = datetime.astimezone(tzinfo)
101 1312ad6b624d Add wrapper class bundling the various formatting functions bound to a specific locale and time-zone. cmlenz parents: 72 diff changeset	498 if hasattr(tzinfo, 'normalize'): # pytz
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	499 datetime = tzinfo.normalize(datetime)
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	500
18 77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area. cmlenz parents: 16 diff changeset	501 locale = Locale.parse(locale)
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area. cmlenz parents: 16 diff changeset	502 if format in ('full', 'long', 'medium', 'short'):
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	503 return get_datetime_format(format, locale=locale) \
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	504 .replace('{0}', format_time(datetime, format, tzinfo=None,
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	505 locale=locale)) \
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	506 .replace('{1}', format_date(datetime, format, locale=locale))
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	507 else:
0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	508 return parse_pattern(format).apply(datetime, locale)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	509
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	510 def format_time(time=None, format='medium', tzinfo=None, locale=LC_TIME):
101 1312ad6b624d Add wrapper class bundling the various formatting functions bound to a specific locale and time-zone. cmlenz parents: 72 diff changeset	511 """Return a time formatted according to the given pattern.
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	512
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	513 >>> t = time(15, 30)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	514 >>> format_time(t, locale='en_US')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	515 u'3:30:00 PM'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	516 >>> format_time(t, format='short', locale='de_DE')
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	517 u'15:30'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	518
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	519 If you don't want to use the locale default formats, you can specify a
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	520 custom time pattern:
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	521
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	522 >>> format_time(t, "hh 'o''clock' a", locale='en')
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	523 u"03 o'clock PM"
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	524
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	525 For any pattern requiring the display of the time-zone, the third-party
da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	526 ``pytz`` package is needed to explicitly specify the time-zone:
da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	527
101 1312ad6b624d Add wrapper class bundling the various formatting functions bound to a specific locale and time-zone. cmlenz parents: 72 diff changeset	528 >>> from pytz import timezone
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	529 >>> t = datetime(2007, 4, 1, 15, 30)
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	530 >>> tzinfo = timezone('Europe/Paris')
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	531 >>> t = tzinfo.localize(t)
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	532 >>> format_time(t, format='full', tzinfo=tzinfo, locale='fr_FR')
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	533 u'15:30:00 HEC'
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	534 >>> format_time(t, "hh 'o''clock' a, zzzz", tzinfo=timezone('US/Eastern'),
3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	535 ... locale='en')
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	536 u"09 o'clock AM, Eastern Daylight Time"
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	537
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	538 As that example shows, when this function gets passed a
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	539 ``datetime.datetime`` value, the actual time in the formatted string is
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	540 adjusted to the timezone specified by the `tzinfo` parameter. If the
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	541 ``datetime`` is "naive" (i.e. it has no associated timezone information),
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	542 it is assumed to be in UTC.
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	543
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	544 These timezone calculations are not performed if the value is of type
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	545 ``datetime.time``, as without date information there's no way to determine
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	546 what a given time would translate to in a different timezone without
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	547 information about whether daylight savings time is in effect or not. This
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	548 means that time values are left as-is, and the value of the `tzinfo`
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	549 parameter is only used to display the timezone name if needed:
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	550
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	551 >>> t = time(15, 30)
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	552 >>> format_time(t, format='full', tzinfo=timezone('Europe/Paris'),
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	553 ... locale='fr_FR')
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	554 u'15:30:00 HEC'
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	555 >>> format_time(t, format='full', tzinfo=timezone('US/Eastern'),
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	556 ... locale='en_US')
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	557 u'3:30:00 PM ET'
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	558
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	559 :param time: the ``time`` or ``datetime`` object; if `None`, the current
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	560 time in UTC is used
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	561 :param format: one of "full", "long", "medium", or "short", or a custom
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	562 date/time pattern
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	563 :param tzinfo: the time-zone to apply to the time for display
19 c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	564 :param locale: a `Locale` object or a locale identifier
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	565 :rtype: `unicode`
19 c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	566
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	567 :note: If the pattern contains date fields, an `AttributeError` will be
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	568 raised when trying to apply the formatting. This is also true if
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	569 the value of ``time`` parameter is actually a ``datetime`` object,
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection. cmlenz parents: 18 diff changeset	570 as this function automatically converts that to a ``time``.
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	571 """
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	572 if time is None:
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	573 time = datetime.utcnow()
33 0740b6d31799 * Import datetime patterns from CLDR. cmlenz parents: 29 diff changeset	574 elif isinstance(time, (int, long)):
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	575 time = datetime.utcfromtimestamp(time)
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	576 if time.tzinfo is None:
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	577 time = time.replace(tzinfo=UTC)
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	578 if isinstance(time, datetime):
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	579 if tzinfo is not None:
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	580 time = time.astimezone(tzinfo)
511 f2098e9c05b4 Fix bad check in format_time (closes #257), reported with patch and tests by jomae fschwarz parents: 503 diff changeset	581 if hasattr(tzinfo, 'normalize'): # pytz
349 7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	582 time = tzinfo.normalize(time)
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	583 time = time.timetz()
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	584 elif tzinfo is not None:
7e2983180f6d Ported [385] to 0.9.x branch. cmlenz parents: 346 diff changeset	585 time = time.replace(tzinfo=tzinfo)
34 3666f3d3df15 Extended time-zone support. cmlenz parents: 33 diff changeset	586
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	587 locale = Locale.parse(locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	588 if format in ('full', 'long', 'medium', 'short'):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	589 format = get_time_format(format, locale=locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	590 return parse_pattern(format).apply(time, locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	591
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	592 def parse_date(string, locale=LC_TIME):
38 a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	593 """Parse a date from a string.
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	594
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	595 This function uses the date format for the locale as a hint to determine
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	596 the order in which the date fields appear in the string.
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	597
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	598 >>> parse_date('4/1/04', locale='en_US')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	599 datetime.date(2004, 4, 1)
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	600 >>> parse_date('01.04.2004', locale='de_DE')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	601 datetime.date(2004, 4, 1)
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	602
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	603 :param string: the string containing the date
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	604 :param locale: a `Locale` object or a locale identifier
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	605 :return: the parsed date
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	606 :rtype: `date`
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	607 """
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	608 # TODO: try ISO format first?
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	609 format = get_date_format(locale=locale).pattern.lower()
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	610 year_idx = format.index('y')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	611 month_idx = format.index('m')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	612 if month_idx < 0:
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	613 month_idx = format.index('l')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	614 day_idx = format.index('d')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	615
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	616 indexes = [(year_idx, 'Y'), (month_idx, 'M'), (day_idx, 'D')]
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	617 indexes.sort()
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	618 indexes = dict([(item[1], idx) for idx, item in enumerate(indexes)])
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	619
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	620 # FIXME: this currently only supports numbers, but should also support month
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	621 # names, both in the requested locale, and english
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	622
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	623 numbers = re.findall('(\d+)', string)
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	624 year = numbers[indexes['Y']]
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	625 if len(year) == 2:
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	626 year = 2000 + int(year)
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	627 else:
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	628 year = int(year)
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	629 month = int(numbers[indexes['M']])
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	630 day = int(numbers[indexes['D']])
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	631 if month > 12:
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	632 month, day = day, month
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	633 return date(year, month, day)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	634
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	635 def parse_datetime(string, locale=LC_TIME):
46 306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	636 """Parse a date and time from a string.
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	637
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	638 This function uses the date and time formats for the locale as a hint to
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	639 determine the order in which the time fields appear in the string.
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	640
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	641 :param string: the string containing the date and time
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	642 :param locale: a `Locale` object or a locale identifier
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	643 :return: the parsed date/time
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	644 :rtype: `datetime`
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	645 """
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	646 raise NotImplementedError
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	647
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	648 def parse_time(string, locale=LC_TIME):
46 306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	649 """Parse a time from a string.
38 a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	650
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	651 This function uses the time format for the locale as a hint to determine
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	652 the order in which the time fields appear in the string.
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	653
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	654 >>> parse_time('15:30:00', locale='en_US')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	655 datetime.time(15, 30)
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	656
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	657 :param string: the string containing the time
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	658 :param locale: a `Locale` object or a locale identifier
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	659 :return: the parsed time
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	660 :rtype: `time`
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	661 """
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	662 # TODO: try ISO format first?
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	663 format = get_time_format(locale=locale).pattern.lower()
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	664 hour_idx = format.index('h')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	665 if hour_idx < 0:
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	666 hour_idx = format.index('k')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	667 min_idx = format.index('m')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	668 sec_idx = format.index('s')
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	669
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	670 indexes = [(hour_idx, 'H'), (min_idx, 'M'), (sec_idx, 'S')]
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	671 indexes.sort()
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	672 indexes = dict([(item[1], idx) for idx, item in enumerate(indexes)])
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	673
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	674 # FIXME: support 12 hour clock, and 0-based hour specification
46 306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	675 # and seconds should be optional, maybe minutes too
306445fbd3ea Minor docstring fixes. cmlenz parents: 39 diff changeset	676 # oh, and time-zones, of course
38 a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	677
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	678 numbers = re.findall('(\d+)', string)
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	679 hour = int(numbers[indexes['H']])
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	680 minute = int(numbers[indexes['M']])
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	681 second = int(numbers[indexes['S']])
a22b7656e9ae Started implementation of datetime parsing, using a very basic approach for now. cmlenz parents: 34 diff changeset	682 return time(hour, minute, second)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	683
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	684
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 8 diff changeset	685 class DateTimePattern(object):
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	686
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	687 def __init__(self, pattern, format):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	688 self.pattern = pattern
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	689 self.format = format
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	690
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	691 def __repr__(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	692 return '<%s %r>' % (type(self).__name__, self.pattern)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	693
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	694 def __unicode__(self):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	695 return self.pattern
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	696
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	697 def __mod__(self, other):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	698 assert type(other) is DateTimeFormat
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	699 return self.format % other
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	700
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	701 def apply(self, datetime, locale):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	702 return self % DateTimeFormat(datetime, locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	703
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	704
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	705 class DateTimeFormat(object):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	706
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	707 def __init__(self, value, locale):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	708 assert isinstance(value, (date, datetime, time))
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	709 if isinstance(value, (datetime, time)) and value.tzinfo is None:
da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	710 value = value.replace(tzinfo=UTC)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	711 self.value = value
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	712 self.locale = Locale.parse(locale)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	713
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	714 def __getitem__(self, name):
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	715 char = name[0]
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	716 num = len(name)
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	717 if char == 'G':
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	718 return self.format_era(char, num)
215 d37628e752c4 Dummy/stub implementation for week-in-year and week-in-month date format fields. Also, treat extended year the same as the regular year field, not even ICU seems to handle it specially. cmlenz parents: 129 diff changeset	719 elif char in ('y', 'Y', 'u'):
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	720 return self.format_year(char, num)
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	721 elif char in ('Q', 'q'):
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	722 return self.format_quarter(char, num)
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	723 elif char in ('M', 'L'):
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	724 return self.format_month(char, num)
215 d37628e752c4 Dummy/stub implementation for week-in-year and week-in-month date format fields. Also, treat extended year the same as the regular year field, not even ICU seems to handle it specially. cmlenz parents: 129 diff changeset	725 elif char in ('w', 'W'):
d37628e752c4 Dummy/stub implementation for week-in-year and week-in-month date format fields. Also, treat extended year the same as the regular year field, not even ICU seems to handle it specially. cmlenz parents: 129 diff changeset	726 return self.format_week(char, num)
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	727 elif char == 'd':
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	728 return self.format(self.value.day, num)
221 898b9450f274 Implement day-of-year date format field. Closes #49. cmlenz parents: 217 diff changeset	729 elif char == 'D':
898b9450f274 Implement day-of-year date format field. Closes #49. cmlenz parents: 217 diff changeset	730 return self.format_day_of_year(num)
241 9fedbb6f9871 Implement day-of-week-in-month field in date formatting. Closes #50. cmlenz parents: 240 diff changeset	731 elif char == 'F':
9fedbb6f9871 Implement day-of-week-in-month field in date formatting. Closes #50. cmlenz parents: 240 diff changeset	732 return self.format_day_of_week_in_month()
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	733 elif char in ('E', 'e', 'c'):
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	734 return self.format_weekday(char, num)
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	735 elif char == 'a':
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	736 return self.format_period(char)
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	737 elif char == 'h':
276 e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	738 if self.value.hour % 12 == 0:
e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	739 return self.format(12, num)
e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	740 else:
e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	741 return self.format(self.value.hour % 12, num)
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	742 elif char == 'H':
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	743 return self.format(self.value.hour, num)
18 77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area. cmlenz parents: 16 diff changeset	744 elif char == 'K':
276 e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	745 return self.format(self.value.hour % 12, num)
18 77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area. cmlenz parents: 16 diff changeset	746 elif char == 'k':
276 e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	747 if self.value.hour == 0:
e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	748 return self.format(24, num)
e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	749 else:
e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	750 return self.format(self.value.hour, num)
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	751 elif char == 'm':
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	752 return self.format(self.value.minute, num)
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	753 elif char == 's':
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	754 return self.format(self.value.second, num)
216 1f3c3924b1b5 Support for fractional seconds field in date formatting. Closes #47. cmlenz parents: 215 diff changeset	755 elif char == 'S':
217 4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	756 return self.format_frac_seconds(num)
4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	757 elif char == 'A':
4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	758 return self.format_milliseconds_in_day(num)
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	759 elif char in ('z', 'Z', 'v', 'V'):
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	760 return self.format_timezone(char, num)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	761 else:
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	762 raise KeyError('Unsupported date/time field %r' % char)
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	763
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	764 def format_era(self, char, num):
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	765 width = {3: 'abbreviated', 4: 'wide', 5: 'narrow'}[max(3, num)]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	766 era = int(self.value.year >= 0)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	767 return get_era_names(width, self.locale)[era]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	768
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	769 def format_year(self, char, num):
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	770 value = self.value.year
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	771 if char.isupper():
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	772 week = self.get_week_number(self.get_day_of_year())
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	773 if week == 0:
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	774 value -= 1
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	775 year = self.format(value, num)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	776 if num == 2:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	777 year = year[-2:]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	778 return year
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	779
397 61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	780 def format_quarter(self, char, num):
61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	781 quarter = (self.value.month - 1) // 3 + 1
61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	782 if num <= 2:
61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	783 return ('%%0%dd' % num) % quarter
61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	784 width = {3: 'abbreviated', 4: 'wide', 5: 'narrow'}[num]
61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	785 context = {'Q': 'format', 'q': 'stand-alone'}[char]
61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	786 return get_quarter_names(width, context, self.locale)[quarter]
61cb2233fa49 Ported [436] to 0.9.x branch. cmlenz parents: 379 diff changeset	787
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	788 def format_month(self, char, num):
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	789 if num <= 2:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	790 return ('%%0%dd' % num) % self.value.month
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	791 width = {3: 'abbreviated', 4: 'wide', 5: 'narrow'}[num]
346 faf0ead3a132 Merged revisions [358:360], [364:370], [373:378], [380:382] from [source:trunk]. cmlenz parents: 276 diff changeset	792 context = {'M': 'format', 'L': 'stand-alone'}[char]
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	793 return get_month_names(width, context, self.locale)[self.value.month]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	794
215 d37628e752c4 Dummy/stub implementation for week-in-year and week-in-month date format fields. Also, treat extended year the same as the regular year field, not even ICU seems to handle it specially. cmlenz parents: 129 diff changeset	795 def format_week(self, char, num):
239 4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	796 if char.islower(): # week of year
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	797 day_of_year = self.get_day_of_year()
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	798 week = self.get_week_number(day_of_year)
240 e47245bf65b3 More work on #46 (week-of-year/week-of-month). cmlenz parents: 239 diff changeset	799 if week == 0:
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	800 date = self.value - timedelta(days=day_of_year)
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	801 week = self.get_week_number(self.get_day_of_year(date),
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	802 date.weekday())
240 e47245bf65b3 More work on #46 (week-of-year/week-of-month). cmlenz parents: 239 diff changeset	803 return self.format(week, num)
239 4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	804 else: # week of month
240 e47245bf65b3 More work on #46 (week-of-year/week-of-month). cmlenz parents: 239 diff changeset	805 week = self.get_week_number(self.value.day)
e47245bf65b3 More work on #46 (week-of-year/week-of-month). cmlenz parents: 239 diff changeset	806 if week == 0:
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	807 date = self.value - timedelta(days=self.value.day)
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	808 week = self.get_week_number(date.day, date.weekday())
240 e47245bf65b3 More work on #46 (week-of-year/week-of-month). cmlenz parents: 239 diff changeset	809 pass
e47245bf65b3 More work on #46 (week-of-year/week-of-month). cmlenz parents: 239 diff changeset	810 return '%d' % week
215 d37628e752c4 Dummy/stub implementation for week-in-year and week-in-month date format fields. Also, treat extended year the same as the regular year field, not even ICU seems to handle it specially. cmlenz parents: 129 diff changeset	811
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	812 def format_weekday(self, char, num):
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	813 if num < 3:
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	814 if char.islower():
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	815 value = 7 - self.locale.first_week_day + self.value.weekday()
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	816 return self.format(value % 7 + 1, num)
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	817 num = 3
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	818 weekday = self.value.weekday()
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	819 width = {3: 'abbreviated', 4: 'wide', 5: 'narrow'}[num]
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	820 context = {3: 'format', 4: 'format', 5: 'stand-alone'}[num]
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	821 return get_day_names(width, context, self.locale)[weekday]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	822
221 898b9450f274 Implement day-of-year date format field. Closes #49. cmlenz parents: 217 diff changeset	823 def format_day_of_year(self, num):
239 4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	824 return self.format(self.get_day_of_year(), num)
221 898b9450f274 Implement day-of-year date format field. Closes #49. cmlenz parents: 217 diff changeset	825
241 9fedbb6f9871 Implement day-of-week-in-month field in date formatting. Closes #50. cmlenz parents: 240 diff changeset	826 def format_day_of_week_in_month(self):
9fedbb6f9871 Implement day-of-week-in-month field in date formatting. Closes #50. cmlenz parents: 240 diff changeset	827 return '%d' % ((self.value.day - 1) / 7 + 1)
9fedbb6f9871 Implement day-of-week-in-month field in date formatting. Closes #50. cmlenz parents: 240 diff changeset	828
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	829 def format_period(self, char):
276 e4dc98533a26 Merged [301:303] from [source:trunk] via svnmerge. cmlenz parents: 256 diff changeset	830 period = {0: 'am', 1: 'pm'}[int(self.value.hour >= 12)]
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	831 return get_period_names(locale=self.locale)[period]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	832
217 4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	833 def format_frac_seconds(self, num):
216 1f3c3924b1b5 Support for fractional seconds field in date formatting. Closes #47. cmlenz parents: 215 diff changeset	834 value = str(self.value.microsecond)
1f3c3924b1b5 Support for fractional seconds field in date formatting. Closes #47. cmlenz parents: 215 diff changeset	835 return self.format(round(float('.%s' % value), num) * 10**num, num)
1f3c3924b1b5 Support for fractional seconds field in date formatting. Closes #47. cmlenz parents: 215 diff changeset	836
217 4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	837 def format_milliseconds_in_day(self, num):
4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	838 msecs = self.value.microsecond // 1000 + self.value.second * 1000 + \
4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	839 self.value.minute * 60000 + self.value.hour * 3600000
4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	840 return self.format(msecs, num)
4de6f4604830 Implement milliseconds in day (#48). cmlenz parents: 216 diff changeset	841
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	842 def format_timezone(self, char, num):
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	843 width = {3: 'short', 4: 'long'}[max(3, num)]
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	844 if char == 'z':
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	845 return get_timezone_name(self.value, width, locale=self.locale)
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	846 elif char == 'Z':
247 f3fbecf951b0 `get_timezone_gmt()` wasn't getting the locale passed in all cases, which led to test errors when the default locale wasn't configured via environment variables. cmlenz parents: 242 diff changeset	847 return get_timezone_gmt(self.value, width, locale=self.locale)
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	848 elif char == 'v':
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	849 return get_timezone_name(self.value.tzinfo, width,
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	850 locale=self.locale)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	851 elif char == 'V':
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	852 if num == 1:
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	853 return get_timezone_name(self.value.tzinfo, width,
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	854 uncommon=True, locale=self.locale)
bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	855 return get_timezone_location(self.value.tzinfo, locale=self.locale)
29 da1c9610e751 More work on timezones. cmlenz parents: 19 diff changeset	856
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	857 def format(self, value, length):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	858 return ('%%0%dd' % length) % value
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	859
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	860 def get_day_of_year(self, date=None):
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	861 if date is None:
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	862 date = self.value
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	863 return (date - date_(date.year, 1, 1)).days + 1
239 4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	864
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	865 def get_week_number(self, day_of_period, day_of_week=None):
239 4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	866 """Return the number of the week of a day within a period. This may be
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	867 the week number in a year or the week number in a month.
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	868
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	869 Usually this will return a value equal to or greater than 1, but if the
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	870 first week of the period is so short that it actually counts as the last
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	871 week of the previous period, this function will return 0.
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	872
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	873 >>> format = DateTimeFormat(date(2006, 1, 8), Locale.parse('de_DE'))
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	874 >>> format.get_week_number(6)
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	875 1
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	876
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	877 >>> format = DateTimeFormat(date(2006, 1, 8), Locale.parse('en_US'))
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	878 >>> format.get_week_number(6)
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	879 2
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	880
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	881 :param day_of_period: the number of the day in the period (usually
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	882 either the day of month or the day of year)
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	883 :param day_of_week: the week day; if ommitted, the week day of the
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	884 current date is assumed
239 4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	885 """
242 059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	886 if day_of_week is None:
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	887 day_of_week = self.value.weekday()
059b74719f6b Finish implementation of day-of-year and day-of-month for now, and fix implementation of year-of-week-of-year field. Closes #46. I suspect there are still cases not entirely covered by this implementation, but those can be filed as separate tickets. cmlenz parents: 241 diff changeset	888 first_day = (day_of_week - self.locale.first_week_day -
239 4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	889 day_of_period + 1) % 7
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	890 if first_day < 0:
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	891 first_day += 7
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	892 week_number = (day_of_period + first_day - 1) / 7
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	893 if 7 - first_day >= self.locale.min_week_days:
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	894 week_number += 1
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	895 return week_number
4afe02d81083 Again, properly implement week-in-year (#46). cmlenz parents: 238 diff changeset	896
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	897
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	898 PATTERN_CHARS = {
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	899 'G': [1, 2, 3, 4, 5], # era
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	900 'y': None, 'Y': None, 'u': None, # year
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	901 'Q': [1, 2, 3, 4], 'q': [1, 2, 3, 4], # quarter
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	902 'M': [1, 2, 3, 4, 5], 'L': [1, 2, 3, 4, 5], # month
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	903 'w': [1, 2], 'W': [1], # week
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	904 'd': [1, 2], 'D': [1, 2, 3], 'F': [1], 'g': None, # day
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	905 'E': [1, 2, 3, 4, 5], 'e': [1, 2, 3, 4, 5], 'c': [1, 3, 4, 5], # week day
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	906 'a': [1], # period
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	907 'h': [1, 2], 'H': [1, 2], 'K': [1, 2], 'k': [1, 2], # hour
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	908 'm': [1, 2], # minute
76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	909 's': [1, 2], 'S': None, 'A': None, # second
233 bc22f5aef216 Upgraded to CLDR 1.5 and improved timezone formatting. cmlenz parents: 221 diff changeset	910 'z': [1, 2, 3, 4], 'Z': [1, 2, 3, 4], 'v': [1, 4], 'V': [1, 4] # zone
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	911 }
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	912
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	913 def parse_pattern(pattern):
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	914 """Parse date, time, and datetime format patterns.
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	915
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	916 >>> parse_pattern("MMMMd").format
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	917 u'%(MMMM)s%(d)s'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	918 >>> parse_pattern("MMM d, yyyy").format
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	919 u'%(MMM)s %(d)s, %(yyyy)s'
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	920
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	921 Pattern can contain literal strings in single quotes:
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	922
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	923 >>> parse_pattern("H:mm' Uhr 'z").format
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	924 u'%(H)s:%(mm)s Uhr %(z)s'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	925
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	926 An actual single quote can be used by using two adjacent single quote
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	927 characters:
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	928
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	929 >>> parse_pattern("hh' o''clock'").format
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	930 u"%(hh)s o'clock"
ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	931
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	932 :param pattern: the formatting pattern to parse
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	933 """
12 a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places. cmlenz parents: 8 diff changeset	934 if type(pattern) is DateTimePattern:
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	935 return pattern
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	936
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	937 result = []
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	938 quotebuf = None
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	939 charbuf = []
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	940 fieldchar = ['']
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	941 fieldnum = [0]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	942
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	943 def append_chars():
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	944 result.append(''.join(charbuf).replace('%', '%%'))
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	945 del charbuf[:]
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	946
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	947 def append_field():
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	948 limit = PATTERN_CHARS[fieldchar[0]]
15 76985c08a339 Minor date formatting improvements. cmlenz parents: 12 diff changeset	949 if limit and fieldnum[0] not in limit:
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	950 raise ValueError('Invalid length for field: %r'
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	951 % (fieldchar[0] * fieldnum[0]))
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	952 result.append('%%(%s)s' % (fieldchar[0] * fieldnum[0]))
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	953 fieldchar[0] = ''
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	954 fieldnum[0] = 0
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	955
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	956 for idx, char in enumerate(pattern.replace("''", '\0')):
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	957 if quotebuf is None:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	958 if char == "'": # quote started
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	959 if fieldchar[0]:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	960 append_field()
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	961 elif charbuf:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	962 append_chars()
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	963 quotebuf = []
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	964 elif char in PATTERN_CHARS:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	965 if charbuf:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	966 append_chars()
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	967 if char == fieldchar[0]:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	968 fieldnum[0] += 1
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	969 else:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	970 if fieldchar[0]:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	971 append_field()
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	972 fieldchar[0] = char
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	973 fieldnum[0] = 1
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	974 else:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	975 if fieldchar[0]:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	976 append_field()
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	977 charbuf.append(char)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	978
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	979 elif quotebuf is not None:
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	980 if char == "'": # end of quote
1 f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	981 charbuf.extend(quotebuf)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	982 quotebuf = None
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	983 else: # inside quote
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	984 quotebuf.append(char)
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	985
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	986 if fieldchar[0]:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	987 append_field()
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	988 elif charbuf:
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	989 append_chars()
f71ca60f2a4a Import of initial code base. cmlenz parents: diff changeset	990
16 ed154241c08d Handle escape chars in datetime patterns. cmlenz parents: 15 diff changeset	991 return DateTimePattern(pattern, u''.join(result).replace('\0', "'"))

Mercurial > babel > old > babel-test

annotate babel/dates.py @ 511:f2098e9c05b4 stable-0.9.x