Skip to content

validators

validate_characters(characters_in=0, as_hex=False)

Validate a characters value.

Parameters:

Name Type Description Default
characters_in int

Integer value passed from another function

 0
as_hex int

Bool value passed from another function

 False

Raises:

Type Description
Exception

When attempting to convert characters_in value to an int fails.
ValueError

When trim_in is less than 0, or greater than the length of a UUID string/hex (36/32 characters).
Source code in src/red_utils/std/uuid_utils/validators.py 
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def validate_characters(characters_in: int = 0, as_hex: bool = False) -> int:
    """Validate a characters value.

    Params:
        characters_in (int): Integer value passed from another function
        as_hex (int): Bool value passed from another function

    Raises:
        Exception: When attempting to convert `characters_in` value to an `int` fails.
        ValueError: When `trim_in` is less than 0, or greater than the length of a UUID string/hex (36/32 characters).

    """
    if not isinstance(characters_in, str):
        try:
            characters_in = int(characters_in)
        except Exception as exc:
            raise Exception(
                f"Unhandled exception converting characters value to int. Errored on converting int (type: {type(characters_in)}): {characters_in}. Details: {exc}"
            )

    if as_hex:
        ## Set length of UUID hex string (without '-' characters)
        uuid_len: int = glob_uuid_lens.hex

        ## If characters_in is greater than uuid_len, set trim to max number of characters
        if characters_in > uuid_len:
            characters_in = uuid_len

    else:
        uuid_len: int = glob_uuid_lens.standard

        if characters_in > uuid_len:
            raise ValueError(
                f"Character count must be less than UUID string length ({uuid_len})"
            )

    if not characters_in >= 0:
        raise ValueError(f"Trim value must be 0 or greater.")

    if characters_in >= uuid_len:
        exc_msg: str = (
            f"Trim value must be less than {uuid_len}. At least 1 character must be returned."
        )

        if as_hex:
            exc_msg: str = (
                f"{exc_msg} Note that a hexadecimal UUID string is only {glob_uuid_lens.hex} characters because of the missing '-' characters."
            )

        raise ValueError(exc_msg)

    return characters_in

validate_trim(trim_in=0, as_hex=False)

Validate a trim value.

Parameters:

Name Type Description Default
trim_in int

Value of trim passed from another function.

 0
as_hex bool

Value of as_hex passed from another function.

 False

Returns

(int): A validated `int`

Raises:

Type Description
ValueError

When trim_in is less than 0, or greater than the length of a UUID string/hex (36/32 characters).
Source code in src/red_utils/std/uuid_utils/validators.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def validate_trim(trim_in: int = 0, as_hex: bool = False) -> int:
    """Validate a trim value.

    Params:
        trim_in (int): Value of `trim` passed from another function.
        as_hex (bool): Value of `as_hex` passed from another function.

    Returns
    -------
        (int): A validated `int`

    Raises:
        ValueError: When `trim_in` is less than 0, or greater than the length of a UUID string/hex (36/32 characters).

    """
    if not isinstance(trim_in, int):
        ## If trim_in is not an int, try converting to one
        try:
            trim_in = int(trim_in)
        except Exception as exc:
            raise Exception(
                f"Unhandled exception converting trim value to int. Errored on converting input (type: {type(trim_in)}): {trim_in}. Details: {exc}"
            )

    if as_hex:
        ## Set length of UUID hex string (without '-' characters)
        uuid_len: int = glob_uuid_lens.hex
    else:
        ## Set length of UUID to standard 36 characters
        uuid_len: int = glob_uuid_lens.standard

    if not trim_in >= 0:
        raise ValueError(f"Trim value must be 0 or greater.")

    ## Check that trim_in does not exceed length of UUID string
    if trim_in >= uuid_len:
        exc_msg: str = (
            f"Trim value must be less than {uuid_len}. At least 1 character must be returned."
        )

        if as_hex:
            exc_msg: str = (
                f"{exc_msg} Note that a hexadecimal UUID string is only 32 characters because of the missing '-' characters."
            )

        raise ValueError(exc_msg)

    return trim_in