限制可能值的Python类型提示友好类型

Question

我想要一种python type-hint友好的方式来创建具有受限制的值范围的Type。

例如，基于类型str的 URL 类型，该类型仅接受看起来像“ http” URL的字符串。

# this code is made up and will not compile
class URL(typing.NewType('_URL', str)):
    def __init__(self, value: str, *args, **kwargs):
        if not (value.startswith('http://') or value.startswith('https://')):
            raise ValueError('string is not an acceptable URL')

Answer 1

覆盖内置的不可变类型效果很好

覆盖str； http URL字符串

以下是覆盖str的示例。这不需要typing模块，但仍可以使用类型提示。

此str派生类断言初始化后的字符串看起来像http URL字符串。

class URL(str):
    def __new__(cls, *value):
        if value:
            v0 = value[0]
            if not type(v0) is str:
                raise TypeError('Unexpected type for URL: "%s"' % type(v0))
            if not (v0.startswith('http://') or v0.startswith('https://')):
                raise ValueError('Passed string value "%s" is not an'
                                 ' "http*://" URL' % (v0,))
        # else allow None to be passed. This allows an "empty" URL instance, e.g. `URL()`
        # `URL()` evaluates False

        return str.__new__(cls, *value)

这将导致只允许某些字符串的类。否则，它的行为就像一个不变的str实例。

# these are okay
URL()
URL('http://example.com')
URL('https://example.com')
URL('https://')

# these raise ValueError
URL('example')  # ValueError: Passed string value "example" is not an "http*://" URL
URL('')  # ValueError: Passed string value "" is not an "http*://" URL

# these evaluate as you would expect
for url in (URL(),  # 'False'
            URL('https://'),  # 'True'
            URL('https://example.com'),  # 'True'
           ):
    print('True') if url else print('False')

（更新：稍后我发现了purl Python库）

另一个例子，

覆盖int；约束整数范围Number

此int派生类仅允许包含值1至9。

这也有一个特殊功能。如果实例不进行任何初始化（Number()），则该值等于0（此行为是从int类派生的）。在这种情况下，__str__应该是'.'（程序要求）。

class Number(int):
    """integer type with constraints; part of a Sudoku game"""

    MIN = 1  # minimum
    MAX = 9  # maximum

    def __new__(cls, *value):
        if value:
            v0 = int(value[0])
            if not (cls.MIN <= v0 <= cls.MAX):
                raise ValueError('Bad value "%s" is not acceptable in'
                                 ' Sudoku' % (v0,))
        # else:
        #    allow None to be passed. This allows an "empty" Number instance that
        #    evaluates False, e.g. `Number()`

        return int.__new__(cls, *value)

    def __str__(self):
        """print the Number accounting for an "empty" value"""
        if self == 0:
            return '.'
        return int.__str__(self)

这确保了错误的输入可以早于而不是迟于处理。否则，它的行为就像int。

# these are okay
Number(1)
Number(9)
Number('9')

# this will evaluate True, just like an int
Number(9) == int(9)
Number('9') == int(9)
Number('9') == float(9)

# this is okay, it will evaluate False
Number()
print('True') if Number() else print('False')  # 'False'

# these raise ValueError
Number(0)  # ValueError: Bad value "0" is not acceptable in Sudoku
Number(11)  # ValueError: Bad value "11" is not acceptable in Sudoku
Number('11')  # ValueError: Bad value "11" is not acceptable in Sudoku

还有特殊的“功能”

print(Number(1)) # '1' (expected)
print(Number())  # '.' (special feature)

---

inheriting immutable types is derived from this SO answer的技术。

Answer 2

子类化内置类型可能导致一些奇怪的情况（请考虑严格检查type(...) is str的代码）

这里是一种纯类型方法，它是类型安全的，并且完全保留了字符串的类型：

from typing import NewType

_Url = NewType('_Url', str)

def URL(s: str) -> _Url:
    if not s.startswith('https://'):
        raise AssertionError(s)
    return _Url(s)

print(type(URL('https://example.com')) is str)  # prints `True`

这里的方法“隐藏”了函数运行时检查，该函数从api的角度看似构造函数，但实际上只是一个tiny type（我找不到对“微小类型”的规范引用这似乎是我能找到的最好的资源。