2017-07-13 5 views
1

J'utilise cette syntaxe bizarre depuis longtemps, et je m'y suis plutôt bien débrouillé. C'est comme prendre la bonne partie de Java, et avoir cela en Python. C'est génial, j'aime bien, mon IDE a même attrapé quelques bugs à cause des annotations. Je ne sais pas cependant qui a spécifié cette syntaxe, à quel point c'est officiel, et je ne connais pas les règles exactes pour cela. Certes, j'utilise PyCharm, mais je ne sais pas si cela fonctionnerait dans d'autres IDE, ou si c'est juste la syntaxe PyCharm - je ne veux pas le penser, et je voudrais utiliser une syntaxe docstring qui fonctionne également pour d'autres outils.J'utilise cette syntaxe docstring depuis 2 ans maintenant, comment l'appelle-t-on, qui la spécifie, et est-ce que c'est "ok" de l'utiliser?

De plus, je vois les gens amazon en utilisant ce type de syntaxe dans leur bibliothèque python Boto: https://github.com/boto/boto/blob/develop/boto/beanstalk/layer1.py#L83

Voici un exemple de la syntaxe.

def asdf(name, descriptions, weird_dict): 
    """ 
    :type weird_dict: dict[tuple[str|None],list[dict[int,str]|MyClass]] 
    :param weird_dict: description description 

    :type name: str 
    :param list[str] descriptions: Description and type annotation 

    :param str name: Here I declared the "suggested" type, and can also describe the param 

    :return: Here I just describe what's returned 
    :rtype: int 
    """ 

S'il vous plaît dites-moi, si quelqu'un sait, quel est le nom de cette syntaxe, qui précise, et comment je peux trouver plus d'informations à ce sujet, parce que j'ai essayé plusieurs fois et juste fini sur le PyCharm site.

Répondre