Exercism v3 launches on Sept 1st 2021. Learn more! ๐Ÿš€๐Ÿš€๐Ÿš€
Avatar of rootulp

rootulp's solution

to ISBN Verifier in the Python Track

Published at Jul 13 2018 · 0 comments
Instructions
Test suite
Solution

Note:

This solution was written on an old version of Exercism. The tests below might not correspond to the solution code, and the exercise may have changed since this code was written.

The ISBN-10 verification process is used to validate book identification numbers. These normally contain dashes and look like: 3-598-21508-8

ISBN

The ISBN-10 format is 9 digits (0 to 9) plus one check character (either a digit or an X only). In the case the check character is an X, this represents the value '10'. These may be communicated with or without hyphens, and can be checked for their validity by the following formula:

(x1 * 10 + x2 * 9 + x3 * 8 + x4 * 7 + x5 * 6 + x6 * 5 + x7 * 4 + x8 * 3 + x9 * 2 + x10 * 1) mod 11 == 0

If the result is 0, then it is a valid ISBN-10, otherwise it is invalid.

Example

Let's take the ISBN-10 3-598-21508-8. We plug it in to the formula, and get:

(3 * 10 + 5 * 9 + 9 * 8 + 8 * 7 + 2 * 6 + 1 * 5 + 5 * 4 + 0 * 3 + 8 * 2 + 8 * 1) mod 11 == 0

Since the result is 0, this proves that our ISBN is valid.

Task

Given a string the program should check if the provided string is a valid ISBN-10. Putting this into place requires some thinking about preprocessing/parsing of the string prior to calculating the check digit for the ISBN.

The program should be able to verify ISBN-10 both with and without separating dashes.

Caveats

Converting from strings to numbers can be tricky in certain languages. Now, it's even trickier since the check digit of an ISBN-10 may be 'X' (representing '10'). For instance 3-598-21507-X is a valid ISBN-10.

Bonus tasks

  • Generate a valid ISBN-13 from the input ISBN-10 (and maybe verify it again with a derived verifier).

  • Generate valid ISBN, maybe even from a given starting ISBN.

Exception messages

Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to indicate what the source of the error is. This makes your code more readable and helps significantly with debugging. Not every exercise will require you to raise an exception, but for those that do, the tests will only pass if you include a message.

To raise a message with an exception, just write it as an argument to the exception type. For example, instead of raise Exception, you should write:

raise Exception("Meaningful message indicating the source of the error")

Running the tests

To run the tests, run the appropriate command below (why they are different):

  • Python 2.7: py.test isbn_verifier_test.py
  • Python 3.4+: pytest isbn_verifier_test.py

Alternatively, you can tell Python to run the pytest module (allowing the same command to be used regardless of Python version): python -m pytest isbn_verifier_test.py

Common pytest options

  • -v : enable verbose output
  • -x : stop running tests on first failure
  • --ff : run failures from previous test before running other test cases

For other options, see python -m pytest -h

Submitting Exercises

Note that, when trying to submit an exercise, make sure the solution is in the $EXERCISM_WORKSPACE/python/isbn-verifier directory.

You can find your Exercism workspace by running exercism debug and looking for the line that starts with Workspace.

For more detailed information about running tests, code style and linting, please see the help page.

Source

Converting a string into a number and some basic processing utilizing a relatable real world example. https://en.wikipedia.org/wiki/International_Standard_Book_Number#ISBN-10_check_digit_calculation

Submitting Incomplete Solutions

It's possible to submit an incomplete solution so you can see how others have completed the exercise.

isbn_verifier_test.py

import unittest

from isbn_verifier import verify


# Tests adapted from `problem-specifications//canonical-data.json` @ v2.4.0

