python-stdnum commit: r33 - in python-stdnum: . stdnum tests

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

Author: arthur
Date: Sat Aug 21 17:37:27 2010
New Revision: 33
URL: http://arthurdejong.org/viewvc/python-stdnum?view=rev&revision=33

Log:
add an ISMN (International Standard Music Number) module

Added:
   python-stdnum/stdnum/ismn.py
   python-stdnum/tests/test_ismn.doctest
Modified:
   python-stdnum/README

Modified: python-stdnum/README
==============================================================================
--- python-stdnum/README        Sat Aug 21 14:41:00 2010        (r32)
+++ python-stdnum/README        Sat Aug 21 17:37:27 2010        (r33)
@@ -11,6 +11,7 @@
 
 - ISBN (International Standard Book Number)
 - ISSN (International Standard Serial Number)
+- ISMN (International Standard Music Number)
 - BSN (Burgerservicenummer, the Dutch national identification number)
 - IMEI (International Mobile Equipment Identity)
 - MEID (Mobile Equipment Identifier)

Added: python-stdnum/stdnum/ismn.py
==============================================================================
--- /dev/null   00:00:00 1970   (empty, because file is newly added)
+++ python-stdnum/stdnum/ismn.py        Sat Aug 21 17:37:27 2010        (r33)
@@ -0,0 +1,103 @@
+# __init__.py - functions for handling ISMNs
+#
+# Copyright (C) 2010 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
+
+"""Module for handling ISMNs (International Standard Music Number). This
+module handles both numbers in the 10-digit 13-digit format.
+
+>>> is_valid('979-0-3452-4680-5')
+True
+>>> is_valid('9790060115615')
+True
+>>> is_valid(' M-2306-7118-7')
+True
+>>> is_valid('9790060115614') # incorrect check digit
+False
+>>> compact('  979-0-3452-4680-5')
+'9790345246805'
+>>> format('9790060115615')
+'979-0-060-11561-5'
+>>> format('M230671187')
+'979-0-2306-7118-7'
+>>> to_ismn13('M230671187')
+'9790230671187'
+"""
+
+
+def compact(number):
+    """Convert the ISMN to the minimal representation. This strips the number
+    of any valid ISMN separators and removes surrounding whitespace."""
+    number = number.replace(' 
','').replace('-','').replace('.','').strip().upper()
+    return number
+
+def _calc_check_digit(number):
+    """Calculate the ISMN check digit. The number passed should not have
+    the check bit included and should be in the 13-digit form."""
+    return str((10 - sum( (2 * (i % 2) + 1) * int(number[i]) for i in 
range(len(number)))) % 10)
+
+def is_valid(number):
+    """Checks to see if the number provided is a valid ISMN (either a legacy
+    10-digit one or a 13-digit one). This checks the length and the check
+    bit but does not check if the publisher is valid."""
+    try:
+        number = compact(number)
+    except:
+        return False
+    if len(number) == 10 and number[0] == 'M' and number[1:].isdigit():
+        if _calc_check_digit('9790' + number[1:-1]) == number[-1]:
+            return True
+    elif len(number) == 13 and number.isdigit():
+        if _calc_check_digit(number[:-1]) == number[-1]:
+            return True
+    return False
+
+def to_ismn13(number):
+    """Convert the number to ISMN13 format."""
+    number = number.strip()
+    min_number = compact(number)
+    if len(min_number) == 13:
+        return number # nothing to do, already 13 digit format
+    # add prefix and strip the M
+    if ' ' in number:
+        return '979 0' + number[1:]
+    elif '-' in number:
+        return '979-0' + number[1:]
+    else:
+        return '9790' + number[1:]
+
+# these are the ranges allocated to publisher codes
+_ranges = ( (3, '000', '099'), (4, '1000', '3999'), (5, '40000', '69999'),
+            (6, '700000', '899999'), (7, '9000000', '9999999') )
+
+def split(number):
+    """Split the specified ISMN into a bookland prefix (979), an ISMN
+    prefix (0), a publisher element (3 to 7 digits), an item element (2 to
+    6 digits) and a check digit."""
+    # clean up number
+    number = to_ismn13(compact(number))
+    # rind the correct range and split the number
+    for length, low, high in _ranges:
+        if low <= number[4:4+length] <= high:
+            return number[:3], number[3], number[4:4+length], 
number[4+length:-1], number[-1]
+
+def format(number, separator='-'):
+    """Reformat the passed number to the standard format with the
+    prefixes, the publisher element, the item element and the check-digit
+    separated by the specified separator. The number is converted to the
+    13-digit format silently."""
+    return separator.join(x for x in split(number) if x)

Added: python-stdnum/tests/test_ismn.doctest
==============================================================================
--- /dev/null   00:00:00 1970   (empty, because file is newly added)
+++ python-stdnum/tests/test_ismn.doctest       Sat Aug 21 17:37:27 2010        
(r33)
@@ -0,0 +1,79 @@
+test_ismn.doctest - more detailed doctests for stdnum.ismn module
+
+Copyright (C) 2010 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
+
+
+This file contains more detailed doctests for the stdnum.ismn module. It
+tries to test more corner cases and detailed functionality that is not
+really useful as module documentation.
+
+>>> from stdnum import ismn
+
+
+These are normal variations that should just work.
+
+>>> ismn.is_valid('979-0-3217-6543-6')
+True
+>>> ismn.is_valid(u'979-0-3217-6544-3')
+True
+>>> ismn.is_valid('9790321765450')
+True
+>>> ismn.is_valid('M-3217-6546-7')
+True
+>>> ismn.is_valid('M321765474')
+True
+>>> ismn.is_valid('979-0-260000438')
+True
+
+
+These are tests to check what happes when a wrong type is passed.
+
+>>> ismn.is_valid(1857982185) # integer, not string
+False
+>>> ismn.is_valid(None)
+False
+>>> ismn.is_valid('')
+False
+
+
+Tests for mangling and incorect check digits.
+
+>>> ismn.is_valid('979-0-3217-6543-x')
+False
+>>> ismn.is_valid('M-3217-6546-8')
+False
+>>> ismn.is_valid('979M321765450')
+False
+
+
+See if 10 to 13 digit conversion works.
+
+>>> ismn.to_ismn13('979-0-32176544-3') # ismn13 should stay ismn13
+'979-0-32176544-3'
+>>> ismn.to_ismn13('M-32176546-7')
+'979-0-32176546-7'
+>>> ismn.to_ismn13('M 3217 65504')
+'979 0 3217 65504'
+
+
+Regrouping tests.
+
+>>> ismn.format('M-3217-6546-7')
+'979-0-3217-6546-7'
+>>> ismn.format('9790321765450')
+'979-0-3217-6545-0'
--
To unsubscribe send an email to
python-stdnum-commits-unsubscribe@lists.arthurdejong.org or see
http://lists.arthurdejong.org/python-stdnum-commits