Source code for jnrbase.iso_8601

#
"""iso_8601 - |ISO|-8601 support."""
# Copyright © 2014-2020  James Rowe <jnrowe@gmail.com>
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This file is part of jnrbase.
#
# jnrbase is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# jnrbase is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# jnrbase.  If not, see <http://www.gnu.org/licenses/>.

import datetime
import re

import ciso8601


def parse_delta(__string: str) -> datetime.timedelta:
    """Parse |ISO|-8601 duration string.

    Args:
        __string: Duration string to parse
    Returns:
        Parsed delta object
    """
    if not __string:
        return datetime.timedelta(0)
    match = re.fullmatch(
        r"""
        P
        ((?P<days>\d+)D)?
        T?
        ((?P<hours>\d{1,2})H)?
        ((?P<minutes>\d{1,2})M)?
        ((?P<seconds>\d{1,2})?((?:\.(?P<microseconds>\d+))?S)?)
    """, __string, re.VERBOSE)
    if not match:
        raise ValueError(f'Unable to parse delta {__string!r}')
    match_dict = {k: int(v) if v else 0 for k, v in match.groupdict().items()}
    return datetime.timedelta(**match_dict)


def format_delta(__timedelta: datetime.timedelta) -> str:
    """Format |ISO|-8601 duration string.

    Args:
        __timedelta: Duration to process
    Returns:
        |ISO|-8601 representation of duration
    """
    if __timedelta == datetime.timedelta(0):
        return ''
    result = ['P', ]
    if __timedelta.days:
        result.append(f'{__timedelta.days}D')
    hours, minutes = divmod(__timedelta.seconds, 3600)
    minutes, seconds = divmod(minutes, 60)
    if hours or minutes or seconds:
        result.append('T')
    for k, v in zip('HMS', [hours, minutes, seconds]):
        if v:
            result.append(f'{v:02d}{k}')
    return ''.join(result)


def parse_datetime(__string: str) -> datetime.datetime:
    """Parse |ISO|-8601 datetime string.

    Args:
        __string: Datetime string to parse
    Returns:
        Parsed datetime object
    """
    if not __string:
        datetime_ = datetime.datetime.now(datetime.timezone.utc)
    else:
        # pylint: disable=no-member
        datetime_ = ciso8601.parse_rfc3339(__string)
    return datetime_


def format_datetime(__datetime: datetime.datetime) -> str:
    """Format |ISO|-8601 datetime string.

    Args:
        __datetime: Datetime to process
    Returns:
        |ISO|-8601 compatible string
    """
    return __datetime.isoformat().replace('+00:00', 'Z')