mypy-extras

功能

• 提供增强其可能性的自定义mypy插件
• 提供新类型，这些类型可以与我们的插件一起使用
• 使用注释完全类型化，并通过mypy检查，与PEP561兼容

安装

pip install mypy-extras

您还需要正确配置 mypy 并安装我们的自定义插件

# In setup.cfg or mypy.ini:
[mypy]
plugins =
  mypy_extras.plugin.entrypoint

我们还建议使用我们使用的相同的mypy设置我们使用的。

用法

AttrOf

我们提供一个特殊类型来获取其他类型的命名属性，如下所示

from typing_extensions import Literal  # or typing on python3.8+
from mypy_extras import AttrOf

class User(object):
    def auth(self, username: str, password: str) -> bool:
        return False  # Just an example

def get_callback(user: User) -> AttrOf[User, Literal['auth']]:
    return user.auth

user: User
reveal_type(get_callback(user))
# Revealed type is 'def (username: builtins.str, password: builtins.str) -> builtins.bool'

ensure_attr

我们可以确保某些str属性在对象上存在

from mypy_extras import ensure_attr


class User(object):
    policy = 'update'


reveal_type(ensure_attr(User, 'policy'))  # Revealed type is 'Literal['policy']'
reveal_type(ensure_attr(User, 'missing'))  # Error: attribute "missing" does not exist on type "User"

当我们根据字符串字段对对象进行任何操作时，这非常有用

DEFAULT_POLICY_FIELD: Final = ensure_attr(User, 'policy')  # typesafe
# vs
DEFAULT_POLICY_FIELD: Final = 'policy'  
# User can rename the field, and this will blow now!

许可协议

MIT