openmedialibrary_platform/Shared/lib/python3.7/site-packages/stdnum/es/nif.py

86 lines
2.7 KiB
Python
Raw Normal View History

2013-10-11 17:28:32 +00:00
# nif.py - functions for handling Spanish NIF (VAT) numbers
# coding: utf-8
#
# Copyright (C) 2012, 2013 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
"""NIF (Número de Identificación Fiscal, Spanish VAT number).
The Spanish VAT number is a 9-digit number where either the first, last
digits or both can be letters.
The number is either a DNI (Documento nacional de identidad, for
Spaniards), a NIE (Número de Identificación de Extranjeros, for
foreigners) or a CIF (Certificado de Identificación Fiscal, for legal
entities and others).
>>> compact('ES B-58378431')
'B58378431'
>>> validate('B64717838')
'B64717838'
>>> validate('B64717839') # invalid check digit
Traceback (most recent call last):
...
InvalidChecksum: ...
>>> validate('54362315K') # resident
'54362315K'
>>> validate('X-5253868-R') # foreign person
'X5253868R'
"""
from stdnum.es import dni, nie, cif
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('ES'):
number = number[2:]
return number
def validate(number):
"""Checks to see if the number provided is a valid VAT number. This checks
the length, formatting and check digit."""
number = compact(number)
if not number[1:-1].isdigit():
raise InvalidFormat()
if len(number) != 9:
raise InvalidLength()
if number[0].isdigit():
# natural resident
dni.validate(number)
elif number[0] in 'XYZ':
# foreign natural person
nie.validate(number)
else:
# otherwise it has to be a valid CIF
cif.validate(number)
return number
def is_valid(number):
"""Checks to see if the number provided is a valid VAT number. This checks
the length, formatting and check digit."""
try:
return bool(validate(number))
except ValidationError:
return False