class IsbnVerifierTest(unittest.TestCase):

    def test_valid_isbn_number(self):
        self.assertIs(verify('3-598-21508-8'), True)

    def test_invalid_check_digit(self):
        self.assertIs(verify('3-598-21508-9'), False)

    def test_valid_with_X_check_digit(self):
        self.assertIs(verify('3-598-21507-X'), True)

    def test_invalid_check_digit_other_than_X(self):
        self.assertIs(verify('3-598-21507-A'), False)

    def test_invalid_character_in_isbn(self):
        self.assertIs(verify('3-598-P1581-X'), False)

    def test_invalid_X_other_than_check_digit(self):
        self.assertIs(verify('3-598-2X507-9'), False)

    def test_valid_isbn_without_separating_dashes(self):
        self.assertIs(verify('3598215088'), True)

    def test_valid_isbn_without_separating_dashes_with_X_check_digit(self):
        self.assertIs(verify('359821507X'), True)

    def test_invalid_isbn_without_check_digit_and_dashes(self):
        self.assertIs(verify('359821507'), False)

    def test_invalid_too_long_isbn_with_no_dashes(self):
        self.assertIs(verify('3598215078X'), False)

    def test_invalid_isbn_without_check_digit(self):
        self.assertIs(verify('3-598-21507'), False)

    def test_invalid_too_long_isbn(self):
        self.assertIs(verify('3-598-21507-XX'), False)

    def test_invalid_check_digit_X_used_for_0(self):
        self.assertIs(verify('3-598-21515-X'), False)

    def test_valid_empty_isbn(self):
        self.assertIs(verify(''), False)

    def test_input_is_nine_characters(self):
        self.assertIs(verify('134456729'), False)


if __name__ == '__main__':
    unittest.main()
class IsbnVerifier(object):

    VALID_SEPERATOR = "-"
    VALID_CHECK_CHARACTER = "X"
    VALID_DIGITS = list(map(str, range(0, 10)))
    VALID_CHARACTERS = set(VALID_DIGITS) | set([VALID_SEPERATOR, VALID_CHECK_CHARACTER])
    VALID_LENGTH = 10

    @classmethod
    def verify(cls, string):
        if cls.invalid(string):
            return False
        return cls.is_valid_isbn(string)

    @classmethod
    def is_valid_isbn(cls, string):
        return cls.checksum(string) % 11 == 0

    @classmethod
    def checksum(cls, string):
        return sum([cls.convert_char_to_int(char) * (10 - i) for i, char in enumerate(cls.remove_seperators(string))])

    @classmethod
    def invalid(cls, string):
        return cls.invalid_character(string) or cls.invalid_length(string) or cls.invalid_X_other_than_check_digit(string)

    @classmethod
    def invalid_character(cls, string):
        return any(char not in cls.VALID_CHARACTERS for char in string)

    @classmethod
    def invalid_length(cls, string):
        return len(cls.remove_invalid_characters_and_seperators(string)) != cls.VALID_LENGTH

    @classmethod
    def invalid_X_other_than_check_digit(cls, string):
        return cls.VALID_CHECK_CHARACTER in string and not string.endswith(cls.VALID_CHECK_CHARACTER)

    @classmethod
    def remove_invalid_characters_and_seperators(cls, string):
        return cls.remove_seperators(cls.remove_invalid_characters(string))

    @classmethod
    def remove_invalid_characters(cls, string):
        return "".join(filter(lambda char: char in cls.VALID_CHARACTERS, string))

    @classmethod
    def convert_char_to_int(cls, char):
        return int(cls.convert_check_character_to_ten(char))

    @classmethod
    def convert_check_character_to_ten(cls, char):
        return 10 if char == cls.VALID_CHECK_CHARACTER else char

    @classmethod
    def remove_seperators(cls, string):
        return "".join(filter(lambda char: char != cls.VALID_SEPERATOR , string))


def verify(isbn):
    return IsbnVerifier.verify(isbn)

Community comments

Find this solution interesting? Ask the author a question to learn more.

What can you learn from this solution?

A huge amount can be learned from reading other peopleโ€™s code. This is why we wanted to give exercism users the option of making their solutions public.

Here are some questions to help you reflect on this solution and learn the most from it.

  • What compromises have been made?
  • Are there new concepts here that you could read more about to improve your understanding?