Skip to content

Add support for spanish postal code #401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions stdnum/es/postal_code.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# postal_code.py - functions for handling Spanish postal code numbers
# coding: utf-8
#
# Copyright (C) 2023 Víctor Ramos
#
# 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

"""Postcode (the Spanish postal code).

They consist of five numerical digits,[2] where the first two digits,
ranging 01 to 52, correspond either to one of the 50 provinces of
Spain or to one of the two autonomous cities on the African coast.

More information:

* https://en.wikipedia.org/wiki/Postal_codes_in_Spain

>>> validate('01000')
'01000'
>>> validate('52000')
'52000'
>>> validate('00000')
Traceback (most recent call last):
...
InvalidFormat: ...
>>> validate('53000')
Traceback (most recent call last):
...
InvalidFormat: ...
>>> validate('99999')
Traceback (most recent call last):
...
InvalidFormat: ...
>>> validate('5200')
Traceback (most recent call last):
...
InvalidLength: ...
>>> validate('520000')
Traceback (most recent call last):
...
InvalidLength: ...
"""


import re

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


_CP_REGEX = re.compile(r'^(?:0[1-9]|[1-4]\d|5[0-2])\d{3}$')


def compact(number):
"""Convert the number to the minimal representation."""
return clean(number, ' ').strip()


def validate(number):
"""Check if the number provided is a valid CAS RN."""
number = compact(number)
if len(number) != 5:
raise InvalidLength()
if not _CP_REGEX.match(number):
raise InvalidFormat()
return number


def is_valid(number):
"""Check if the number provided is a valid CAS RN."""
try:
return bool(validate(number))
except ValidationError:
return False