python-stdnum commit: r111 - in python-stdnum: . stdnum stdnum/es tests

[Commits of the python-stdnum project <python-stdnum-commits [at] lists.arthurdejong.org>]

Author: arthur
Date: Fri Feb 10 21:53:56 2012
New Revision: 111
URL: http://arthurdejong.org/viewvc/python-stdnum?revision=111&view=revision

Log:
add a NIE (Número de Identificación de Extranjeros, Spanish identification 
number for foreigners) module

Added:
   python-stdnum/stdnum/es/nie.py
Modified:
   python-stdnum/README
   python-stdnum/stdnum/__init__.py
   python-stdnum/tests/test_robustness.doctest

Modified: python-stdnum/README
==============================================================================
--- python-stdnum/README        Fri Feb 10 21:49:17 2012        (r110)
+++ python-stdnum/README        Fri Feb 10 21:53:56 2012        (r111)
@@ -25,6 +25,8 @@
  * SSN (U.S. Social Security Number)
  * HETU (Finnish personal identity code)
  * DNI (Documento nacional de identidad, Spanish personal identity codes)
+ * NIE (Número de Identificación de Extranjeros, Spanish identification number
+   for foreigners)
  * FPA, ΦΠΑ (Foros Prostithemenis Aksias, the Greek VAT number)
  * Ust ID Nr. (Umsatzsteur Identifikationnummer, the German VAT number)
  * BTW, TVA, NWSt (Belgian VAT number)

Modified: python-stdnum/stdnum/__init__.py
==============================================================================
--- python-stdnum/stdnum/__init__.py    Fri Feb 10 21:49:17 2012        (r110)
+++ python-stdnum/stdnum/__init__.py    Fri Feb 10 21:53:56 2012        (r111)
@@ -39,6 +39,8 @@
  * SSN (U.S. Social Security Number)
  * HETU (Finnish personal identity code)
  * DNI (Documento nacional de identidad, Spanish personal identity codes)
+ * NIE (Número de Identificación de Extranjeros, Spanish identification number
+   for foreigners)
  * FPA, ΦΠΑ (Foros Prostithemenis Aksias, the Greek VAT number)
  * Ust ID Nr. (Umsatzsteur Identifikationnummer, the German VAT number)
  * BTW, TVA, NWSt (Belgian VAT number)

Added: python-stdnum/stdnum/es/nie.py
==============================================================================
--- /dev/null   00:00:00 1970   (empty, because file is newly added)
+++ python-stdnum/stdnum/es/nie.py      Fri Feb 10 21:53:56 2012        (r111)
@@ -0,0 +1,60 @@
+# nie.py - functions for handling Spanish foreigner identity codes
+# coding: utf-8
+#
+# Copyright (C) 2012 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
+
+"""Module for handling Spanish tax identification number (Número de
+Identificación de Extranjeros) for foreigners. The NIE is a 9 digit number
+where the fir digit is either X, Y or Z and last digit is a checksum letter.
+
+>>> compact('x-2482300w')
+'X2482300W'
+>>> is_valid('x-2482300w')
+True
+>>> is_valid('x-2482300a')  # invalid check digit
+False
+"""
+
+from stdnum.es import dni
+from stdnum.util import clean
+
+
+__all__ = ['compact', 'is_valid']
+
+
+# use the same compact function as DNI
+compact = dni.compact
+
+
+def calc_check_digit(number):
+    """Calculate the check digit. The number passed should not have the
+    check digit included."""
+    # replace XYZ with 012
+    number = str('XYZ'.index(number[0])) + number[1:]
+    return dni.calc_check_digit(number)
+
+
+def is_valid(number):
+    """Checks to see if the number provided is a valid DNI number. This
+    checks the length, formatting and check digit."""
+    try:
+        number = compact(number)
+    except:
+        return False
+    return len(number) == 9 and number[1:-1].isdigit() and \
+           number[0] in 'XYZ' and calc_check_digit(number[:-1]) == number[-1]

Modified: python-stdnum/tests/test_robustness.doctest
==============================================================================
--- python-stdnum/tests/test_robustness.doctest Fri Feb 10 21:49:17 2012        
(r110)
+++ python-stdnum/tests/test_robustness.doctest Fri Feb 10 21:53:56 2012        
(r111)
@@ -30,7 +30,7 @@
 >>> from stdnum.br import cpf
 >>> from stdnum.cz import rc
 >>> from stdnum.de import vat as de_vat
->>> from stdnum.es import dni
+>>> from stdnum.es import dni, nie
 >>> from stdnum.fi import hetu
 >>> from stdnum.fr import siren
 >>> from stdnum.gr import vat as gr_vat
-- 
To unsubscribe send an email to
python-stdnum-commits-unsubscribe@lists.arthurdejong.org or see
http://lists.arthurdejong.org/python-stdnum-commits/