diff options
| author | Arthur de Jong <arthur@arthurdejong.org> | 2014-02-06 21:05:23 +0100 |
|---|---|---|
| committer | Arthur de Jong <arthur@arthurdejong.org> | 2014-02-06 21:05:23 +0100 |
| commit | 71d9837302612de4b53c64e91a5c2a2b56192f30 (patch) | |
| tree | 8a17dbd20571978cc8bd9c92e49470c01de8c9bc /stdnum/eu/at_02.py | |
| parent | 099078eac6360c547ec7c9c9fe5ff4e5535f96fa (diff) | |
Rename AT-02 module to stdnum.eu.at_02
Diffstat (limited to 'stdnum/eu/at_02.py')
| -rw-r--r-- | stdnum/eu/at_02.py | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/stdnum/eu/at_02.py b/stdnum/eu/at_02.py new file mode 100644 index 0000000..dc1fa18 --- /dev/null +++ b/stdnum/eu/at_02.py @@ -0,0 +1,76 @@ +# at_02.py - functions for handling AT-02 (SEPA Creditor identifier) +# +# Copyright (C) 2014 Sergi Almacellas Abellana +# +# 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 + +""" SEPA Identifier of the Creditor (AT-02) + +This identifier is indicated in the ISO 20022 data element `Creditor Scheme +Identification`. The creditor can be a legal entity, or an association that +is not a legal entity, or a person. +Ther first two digits contain the ISO country code, the nex two are check +digitsi for the ISO 7064 Mod 97, 10 checksum, the next tree contain the +Creditor Bussines Code (or `ZZZ` if no bussness code used) and the remainder +contain the country-specific identifier. + +>>> validate('ES23ZZZ47690558N') +'ES23ZZZ47690558N' +>>> validate('ES2300047690558N') +'ES2300047690558N' +>>> compact('ES++()+23ZZZ4//7690558N') +'ES23ZZZ47690558N' +""" + +from stdnum.exceptions import * +from stdnum.iso7064 import mod_97_10 +from stdnum.util import clean + +# the valid characters we have +_alphabet = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ' + + +def compact(number): + """Convert the AT-02 number to the minimal representation. This strips the + number of any valid separators and removes invalid characters.""" + return clean(number, ' -/?:().m\'+"').strip().upper() + + +def _to_base10(number): + """Prepare the number to it's base10 representation so it can be checked + with the ISO 7064 Mod 97, 10 algorithm. That means excluding positions + 5 to 7 and moving the first four digits to the end""" + return ''.join(str(_alphabet.index(x)) for x in number[7:] + number[:4]) + + +def validate(number): + """Checks to see if the number provided is a valid AT-02.""" + number = compact(number) + try: + test_number = _to_base10(number) + except: + raise InvalidFormat() + # ensure that checksum is valid + mod_97_10.validate(test_number) + return number + + +def is_valid(number): + """Checks to see if the number provided is a valid AT-02.""" + try: + return bool(validate(number)) + except ValidationError: + return False |