import datetime
import re
from collections import UserString
from typing import Any
from typing import Dict
from typing import NamedTuple
from typing import Optional
from xsdata.utils.collections import Immutable
from xsdata.utils.dates import calculate_duration
from xsdata.utils.dates import calculate_offset
from xsdata.utils.dates import calculate_timezone
from xsdata.utils.dates import format_date
from xsdata.utils.dates import format_offset
from xsdata.utils.dates import format_time
from xsdata.utils.dates import parse_date_args
from xsdata.utils.dates import validate_date
from xsdata.utils.dates import validate_time
xml_duration_re = re.compile(
r"^([-]?)P"
r"(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)D)?"
r"(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(.\d+)?)S)?)?$"
)
class DateFormat:
DATE = "%Y-%m-%d%z"
TIME = "%H:%M:%S%z"
DATE_TIME = "%Y-%m-%dT%H:%M:%S%z"
G_DAY = "---%d%z"
G_MONTH = "--%m%z"
G_MONTH_DAY = "--%m-%d%z"
G_YEAR = "%Y%z"
G_YEAR_MONTH = "%Y-%m%z"
[docs]class XmlDate(Immutable):
"""
Concrete xs:date builtin type.
Represents iso 8601 date format [-]CCYY-MM-DD[Z|(+|-)hh:mm] with
rich comparisons and hashing.
:param year: Any signed integer, eg (0, -535, 2020)
:param month: Unsigned integer between 1-12
:param day: Unsigned integer between 1-31
:param offset: Signed integer representing timezone offset in
minutes
"""
__slots__ = ("year", "month", "day", "offset")
def __init__(self, year: int, month: int, day: int, offset: Optional[int] = None):
self.year = year
self.month = month
self.day = day
self.offset = offset
validate_date(year, month, day)
self._hashcode = -1 # Lock the object
[docs] def replace(
self,
year: Optional[int] = None,
month: Optional[int] = None,
day: Optional[int] = None,
offset: Optional[int] = True,
) -> "XmlDate":
"""Return a new instance replacing the specified fields with new
values."""
if year is None:
year = self.year
if month is None:
month = self.month
if day is None:
day = self.day
if offset is True:
offset = self.offset
return type(self)(year, month, day, offset)
[docs] @classmethod
def from_string(cls, string: str) -> "XmlDate":
"""Initialize from string with format ``%Y-%m-%dT%z``"""
return XmlDate(*parse_date_args(string, DateFormat.DATE))
[docs] @classmethod
def from_date(cls, obj: datetime.date) -> "XmlDate":
"""
Initialize from :class:`datetime.date` instance.
.. warning::
date instances don't have timezone information!
"""
return XmlDate(obj.year, obj.month, obj.day)
[docs] @classmethod
def from_datetime(cls, obj: datetime.datetime) -> "XmlDate":
"""Initialize from :class:`datetime.datetime` instance."""
return XmlDate(obj.year, obj.month, obj.day, calculate_offset(obj))
[docs] @classmethod
def today(cls) -> "XmlDate":
"""Initialize from datetime.date.today()"""
return cls.from_date(datetime.date.today())
[docs] def to_date(self) -> datetime.date:
"""Return a :class:`datetime.date` instance."""
return datetime.date(self.year, self.month, self.day)
[docs] def to_datetime(self) -> datetime.datetime:
"""Return a :class:`datetime.datetime` instance."""
tz_info = calculate_timezone(self.offset)
return datetime.datetime(self.year, self.month, self.day, tzinfo=tz_info)
[docs] def __str__(self) -> str:
"""
Return the date formatted according to ISO 8601 for xml.
Examples:
- 2001-10-26
- 2001-10-26+02:00
- 2001-10-26Z
"""
return format_date(self.year, self.month, self.day) + format_offset(self.offset)
def __repr__(self) -> str:
args = [self.year, self.month, self.day, self.offset]
if args[-1] is None:
del args[-1]
return f"{self.__class__.__name__}({', '.join(map(str, args))})"
[docs]class XmlDateTime(Immutable):
"""
Concrete xs:dateTime builtin type.
Represents iso 8601 date time format [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]
with rich comparisons and hashing.
:param year: Any signed integer, eg (0, -535, 2020)
:param month: Unsigned integer between 1-12
:param day: Unsigned integer between 1-31
:param hour: Unsigned integer between 0-24
:param minute: Unsigned integer between 0-59
:param second: Unsigned integer between 0-59
:param microsecond: Unsigned integer between 0-999999
:param offset: Signed integer representing timezone offset in
minutes
"""
__slots__ = (
"year",
"month",
"day",
"hour",
"minute",
"second",
"microsecond",
"offset",
"_duration",
)
def __init__(
self,
year: int,
month: int,
day: int,
hour: int,
minute: int,
second: int,
microsecond: int = 0,
offset: Optional[int] = None,
):
self.year = year
self.month = month
self.day = day
self.hour = hour
self.minute = minute
self.second = second
self.microsecond = microsecond
self.offset = offset
validate_date(year, month, day)
validate_time(hour, minute, second, microsecond)
self._duration = calculate_duration(
year, month, day, hour, minute, second, microsecond, offset or 0
)
self._hashcode = -1 # Lock the object
[docs] @classmethod
def from_string(cls, string: str) -> "XmlDateTime":
"""Initialize from string with format ``%Y-%m-%dT%H:%M:%S%z``"""
return XmlDateTime(*parse_date_args(string, DateFormat.DATE_TIME))
[docs] @classmethod
def from_datetime(cls, obj: datetime.datetime) -> "XmlDateTime":
"""Initialize from :class:`datetime.datetime` instance."""
return XmlDateTime(
obj.year,
obj.month,
obj.day,
obj.hour,
obj.minute,
obj.second,
obj.microsecond,
calculate_offset(obj),
)
[docs] @classmethod
def now(cls, tz: Optional[datetime.timezone] = None) -> "XmlDateTime":
"""Initialize from datetime.datetime.now()"""
return cls.from_datetime(datetime.datetime.now(tz=tz))
[docs] @classmethod
def utcnow(cls) -> "XmlDateTime":
"""Initialize from datetime.datetime.utcnow()"""
return cls.from_datetime(datetime.datetime.utcnow())
[docs] def to_datetime(self) -> datetime.datetime:
"""Return a :class:`datetime.datetime` instance."""
return datetime.datetime(
self.year,
self.month,
self.day,
self.hour,
self.minute,
self.second,
self.microsecond,
tzinfo=calculate_timezone(self.offset),
)
[docs] def replace(
self,
year: Optional[int] = None,
month: Optional[int] = None,
day: Optional[int] = None,
hour: Optional[int] = None,
minute: Optional[int] = None,
second: Optional[int] = None,
microsecond: Optional[int] = None,
offset: Optional[int] = True,
) -> "XmlDateTime":
"""Return a new instance replacing the specified fields with new
values."""
if year is None:
year = self.year
if month is None:
month = self.month
if day is None:
day = self.day
if hour is None:
hour = self.hour
if minute is None:
minute = self.minute
if second is None:
second = self.second
if microsecond is None:
microsecond = self.microsecond
if offset is True:
offset = self.offset
return type(self)(year, month, day, hour, minute, second, microsecond, offset)
def __cmp_value__(self) -> float:
return self._duration
[docs] def __str__(self) -> str:
"""
Return the datetime formatted according to ISO 8601 for xml.
Examples:
- 2001-10-26T21:32:52
- 2001-10-26T21:32:52+02:00
- 2001-10-26T19:32:52Z
- 2001-10-26T19:32:52.126789
- 2001-10-26T21:32:52.126
- -2001-10-26T21:32:52.126Z
"""
return "{}T{}{}".format(
format_date(self.year, self.month, self.day),
format_time(self.hour, self.minute, self.second, self.microsecond),
format_offset(self.offset),
)
def __repr__(self) -> str:
args = list(self)
if args[-1] is None:
del args[-1]
if args[-1] == 0:
del args[-1]
return f"{self.__class__.__name__}({', '.join(map(str, args))})"
[docs]class XmlTime(Immutable):
"""
Concrete xs:time builtin type.
Represents iso 8601 time format hh:mm:ss[Z|(+|-)hh:mm]
with rich comparisons and hashing.
:param hour: Unsigned integer between 0-24
:param minute: Unsigned integer between 0-59
:param second: Unsigned integer between 0-59
:param microsecond: Unsigned integer between 0-999999
:param offset: Signed integer representing timezone offset in
minutes
"""
__slots__ = ("hour", "minute", "second", "microsecond", "offset", "_duration")
def __init__(
self,
hour: int,
minute: int,
second: int,
microsecond: int = 0,
offset: Optional[int] = None,
):
self.hour = hour
self.minute = minute
self.second = second
self.microsecond = microsecond
self.offset = offset
validate_time(hour, minute, second, microsecond)
self._duration = calculate_duration(
0, 0, 0, hour, minute, second, microsecond, offset or 0
)
self._hashcode = -1 # Lock the object
[docs] def replace(
self,
hour: Optional[int] = None,
minute: Optional[int] = None,
second: Optional[int] = None,
microsecond: Optional[int] = None,
offset: Optional[int] = True,
) -> "XmlTime":
"""Return a new instance replacing the specified fields with new
values."""
if hour is None:
hour = self.hour
if minute is None:
minute = self.minute
if second is None:
second = self.second
if microsecond is None:
microsecond = self.microsecond
if offset is True:
offset = self.offset
return type(self)(hour, minute, second, microsecond, offset)
[docs] @classmethod
def from_string(cls, string: str) -> "XmlTime":
"""Initialize from string format ``%H:%M:%S%z``"""
return XmlTime(*parse_date_args(string, DateFormat.TIME))
[docs] @classmethod
def from_time(cls, obj: datetime.time) -> "XmlTime":
"""Initialize from :class:`datetime.time` instance."""
return XmlTime(
obj.hour, obj.minute, obj.second, obj.microsecond, calculate_offset(obj)
)
[docs] @classmethod
def now(cls, tz: Optional[datetime.timezone] = None) -> "XmlTime":
"""Initialize from datetime.datetime.now()"""
return cls.from_time(datetime.datetime.now(tz=tz).time())
[docs] @classmethod
def utcnow(cls) -> "XmlTime":
"""Initialize from datetime.datetime.utcnow()"""
return cls.from_time(datetime.datetime.utcnow().time())
[docs] def to_time(self) -> datetime.time:
"""Return a :class:`datetime.time` instance."""
return datetime.time(
self.hour,
self.minute,
self.second,
self.microsecond,
tzinfo=calculate_timezone(self.offset),
)
def __cmp_value__(self) -> float:
return self._duration
[docs] def __str__(self) -> str:
"""
Return the time formatted according to ISO 8601 for xml.
Examples:
- 21:32:52
- 21:32:52+02:00,
- 19:32:52Z
- 21:32:52.126789
- 21:32:52.126Z
"""
return "{}{}".format(
format_time(self.hour, self.minute, self.second, self.microsecond),
format_offset(self.offset),
)
def __repr__(self) -> str:
args = list(self)
if args[-1] is None:
del args[-1]
return f"{self.__class__.__name__}({', '.join(map(str, args))})"
class TimeInterval(NamedTuple):
negative: bool
years: Optional[int]
months: Optional[int]
days: Optional[int]
hours: Optional[int]
minutes: Optional[int]
seconds: Optional[float]
[docs]class XmlDuration(UserString):
"""
Concrete xs:duration builtin type.
Represents iso 8601 duration format PnYnMnDTnHnMnS
with rich comparisons and hashing.
Format PnYnMnDTnHnMnS:
- **P**: literal value that starts the expression
- **nY**: the number of years followed by a literal Y
- **nM**: the number of months followed by a literal M
- **nD**: the number of days followed by a literal D
- **T**: literal value that separates date and time parts
- **nH**: the number of hours followed by a literal H
- **nM**: the number of minutes followed by a literal M
- **nS**: the number of seconds followed by a literal S
:param value: String representation of a xs:duration, eg **P2Y6M5DT12H**
"""
def __init__(self, value: str) -> None:
super().__init__(value)
self._interval = self._parse_interval(value)
@property
def years(self) -> Optional[int]:
"""Number of years in the interval."""
return self._interval.years
@property
def months(self) -> Optional[int]:
"""Number of months in the interval."""
return self._interval.months
@property
def days(self) -> Optional[int]:
"""Number of days in the interval."""
return self._interval.days
@property
def hours(self) -> Optional[int]:
"""Number of hours in the interval."""
return self._interval.hours
@property
def minutes(self) -> Optional[int]:
"""Number of minutes in the interval."""
return self._interval.minutes
@property
def seconds(self) -> Optional[float]:
"""Number of seconds in the interval."""
return self._interval.seconds
@property
def negative(self) -> bool:
"""Negative flag of the interval."""
return self._interval.negative
@classmethod
def _parse_interval(cls, value: str) -> TimeInterval:
if not isinstance(value, str):
raise ValueError("Value must be string")
if len(value) < 3 or value.endswith("T"):
raise ValueError(f"Invalid format '{value}'")
match = xml_duration_re.match(value)
if not match:
raise ValueError(f"Invalid format '{value}'")
groups = match.groups()
res = TimeInterval(
negative=groups[0] == "-",
years=int(groups[1]) if groups[1] else None,
months=int(groups[2]) if groups[2] else None,
days=int(groups[3]) if groups[3] else None,
hours=int(groups[4]) if groups[4] else None,
minutes=int(groups[5]) if groups[5] else None,
seconds=float(groups[6]) if groups[6] else None,
)
return res
def asdict(self) -> Dict:
return self._interval._asdict()
def __repr__(self) -> str:
return f'{self.__class__.__name__}("{self.data}")'
class TimePeriod(NamedTuple):
year: Optional[int]
month: Optional[int]
day: Optional[int]
offset: Optional[int]
[docs]class XmlPeriod(UserString):
"""
Concrete xs:gYear/Month/Day builtin type.
Represents iso 8601 period formats with rich comparisons and hashing.
Formats:
- xs:gDay: **---%d%z**
- xs:gMonth: **--%m%z**
- xs:gYear: **%Y%z**
- xs:gMonthDay: **--%m-%d%z**
- xs:gYearMonth: **%Y-%m%z**
:param value: String representation of a xs:period, eg **--11-01Z**
"""
def __init__(self, value: str) -> None:
value = value.strip()
super().__init__(value)
self._period = self._parse_period(value)
@property
def year(self) -> Optional[int]:
"""Period year."""
return self._period.year
@property
def month(self) -> Optional[int]:
"""Period month."""
return self._period.month
@property
def day(self) -> Optional[int]:
"""Period day."""
return self._period.day
@property
def offset(self) -> Optional[int]:
"""Period timezone offset in minutes."""
return self._period.offset
@classmethod
def _parse_period(cls, value: str) -> TimePeriod:
year = month = day = offset = None
if value.startswith("---"):
day, offset = parse_date_args(value, DateFormat.G_DAY)
elif value.startswith("--"):
# Bogus format --MM--, --05---05:00
if value[4:6] == "--":
value = value[:4] + value[6:]
if len(value) in (4, 5, 10): # fixed lengths with/out timezone
month, offset = parse_date_args(value, DateFormat.G_MONTH)
else:
month, day, offset = parse_date_args(value, DateFormat.G_MONTH_DAY)
else:
end = len(value)
if value.find(":") > -1: # offset
end -= 6
if value[:end].rfind("-") > 3: # Minimum position for month sep
year, month, offset = parse_date_args(value, DateFormat.G_YEAR_MONTH)
else:
year, offset = parse_date_args(value, DateFormat.G_YEAR)
validate_date(0, month or 1, day or 1)
return TimePeriod(year=year, month=month, day=day, offset=offset)
[docs] def as_dict(self) -> Dict:
"""Return date units as dict."""
return self._period._asdict()
def __repr__(self) -> str:
return f'{self.__class__.__name__}("{self.data}")'
[docs] def __eq__(self, other: Any) -> bool:
if isinstance(other, XmlPeriod):
return self._period == other._period
return NotImplemented
[docs]class XmlHexBinary(bytes):
"""
Subclass bytes to infer base16 format.
This type can be used with xs:anyType fields that don't have a
format property to specify the target output format.
"""
[docs]class XmlBase64Binary(bytes):
"""
Subclass bytes to infer base64 format.
This type can be used with xs:anyType fields that don't have a
format property to specify the target output format.
"""