Comment spécifier des types de données d'entrée et de sortie dans les commentaires python?

Fonction des annotations ne sont pas destinés à un usage spécifique, ils peuvent être utilisés pour n'importe quoi.

Outils peuvent être écrits pour extraire des informations à partir des annotations et faire ce que vous voulez, y compris la vérification de types ou de la génération de la documentation. Mais python lui-même ne pas faire n'importe quoi avec l'information. Vous pouvez utiliser à un but complètement différent, c'est à dire de fournir une fonction qui sera appelée sur le paramètre ou de déclarer une chaîne de valeurs de retour possibles.

Les Annotations peuvent être n'importe quel objet:

def somefunc(param1: "string annotation", 
             param2: 151631,  
             param3: any_object): -> "some information here":

et vous pouvez récupérer des objets à l'aide de:

print (somefunc.func_annotations)
{'param1': "string annotation", 
 'param2': 151631,  
 'param3': <object any_object>,
 'return': "some information here"}

Cas d'utilisation des suggestions fournies par le PEP:

• Fournir des informations de typage
  • Vérification de Type
  • Laisser IDEs montrer quels types une fonction attend et retourne
  • De surcharge de fonctions /fonctions génériques
  • En langue étrangère ponts
  • Adaptation
  • Logique des prédicats fonctions
  • Requête de base de données de cartographie
  • RPC paramètre de regroupement
• Autres informations
  • De la Documentation pour les paramètres et valeurs de retour

Depuis la fonction d'annotation syntaxe est trop nouveau, il est vraiment pas utilisés pour des outils de production.

Je suggère d'utiliser d'autres méthodes de document. J'utilise epydoc pour générer ma documentation, et il peut lire le typage des paramètres des informations de docstrings:

def x_intercept(m, b):
    """
    Return the x intercept of the line M{y=m*x+b}.  The X{x intercept}
    of a line is the point at which it crosses the x axis (M{y=0}).

    This function can be used in conjuction with L{z_transform} to
    find an arbitrary function's zeros.

    @type  m: number
    @param m: The slope of the line.
    @type  b: number
    @param b: The y intercept of the line.  The X{y intercept} of a
              line is the point at which it crosses the y axis (M{x=0}).
    @rtype:   number
    @return:  the x intercept of the line M{y=m*x+b}.
    """
    return -b/m

Cet exemple est de epydoc du site web. Il peut générer de la documentation dans une variété de formats, et peut générer des graphiques à partir de vos classes et de différents profils d'utilisateurs.

Python 3.5 officiel typing

https://docs.python.org/3/library/typing.html

Cette mise à jour apporte une réelle partie de la langue.

Exemple:

#!/usr/bin/env python3

from typing import List

def f(x: int, ys: List[float]) -> str:
    return "abc"

# Good.
f(1, [2.0, 3.0])

# Bad.
f("abc", {}) # line 12

x = 1
x = "a" # line 15

y = [] # type: List[int]
y.append("a") # line 18

Ce code fonctionne normalement: Python 3.5 ne pas appliquer en tapant par défaut.

Mais il peut toutefois être utilisé par des linters de diagnoze de problèmes, par exemple:

sudo pip3 install mypy
mypy a.py

donne:

a.py:12: error: Argument 1 to "f" has incompatible type "str"; expected "int"
a.py:12: error: Argument 2 to "f" has incompatible type Dict[<nothing>, <nothing>]; expected List[float]
a.py:15: error: Incompatible types in assignment (expression has type "str", variable has type "int")
a.py:18: error: Argument 1 to "append" of "list" has incompatible type "str"; expected "int"

Existant analyseurs statiques comme Pycharm peut déjà analyser les Sphinx documents types, mais ce langage de mise à jour donne un fonctionnaire manière canonique qui sera susceptible de l'emporter.