Skip to content

input4mips_validation.validation.tracking_id#

input4mips_validation.validation.tracking_id #

Validation of the tracking_id attribute

PREFIX: str = 'hdl:21.14100/' module-attribute #

Prefix that we expect to start the tracking ID values.

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

REGEXP_CHECKER: str = 'hdl\\:21\\.14100\\/[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}' module-attribute #

Regular expression to use to check that the tracking ID is correct.

Technically, this regular expression is not strict enough to check the UUID is actually correctly formatted. However, this is a helpful first check (if this fails, the tracking ID is definitely wrong) and ensures that the correct prefix is used.

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

validate_tracking_id(tracking_id) #

Validate the tracking ID value

Parameters:

Name Type Description Default
tracking_id str

Tracking ID value to validate

 required

Raises:

Type Description
ValueError

tracking_id's value is not correctly formed
Source code in src/input4mips_validation/validation/tracking_id.py 
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
64
65
66
67
68
69
70
71
72
def validate_tracking_id(tracking_id: str) -> None:
    """
    Validate the tracking ID value

    Parameters
    ----------
    tracking_id
        Tracking ID value to validate

    Raises
    ------
    ValueError
        `tracking_id`'s value is not correctly formed
    """
    try:
        validate_matches_regexp(
            value=tracking_id,
            regexp_to_match=REGEXP_CHECKER,
        )

        tracking_id_uuid_part = tracking_id.split(PREFIX)[-1]
        uuid.UUID(tracking_id_uuid_part, version=4)

    except (DoesNotMatchRegexpError, ValueError) as exc:
        msg = (
            "The `tracking_id` attribute must start with the prefix 'hdl:21.14100/', "
            "followed by a version 4 universally unique identifier (UUID4). "
            "If it does this, it will match the following regular expression, "
            f"{REGEXP_CHECKER!r}. "
            f"Received {tracking_id=!r}. "
            "To see how to generate a correct tracking ID, "
            "see `input4mips_validation.io.generate_tracking_id`."
        )
        raise ValueError(msg) from exc