_strptime.py 19.3 KB
Newer Older
1 2 3
"""Strptime-related classes and functions.

CLASSES:
4
    LocaleTime -- Discovers and stores locale-specific time information
5
    TimeRE -- Creates regexes for pattern matching a string of text containing
6
                time information
7 8

FUNCTIONS:
9
    _getlang -- Figure out what language is being used for the locale
10 11 12 13 14 15 16
    strptime -- Calculates the time struct represented by the passed-in string

"""
import time
import locale
import calendar
from re import compile as re_compile
17
from re import IGNORECASE, ASCII
18
from re import escape as re_escape
19
from datetime import date as datetime_date
20
try:
21
    from _thread import allocate_lock as _thread_allocate_lock
22
except:
23
    from _dummy_thread import allocate_lock as _thread_allocate_lock
24

Christian Heimes's avatar
Christian Heimes committed
25
__all__ = []
26

27 28
def _getlang():
    # Figure out what the current language is set to.
29
    return locale.getlocale(locale.LC_TIME)
30

31 32 33
class LocaleTime(object):
    """Stores and handles locale-specific information related to time.

34
    ATTRIBUTES:
35 36
        f_weekday -- full weekday names (7-item list)
        a_weekday -- abbreviated weekday names (7-item list)
37
        f_month -- full month names (13-item list; dummy value in [0], which
38
                    is added by code)
39
        a_month -- abbreviated month names (13-item list, dummy value in
40 41 42 43 44
                    [0], which is added by code)
        am_pm -- AM/PM representation (2-item list)
        LC_date_time -- format string for date/time representation (string)
        LC_date -- format string for date representation (string)
        LC_time -- format string for time representation (string)
Tim Peters's avatar
Tim Peters committed
45
        timezone -- daylight- and non-daylight-savings timezone representation
46 47
                    (2-item list of sets)
        lang -- Language used by instance (2-item tuple)
48 49
    """

50 51
    def __init__(self):
        """Set all attributes.
52

53 54 55 56 57 58 59 60 61 62 63
        Order of methods called matters for dependency reasons.

        The locale language is set at the offset and then checked again before
        exiting.  This is to make sure that the attributes were not set with a
        mix of information from more than one locale.  This would most likely
        happen when using threads where one thread calls a locale-dependent
        function while another thread changes the locale while the function in
        the other thread is still running.  Proper coding would call for
        locks to prevent changing the locale while locale-dependent code is
        running.  The check here is done in case someone does not think about
        doing this.
64 65 66 67

        Only other possible issue is if someone changed the timezone and did
        not call tz.tzset .  That is an issue for the programmer, though,
        since changing the timezone is worthless without that call.
68

69 70 71 72 73 74 75 76 77
        """
        self.lang = _getlang()
        self.__calc_weekday()
        self.__calc_month()
        self.__calc_am_pm()
        self.__calc_timezone()
        self.__calc_date_time()
        if _getlang() != self.lang:
            raise ValueError("locale changed during initialization")
78 79

    def __pad(self, seq, front):
80
        # Add '' to seq to either the front (is True), else the back.
81
        seq = list(seq)
82 83 84 85
        if front:
            seq.insert(0, '')
        else:
            seq.append('')
86 87 88
        return seq

    def __calc_weekday(self):
89
        # Set self.a_weekday and self.f_weekday using the calendar
90
        # module.
91 92 93 94
        a_weekday = [calendar.day_abbr[i].lower() for i in range(7)]
        f_weekday = [calendar.day_name[i].lower() for i in range(7)]
        self.a_weekday = a_weekday
        self.f_weekday = f_weekday
Tim Peters's avatar
Tim Peters committed
95

96
    def __calc_month(self):
97 98 99 100 101
        # Set self.f_month and self.a_month using the calendar module.
        a_month = [calendar.month_abbr[i].lower() for i in range(13)]
        f_month = [calendar.month_name[i].lower() for i in range(13)]
        self.a_month = a_month
        self.f_month = f_month
102 103

    def __calc_am_pm(self):
104
        # Set self.am_pm by using time.strftime().
Tim Peters's avatar
Tim Peters committed
105

106 107 108
        # The magic date (1999,3,17,hour,44,55,2,76,0) is not really that
        # magical; just happened to have used it everywhere else where a
        # static date was needed.
