Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArthur de Jong <arthur@arthurdejong.org>2013-11-09 22:29:58 +0100
committerArthur de Jong <arthur@arthurdejong.org>2013-11-10 20:12:58 +0100
commitb0c47d5e2889fe7ead576c9b4e8334e9699e5fda (patch)
tree53c18d41193dff301c5a09a548a9224d34437d80
parent73d05b0a352089131b80de57a3b705425a44e6c6 (diff)
Add a Dutch postal code module
The Dutch postal code (postcode) consists of four digits followed by two characters and together with the house number should uniquely identify any address. Addresses trac ticket #7.
-rw-r--r--stdnum/nl/__init__.py5
-rw-r--r--stdnum/nl/postcode.py77
2 files changed, 80 insertions, 2 deletions
diff --git a/stdnum/nl/__init__.py b/stdnum/nl/__init__.py
index b119938..aa4f68d 100644
--- a/stdnum/nl/__init__.py
+++ b/stdnum/nl/__init__.py
@@ -1,7 +1,7 @@
# __init__.py - collection of Dutch numbers
# coding: utf-8
#
-# Copyright (C) 2012 Arthur de Jong
+# 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
@@ -20,5 +20,6 @@
"""Collection of Dutch numbers."""
-# provide vat as an alias
+# provide aliases
from stdnum.nl import btw as vat
+from stdnum.nl import postcode as postcal_code
diff --git a/stdnum/nl/postcode.py b/stdnum/nl/postcode.py
new file mode 100644
index 0000000..b154588
--- /dev/null
+++ b/stdnum/nl/postcode.py
@@ -0,0 +1,77 @@
+# postcode.py - functions for handling Dutch postal codes
+#
+# Copyright (C) 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
+
+"""Postcode (Dutch postal code).
+
+The Dutch postal code consists of four numbers followed by two letters.
+
+>>> validate('2601 DC')
+'2601 DC'
+>>> validate('NL-2611ET')
+'2611 ET'
+>>> validate('26112 ET')
+Traceback (most recent call last):
+ ...
+InvalidFormat: ...
+>>> validate('2611 SS') # a few letter combinations are banned
+Traceback (most recent call last):
+ ...
+InvalidComponent: ...
+"""
+
+import re
+
+from stdnum.exceptions import *
+from stdnum.util import clean
+
+
+_postcode_re = re.compile(r'^(?P<pt1>[1-9][0-9]{3})(?P<pt2>[A-Z]{2})$')
+
+
+_postcode_blacklist = ('SA', 'SD' ,'SS')
+
+
+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('NL'):
+ number = number[2:]
+ return number
+
+
+def validate(number):
+ """Checks to see if the number provided is in the correct format.
+ This currently does not check whether the code corresponds to a real
+ address."""
+ number = compact(number)
+ match = _postcode_re.search(number)
+ if not match:
+ raise InvalidFormat()
+ if match.group('pt2') in _postcode_blacklist:
+ raise InvalidComponent()
+ return '%s %s' % (match.group('pt1'), match.group('pt2'))
+
+
+def is_valid(number):
+ """Checks to see if the number provided is a valid postal code."""
+ try:
+ return bool(validate(number))
+ except ValidationError:
+ return False