Conseils de type Python 3 et analyse statique

Python 3.5 introduit le nouveau module de type, qui fournit une prise en charge de bibliothèque standard pour les astuces de type facultatives utilisant des annotations de fonction. Cela ouvre la porte à la vérification de type statique (comme mypy) et éventuellement à une optimisation automatisée basée sur le type à l'avenir. Les indices de type sont spécifiés dans PEP-483 et PEP-484.

Dans ce tutoriel, je vais explorer les possibilités de rendu des indices de type et vous montrer comment utiliser mypy pour analyser statiquement vos programmes Python et améliorer considérablement la qualité du code.

Conseils de type

Les indices de type sont construits sur les annotations de fonction. En bref, les annotations de fonction permettent d'annoter les paramètres et de renvoyer les valeurs d'une fonction ou d'une méthode avec des métadonnées arbitraires. Les indices de type sont un cas particulier d'annotations de fonction qui annotent spécifiquement les paramètres de fonction et renvoient des valeurs avec des informations de type standard. Les annotations de fonctions générales et les astuces de type spécial sont totalement facultatives. Regardons un exemple simple :

def reverse_slice(text: str, start: int, end: int) -> str:
    return text[start:end][::-1]
    
reverse_slice('abcdef', 3, 5)
'ed'

Les paramètres sont annotés avec leur type et leur valeur de retour. Mais il est important de réaliser que Python ignore complètement cela. Il fournit des informations de type via la propriété annotation de l'objet fonction et rien de plus.

reverse_slice.__annotations
{'end': int, 'return': str, 'start': int, 'text': str}

Pour vérifier que Python ignore réellement les indices de type, éliminons complètement les indices de type :

def reverse_slice(text: float, start: str, end: bool) -> dict:
    return text[start:end][::-1]
    
reverse_slice('abcdef', 3, 5)
'ed'

Comme vous pouvez le voir, le code se comporte de la même manière quelles que soient les indications de type.

Motivation pour les conseils de type

D'accord. Les indices de type sont facultatifs. Python ignore complètement les indications de type. Alors, quel est leur intérêt ? Eh bien, il y a quelques bonnes raisons :

• Analyse statique
• Support IDE
• Documents standards

J'utiliserai Mypy pour l'analyse statique plus tard. La prise en charge de l'IDE a commencé avec la prise en charge de PyCharm 5 pour les indications de type. La documentation standard est utile pour les développeurs qui peuvent facilement découvrir les types de paramètres et les valeurs de retour simplement en regardant la signature de la fonction, ainsi qu'un générateur de documentation automatique qui peut extraire des informations de type à partir d'indices.

typingModule

Le module d'entrée contient des types conçus pour prendre en charge les indications de type. Pourquoi ne pas simplement utiliser les types Python existants comme int, str, list et dict ? Vous pouvez certainement utiliser ces types, mais en raison du typage dynamique de Python, vous n'obtiendrez pas beaucoup d'informations au-delà des types de base. Par exemple, si vous souhaitez spécifier qu'un paramètre peut être une correspondance entre des chaînes et des entiers, vous ne pouvez pas le faire en utilisant des types Python standard. En utilisant le module de saisie, c'est aussi simple que ceci :

Mapping[str, int]

Regardons un exemple plus complet : une fonction à deux paramètres. L'un d'eux est une liste de dictionnaires, où chaque dictionnaire contient des clés de chaîne et des valeurs entières. L'autre paramètre est une chaîne ou un entier. Les modules de type permettent de spécifier avec précision des paramètres aussi complexes.

from typing import List, Dict, Union

def foo(a: List[Dict[str, int]],
        b: Union[str, int]) -> int:
    """Print a list of dictionaries and return the number of dictionaries
    """
    if isinstance(b, str):
        b = int(b)
    for i in range(b):
        print(a)


x = [dict(a=1, b=2), dict(c=3, d=4)]
foo(x, '3')

[{'b': 2, 'a': 1}, {'d': 4, 'c': 3}]
[{'b': 2, 'a': 1}, {'d': 4, 'c': 3}]
[{'b': 2, 'a': 1}, {'d': 4, 'c': 3}]

Types utiles

Examinons certains des types les plus intéressants du module de saisie.

Le type Callable vous permet de spécifier des fonctions qui peuvent être transmises comme arguments ou renvoyées comme résultats, car Python traite les fonctions comme des citoyens de première classe. La syntaxe d'un objet appelable consiste à fournir un tableau de types de paramètres (également issus du module de typage), suivi d'une valeur de retour. Si cela prête à confusion, voici un exemple :

def do_something_fancy(data: Set[float], on_error: Callable[[Exception, int], None]):
    ...
    

La fonction de rappel

on_error est spécifiée comme une fonction qui accepte une exception et un entier comme arguments et ne renvoie rien.

Tout type signifie que le vérificateur de type statique doit autoriser toute opération et affectation à tout autre type. Chaque type est un sous-type de Any.

Le type Union que vous avez vu précédemment est utile lorsque les arguments peuvent être de plusieurs types, ce qui est courant en Python. Dans l'exemple suivant, la fonction verify_config() accepte un paramètre de configuration, qui peut être un objet Config ou un nom de fichier. S'il s'agit d'un nom de fichier, appelez une autre fonction pour analyser le fichier dans un objet Config et le renvoyer.

def verify_config(config: Union[str, Config]):
    if isinstance(config, str):
        config = parse_config_file(config)
    ...
    
def parse_config_file(filename: str) -> Config:
    ...
    

Le type facultatif signifie que le paramètre peut également être Aucun. 可选[T] 相当于 Union[T, None]

Il existe de nombreux autres types représentant diverses fonctions telles que Iterable, Iterator, Reversible, SupportsInt, SupportsFloat, Sequence, MutableSequence et IO. Consultez la documentation du module de saisie pour une liste complète.

Mieux encore, vous pouvez spécifier les types de paramètres de manière très fine, en prenant en charge le système de types Python avec une haute fidélité et en autorisant les classes de base génériques et abstraites.

Reposter le devis

Parfois, vous souhaitez référencer une classe dans un indice de type pour l'une de ses méthodes. Par exemple, supposons que la classe A puisse effectuer une opération de fusion qui prend une autre instance de A, la fusionne avec elle-même et renvoie le résultat. Voici une tentative naïve de le spécifier à l'aide d'indices de type :

class A:
    def merge(other: A) -> A:
        ...

      1 class A:
----> 2         def merge(other: A = None) -> A:
      3                 ...
      4

NameError: name 'A' is not defined

Que s'est-il passé ? Lorsque Python vérifie les indications de type pour sa méthode merge(), la classe A n'est pas encore définie, donc la classe A ne peut pas être utilisée (directement) pour le moment. La solution est très simple et je l’ai déjà vue utilisée avec SQLAlchemy. Vous spécifiez simplement l'indice de type sous forme de chaîne. Python comprendra qu'il s'agit d'une référence directe et fera ce qu'il faut :

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 已经利用它来提供更好的开发人员体验。

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!