109
        am_pm = []
110
        for hour in (1, 22):
111
            time_tuple = time.struct_time((1999,3,17,hour,44,55,2,76,0))
112 113
            am_pm.append(time.strftime("%p", time_tuple).lower())
        self.am_pm = am_pm
114 115

    def __calc_date_time(self):
116
        # Set self.date_time, self.date, & self.time by using
117
        # time.strftime().
118

119 120 121 122
        # Use (1999,3,17,22,44,55,2,76,0) for magic date because the amount of
        # overloaded numbers is minimized.  The order in which searches for
        # values within the format string is very important; it eliminates
        # possible ambiguity for what something represents.
123 124
        time_tuple = time.struct_time((1999,3,17,22,44,55,2,76,0))
        date_time = [None, None, None]
125 126 127 128
        date_time[0] = time.strftime("%c", time_tuple).lower()
        date_time[1] = time.strftime("%x", time_tuple).lower()
        date_time[2] = time.strftime("%X", time_tuple).lower()
        replacement_pairs = [('%', '%%'), (self.f_weekday[2], '%A'),
129 130 131 132 133 134
                    (self.f_month[3], '%B'), (self.a_weekday[2], '%a'),
                    (self.a_month[3], '%b'), (self.am_pm[1], '%p'),
                    ('1999', '%Y'), ('99', '%y'), ('22', '%H'),
                    ('44', '%M'), ('55', '%S'), ('76', '%j'),
                    ('17', '%d'), ('03', '%m'), ('3', '%m'),
                    # '3' needed for when no leading zero.
135 136 137 138 139 140
                    ('2', '%w'), ('10', '%I')]
        replacement_pairs.extend([(tz, "%Z") for tz_values in self.timezone
                                                for tz in tz_values])
        for offset,directive in ((0,'%c'), (1,'%x'), (2,'%X')):
            current_format = date_time[offset]
            for old, new in replacement_pairs:
141 142 143 144 145
                # Must deal with possible lack of locale info
                # manifesting itself as the empty string (e.g., Swedish's
                # lack of AM/PM info) or a platform returning a tuple of empty
                # strings (e.g., MacOS 9 having timezone as ('','')).
                if old:
146
                    current_format = current_format.replace(old, new)
147 148 149
            # If %W is used, then Sunday, 2005-01-03 will fall on week 0 since
            # 2005-01-03 occurs before the first Monday of the year.  Otherwise
            # %U is used.
150
            time_tuple = time.struct_time((1999,1,3,1,1,1,6,3,0))
151
            if '00' in time.strftime(directive, time_tuple):
152
                U_W = '%W'
153 154
            else:
                U_W = '%U'
155
            date_time[offset] = current_format.replace('11', U_W)
156 157
        self.LC_date_time = date_time[0]
        self.LC_date = date_time[1]
158
        self.LC_time = date_time[2]
159 160

    def __calc_timezone(self):
161
        # Set self.timezone by using time.tzname.
162 163
        # Do not worry about possibility of time.tzname[0] == timetzname[1]
        # and time.daylight; handle that in strptime .
164 165 166 167
        try:
            time.tzset()
        except AttributeError:
            pass
168
        no_saving = frozenset(["utc", "gmt", time.tzname[0].lower()])
169
        if time.daylight:
170
            has_saving = frozenset([time.tzname[1].lower()])
171
        else:
172
            has_saving = frozenset()
173
        self.timezone = (no_saving, has_saving)
174 175 176 177 178


class TimeRE(dict):
    """Handle conversion from format directives to regexes."""

179
    def __init__(self, locale_time=None):
180
        """Create keys/values.
181

182
        Order of execution is important for dependency reasons.
183

184 185 186 187 188
        """
        if locale_time:
            self.locale_time = locale_time
        else:
            self.locale_time = LocaleTime()
189
        base = super()
