tr/cwmpdate.py

# Copyright 2011 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Time handling for CWMP.

CWMP uses ISO 8601 time strings, and further specifies that UTC time be
used unless otherwise specified (and then, to my knowledge, never
specifies a case where another timezone can be used).

Python datetime objects are suitable for use with CWMP so long as
they contain a tzinfo specifying UTC offset=0. Most Python programmers
create datetime objects with no tzinfo, so we add one.
"""

__author__ = 'dgentry@google.com (Denton Gentry)'

# TODO(apenwarr): move this code into tr.cwmptypes.Date.
#  (tr.cwmptypes.Date currently calls these functions and so do other places;
#   the other places should be removed eventually)

import datetime


def format(arg):  # pylint:disable=redefined-builtin
  """Print a datetime with 'Z' for the UTC timezone, as CWMP requires."""
  if not arg:
    return '0001-01-01T00:00:00Z'  # CWMP Unknown Time
  elif isinstance(arg, float):
    dt = datetime.datetime.utcfromtimestamp(arg)
  else:
    dt = arg

  if not dt.tzinfo or not dt.tzinfo.utcoffset(dt):
    if dt.microsecond:
      return dt.strftime('%Y-%m-%dT%H:%M:%S.%fZ')
    else:
      return dt.strftime('%Y-%m-%dT%H:%M:%SZ')
  else:
    return dt.isoformat()


def parse(arg):
  # TODO(dgentry) handle timezone properly
  try:
    dt = datetime.datetime.strptime(arg, '%Y-%m-%dT%H:%M:%SZ')
  except ValueError:
    dt = datetime.datetime.strptime(arg, '%Y-%m-%dT%H:%M:%S.%fZ')
  return dt


def valid(arg):
  # pylint:disable=bare-except
  try:
    parse(arg)
  except:
    return False
  return True