python-stdnum branch master updated. 1.18-18-g96abcfe

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

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "python-stdnum".

The branch, master has been updated
       via  96abcfe78c6f0b086be59757e5400d98f99d9459 (commit)
      from  36858cc6236529ea7a0991865432ca86d72e8295 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
https://arthurdejong.org/git/python-stdnum/commit/?id=96abcfe78c6f0b086be59757e5400d98f99d9459

commit 96abcfe78c6f0b086be59757e5400d98f99d9459
Author: Victor <victor@calidae.com>
Date:   Fri Feb 24 11:55:42 2023 +0100

    Add Spanish postcode validator
    
    Closes https://github.com/arthurdejong/python-stdnum/pull/401

diff --git a/stdnum/es/postal_code.py b/stdnum/es/postal_code.py
new file mode 100644
index 0000000..0087fd1
--- /dev/null
+++ b/stdnum/es/postal_code.py
@@ -0,0 +1,84 @@
+# 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).
+
+The Spanish postal code consists of five digits 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):
+    ...
+InvalidComponent: ...
+>>> validate('53000')
+Traceback (most recent call last):
+    ...
+InvalidComponent: ...
+>>> validate('99999')
+Traceback (most recent call last):
+    ...
+InvalidComponent: ...
+>>> validate('5200')
+Traceback (most recent call last):
+    ...
+InvalidLength: ...
+>>> validate('520000')
+Traceback (most recent call last):
+    ...
+InvalidLength: ...
+"""
+
+
+from stdnum.exceptions import *
+from stdnum.util import clean, isdigits
+
+
+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 postal code."""
+    number = compact(number)
+    if len(number) != 5:
+        raise InvalidLength()
+    if not isdigits(number):
+        raise InvalidFormat()
+    if not '01' <= number[:2] <= '52':
+        raise InvalidComponent()
+    return number
+
+
+def is_valid(number):
+    """Check if the number provided is a valid postal code."""
+    try:
+        return bool(validate(number))
+    except ValidationError:
+        return False

-----------------------------------------------------------------------

Summary of changes:
 stdnum/{fi/veronumero.py => es/postal_code.py} | 57 +++++++++++++++-----------
 1 file changed, 34 insertions(+), 23 deletions(-)
 copy stdnum/{fi/veronumero.py => es/postal_code.py} (54%)


hooks/post-receive
-- 
python-stdnum