190
        base.__init__({
191
            # The " \d" part of the regex is to make %c from ANSI C work
192
            'd': r"(?P<d>3[0-1]|[1-2]\d|0[1-9]|[1-9]| [1-9])",
Christian Heimes's avatar
Christian Heimes committed
193
            'f': r"(?P<f>[0-9]{1,6})",
194
            'H': r"(?P<H>2[0-3]|[0-1]\d|\d)",
195 196 197
            'I': r"(?P<I>1[0-2]|0[1-9]|[1-9])",
            'j': r"(?P<j>36[0-6]|3[0-5]\d|[1-2]\d\d|0[1-9]\d|00[1-9]|[1-9]\d|0[1-9]|[1-9])",
            'm': r"(?P<m>1[0-2]|0[1-9]|[1-9])",
198 199 200 201
            'M': r"(?P<M>[0-5]\d|\d)",
            'S': r"(?P<S>6[0-1]|[0-5]\d|\d)",
            'U': r"(?P<U>5[0-3]|[0-4]\d|\d)",
            'w': r"(?P<w>[0-6])",
202
            # W is set below by using 'U'
203
            'y': r"(?P<y>\d\d)",
204 205 206 207 208 209 210 211
            #XXX: Does 'Y' need to worry about having less or more than
            #     4 digits?
            'Y': r"(?P<Y>\d\d\d\d)",
            'A': self.__seqToRE(self.locale_time.f_weekday, 'A'),
            'a': self.__seqToRE(self.locale_time.a_weekday, 'a'),
            'B': self.__seqToRE(self.locale_time.f_month[1:], 'B'),
            'b': self.__seqToRE(self.locale_time.a_month[1:], 'b'),
            'p': self.__seqToRE(self.locale_time.am_pm, 'p'),
212 213
            'Z': self.__seqToRE((tz for tz_names in self.locale_time.timezone
                                        for tz in tz_names),
214 215
                                'Z'),
            '%': '%'})
216
        base.__setitem__('W', base.__getitem__('U').replace('U', 'W'))
217 218 219
        base.__setitem__('c', self.pattern(self.locale_time.LC_date_time))
        base.__setitem__('x', self.pattern(self.locale_time.LC_date))
        base.__setitem__('X', self.pattern(self.locale_time.LC_time))
Tim Peters's avatar
Tim Peters committed
220

221
    def __seqToRE(self, to_convert, directive):
222
        """Convert a list to a regex string for matching a directive.
223

224 225 226 227
        Want possible matching values to be from longest to shortest.  This
        prevents the possibility of a match occuring for a value that also
        a substring of a larger value that should have matched (e.g., 'abc'
        matching when 'abcdef' should have been the match).
228

229
        """
230
        to_convert = sorted(to_convert, key=len, reverse=True)
231 232 233 234 235
        for value in to_convert:
            if value != '':
                break
        else:
            return ''
236
        regex = '|'.join(re_escape(stuff) for stuff in to_convert)
237
        regex = '(?P<%s>%s' % (directive, regex)
238 239 240
        return '%s)' % regex

    def pattern(self, format):
241
        """Return regex pattern for the format string.
Tim Peters's avatar
Tim Peters committed
242

243
        Need to make sure that any characters that might be interpreted as
244
        regex syntax are escaped.
Tim Peters's avatar
Tim Peters committed
245

246
        """
247
        processed_format = ''
248
        # The sub() call escapes all characters that might be misconstrued
249 250
        # as regex syntax.  Cannot use re.escape since we have to deal with
        # format directives (%m, etc.).
251
        regex_chars = re_compile(r"([\\.^$*+?\(\){}\[\]|])")
252
        format = regex_chars.sub(r"\\\1", format)
253
        whitespace_replacement = re_compile('\s+')
254
        format = whitespace_replacement.sub('\s+', format)
255
        while '%' in format:
256
            directive_index = format.index('%')+1
Tim Peters's avatar
Tim Peters committed
257
            processed_format = "%s%s%s" % (processed_format,
258 259
                                           format[:directive_index-1],
                                           self[format[directive_index]])
260 261 262 263 264
            format = format[directive_index+1:]
        return "%s%s" % (processed_format, format)

    def compile(self, format):
        """Return a compiled re object for the format string."""
265
        return re_compile(self.pattern(format), IGNORECASE | ASCII)
266

