#!/usr/bin/env python # -*- coding: utf-8 -*- ''' This module was borrowed and modified from: https://github.com/wroberts/pytimeparse timeparse.py (c) Will Roberts 1 February, 2014 Implements a single function, `timeparse`, which can parse various kinds of time expressions. ''' # MIT LICENSE # # Permission is hereby granted, free of charge, to any person # obtaining a copy of this software and associated documentation files # (the "Software"), to deal in the Software without restriction, # including without limitation the rights to use, copy, modify, merge, # publish, distribute, sublicense, and/or sell copies of the Software, # and to permit persons to whom the Software is furnished to do so, # subject to the following conditions: # # The above copyright notice and this permission notice shall be # included in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. import re SIGN = r'(?P[+|-])?' DAYS = r'(?P[\d.]+)\s*(?:d|dys?|days?)' HOURS = r'(?P[\d.]+)\s*(?:h|hrs?|hours?)' MINS = r'(?P[\d.]+)\s*(?:m|(mins?)|(minutes?))' SECS = r'(?P[\d.]+)\s*(?:s|secs?|seconds?)' SEPARATORS = r'[,/]' SECCLOCK = r':(?P\d{2}(?:\.\d+)?)' MINCLOCK = r'(?P\d{1,2}):(?P\d{2}(?:\.\d+)?)' HOURCLOCK = r'(?P\d+):(?P\d{2}):(?P\d{2}(?:\.\d+)?)' DAYCLOCK = r'(?P\d+):(?P\d{2}):(?P\d{2}):(?P\d{2}(?:\.\d+)?)' def _opt(string): return f'(?:{string})?' def _optsep(string): return fr'(?:{string}\s*(?:{SEPARATORS}\s*)?)?' TIMEFORMATS = [ fr'{_optsep(DAYS)}\s*{_optsep(HOURS)}\s*{_optsep(MINS)}\s*{_opt(SECS)}', f'{MINCLOCK}', fr'{_optsep(DAYS)}\s*{HOURCLOCK}', f'{DAYCLOCK}', f'{SECCLOCK}', ] COMPILED_SIGN = re.compile(r'\s*' + SIGN + r'\s*(?P.*)$') COMPILED_TIMEFORMATS = [re.compile(r'\s*' + timefmt + r'\s*$', re.I) for timefmt in TIMEFORMATS] MULTIPLIERS = { 'days': 60 * 60 * 24, 'hours': 60 * 60, 'mins': 60, 'secs': 1, } def timeparse(sval): ''' Parse a time expression, returning it as a number of seconds. If possible, the return value will be an `int`; if this is not possible, the return will be a `float`. Returns `None` if a time expression cannot be parsed from the given string. Arguments: - `sval`: the string value to parse >>> timeparse('1:24') 84 >>> timeparse(':22') 22 >>> timeparse('1 minute, 24 secs') 84 >>> timeparse('1m24s') 84 >>> timeparse('1.2 minutes') 72 >>> timeparse('1.2 seconds') 1.2 Time expressions can be signed. >>> timeparse('- 1 minute') -60 >>> timeparse('+ 1 minute') 60 ''' try: return float(sval) except TypeError: pass except ValueError: match = COMPILED_SIGN.match(sval) sign = -1 if match.groupdict()['sign'] == '-' else 1 sval = match.groupdict()['unsigned'] for timefmt in COMPILED_TIMEFORMATS: match = timefmt.match(sval) if match and match.group(0).strip(): mdict = match.groupdict() # if all of the fields are integer numbers if all(v.isdigit() for v in list(mdict.values()) if v): return sign * sum((MULTIPLIERS[k] * int(v, 10) for (k, v) in list(mdict.items()) if v is not None)) # if SECS is an integer number if 'secs' not in mdict or mdict['secs'] is None or mdict['secs'].isdigit(): # we will return an integer return sign * int( sum( ( MULTIPLIERS[k] * float(v) for (k, v) in list(mdict.items()) if k != 'secs' and v is not None ) ) ) + (int(mdict['secs'], 10) if mdict['secs'] else 0) # SECS is a float, we will return a float return sign * sum((MULTIPLIERS[k] * float(v) for (k, v) in list(mdict.items()) if v is not None)) return None