Python 3 유형 힌트 및 정적 분석

Python 3.5에는 함수 주석을 활용하는 선택적 유형 힌트에 대한 표준 라이브러리 지원을 제공하는 새로운 유형 모듈이 도입되었습니다. 이는 정적 유형 검사(mypy와 같은) 및 향후 자동화된 유형 기반 최적화의 가능성을 열어줍니다. 유형 힌트는 PEP-483 및 PEP-484에 지정됩니다.

이 튜토리얼에서는 유형 힌트 렌더링의 가능성을 살펴보고 mypy를 사용하여 Python 프로그램을 정적으로 분석하고 코드 품질을 크게 향상시키는 방법을 보여 드리겠습니다.

입력 팁

유형 힌트는 함수 주석 위에 구축됩니다. 즉, 함수 주석을 사용하면 매개변수에 주석을 달고 임의의 메타데이터를 사용하여 함수나 메서드의 반환 값을 지정할 수 있습니다. 유형 힌트는 함수 매개변수에 특별히 주석을 달고 표준 유형 정보로 값을 반환하는 함수 주석의 특별한 경우입니다. 일반 함수 주석과 특수 유형 힌트는 완전히 선택 사항입니다. 간단한 예를 살펴보겠습니다:

으아아아

매개변수에는 해당 유형과 반환 값이 주석으로 추가됩니다. 그러나 Python은 이를 완전히 무시한다는 점을 인식하는 것이 중요합니다. 함수 객체의 annotation 속성을 통해 유형 정보만 제공합니다.

으아아아

파이썬이 실제로 유형 힌트를 무시하는지 확인하기 위해 유형 힌트를 완전히 망쳐봅시다:

으아아아

보시다시피 코드는 유형 힌트에 관계없이 동일하게 동작합니다.

타이핑 팁에 대한 동기 부여

알겠습니다. 유형 힌트는 선택 사항입니다. Python은 유형 힌트를 완전히 무시합니다. 그렇다면 그들의 요점은 무엇입니까? 음, 몇 가지 좋은 이유가 있습니다:

• 정적 분석
• IDE 지원
• 표준 문서

나중에는 정적 분석을 위해 Mypy를 사용할 예정입니다. IDE 지원은 유형 힌트에 대한 PyCharm 5 지원으로 시작되었습니다. 표준 문서는 함수 시그니처만 봐도 매개변수와 반환값의 종류를 쉽게 알 수 있을 뿐만 아니라, 힌트에서 형식 정보를 추출할 수 있는 자동 문서 생성기 등 개발자에게 유용하다.

typing 모듈

입력 모듈에는 유형 힌트를 지원하도록 설계된 유형이 포함되어 있습니다. int, str, list 및 dict와 같은 기존 Python 유형을 사용하면 안되는 이유는 무엇입니까? 이러한 유형을 확실히 사용할 수 있지만 Python의 동적 유형 지정으로 인해 기본 유형 이상의 정보를 얻을 수 없습니다. 예를 들어, 매개변수가 문자열과 정수 사이의 맵이 될 수 있도록 지정하려는 경우 표준 Python 유형을 사용하여 이 작업을 수행할 수 없습니다. 입력 모듈을 사용하면 다음과 같이 쉽습니다:

으아아아

두 개의 인수가 있는 함수인 좀 더 완전한 예를 살펴보겠습니다. 그 중 하나는 사전 목록으로, 각 사전에는 문자열 키와 정수 값이 포함되어 있습니다. 다른 매개변수는 문자열 또는 정수입니다. 유형 모듈을 사용하면 이러한 복잡한 매개변수를 정확하게 지정할 수 있습니다.

으아아아

유용한 유형

타이핑 모듈에서 더 흥미로운 유형 중 일부를 살펴보겠습니다.

Callable 유형을 사용하면 Python이 함수를 일급 시민으로 취급하기 때문에 인수로 전달되거나 결과로 반환될 수 있는 함수를 지정할 수 있습니다. 호출 가능 객체의 구문은 매개 변수 유형의 배열(입력 모듈에서도 제공)과 반환 값을 제공하는 것입니다. 혼란스러우면 다음 예를 참조하세요.

으아아아

on_error 콜백 함수는 Exception과 정수를 인수로 받아들이고 아무것도 반환하지 않는 함수로 지정됩니다.

모든 유형은 정적 유형 검사기가 다른 유형에 대한 모든 작업 및 할당을 허용해야 함을 의미합니다. 모든 유형은 Any의 하위 유형입니다.

