Source code for pyrfu.pyrf.date_str

#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Built-in imports
from datetime import datetime

__author__ = "Louis Richard"
__email__ = "louisr@irfu.se"
__copyright__ = "Copyright 2020-2023"
__license__ = "MIT"
__version__ = "2.4.2"
__status__ = "Prototype"


def date_str(tint, fmt: int = 1):
    r"""Creates a string corresponding to time interval for output plot naming.

    Parameters
    ----------
    tint : list of str
        Time interval.
    fmt : int
        Format of the output :
            * 1 : "%Y%m%d_%H%M"
            * 2 : "%y%m%d%H%M%S"
            * 3 : "%Y%m%d_%H%M%S"_"%H%M%S"
            * 4 : "%Y%m%d_%H%M%S"_"%Y%m%d_%H%M%S"

    Returns
    -------
    out : str
        String corresponding to the time interval in the desired format.

    """

    # Check input
    assert isinstance(tint, list), "tint must be a list"
    assert isinstance(tint[0], str), "1st element of tint must be a string"
    assert isinstance(tint[1], str), "2nd element of tint must be a string"
    assert fmt in range(1, 5), "fmt must be 1, 2, 3, or 4"

    assert len(tint[0]) > 25, "tint[0] must be in %Y-%m-%dT%H:%M:%S.%f format"
    assert len(tint[1]) > 25, "tint[1] must be in %Y-%m-%dT%H:%M:%S.%f format"

    tint = [t_[:26] for t_ in tint]

    start_time = datetime.strptime(tint[0], "%Y-%m-%dT%H:%M:%S.%f")
    end_time = datetime.strptime(tint[1], "%Y-%m-%dT%H:%M:%S.%f")

    if fmt == 1:
        out = start_time.strftime("%Y%m%d_%H%M")
    elif fmt == 2:
        out = start_time.strftime("%y%m%d%H%M%S")
    elif fmt == 3:
        out = "_".join(
            [
                start_time.strftime("%Y%m%d_%H%M%S"),
                end_time.strftime("%H%M%S"),
            ],
        )
    else:
        out = "_".join(
            [
                start_time.strftime("%Y%m%d_%H%M%S"),
                end_time.strftime("%Y%m%d_%H%M%S"),
            ],
        )

    return out