Skip to content

finance

validators.finance.cusip(value)

Return whether or not given value is a valid CUSIP.

Checks if the value is a valid CUSIP.

Examples:

>>> cusip('037833DP2')
True
>>> cusip('037833DP3')
ValidationFailure(func=cusip, ...)

Parameters:

Name Type Description Default
value str

CUSIP string to validate.

 required

Returns:

Type Description
Literal[True]

If value is a valid CUSIP string.
ValidationError

If value is an invalid CUSIP string.
Source code in src/validators/finance.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
@validator
def cusip(value: str):
    """Return whether or not given value is a valid CUSIP.

    Checks if the value is a valid [CUSIP][1].
    [1]: https://en.wikipedia.org/wiki/CUSIP

    Examples:
        >>> cusip('037833DP2')
        True
        >>> cusip('037833DP3')
        ValidationFailure(func=cusip, ...)

    Args:
        value: CUSIP string to validate.

    Returns:
        (Literal[True]): If `value` is a valid CUSIP string.
        (ValidationError): If `value` is an invalid CUSIP string.
    """
    return len(value) == 9 and _cusip_checksum(value)

validators.finance.isin(value)

Return whether or not given value is a valid ISIN.

Checks if the value is a valid ISIN.

Examples:

>>> isin('037833DP2')
True
>>> isin('037833DP3')
ValidationFailure(func=isin, ...)

Parameters:

Name Type Description Default
value str

ISIN string to validate.

 required

Returns:

Type Description
Literal[True]

If value is a valid ISIN string.
ValidationError

If value is an invalid ISIN string.
Source code in src/validators/finance.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@validator
def isin(value: str):
    """Return whether or not given value is a valid ISIN.

    Checks if the value is a valid [ISIN][1].
    [1]: https://en.wikipedia.org/wiki/International_Securities_Identification_Number

    Examples:
        >>> isin('037833DP2')
        True
        >>> isin('037833DP3')
        ValidationFailure(func=isin, ...)

    Args:
        value: ISIN string to validate.

    Returns:
        (Literal[True]): If `value` is a valid ISIN string.
        (ValidationError): If `value` is an invalid ISIN string.
    """
    return len(value) == 12 and _isin_checksum(value)

validators.finance.sedol(value)

Return whether or not given value is a valid SEDOL.

Checks if the value is a valid SEDOL.

Examples:

>>> sedol('2936921')
True
>>> sedol('29A6922')
ValidationFailure(func=sedol, ...)

Parameters:

Name Type Description Default
value str

SEDOL string to validate.

 required

Returns:

Type Description
Literal[True]

If value is a valid SEDOL string.
ValidationError

If value is an invalid SEDOL string.
Source code in src/validators/finance.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
@validator
def sedol(value: str):
    """Return whether or not given value is a valid SEDOL.

    Checks if the value is a valid [SEDOL][1].
    [1]: https://en.wikipedia.org/wiki/SEDOL

    Examples:
        >>> sedol('2936921')
        True
        >>> sedol('29A6922')
        ValidationFailure(func=sedol, ...)

    Args:
        value: SEDOL string to validate.

    Returns:
        (Literal[True]): If `value` is a valid SEDOL string.
        (ValidationError): If `value` is an invalid SEDOL string.
    """
    if len(value) != 7:
        return False

    weights = [1, 3, 1, 7, 3, 9, 1]
    check = 0
    for idx in range(7):
        c = value[idx]
        if c in "AEIOU":
            return False

        val = None
        if c >= "0" and c <= "9":
            val = ord(c) - ord("0")
        elif c >= "A" and c <= "Z":
            val = 10 + ord(c) - ord("A")
        else:
            return False
        check += val * weights[idx]

    return (check % 10) == 0