267 268 269 270
_cache_lock = _thread_allocate_lock()
# DO NOT modify _TimeRE_cache or _regex_cache without acquiring the cache lock
# first!
_TimeRE_cache = TimeRE()
271
_CACHE_MAX_SIZE = 5 # Max number of regexes stored in _regex_cache
272
_regex_cache = {}
273

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
def _calc_julian_from_U_or_W(year, week_of_year, day_of_week, week_starts_Mon):
    """Calculate the Julian day based on the year, week of the year, and day of
    the week, with week_start_day representing whether the week of the year
    assumes the week starts on Sunday or Monday (6 or 0)."""
    first_weekday = datetime_date(year, 1, 1).weekday()
    # If we are dealing with the %U directive (week starts on Sunday), it's
    # easier to just shift the view to Sunday being the first day of the
    # week.
    if not week_starts_Mon:
        first_weekday = (first_weekday + 1) % 7
        day_of_week = (day_of_week + 1) % 7
    # Need to watch out for a week 0 (when the first day of the year is not
    # the same as that specified by %U or %W).
    week_0_length = (7 - first_weekday) % 7
    if week_of_year == 0:
        return 1 + day_of_week - first_weekday
    else:
        days_to_week = week_0_length + (7 * (week_of_year - 1))
        return 1 + days_to_week + day_of_week


Christian Heimes's avatar
Christian Heimes committed
295
def _strptime(data_string, format="%a %b %d %H:%M:%S %Y"):
296
    """Return a time struct based on the input string and the format string."""
297
    global _TimeRE_cache, _regex_cache
298
    with _cache_lock:
299
        if _getlang() != _TimeRE_cache.locale_time.lang:
300
            _TimeRE_cache = TimeRE()
301
            _regex_cache.clear()
302 303
        if len(_regex_cache) > _CACHE_MAX_SIZE:
            _regex_cache.clear()
304
        locale_time = _TimeRE_cache.locale_time
305 306
        format_regex = _regex_cache.get(format)
        if not format_regex:
307
            try:
308
                format_regex = _TimeRE_cache.compile(format)
309 310
            # KeyError raised when a bad format is found; can be specified as
            # \\, in which case it was a stray % but with a space after it
311
            except KeyError as err:
312 313 314 315 316 317 318 319 320
                bad_directive = err.args[0]
                if bad_directive == "\\":
                    bad_directive = "%"
                del err
                raise ValueError("'%s' is a bad directive in format '%s'" %
                                    (bad_directive, format))
            # IndexError only occurs when the format string is "%"
            except IndexError:
                raise ValueError("stray %% in format '%s'" % format)
321
            _regex_cache[format] = format_regex
322
    found = format_regex.match(data_string)
323
    if not found:
324
        raise ValueError("time data %r does not match format %r" %
325
                         (data_string, format))
326 327 328
    if len(data_string) != found.end():
        raise ValueError("unconverted data remains: %s" %
                          data_string[found.end():])
329 330
    year = 1900
    month = day = 1
Christian Heimes's avatar
Christian Heimes committed
331
    hour = minute = second = fraction = 0
332
    tz = -1
Brett Cannon's avatar
Brett Cannon committed
333 334
    # Default to -1 to signify that values not known; not critical to have,
    # though
335 336
    week_of_year = -1
    week_of_year_start = -1
Brett Cannon's avatar
Brett Cannon committed
337 338
    # weekday and julian defaulted to -1 so as to signal need to calculate
    # values
339 340
    weekday = julian = -1
    found_dict = found.groupdict()
341
    for group_key in found_dict.keys():
342 343 344 345 346
        # Directives not explicitly handled below:
        #   c, x, X
        #      handled by making out of other directives
        #   U, W
        #      worthless without day of the week
347 348 349 350 351 352 353 354 355 356 357 358 359 360
        if group_key == 'y':
            year = int(found_dict['y'])
            # Open Group specification for strptime() states that a %y
            #value in the range of [00, 68] is in the century 2000, while
            #[69,99] is in the century 1900
            if year <= 68:
                year += 2000
            else:
                year += 1900
        elif group_key == 'Y':
            year = int(found_dict['Y'])
        elif group_key == 'm':
            month = int(found_dict['m'])
        elif group_key == 'B':
361
            month = locale_time.f_month.index(found_dict['B'].lower())
362
        elif group_key == 'b':
363
            month = locale_time.a_month.index(found_dict['b'].lower())
