Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
path: root/stdnum/cl/rut.py
diff options
context:
space:
mode:
authorArthur de Jong <arthur@arthurdejong.org>2015-04-18 18:02:41 +0200
committerArthur de Jong <arthur@arthurdejong.org>2015-04-23 23:45:19 +0200
commitc69c8f0fc52d003faeba378a6834fe555eff3b72 (patch)
tree299d7850e7b69e274614fdc69331e96c9ecf0986 /stdnum/cl/rut.py
parent3db826c62332bab0e839d83514781ff1f5f17320 (diff)
Add Chilean national tax number (RUT)
Based on the implementation in the vatnumber module.
Diffstat (limited to 'stdnum/cl/rut.py')
-rw-r--r--stdnum/cl/rut.py91
1 files changed, 91 insertions, 0 deletions
diff --git a/stdnum/cl/rut.py b/stdnum/cl/rut.py
new file mode 100644
index 0000000..ba27fa8
--- /dev/null
+++ b/stdnum/cl/rut.py
@@ -0,0 +1,91 @@
+# rut.py - functions for handling Chile RUT/RUN numbers
+# coding: utf-8
+#
+# Copyright (C) 2008-2011 Cédric Krier
+# Copyright (C) 2008-2011 B2CK
+# 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
+
+"""RUT (Rol Único Tributario, Chilean national tax number).
+
+The RUT, the Chilean national tax number is the same as the RUN (Rol Único
+Nacional) the Chilean national identification number. The number consists of
+8 digits, followed by a check digit.
+
+>>> validate('76086428-5')
+'760864285'
+>>> validate('CL 12531909-2')
+'125319092'
+>>> validate('12531909-3')
+Traceback (most recent call last):
+ ...
+InvalidChecksum: ...
+>>> validate('76086A28-5')
+Traceback (most recent call last):
+ ...
+InvalidFormat: ...
+>>> format('125319092')
+'12.531.909-2'
+"""
+
+from stdnum.exceptions import *
+from stdnum.util import clean
+
+
+def compact(number):
+ """Convert the number to the minimal representation. This strips the
+ number of any valid separators and removes surrounding whitespace."""
+ number = clean(number, ' -.').upper().strip()
+ if number.startswith('CL'):
+ number = number[2:]
+ return number
+
+
+def calc_check_digit(number):
+ """Calculate the check digit. The number passed should not have the
+ check digit included."""
+ s = sum(int(n) * (4 + (5 - i) % 6) for i, n in enumerate(number[::-1]))
+ return '0123456789K'[s % 11]
+
+
+def validate(number):
+ """Checks to see if the number provided is a valid number. This
+ checks the length, formatting and check digit."""
+ number = compact(number)
+ if len(number) not in (8, 9):
+ raise InvalidLength()
+ if not number[:-1].isdigit():
+ raise InvalidFormat()
+ if number[-1] != calc_check_digit(number[:-1]):
+ raise InvalidChecksum()
+ return number
+
+
+def is_valid(number):
+ """Checks to see if the number provided is a valid number. This
+ checks the length, formatting and check digit."""
+ try:
+ return bool(validate(number))
+ except ValidationError:
+ return False
+
+
+def format(number):
+ """Reformat the passed number to the standard format."""
+ number = compact(number)
+ return (number[:-7] + '.' + number[-7:-4] + '.' +
+ number[-4:-1] + '-' + number[-1])