앞서 본 Union 유형은 인수가 여러 유형일 수 있는 경우 유용하며, 이는 Python에서 일반적입니다. 다음 예에서 verify_config() 함수는 구성 개체 또는 파일 이름일 수 있는 구성 매개변수를 허용합니다. 파일 이름인 경우 다른 함수를 호출하여 파일을 Config 객체로 구문 분석하고 반환합니다.

으아아아

옵션 유형은 매개변수가 없음일 수도 있음을 의미합니다. 可选[T] 相当于 Union[T, None]

Iterable, Iterator, Reversible, SupportsInt, SupportsFloat, Sequence, MutableSequence 및 IO와 같은 다양한 기능을 나타내는 더 많은 유형이 있습니다. 전체 목록을 보려면 타이핑 모듈 문서를 확인하세요.

무엇보다도, 매우 세분화된 방식으로 인수 유형을 지정할 수 있으며, 높은 충실도로 Python 유형 시스템을 지원하고 제네릭 및 추상 기본 클래스를 허용합니다.

리트윗 인용

때때로 메소드 중 하나에 대한 유형 힌트에서 클래스를 참조하고 싶을 때가 있습니다. 예를 들어, 클래스 A가 A의 다른 인스턴스를 가져와 자신과 병합하고 결과를 반환하는 일부 병합 작업을 수행할 수 있다고 가정합니다. 다음은 유형 힌트를 사용하여 이를 지정하려는 순진한 시도입니다.

으아아아

무슨 일이 있었나요? Python이 merge() 메서드에 대한 유형 힌트를 확인할 때 클래스 A는 아직 정의되지 않았으므로 지금은 클래스 A를 (직접) 사용할 수 없습니다. 솔루션은 매우 간단하며 이전에 SQLAlchemy와 함께 사용되는 것을 본 적이 있습니다. 유형 힌트를 문자열로 지정하면 됩니다. Python은 이것이 전방 참조임을 이해하고 올바른 일을 수행합니다:

class A:
    def merge(other: 'A' = None) -> 'A':
        ...

输入别名

对长类型规范使用类型提示的一个缺点是，即使它提供了大量类型信息，它也会使代码变得混乱并降低可读性。您可以像任何其他对象一样为类型添加别名。很简单：