364 365
        elif group_key == 'd':
            day = int(found_dict['d'])
366
        elif group_key == 'H':
367 368 369 370 371
            hour = int(found_dict['H'])
        elif group_key == 'I':
            hour = int(found_dict['I'])
            ampm = found_dict.get('p', '').lower()
            # If there was no AM/PM indicator, we'll treat this like AM
372
            if ampm in ('', locale_time.am_pm[0]):
373 374 375 376 377
                # We're in AM so the hour is correct unless we're
                # looking at 12 midnight.
                # 12 midnight == 12 AM == hour 0
                if hour == 12:
                    hour = 0
378
            elif ampm == locale_time.am_pm[1]:
379 380 381 382 383 384 385 386 387
                # We're in PM so we need to add 12 to the hour unless
                # we're looking at 12 noon.
                # 12 noon == 12 PM == hour 12
                if hour != 12:
                    hour += 12
        elif group_key == 'M':
            minute = int(found_dict['M'])
        elif group_key == 'S':
            second = int(found_dict['S'])
Christian Heimes's avatar
Christian Heimes committed
388 389 390 391 392
        elif group_key == 'f':
            s = found_dict['f']
            # Pad to always return microseconds.
            s += "0" * (6 - len(s))
            fraction = int(s)
393
        elif group_key == 'A':
394
            weekday = locale_time.f_weekday.index(found_dict['A'].lower())
395
        elif group_key == 'a':
396
            weekday = locale_time.a_weekday.index(found_dict['a'].lower())
397 398 399 400 401 402 403 404
        elif group_key == 'w':
            weekday = int(found_dict['w'])
            if weekday == 0:
                weekday = 6
            else:
                weekday -= 1
        elif group_key == 'j':
            julian = int(found_dict['j'])
405 406 407
        elif group_key in ('U', 'W'):
            week_of_year = int(found_dict[group_key])
            if group_key == 'U':
408
                # U starts week on Sunday.
409 410
                week_of_year_start = 6
            else:
411
                # W starts week on Monday.
412
                week_of_year_start = 0
413
        elif group_key == 'Z':
414 415
            # Since -1 is default value only need to worry about setting tz if
            # it can be something other than -1.
416
            found_zone = found_dict['Z'].lower()
417 418 419 420 421
            for value, tz_values in enumerate(locale_time.timezone):
                if found_zone in tz_values:
                    # Deal with bad locale setup where timezone names are the
                    # same and yet time.daylight is true; too ambiguous to
                    # be able to tell what timezone has daylight savings
422 423
                    if (time.tzname[0] == time.tzname[1] and
                       time.daylight and found_zone not in ("utc", "gmt")):
Tim Peters's avatar
Tim Peters committed
424
                        break
425
                    else:
426
                        tz = value
427
                        break
428
    # If we know the week of the year and what day of that week, we can figure
429
    # out the Julian day of the year.
430
    if julian == -1 and week_of_year != -1 and weekday != -1:
431 432 433
        week_starts_Mon = True if week_of_year_start == 0 else False
        julian = _calc_julian_from_U_or_W(year, week_of_year, weekday,
                                            week_starts_Mon)
434
    # Cannot pre-calculate datetime_date() since can change in Julian
435 436
    # calculation and thus could have different value for the day of the week
    # calculation.
437
    if julian == -1:
438 439 440 441
        # Need to add 1 to result since first day of the year is 1, not 0.
        julian = datetime_date(year, month, day).toordinal() - \
                  datetime_date(year, 1, 1).toordinal() + 1
    else:  # Assume that if they bothered to include Julian day it will
442
           # be accurate.
443 444 445 446
        datetime_result = datetime_date.fromordinal((julian - 1) + datetime_date(year, 1, 1).toordinal())
        year = datetime_result.year
        month = datetime_result.month
        day = datetime_result.day
447
    if weekday == -1:
448
        weekday = datetime_date(year, month, day).weekday()
Christian Heimes's avatar
Christian Heimes committed
449 450 451 452 453 454
    return (time.struct_time((year, month, day,
                              hour, minute, second,
                              weekday, julian, tz)), fraction)

def _strptime_time(data_string, format="%a %b %d %H:%M:%S %Y"):
    return _strptime(data_string, format)[0]