isbn verifier exercise

This commit is contained in:
Xevion
2019-07-14 03:39:33 -05:00
parent 05203204d7
commit 83c3b8a76c
4 changed files with 162 additions and 0 deletions

View File

@@ -0,0 +1 @@
{"track":"python","exercise":"isbn-verifier","id":"fa2d5d0d7cc8469586d7227f197cff9f","url":"https://exercism.io/my/solutions/fa2d5d0d7cc8469586d7227f197cff9f","handle":"Xevion","is_requester":true,"auto_approve":false}

View File

@@ -0,0 +1,90 @@
# ISBN Verifier
The [ISBN-10 verification process](https://en.wikipedia.org/wiki/International_Standard_Book_Number) 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:
```python
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](https://github.com/pytest-dev/pytest/issues/1629#issue-161422224)):
- 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 [Running the Tests](http://exercism.io/tracks/python/tests).
## 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](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.

View File

@@ -0,0 +1,8 @@
def is_valid(isbn):
# Filter out hyphens or any other junk
isbn = [num for num in isbn if num in '0123456789X']
# Check length as well as out of place 'X' chars
if len(isbn) < 10 or len(isbn) > 10 or any([True if (isbn[i] == 'X' and i < 9) else False for i in range(len(isbn))]): return False
# Convert to ints then calculate isbn validity
isbn = [int(digit) if digit != 'X' else 10 for digit in isbn]
return (isbn[0] * 10 + isbn[1] * 9 + isbn[2] * 8 + isbn[3] * 7 + isbn[4] * 6 + isbn[5] * 5 + isbn[6] * 4 + isbn[7] * 3 + isbn[8] * 2 + isbn[9] * 1) % 11 == 0

View File

@@ -0,0 +1,63 @@
import unittest
from isbn_verifier import is_valid
# Tests adapted from `problem-specifications//canonical-data.json` @ v2.7.0
class IsbnVerifierTest(unittest.TestCase):
def test_valid_isbn_number(self):
self.assertIs(is_valid('3-598-21508-8'), True)
def test_invalid_check_digit(self):
self.assertIs(is_valid('3-598-21508-9'), False)
def test_valid_with_X_check_digit(self):
self.assertIs(is_valid('3-598-21507-X'), True)
def test_invalid_check_digit_other_than_X(self):
self.assertIs(is_valid('3-598-21507-A'), False)
def test_invalid_character_in_isbn(self):
self.assertIs(is_valid('3-598-P1581-X'), False)
def test_invalid_X_other_than_check_digit(self):
self.assertIs(is_valid('3-598-2X507-9'), False)
def test_valid_isbn_without_separating_dashes(self):
self.assertIs(is_valid('3598215088'), True)
def test_valid_isbn_without_separating_dashes_with_X_check_digit(self):
self.assertIs(is_valid('359821507X'), True)
def test_invalid_isbn_without_check_digit_and_dashes(self):
self.assertIs(is_valid('359821507'), False)
def test_invalid_too_long_isbn_with_no_dashes(self):
self.assertIs(is_valid('3598215078X'), False)
def test_invalid_too_short_isbn(self):
self.assertIs(is_valid('00'), False)
def test_invalid_isbn_without_check_digit(self):
self.assertIs(is_valid('3-598-21507'), False)
def test_invalid_check_digit_X_used_for_0(self):
self.assertIs(is_valid('3-598-21515-X'), False)
def test_valid_empty_isbn(self):
self.assertIs(is_valid(''), False)
def test_input_is_nine_characters(self):
self.assertIs(is_valid('134456729'), False)
def test_invalid_characters_are_not_ignored(self):
self.assertIs(is_valid('3132P34035'), False)
def test_input_is_too_long_but_contains_a_valid_isbn(self):
self.assertIs(is_valid('98245726788'), False)
if __name__ == '__main__':
unittest.main()