Data = Dict[int, Sequence[Dict[str, Optional[List[float]]]]

def foo(data: Data) -> bool:
    ...

get_type_hints() 辅助函数

类型模块提供 get_type_hints() 函数，该函数提供有关参数类型和返回值的信息。虽然 annotations 属性返回类型提示，因为它们只是注释，但我仍然建议您使用 get_type_hints() 函数，因为它可以解析前向引用。另外，如果您为其中一个参数指定默认值 None，则 get_type_hints() 函数将自动将其类型返回为 Union[T, NoneType]（如果您刚刚指定了 T）。让我们看看使用 A.merge() 方法的区别之前定义：

print(A.merge.__annotations__)

{'other': 'A', 'return': 'A'}

annotations 属性仅按原样返回注释值。在本例中，它只是字符串“A”，而不是 A 类对象，“A”只是对其的前向引用。

print(get_type_hints(A.merge))

{'return': , 'other': typing.Union[__main__.A, NoneType]}

由于 None 默认参数，get_type_hints() 函数将 other 参数的类型转换为 A（类）和 NoneType 的并集。返回类型也转换为 A 类。

装饰器

类型提示是函数注释的特殊化，它们也可以与其他函数注释一起工作。

为了做到这一点，类型模块提供了两个装饰器：@no_type_check和@no_type_check_decorator。 @no_type_check 装饰器可以应用于类或函数。它将 no_type_check 属性添加到函数（或类的每个方法）。这样，类型检查器就会知道忽略注释，它们不是类型提示。

这有点麻烦，因为如果你编写一个将被广泛使用的库，你必须假设将使用类型检查器，并且如果你想用非类型提示来注释你的函数，你还必须装饰它们与@no_type_check。

使用常规函数注释时的一个常见场景也是有一个对其进行操作的装饰器。在这种情况下，您还想关闭类型检查。一种选择是除了装饰器之外还使用 @no_type_check 装饰器，但这会过时。相反，@no_Type_check_decorator可用于装饰您的装饰器，使其行为类似于@no_type_check（添加no_type_check属性）。 p>

让我来说明所有这些概念。如果您尝试在使用常规字符串注释的函数上使用 get_type_hint() （任何类型检查器都会这样做），则 get_type_hints() 会将其解释为前向引用：

def f(a: 'some annotation'):
    pass

print(get_type_hints(f))

SyntaxError: ForwardRef must be an expression -- got 'some annotation'

要避免这种情况，请添加 @no_type_check 装饰器，get_type_hints 仅返回一个空字典，而 __annotations__ 属性返回注释：

@no_type_check
def f(a: 'some annotation'):
    pass
    
print(get_type_hints(f))
{}

print(f.__annotations__)
{'a': 'some annotation'}

现在，假设我们有一个打印注释字典的装饰器。您可以使用 @no_Type_check_decorator 装饰它，然后装饰该函数，而不用担心某些类型检查器调用 get_type_hints() 并感到困惑。对于每个使用注释操作的装饰器来说，这可能是最佳实践。不要忘记@functools.wraps，否则注释将不会被复制到装饰函数中，一切都会崩溃。 Python 3 函数注释对此进行了详细介绍。

@no_type_check_decorator
def print_annotations(f):
    @functools.wraps(f)
    def decorated(*args, **kwargs):
        print(f.__annotations__)
        return f(*args, **kwargs)
    return decorated

现在，您可以仅使用 @print_annotations 来装饰该函数，并且每当调用它时，它都会打印其注释。

@print_annotations
def f(a: 'some annotation'):
    pass
    
f(4)
{'a': 'some annotation'}

调用 get_type_hints() 也是安全的，并返回一个空字典。

print(get_type_hints(f))
{}

使用 Mypy 进行静态分析

Mypy 是一个静态类型检查器，它是类型提示和类型模块的灵感来源。 Guido van Rossum 本人是 PEP-483 的作者，也是 PEP-484 的合著者。

安装 Mypy

Mypy 正处于非常活跃的开发阶段，截至撰写本文时，PyPI 上的软件包已经过时，并且无法与 Python 3.5 一起使用。要将 Mypy 与 Python 3.5 结合使用，请从 GitHub 上的 Mypy 存储库获取最新版本。很简单：

pip3 install git+git://github.com/JukkaL/mypy.git

使用 Mypy

一旦安装了 Mypy，您就可以在您的程序上运行 Mypy。以下程序定义了一个需要字符串列表的函数。然后它使用整数列表调用该函数。

from typing import List

def case_insensitive_dedupe(data: List[str]):
    """Converts all values to lowercase and removes duplicates"""
    return list(set(x.lower() for x in data))


print(case_insensitive_dedupe([1, 2]))

运行程序时，显然在运行时失败并出现以下错误：

python3 dedupe.py
Traceback (most recent call last):
  File "dedupe.py", line 8, in <module>
    print(case_insensitive_dedupe([1, 2, 3]))
  File "dedupe.py", line 5, in case_insensitive_dedupe
    return list(set(x.lower() for x in data))
  File "dedupe.py", line 5, in <genexpr>
    return list(set(x.lower() for x in data))
AttributeError: 'int' object has no attribute 'lower'

这有什么问题吗？问题在于，即使在这个非常简单的案例中，也无法立即弄清楚根本原因是什么。是输入类型的问题吗？或者代码本身可能是错误的，不应该尝试调用“int”对象的 lower() 方法。另一个问题是，如果您没有 100% 的测试覆盖率（老实说，我们都没有），那么此类问题可能潜伏在一些未经测试、很少使用的代码路径中，并在生产中最糟糕的时间被检测到。

静态类型在类型提示的帮助下，通过确保您始终使用正确的类型调用函数（用类型提示注释），为您提供了额外的安全网。这是 Mypy 的输出：

(N) > mypy dedupe.py
dedupe.py:8: error: List item 0 has incompatible type "int"
dedupe.py:8: error: List item 1 has incompatible type "int"
dedupe.py:8: error: List item 2 has incompatible type "int"

这很简单，直接指出问题，并且不需要运行大量测试。静态类型检查的另一个好处是，如果您提交它，则可以跳过动态类型检查，除非解析外部输入（读取文件、传入的网络请求或用户输入）。就重构而言，它还建立了很大的信心。

结论

类型提示和类型模块对于 Python 的表达能力来说是完全可选的补充。虽然它们可能不适合每个人的口味，但对于大型项目和大型团队来说它们是不可或缺的。证据是大型团队已经使用静态类型检查。现在类型信息已经标准化，共享使用它的代码、实用程序和工具将变得更加容易。像 PyCharm 这样的 IDE 已经利用它来提供更好的开发人员体验。

위 내용은 Python 3 유형 힌트 및 정적 분석의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!