Skip to content

input4mips_validation.validation.creation_date#

input4mips_validation.validation.creation_date #

Validation of the creation_date attribute

CREATION_DATE_FORMAT: str = '%Y-%m-%dT%H:%M:%SZ' module-attribute #

Format to use for creation dates

According to the specifications, the creation date must be provided as an ISO8601 formatted string in the UTC timezone. In otherwords, it must take the form given above, which can also be written as "YYYY-MM-DDThh:mm:ssZ" (where the trailing "Z" indicates that the timezone is UTC).

For futher details, see:

  • https://stackoverflow.com/a/29282022
  • https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations

This constant is exposed for clarity. If you change it, we do not guarantee correct performance of the codebase.

validate_creation_date(creation_date) #

Validate the creation date value

Parameters:

Name Type Description Default
creation_date str

Creation date value to validate

 required

Raises:

Type Description
ValueError

creation_date's value is not correctly formed
Source code in src/input4mips_validation/validation/creation_date.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def validate_creation_date(creation_date: str) -> None:
    """
    Validate the creation date value

    Parameters
    ----------
    creation_date
        Creation date value to validate

    Raises
    ------
    ValueError
        `creation_date`'s value is not correctly formed
    """
    try:
        validate_matches_regexp(
            value=creation_date,
            regexp_to_match=r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$",
        )

        dt.datetime.strptime(creation_date, CREATION_DATE_FORMAT)

    except (DoesNotMatchRegexpError, ValueError) as exc:
        msg = (
            "The `creation_date` attribute must be of the form YYYY-MM-DDThh:mm:ssZ, "
            "i.e. be an ISO 8601 timestamp in the UTC timezone. "
            f"Received {creation_date=!r}"
        )
        raise ValueError(msg) from exc