# -*- coding: utf-8 -*-
"""Cocoa timestamp implementation."""
import decimal
from dfdatetime import definitions
from dfdatetime import factory
from dfdatetime import interface
[docs]
class CocoaTimeEpoch(interface.DateTimeEpoch):
"""Cocoa time epoch."""
[docs]
def __init__(self):
"""Initializes a Cocoa time epoch."""
super(CocoaTimeEpoch, self).__init__(2001, 1, 1)
[docs]
class CocoaTime(interface.DateTimeValues):
"""Cocoa timestamp.
The Cocoa timestamp is a floating point value that contains the number of
seconds since 2001-01-01 00:00:00 (also known as the Cocoa epoch).
Negative values represent date and times predating the Cocoa epoch.
Attributes:
is_local_time (bool): True if the date and time value is in local time.
"""
# The difference between January 1, 2001 and January 1, 1970 in seconds.
_COCOA_TO_POSIX_BASE = -978307200
_EPOCH = CocoaTimeEpoch()
[docs]
def __init__(self, precision=None, time_zone_offset=None, timestamp=None):
"""Initializes a Cocoa timestamp.
Args:
precision (Optional[str]): precision of the date and time value, which
should be one of the PRECISION_VALUES in definitions.
time_zone_offset (Optional[int]): time zone offset in number of minutes
from UTC or None if not set.
timestamp (Optional[float]): Cocoa timestamp.
"""
super(CocoaTime, self).__init__(
precision=precision or definitions.PRECISION_1_SECOND,
time_zone_offset=time_zone_offset)
self._timestamp = timestamp
@property
def timestamp(self):
"""float: Cocoa timestamp or None if not set."""
return self._timestamp
def _GetNormalizedTimestamp(self):
"""Retrieves the normalized timestamp.
Returns:
float: normalized timestamp, which contains the number of seconds since
January 1, 1970 00:00:00 and a fraction of second used for increased
precision, or None if the normalized timestamp cannot be determined.
"""
if self._normalized_timestamp is None:
if self._timestamp is not None:
self._normalized_timestamp = (
decimal.Decimal(self._timestamp) - self._COCOA_TO_POSIX_BASE)
if self._time_zone_offset:
self._normalized_timestamp -= self._time_zone_offset * 60
return self._normalized_timestamp
[docs]
def CopyFromDateTimeString(self, time_string):
"""Copies a Cocoa timestamp from a date and time string.
Args:
time_string (str): date and time value formatted as:
YYYY-MM-DD hh:mm:ss.######[+-]##:##
Where # are numeric digits ranging from 0 to 9 and the seconds
fraction can be either 3, 6 or 9 digits. The time of day, seconds
fraction and time zone offset are optional. The default time zone
is UTC.
Raises:
ValueError: if the time string is invalid or not supported.
"""
date_time_values = self._CopyDateTimeFromString(time_string)
year = date_time_values.get('year', 0)
month = date_time_values.get('month', 0)
day_of_month = date_time_values.get('day_of_month', 0)
hours = date_time_values.get('hours', 0)
minutes = date_time_values.get('minutes', 0)
seconds = date_time_values.get('seconds', 0)
nanoseconds = date_time_values.get('nanoseconds', 0)
time_zone_offset = date_time_values.get('time_zone_offset', None)
timestamp = self._GetNumberOfSecondsFromElements(
year, month, day_of_month, hours, minutes, seconds)
timestamp += self._COCOA_TO_POSIX_BASE
timestamp = float(timestamp)
timestamp += float(nanoseconds) / definitions.NANOSECONDS_PER_SECOND
self._normalized_timestamp = None
self._timestamp = timestamp
self._time_zone_offset = time_zone_offset
[docs]
def CopyToDateTimeString(self):
"""Copies the Cocoa timestamp to a date and time string.
Returns:
str: date and time value formatted as: YYYY-MM-DD hh:mm:ss.###### or
None if the timestamp cannot be copied to a date and time string.
"""
if self._timestamp is None:
return None
number_of_days, hours, minutes, seconds = self._GetTimeValues(
int(self._timestamp))
year, month, day_of_month = self._GetDateValuesWithEpoch(
number_of_days, self._EPOCH)
microseconds = int(
(self._timestamp % 1) * definitions.MICROSECONDS_PER_SECOND)
return (f'{year:04d}-{month:02d}-{day_of_month:02d} '
f'{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}')
factory.Factory.RegisterDateTimeValues(CocoaTime)