Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
path: root/stdnum/do/cedula.py
blob: 720a69134a64de90ed4f1a0688d43988ae32f164 (plain)
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
# cedula.py - functions for handling Dominican Republic national identifier
#
# Copyright (C) 2015 Arthur de Jong
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA

"""Cedula (Dominican Republic national identification number).

A cedula is is an 11-digit number issues by the Dominican Republic government
to citizens or residents for identification purposes.

>>> validate('00113918205')
'00113918205'
>>> validate('00113918204')
Traceback (most recent call last):
    ...
InvalidChecksum: ...
>>> validate('0011391820A')
Traceback (most recent call last):
    ...
InvalidFormat: ...
>>> format('22400022111')
'224-0002211-1'
"""

from stdnum.exceptions import *
from stdnum.util import clean
from stdnum import luhn


# list of Cedulas that do not match the checksum but are nonetheless valid
whitelist = set('''
00000021249 00000035692 00000058035 00000065377 00000078587 00000111941
00000126295 00000140874 00000155482 00000236621 00000292212 00000564933
00000719400 00004110056 00100000169 00100012146 00100013114 00100016495
00100053841 00100061611 00100061945 00100083860 00100101767 00100126468
00100145737 00100165504 00100169706 00100172940 00100174666 00100181057
00100228718 00100231017 00100238382 00100239662 00100255349 00100288143
00100288929 00100322649 00100350928 00100378440 00100384523 00100415853
00100523399 00100524531 00100530588 00100587320 00100590683 00100593378
00100622461 00100709215 00100728113 00100729795 00100756082 00100759932
00101118022 00101166065 00101527366 00101541404 00101621981 00101659661
00101684656 00101686299 00101821735 00101961125 00102025201 00102398239
00102577448 00102630192 00103266558 00103436936 00103443802 00103754365
00103822440 00103983004 00104486903 00104532086 00104662561 00104727362
00104785104 00104862525 00105263314 00105328185 00105512386 00105530894
00105606543 00105832408 00106190966 00106284933 00106418989 00106442522
00106479922 00106916538 00107045499 00107184305 00107445493 00107602067
00107665688 00107687383 00107691942 00108113363 00108132448 00108184024
00108264871 00108286792 00108384121 00108413431 00108497822 00108784684
00108796883 00109183462 00109229090 00109402756 00109785951 00109987435
00110047715 00110071113 00110111536 00110490843 00110578459 00110646203
00111014782 00111150559 00113453700 00114272360 00114532330 00114532355
00114687216 00115039795 00115343847 00116256005 00116448241 00116508511
00117582001 00119161853 00121344165 00121581750 00121581800 00129737056
00130610001 00131257003 00133987848 00134588056 00142864013 00143072001
00144435001 00146965001 00147485003 00149657590 00155144906 00161884001
00162906003 00163540003 00163549012 00163709018 00166533003 00167311001
00170009162 00170115579 00171404771 00174729003 00174940001 00181880003
00184129003 00189213001 00189405093 00190002567 00196714003 00200021994
00200028716 00200040516 00200063601 00200123640 00200291381 00200409772
00200435544 00200969260 00201023001 00202110760 00202744522 00207327056
00208430205 00208832003 00218507031 00222017001 00235482001 00236245013
00241997013 00246160013 00261011013 00270764013 00274652001 00278005023
00289931003 00291431001 00291549003 00297018001 00298109001 00299724003
00300001538 00300011700 00300013835 00300017875 00300019575 00300020806
00300025568 00300052890 00300169535 00300244009 00300636564 00301200901
00305535206 00345425001 00352861001 00356533003 00362684023 00376023023
00400001552 00400001614 00400012957 00400189811 00425759001 00435518003
00475916056 00481106001 00481595003 00493593003 00516077003 00520207699
00524571001 00539342005 00540077717 00544657001 00574599001 00599408003
00633126023 00644236001 00648496171 00651322001 00686904003 00720758056
00731054054 00741721056 00757398001 00800106971 00848583056 00857630012
00971815056 01000005580 01000250733 01000268998 01000728704 01000855890
01038813907 01094560111 01100014261 01100620962 01154421047 01200004166
01200008613 01200011252 01200014133 01200033420 01200771767 01300001142
01300005424 01300020331 01400000282 01400074875 01600009531 01600019983
01600026316 01600027894 01650257001 01700052445 01700200811 01800022457
01800058439 01800527104 01810035037 02038569001 02100061022 02300003061
02300023225 02300031758 02300037618 02300047220 02300052220 02300054193
02300062066 02300085158 02400229955 02500045676 02600036132 02600094954
02700029905 02755972001 02800000129 02800021761 02800025877 02800029588
02831146001 03000411295 03100109611 03100488033 03100654224 03100673050
03100963776 03101070888 03102828522 03102936385 03103315310 03103749672
03104354892 03111670001 03121982479 03200066940 03300023841 03400058730
03400157849 03401709701 03500037890 03600046116 03600127038 03600180637
03700663589 03800032522 03807240010 03852380001 03900069856 03900192284
04022130495 04400002002 04600198229 04700004024 04700020933 04700027064
04700061076 04700070460 04700074827 04700221469 04701174268 04800019561
04800034846 04800046910 04800956889 04801245892 04900009932 04900011690
04900013913 04900014592 04900026260 04900028443 04900448230 04902549001
04941042001 05100085656 05300013029 05400016031 05400021759 05400022042
05400028496 05400033166 05400034790 05400037495 05400038776 05400040523
05400047674 05400048248 05400049237 05400049834 05400053627 05400054156
05400055485 05400055770 05400057300 05400058964 05400059956 05400060743
05400062459 05400067703 05400072273 05400076481 05400216948 05500003079
05500006796 05500008806 05500012039 05500014375 05500017761 05500021118
05500022399 05500023407 05500024135 05500024190 05500027749 05500032681
05500173451 05500303477 05600037761 05600038251 05600038964 05600051191
05600063115 05600267737 05600553831 05700064077 05700071202 05900072869
06100007818 06100009131 06100011935 06100013662 06100016486 06337850001
06400007916 06400011981 06400014372 06486186001 06500162568 06800008448
06800245196 06843739551 06900069184 07000007872 07100018031 07100063262
07400001254 07600000691 07700009346 07800000968 07800002361 08016809001
08100002398 08498619001 08800003986 08900001310 08900005064 08952698001
09000117963 09000169133 09010011235 09022066011 09300006239 09300035357
09421581768 09500008222 09700003030 09700179110 09900017864 10061805811
10100178199 10201116357 10462157001 10491297001 10621581792 10983439110
11700000658 12019831001 12300074628 22321581834 22721581818 40200401324
40200452735 40200639953 40200700675 90001200901
'''.split())


def compact(number):
    """Convert the number to the minimal representation. This strips the
    number of any valid separators and removes surrounding whitespace."""
    return clean(number, ' -').strip()


def validate(number):
    """Checks to see if the number provided is a valid cedula."""
    number = compact(number)
    if len(number) != 11:
        raise InvalidLength()
    if not number.isdigit():
        raise InvalidFormat()
    if number in whitelist:
        return number
    return luhn.validate(number)


def is_valid(number):
    """Checks to see if the number provided is a valid cedula."""
    try:
        return bool(validate(number))
    except ValidationError:
        return False


def format(number):
    """Reformat the passed number to the standard format."""
    number = compact(number)
    return '-'.join((number[:3], number[3:-1], number[-1]))