annotate babel/dates.py @ 33:0740b6d31799

* Import datetime patterns from CLDR. * Make the date/time arguments to the formatting functions optional, defaulting to the current date/time.
author cmlenz
date Mon, 04 Jun 2007 14:28:54 +0000
parents da1c9610e751
children 3666f3d3df15
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
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
25
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
26 from babel.core import Locale
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
27 from babel.util import default_locale, UTC
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
28
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
29 __all__ = ['format_date', 'format_datetime', 'format_time', 'parse_date',
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
30 'parse_datetime', 'parse_time']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
31 __docformat__ = 'restructuredtext en'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
32
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
33 LC_TIME = default_locale('LC_TIME')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
34
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
35 # Aliases for use in scopes where the modules are shadowed by local variables
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
36 date_ = date
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
37 datetime_ = datetime
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
38 time_ = time
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
39
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
40 def get_period_names(locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
41 """Return the names for day periods (AM/PM) used by the locale.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
42
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
43 >>> get_period_names(locale='en_US')['am']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
44 u'AM'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
45
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
46 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
47 :return: the dictionary of period names
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
48 :rtype: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
49 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
50 return Locale.parse(locale).periods
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
51
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
52 def get_day_names(width='wide', context='format', locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
53 """Return the day names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
54
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
55 >>> get_day_names('wide', locale='en_US')[1]
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
56 u'Tuesday'
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
57 >>> get_day_names('abbreviated', locale='es')[1]
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
58 u'mar'
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
59 >>> get_day_names('narrow', context='stand-alone', locale='de_DE')[1]
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
60 u'D'
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
61
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
62 :param width: the width to use, one of "wide", "abbreviated", or "narrow"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
63 :param context: the context, either "format" or "stand-alone"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
64 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
65 :return: the dictionary of day names
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
66 :rtype: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
67 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
68 return Locale.parse(locale).days[context][width]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
69
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
70 def get_month_names(width='wide', context='format', locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
71 """Return the month names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
72
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
73 >>> get_month_names('wide', locale='en_US')[1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
74 u'January'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
75 >>> get_month_names('abbreviated', locale='es')[1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
76 u'ene'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
77 >>> get_month_names('narrow', context='stand-alone', locale='de_DE')[1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
78 u'J'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
79
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
80 :param width: the width to use, one of "wide", "abbreviated", or "narrow"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
81 :param context: the context, either "format" or "stand-alone"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
82 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
83 :return: the dictionary of month names
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
84 :rtype: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
85 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
86 return Locale.parse(locale).months[context][width]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
87
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
88 def get_quarter_names(width='wide', context='format', locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
89 """Return the quarter names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
90
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
91 >>> get_quarter_names('wide', locale='en_US')[1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
92 u'1st quarter'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
93 >>> get_quarter_names('abbreviated', locale='de_DE')[1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
94 u'Q1'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
95
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
96 :param width: the width to use, one of "wide", "abbreviated", or "narrow"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
97 :param context: the context, either "format" or "stand-alone"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
98 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
99 :return: the dictionary of quarter names
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
100 :rtype: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
101 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
102 return Locale.parse(locale).quarters[context][width]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
103
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
104 def get_era_names(width='wide', locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
105 """Return the era names used by the locale for the specified format.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
106
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
107 >>> get_era_names('wide', locale='en_US')[1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
108 u'Anno Domini'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
109 >>> get_era_names('abbreviated', locale='de_DE')[1]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
110 u'n. Chr.'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
111
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
112 :param width: the width to use, either "wide" or "abbreviated"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
113 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
114 :return: the dictionary of era names
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
115 :rtype: `dict`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
116 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
117 return Locale.parse(locale).eras[width]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
118
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
119 def get_date_format(format='medium', locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
120 """Return the date formatting patterns used by the locale for the specified
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
121 format.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
122
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
123 >>> get_date_format(locale='en_US')
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 8
diff changeset
124 <DateTimePattern u'MMM d, yyyy'>
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
125 >>> get_date_format('full', locale='de_DE')
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 8
diff changeset
126 <DateTimePattern u'EEEE, d. MMMM yyyy'>
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
127
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
128 :param format: the format to use, one of "full", "long", "medium", or
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
129 "short"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
130 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
131 :return: the date format pattern
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
132 :rtype: `DateTimePattern`
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
133 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
134 return Locale.parse(locale).date_formats[format]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
135
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
136 def get_datetime_format(format='medium', locale=LC_TIME):
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
137 """Return the datetime formatting patterns used by the locale for the
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
138 specified format.
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
139
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
140 >>> get_datetime_format(locale='en_US')
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
141 u'{1} {0}'
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
142
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
143 :param format: the format to use, one of "full", "long", "medium", or
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
144 "short"
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
145 :param locale: the `Locale` object, or a locale string
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
146 :return: the datetime format pattern
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
147 :rtype: `unicode`
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
148 """
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
149 patterns = Locale.parse(locale).datetime_formats
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
150 if format not in patterns:
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
151 format = None
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
152 return patterns[format]
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
153
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
154 def get_time_format(format='medium', locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
155 """Return the time formatting patterns used by the locale for the specified
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
156 format.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
157
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
158 >>> get_time_format(locale='en_US')
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 8
diff changeset
159 <DateTimePattern u'h:mm:ss a'>
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
160 >>> get_time_format('full', locale='de_DE')
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 8
diff changeset
161 <DateTimePattern u"H:mm' Uhr 'z">
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
162
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
163 :param format: the format to use, one of "full", "long", "medium", or
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
164 "short"
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
165 :param locale: the `Locale` object, or a locale string
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
166 :return: the time format pattern
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
167 :rtype: `DateTimePattern`
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
168 """
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
169 return Locale.parse(locale).time_formats[format]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
170
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
171 def format_date(date=None, format='medium', locale=LC_TIME):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
172 """Returns a date formatted according to the given pattern.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
173
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
174 >>> d = date(2007, 04, 01)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
175 >>> format_date(d, locale='en_US')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
176 u'Apr 1, 2007'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
177 >>> format_date(d, format='full', locale='de_DE')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
178 u'Sonntag, 1. April 2007'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
179
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
180 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
181 custom date pattern:
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
182
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
183 >>> format_date(d, "EEE, MMM d, ''yy", locale='en')
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
184 u"Sun, Apr 1, '07"
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
185
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
186 :param date: the ``date`` or ``datetime`` object; if `None`, the current
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
187 date is used
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
188 :param format: one of "full", "long", "medium", or "short", or a custom
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
189 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
190 :param locale: a `Locale` object or a locale identifier
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
191 :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
192
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection.
cmlenz
parents: 18
diff changeset
193 :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
194 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
195 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
196 as this function automatically converts that to a ``date``.
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
197 """
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
198 if date is None:
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
199 date = date_.today()
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
200 elif isinstance(date, datetime):
18
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
201 date = date.date()
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
202 locale = Locale.parse(locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
203 if format in ('full', 'long', 'medium', 'short'):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
204 format = get_date_format(format, locale=locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
205 pattern = parse_pattern(format)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
206 return parse_pattern(format).apply(date, locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
207
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
208 def format_datetime(datetime=None, format='medium', tzinfo=UTC, locale=LC_TIME):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
209 """Returns a date formatted according to the given pattern.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
210
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
211 >>> dt = datetime(2007, 04, 01, 15, 30)
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
212 >>> format_datetime(dt, locale='en_US')
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
213 u'Apr 1, 2007 3:30:00 PM'
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
214
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
215 :param datetime: the `datetime` object; if `None`, the current date and
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
216 time is used
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
217 :param format: one of "full", "long", "medium", or "short", or a custom
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
218 date/time pattern
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
219 :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
220 :param locale: a `Locale` object or a locale identifier
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
221 :rtype: `unicode`
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
222 """
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
223 if datetime is None:
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
224 datetime = datetime_.now()
18
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
225 locale = Locale.parse(locale)
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
226 if format in ('full', 'long', 'medium', 'short'):
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
227 return get_datetime_format(format, locale=locale) \
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
228 .replace('{0}', format_time(datetime, format, tzinfo=tzinfo,
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
229 locale=locale)) \
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
230 .replace('{1}', format_date(datetime, format, locale=locale))
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
231 else:
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
232 return parse_pattern(format).apply(datetime, locale)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
233
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
234 def format_time(time=None, format='medium', tzinfo=UTC, locale=LC_TIME):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
235 """Returns a time formatted according to the given pattern.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
236
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
237 >>> t = time(15, 30)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
238 >>> format_time(t, locale='en_US')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
239 u'3:30:00 PM'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
240 >>> format_time(t, format='short', locale='de_DE')
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
241 u'15:30'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
242
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
243 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
244 custom time pattern:
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
245
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
246 >>> format_time(t, "hh 'o''clock' a", locale='en')
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
247 u"03 o'clock PM"
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
248
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
249 For any pattern requiring the display of the time-zone, the third-party
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
250 ``pytz`` package is needed to explicitly specify the time-zone:
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
251
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
252 >>> from pytz import timezone
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
253 >>> cet = timezone('Europe/Berlin')
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
254 >>> format_time(t, format='full', tzinfo=cet, locale='de_DE')
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
255 u'15:30 Uhr MEZ'
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
256
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
257 :param time: the ``time`` or ``datetime`` object; if `None`, the current
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
258 time is used
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
259 :param format: one of "full", "long", "medium", or "short", or a custom
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
260 date/time pattern
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
261 :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
262 :param locale: a `Locale` object or a locale identifier
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
263 :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
264
c0c92d11f1ab Moved some datetime tests from doctest to unittest, to avoid breaking docutils/epydoc doctest block detection.
cmlenz
parents: 18
diff changeset
265 :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
266 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
267 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
268 as this function automatically converts that to a ``time``.
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
269 """
33
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
270 if time is None:
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
271 time = datetime.now().time()
0740b6d31799 * Import datetime patterns from CLDR.
cmlenz
parents: 29
diff changeset
272 elif isinstance(time, (int, long)):
18
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
273 time = datetime.fromtimestamp(time).time()
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
274 elif isinstance(time, datetime):
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
275 time = time.time()
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
276 if time.tzinfo is None:
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
277 time = time.replace(tzinfo=tzinfo)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
278 locale = Locale.parse(locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
279 if format in ('full', 'long', 'medium', 'short'):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
280 format = get_time_format(format, locale=locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
281 return parse_pattern(format).apply(time, locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
282
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
283 def parse_date(string, locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
284 raise NotImplementedError
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
285
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
286 def parse_datetime(string, locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
287 raise NotImplementedError
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
288
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
289 def parse_time(string, locale=LC_TIME):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
290 raise NotImplementedError
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
291
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
292
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 8
diff changeset
293 class DateTimePattern(object):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
294
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
295 def __init__(self, pattern, format):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
296 self.pattern = pattern
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
297 self.format = format
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
298
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
299 def __repr__(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
300 return '<%s %r>' % (type(self).__name__, self.pattern)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
301
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
302 def __unicode__(self):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
303 return self.pattern
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
304
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
305 def __mod__(self, other):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
306 assert type(other) is DateTimeFormat
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
307 return self.format % other
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
308
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
309 def apply(self, datetime, locale):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
310 return self % DateTimeFormat(datetime, locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
311
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
312
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
313 class DateTimeFormat(object):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
314
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
315 def __init__(self, value, locale):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
316 assert isinstance(value, (date, datetime, time))
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
317 if isinstance(value, (datetime, time)) and value.tzinfo is None:
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
318 value = value.replace(tzinfo=UTC)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
319 self.value = value
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
320 self.locale = Locale.parse(locale)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
321
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
322 def __getitem__(self, name):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
323 # TODO: a number of fields missing here
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
324 char = name[0]
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
325 num = len(name)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
326 if char == 'G':
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
327 return self.format_era(char, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
328 elif char in ('y', 'Y'):
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
329 return self.format_year(char, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
330 elif char in ('Q', 'q'):
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
331 return self.format_quarter(char, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
332 elif char in ('M', 'L'):
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
333 return self.format_month(char, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
334 elif char == 'd':
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
335 return self.format(self.value.day, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
336 elif char in ('E', 'e', 'c'):
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
337 return self.format_weekday(char, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
338 elif char == 'a':
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
339 return self.format_period(char)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
340 elif char == 'h':
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
341 return self.format(self.value.hour % 12, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
342 elif char == 'H':
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
343 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
344 elif char == 'K':
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
345 return self.format(self.value.hour % 12 - 1, num)
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
346 elif char == 'k':
77a68f88f6bc Started documentation for date formatting, plus some code tweaks in that area.
cmlenz
parents: 16
diff changeset
347 return self.format(self.value.hour + 1, num)
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
348 elif char == 'm':
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
349 return self.format(self.value.minute, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
350 elif char == 's':
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
351 return self.format(self.value.second, num)
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
352 elif char in ('z', 'Z', 'v'):
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
353 return self.format_timezone(char, num)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
354 else:
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
355 raise KeyError('Unsupported date/time field %r' % char)
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
356
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
357 def format_era(self, char, num):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
358 width = {3: 'abbreviated', 4: 'wide', 5: 'narrow'}[max(3, num)]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
359 era = int(self.value.year >= 0)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
360 return get_era_names(width, self.locale)[era]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
361
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
362 def format_year(self, char, num):
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
363 if char.islower():
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
364 value = self.value.year
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
365 else:
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
366 value = self.value.isocalendar()[0]
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
367 year = self.format(value, num)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
368 if num == 2:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
369 year = year[-2:]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
370 return year
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
371
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
372 def format_month(self, char, num):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
373 if num <= 2:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
374 return ('%%0%dd' % num) % self.value.month
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
375 width = {3: 'abbreviated', 4: 'wide', 5: 'narrow'}[num]
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
376 context = {3: 'format', 4: 'format', 5: 'stand-alone'}[num]
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
377 return get_month_names(width, context, self.locale)[self.value.month]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
378
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
379 def format_weekday(self, char, num):
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
380 if num < 3:
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
381 if char.islower():
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
382 value = 7 - self.locale.first_week_day + self.value.weekday()
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
383 return self.format(value % 7 + 1, num)
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
384 num = 3
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
385 weekday = self.value.weekday()
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
386 width = {3: 'abbreviated', 4: 'wide', 5: 'narrow'}[num]
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
387 context = {3: 'format', 4: 'format', 5: 'stand-alone'}[num]
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
388 return get_day_names(width, context, self.locale)[weekday]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
389
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
390 def format_period(self, char):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
391 period = {0: 'am', 1: 'pm'}[int(self.value.hour > 12)]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
392 return get_period_names(locale=self.locale)[period]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
393
29
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
394 def format_timezone(self, char, num):
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
395 if char == 'z':
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
396 zone = self.value.tzinfo.zone
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
397 if num < 4:
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
398 return self.locale.time_zones[zone]['short'][
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
399 self.value.dst() and 'daylight' or 'standard'
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
400 ]
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
401 else:
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
402 return self.locale.time_zones[zone]['long'][
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
403 self.value.dst() and 'daylight' or 'standard'
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
404 ]
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
405
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
406 elif char == 'Z':
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
407 offset = self.value.utcoffset()
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
408 hours, seconds = divmod(offset.seconds, 3600)
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
409 minutes = seconds // 60
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
410 sign = '+'
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
411 if offset.seconds < 0:
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
412 sign = '-'
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
413 pattern = {3: '%s%02d%02d', 4: 'GMT %s%02d:%02d'}[max(3, num)]
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
414 return pattern % (sign, hours, minutes)
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
415
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
416 elif char == 'v':
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
417 raise NotImplementedError
da1c9610e751 More work on timezones.
cmlenz
parents: 19
diff changeset
418
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
419 def format(self, value, length):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
420 return ('%%0%dd' % length) % value
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
421
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
422
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
423 PATTERN_CHARS = {
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
424 'G': [1, 2, 3, 4, 5], # era
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
425 'y': None, 'Y': None, 'u': None, # year
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
426 'Q': [1, 2, 3, 4], 'q': [1, 2, 3, 4], # quarter
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
427 'M': [1, 2, 3, 4, 5], 'L': [1, 2, 3, 4, 5], # month
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
428 'w': [1, 2], 'W': [1], # week
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
429 'd': [1, 2], 'D': [1, 2, 3], 'F': [1], 'g': None, # day
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
430 '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
431 'a': [1], # period
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
432 'h': [1, 2], 'H': [1, 2], 'K': [1, 2], 'k': [1, 2], # hour
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
433 'm': [1, 2], # minute
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
434 's': [1, 2], 'S': None, 'A': None, # second
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
435 'z': [1, 2, 3, 4], 'Z': [1, 2, 3, 4], 'v': [1, 4] # zone
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
436 }
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
437
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
438 def parse_pattern(pattern):
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
439 """Parse date, time, and datetime format patterns.
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
440
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
441 >>> parse_pattern("MMMMd").format
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
442 u'%(MMMM)s%(d)s'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
443 >>> parse_pattern("MMM d, yyyy").format
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
444 u'%(MMM)s %(d)s, %(yyyy)s'
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
445
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
446 Pattern can contain literal strings in single quotes:
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
447
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
448 >>> parse_pattern("H:mm' Uhr 'z").format
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
449 u'%(H)s:%(mm)s Uhr %(z)s'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
450
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
451 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
452 characters:
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
453
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
454 >>> parse_pattern("hh' o''clock'").format
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
455 u"%(hh)s o'clock"
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
456
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
457 :param pattern: the formatting pattern to parse
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
458 """
12
a2c54ef107c2 * Removed pkg_resources/setuptools requirement from various places.
cmlenz
parents: 8
diff changeset
459 if type(pattern) is DateTimePattern:
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
460 return pattern
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
461
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
462 result = []
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
463 quotebuf = None
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
464 charbuf = []
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
465 fieldchar = ['']
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
466 fieldnum = [0]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
467
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
468 def append_chars():
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
469 result.append(''.join(charbuf).replace('%', '%%'))
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
470 del charbuf[:]
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
471
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
472 def append_field():
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
473 limit = PATTERN_CHARS[fieldchar[0]]
15
76985c08a339 Minor date formatting improvements.
cmlenz
parents: 12
diff changeset
474 if limit and fieldnum[0] not in limit:
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
475 raise ValueError('Invalid length for field: %r'
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
476 % (fieldchar[0] * fieldnum[0]))
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
477 result.append('%%(%s)s' % (fieldchar[0] * fieldnum[0]))
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
478 fieldchar[0] = ''
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
479 fieldnum[0] = 0
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
480
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
481 for idx, char in enumerate(pattern.replace("''", '\0')):
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
482 if quotebuf is None:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
483 if char == "'": # quote started
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
484 if fieldchar[0]:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
485 append_field()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
486 elif charbuf:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
487 append_chars()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
488 quotebuf = []
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
489 elif char in PATTERN_CHARS:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
490 if charbuf:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
491 append_chars()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
492 if char == fieldchar[0]:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
493 fieldnum[0] += 1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
494 else:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
495 if fieldchar[0]:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
496 append_field()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
497 fieldchar[0] = char
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
498 fieldnum[0] = 1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
499 else:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
500 if fieldchar[0]:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
501 append_field()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
502 charbuf.append(char)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
503
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
504 elif quotebuf is not None:
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
505 if char == "'": # end of quote
1
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
506 charbuf.extend(quotebuf)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
507 quotebuf = None
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
508 else: # inside quote
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
509 quotebuf.append(char)
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
510
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
511 if fieldchar[0]:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
512 append_field()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
513 elif charbuf:
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
514 append_chars()
f71ca60f2a4a Import of initial code base.
cmlenz
parents:
diff changeset
515
16
ed154241c08d Handle escape chars in datetime patterns.
cmlenz
parents: 15
diff changeset
516 return DateTimePattern(pattern, u''.join(result).replace('\0', "'"))
Copyright (C) 2012-2017 Edgewall Software