跳到内容

ISBN

pydantic_extra_types.isbn 模块提供了接收和验证 ISBN 的功能。

ISBN（国际标准书号）是一个旨在成为唯一的数字商业图书标识符。此模块为 Pydantic 模型提供了一个 ISBN 类型。

ISBN

Bases: str

表示 ISBN，并提供转换、验证和序列化方法。

from pydantic import BaseModel

from pydantic_extra_types.isbn import ISBN


class Book(BaseModel):
    isbn: ISBN

book = Book(isbn="8537809667")
print(book)
#> isbn='9788537809662'

validate_isbn_format staticmethod 

validate_isbn_format(value: str) -> None

从提供的 str 值验证 ISBN 格式。

参数

名称 类型 描述 默认值
value str

表示 10 位或 13 位 ISBN 的 str 值。

 必需

引发

类型 描述
PydanticCustomError

如果 ISBN 无效。
Source code in .venv/lib/python3.12/site-packages/pydantic_extra_types/isbn.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
@staticmethod
def validate_isbn_format(value: str) -> None:
    """Validate a ISBN format from the provided str value.

    Args:
        value: The str value representing the ISBN in 10 or 13 digits.

    Raises:
        PydanticCustomError: If the ISBN is not valid.
    """

    isbn_length = len(value)

    if isbn_length not in (10, 13):
        raise PydanticCustomError('isbn_length', f'Length for ISBN must be 10 or 13 digits, not {isbn_length}')

    if isbn_length == 10:
        if not value[:-1].isdigit() or ((value[-1] != 'X') and (not value[-1].isdigit())):
            raise PydanticCustomError('isbn10_invalid_characters', 'First 9 digits of ISBN-10 must be integers')
        if isbn10_digit_calc(value) != value[-1]:
            raise PydanticCustomError('isbn_invalid_digit_check_isbn10', 'Provided digit is invalid for given ISBN')

    if isbn_length == 13:
        if not value.isdigit():
            raise PydanticCustomError('isbn13_invalid_characters', 'All digits of ISBN-13 must be integers')
        if value[:3] not in ('978', '979'):
            raise PydanticCustomError(
                'isbn_invalid_early_characters', 'The first 3 digits of ISBN-13 must be 978 or 979'
            )
        if isbn13_digit_calc(value) != value[-1]:
            raise PydanticCustomError('isbn_invalid_digit_check_isbn13', 'Provided digit is invalid for given ISBN')

convert_isbn10_to_isbn13 staticmethod 

convert_isbn10_to_isbn13(value: str) -> str

将 ISBN-10 转换为 ISBN-13。

参数

名称 类型 描述 默认值
value str

要转换的 ISBN-10 值。

 必需

返回

类型 描述
str

转换后的 ISBN 或原始值（如果不需要转换）。
Source code in .venv/lib/python3.12/site-packages/pydantic_extra_types/isbn.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
@staticmethod
def convert_isbn10_to_isbn13(value: str) -> str:
    """Convert an ISBN-10 to ISBN-13.

    Args:
        value: The ISBN-10 value to be converted.

    Returns:
        The converted ISBN or the original value if no conversion is necessary.
    """

    if len(value) == 10:
        base_isbn = f'978{value[:-1]}'
        isbn13_digit = isbn13_digit_calc(base_isbn)
        return ISBN(f'{base_isbn}{isbn13_digit}')

    return ISBN(value)

isbn10_digit_calc 

isbn10_digit_calc(isbn: str) -> str

从提供的 str 值计算 ISBN-10 的最后一位数字。有关验证算法的更多信息，请访问 Wikipedia

参数

名称 类型 描述 默认值
isbn str

表示 10 位 ISBN 的 str 值。

 必需

返回

类型 描述
str

计算出的 ISBN-10 值的最后一位数字。
Source code in .venv/lib/python3.12/site-packages/pydantic_extra_types/isbn.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
def isbn10_digit_calc(isbn: str) -> str:
    """Calc a ISBN-10 last digit from the provided str value. More information of validation algorithm on [Wikipedia](https://en.wikipedia.org/wiki/ISBN#Check_digits)

    Args:
        isbn: The str value representing the ISBN in 10 digits.

    Returns:
        The calculated last digit of the ISBN-10 value.
    """
    total = sum(int(digit) * (10 - idx) for idx, digit in enumerate(isbn[:9]))

    for check_digit in range(1, 11):
        if (total + check_digit) % 11 == 0:
            valid_check_digit = 'X' if check_digit == 10 else str(check_digit)

    return valid_check_digit

isbn13_digit_calc 

isbn13_digit_calc(isbn: str) -> str

从提供的 str 值计算 ISBN-13 的最后一位数字。有关验证算法的更多信息，请访问 Wikipedia

参数

名称 类型 描述 默认值
isbn str

表示 13 位 ISBN 的 str 值。

 必需

返回

类型 描述
str

计算出的 ISBN-13 值的最后一位数字。
Source code in .venv/lib/python3.12/site-packages/pydantic_extra_types/isbn.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def isbn13_digit_calc(isbn: str) -> str:
    """Calc a ISBN-13 last digit from the provided str value. More information of validation algorithm on [Wikipedia](https://en.wikipedia.org/wiki/ISBN#Check_digits)

    Args:
        isbn: The str value representing the ISBN in 13 digits.

    Returns:
        The calculated last digit of the ISBN-13 value.
    """
    total = sum(int(digit) * (1 if idx % 2 == 0 else 3) for idx, digit in enumerate(isbn[:12]))

    check_digit = (10 - (total % 10)) % 10

    return str(check_digit)