sfa/util/sfatime.py

   1 #----------------------------------------------------------------------
   2 # Copyright (c) 2008 Board of Trustees, Princeton University
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining
   5 # a copy of this software and/or hardware specification (the "Work") to
   6 # deal in the Work without restriction, including without limitation the
   7 # rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 # and/or sell copies of the Work, and to permit persons to whom the Work
   9 # is furnished to do so, subject to the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be
  12 # included in all copies or substantial portions of the Work.
  13 #
  14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
  21 # IN THE WORK.
  22 #----------------------------------------------------------------------
  23 from types import StringTypes
  24 import time
  25 import datetime
  26 import dateutil.parser
  27 import calendar
  28 import re
  29
  30 from sfa.util.sfalogging import logger
  31
  32 SFATIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
  33
  34 def utcparse(input):
  35     """ Translate a string into a time using dateutil.parser.parse but make sure it's in UTC time and strip
  36 the timezone, so that it's compatible with normal datetime.datetime objects.
  37
  38 For safety this can also handle inputs that are either timestamps, or datetimes
  39 """
  40
  41     def handle_shorthands (input):
  42         """recognize string like +5d or +3w or +2m as
  43         2 days, 3 weeks or 2 months from now"""
  44         if input.startswith('+'):
  45             match=re.match (r"([0-9]+)([dwm])",input[1:])
  46             if match:
  47                 how_many=int(match.group(1))
  48                 what=match.group(2)
  49                 if what == 'd':         d=datetime.timedelta(days=how_many)
  50                 elif what == 'w':       d=datetime.timedelta(weeks=how_many)
  51                 elif what == 'm':       d=datetime.timedelta(weeks=4*how_many)
  52                 return datetime.datetime.utcnow()+d
  53
  54     # prepare the input for the checks below by
  55     # casting strings ('1327098335') to ints
  56     if isinstance(input, StringTypes):
  57         try:
  58             input = int(input)
  59         except ValueError:
  60             try:
  61                 new_input=handle_shorthands(input)
  62                 if new_input is not None: input=new_input
  63             except:
  64                 import traceback
  65                 traceback.print_exc()
  66
  67     #################### here we go
  68     if isinstance (input, datetime.datetime):
  69         #logger.info ("argument to utcparse already a datetime - doing nothing")
  70         return input
  71     elif isinstance (input, StringTypes):
  72         t = dateutil.parser.parse(input)
  73         if t.utcoffset() is not None:
  74             t = t.utcoffset() + t.replace(tzinfo=None)
  75         return t
  76     elif isinstance (input, (int,float,long)):
  77         return datetime.datetime.fromtimestamp(input)
  78     else:
  79         logger.error("Unexpected type in utcparse [%s]"%type(input))
  80
  81 def datetime_to_string(dt):
  82     return datetime.datetime.strftime(dt, SFATIME_FORMAT)
  83
  84 def datetime_to_utc(dt):
  85     return time.gmtime(datetime_to_epoch(dt))
  86
  87 # see https://docs.python.org/2/library/time.html
  88 # all timestamps are in UTC so time.mktime() would be *wrong*
  89 def datetime_to_epoch(dt):
  90     return int(calendar.timegm(dt.timetuple()))
  91
  92 def add_datetime(input, days=0, hours=0, minutes=0, seconds=0):
  93     """
  94     Adjust the input date by the specified delta (in seconds).
  95     """
  96     dt = utcparse(input)
  97     return dt + datetime.timedelta(days=days, hours=hours, minutes=minutes, seconds=seconds)
  98
  99 if __name__ == '__main__':
 100         # checking consistency
 101     print 20*'X'
 102     print ("Should be close to zero: %s"%(datetime_to_epoch(datetime.datetime.utcnow())-time.time()))
 103     print 20*'X'
 104     for input in [
 105             '+2d',
 106             '+3w',
 107             '+2m',
 108             1401282977.575632,
 109             1401282977,
 110             '1401282977',
 111             '2014-05-28',
 112             '2014-05-28T15:18',
 113             '2014-05-28T15:18:30',
 114     ]:
 115         print "input=%20s -> parsed %s"%(input,datetime_to_string(utcparse(input)))