Skip to content

Commit bddeb74

Browse files
committed
Started working on the ISBN Verifier challenge
1 parent 90f024c commit bddeb74

File tree

4 files changed

+153
-0
lines changed

4 files changed

+153
-0
lines changed

Diff for: isbn-verifier/.exercism/metadata.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"track":"python","exercise":"isbn-verifier","id":"52722cfe3d584b4abcd086f9019ff85b","url":"https://exercism.io/my/solutions/52722cfe3d584b4abcd086f9019ff85b","handle":"sinanata","is_requester":true,"auto_approve":false}

Diff for: isbn-verifier/README.md

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# ISBN Verifier
2+
3+
The [ISBN-10 verification process](https://en.wikipedia.org/wiki/International_Standard_Book_Number) is used to validate book identification
4+
numbers. These normally contain dashes and look like: `3-598-21508-8`
5+
6+
## ISBN
7+
8+
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:
9+
10+
```
11+
(x1 * 10 + x2 * 9 + x3 * 8 + x4 * 7 + x5 * 6 + x6 * 5 + x7 * 4 + x8 * 3 + x9 * 2 + x10 * 1) mod 11 == 0
12+
```
13+
14+
If the result is 0, then it is a valid ISBN-10, otherwise it is invalid.
15+
16+
## Example
17+
18+
Let's take the ISBN-10 `3-598-21508-8`. We plug it in to the formula, and get:
19+
```
20+
(3 * 10 + 5 * 9 + 9 * 8 + 8 * 7 + 2 * 6 + 1 * 5 + 5 * 4 + 0 * 3 + 8 * 2 + 8 * 1) mod 11 == 0
21+
```
22+
23+
Since the result is 0, this proves that our ISBN is valid.
24+
25+
## Task
26+
27+
Given a string the program should check if the provided string is a valid ISBN-10.
28+
Putting this into place requires some thinking about preprocessing/parsing of the string prior to calculating the check digit for the ISBN.
29+
30+
The program should be able to verify ISBN-10 both with and without separating dashes.
31+
32+
33+
## Caveats
34+
35+
Converting from strings to numbers can be tricky in certain languages.
36+
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.
37+
38+
## Bonus tasks
39+
40+
* Generate a valid ISBN-13 from the input ISBN-10 (and maybe verify it again with a derived verifier).
41+
42+
* Generate valid ISBN, maybe even from a given starting ISBN.
43+
44+
## Exception messages
45+
46+
Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to
47+
indicate what the source of the error is. This makes your code more readable and helps significantly with debugging. Not
48+
every exercise will require you to raise an exception, but for those that do, the tests will only pass if you include
49+
a message.
50+
51+
To raise a message with an exception, just write it as an argument to the exception type. For example, instead of
52+
`raise Exception`, you should write:
53+
54+
```python
55+
raise Exception("Meaningful message indicating the source of the error")
56+
```
57+
58+
## Running the tests
59+
60+
To run the tests, run `pytest isbn_verifier_test.py`
61+
62+
Alternatively, you can tell Python to run the pytest module:
63+
`python -m pytest isbn_verifier_test.py`
64+
65+
### Common `pytest` options
66+
67+
- `-v` : enable verbose output
68+
- `-x` : stop running tests on first failure
69+
- `--ff` : run failures from previous test before running other test cases
70+
71+
For other options, see `python -m pytest -h`
72+
73+
## Submitting Exercises
74+
75+
Note that, when trying to submit an exercise, make sure the solution is in the `$EXERCISM_WORKSPACE/python/isbn-verifier` directory.
76+
77+
You can find your Exercism workspace by running `exercism debug` and looking for the line that starts with `Workspace`.
78+
79+
For more detailed information about running tests, code style and linting,
80+
please see [Running the Tests](http://exercism.io/tracks/python/tests).
81+
82+
## Source
83+
84+
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)
85+
86+
## Submitting Incomplete Solutions
87+
88+
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

Diff for: isbn-verifier/isbn_verifier.py

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
def is_valid(isbn):
2+
pass

Diff for: isbn-verifier/isbn_verifier_test.py

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
import unittest
2+
3+
from isbn_verifier import is_valid
4+
5+
# Tests adapted from `problem-specifications//canonical-data.json` @ v2.7.0
6+
7+
8+
class IsbnVerifierTest(unittest.TestCase):
9+
def test_valid_isbn_number(self):
10+
self.assertIs(is_valid("3-598-21508-8"), True)
11+
12+
def test_invalid_isbn_check_digit(self):
13+
self.assertIs(is_valid("3-598-21508-9"), False)
14+
15+
def test_valid_isbn_number_with_a_check_digit_of_10(self):
16+
self.assertIs(is_valid("3-598-21507-X"), True)
17+
18+
def test_check_digit_is_a_character_other_than_x(self):
19+
self.assertIs(is_valid("3-598-21507-A"), False)
20+
21+
def test_invalid_character_in_isbn(self):
22+
self.assertIs(is_valid("3-598-P1581-X"), False)
23+
24+
def test_x_is_only_valid_as_a_check_digit(self):
25+
self.assertIs(is_valid("3-598-2X507-9"), False)
26+
27+
def test_valid_isbn_without_separating_dashes(self):
28+
self.assertIs(is_valid("3598215088"), True)
29+
30+
def test_isbn_without_separating_dashes_and_x_as_check_digit(self):
31+
self.assertIs(is_valid("359821507X"), True)
32+
33+
def test_isbn_without_check_digit_and_dashes(self):
34+
self.assertIs(is_valid("359821507"), False)
35+
36+
def test_too_long_isbn_and_no_dashes(self):
37+
self.assertIs(is_valid("3598215078X"), False)
38+
39+
def test_too_short_isbn(self):
40+
self.assertIs(is_valid("00"), False)
41+
42+
def test_isbn_without_check_digit(self):
43+
self.assertIs(is_valid("3-598-21507"), False)
44+
45+
def test_check_digit_of_x_should_not_be_used_for_0(self):
46+
self.assertIs(is_valid("3-598-21515-X"), False)
47+
48+
def test_empty_isbn(self):
49+
self.assertIs(is_valid(""), False)
50+
51+
def test_input_is_9_characters(self):
52+
self.assertIs(is_valid("134456729"), False)
53+
54+
def test_invalid_characters_are_not_ignored(self):
55+
self.assertIs(is_valid("3132P34035"), False)
56+
57+
def test_input_is_too_long_but_contains_a_valid_isbn(self):
58+
self.assertIs(is_valid("98245726788"), False)
59+
60+
61+
if __name__ == "__main__":
62+
unittest.main()

0 commit comments

Comments
 (0)