-
Notifications
You must be signed in to change notification settings - Fork 174
Expand file tree
/
Copy pathes.py
More file actions
168 lines (134 loc) · 5.04 KB
/
es.py
File metadata and controls
168 lines (134 loc) · 5.04 KB
1
2
3
4
5
6
7
8
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
57
58
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
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
"""Spain."""
# standard
from typing import Dict
# local
from validators.utils import validator
def _nif_nie_validation(value: str, number_by_letter: Dict[str, str]):
"""Validate if the doi is a NIF or a NIE."""
if len(value) != 9:
return False
value = value.upper()
table = "TRWAGMYFPDXBNJZSQVHLCKE"
# If it is not a DNI, convert the first
# letter to the corresponding digit
numbers = number_by_letter.get(value[0], value[0]) + value[1:8]
# doi[8] is control
return numbers.isdigit() and value[8] == table[int(numbers) % 23]
@validator
def es_cif(value: str, /):
"""Validate a Spanish CIF.
Each company in Spain prior to 2008 had a distinct CIF and has been
discontinued. For more information see [wikipedia.org/cif][1].
The new replacement is to use NIF for absolutely everything. The issue is
that there are "types" of NIFs now: company, person [citizen or resident]
all distinguished by the first character of the DOI. For this reason we
will continue to call CIFs NIFs, that are used for companies.
This validator is based on [generadordni.es][2].
[1]: https://es.wikipedia.org/wiki/C%C3%B3digo_de_identificaci%C3%B3n_fiscal
[2]: https://generadordni.es/
Examples:
>>> es_cif('B25162520')
True
>>> es_cif('B25162529')
ValidationError(func=es_cif, args={'value': 'B25162529'})
Args:
value:
DOI string which is to be validated.
Returns:
(Literal[True]): If `value` is a valid DOI string.
(ValidationError): If `value` is an invalid DOI string.
"""
if not value or len(value) != 9:
return False
value = value.upper()
table = "JABCDEFGHI"
first_chr = value[0]
doi_body = value[1:8]
control = value[8]
if not doi_body.isdigit():
return False
res = (
10
- sum(
# Multiply each positionally even doi
# digit by 2 and sum it all together
sum(map(int, str(int(char) * 2))) if index % 2 == 0 else int(char)
for index, char in enumerate(doi_body)
)
% 10
) % 10
if first_chr in "ABEH": # Number type
return str(res) == control
if first_chr in "PSQW": # Letter type
return table[res] == control
return control in {str(res), table[res]} if first_chr in "CDFGJNRUV" else False
@validator
def es_nif(value: str, /):
"""Validate a Spanish NIF.
Each entity, be it person or company in Spain has a distinct NIF. Since
we've designated CIF to be a company NIF, this NIF is only for person.
For more information see [wikipedia.org/nif][1]. This validator
is based on [generadordni.es][2].
[1]: https://es.wikipedia.org/wiki/N%C3%BAmero_de_identificaci%C3%B3n_fiscal
[2]: https://generadordni.es/
Examples:
>>> es_nif('26643189N')
True
>>> es_nif('26643189X')
ValidationError(func=es_nif, args={'value': '26643189X'})
Args:
value:
DOI string which is to be validated.
Returns:
(Literal[True]): If `value` is a valid DOI string.
(ValidationError): If `value` is an invalid DOI string.
"""
number_by_letter = {"L": "0", "M": "0", "K": "0"}
return _nif_nie_validation(value, number_by_letter)
@validator
def es_nie(value: str, /):
"""Validate a Spanish NIE.
The NIE is a tax identification number in Spain, known in Spanish
as the NIE, or more formally the Número de identidad de extranjero.
For more information see [wikipedia.org/nie][1]. This validator
is based on [generadordni.es][2].
[1]: https://es.wikipedia.org/wiki/N%C3%BAmero_de_identidad_de_extranjero
[2]: https://generadordni.es/
Examples:
>>> es_nie('X0095892M')
True
>>> es_nie('X0095892X')
ValidationError(func=es_nie, args={'value': 'X0095892X'})
Args:
value:
DOI string which is to be validated.
Returns:
(Literal[True]): If `value` is a valid DOI string.
(ValidationError): If `value` is an invalid DOI string.
"""
number_by_letter = {"X": "0", "Y": "1", "Z": "2"}
# NIE must must start with X Y or Z
if value and value[0] in number_by_letter:
return _nif_nie_validation(value, number_by_letter)
return False
@validator
def es_doi(value: str, /):
"""Validate a Spanish DOI.
A DOI in spain is all NIF / CIF / NIE / DNI -- a digital ID.
For more information see [wikipedia.org/doi][1]. This validator
is based on [generadordni.es][2].
[1]: https://es.wikipedia.org/wiki/Identificador_de_objeto_digital
[2]: https://generadordni.es/
Examples:
>>> es_doi('X0095892M')
True
>>> es_doi('X0095892X')
ValidationError(func=es_doi, args={'value': 'X0095892X'})
Args:
value:
DOI string which is to be validated.
Returns:
(Literal[True]): If `value` is a valid DOI string.
(ValidationError): If `value` is an invalid DOI string.
"""
return es_nie(value) or es_nif(value) or es_cif(value)