Quelle est la fonction du côlon: avant de revenir ici? Est-ce une chose de style en Python?Colons au début des lignes dans les commentaires Python
def close(self): """ Close this connection. :returns: None """ self.conn.close() return
Parce qu'il est dans un docstring (entre guillemets triples), il est comme un commentaire et ne fait pas autre chose que documenter votre code.
Il existe différentes conventions d'écriture de docstrings - c'est l'une d'elles (le format reST utilisé par Sphinx).
Les colons sont généralement utilisés pour décrire les paramètres de la fonction attend et ce que la fonction retourne, comme ceci:
"""
This is a reST style.
:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""
Dans ce cas, il est dit que la fonction devrait revenir Néant. Voir this pour plus de détails sur les différentes conventions.
Ceci est la bonne réponse, c'est juste une docstring, lisez le PEP-8 pour cela [docstring] (https://www.python.org/dev/peps/pep-0257/) – Lewis909
Sur certains EDI (à savoir PyCharm), si vous tapez des guillemets, puis entrez une signature de fonction, l'EDI documentera automatiquement les paramètres et renverra la valeur de la fonction/méthode dans le style que vous affichez. Ils sont appelés document comments et permettent à l'EDI de présenter des informations de survol d'une valeur de paramètre/retour lorsqu'elles sont utilisées ailleurs.
Ce style de documentation n'a aucun effet sur le comportement du programme.
Je pense que cela fonctionnerait de la même manière avec ou sans les deux-points – chngzm
Cela ressemble au type de chose que vous voyez dans les langages de balisage orientés documentation, comme Restructured Text, où une telle syntaxe est utilisée pour faire des 'return' apparaissent en italique ou en largeur fixe lors de la génération de documents HTML à partir de docstrings. Je ne suis pas sûr de la bibliothèque de génération de documentation particulière qui vient de si. – BrenBarn
D'accord avec @BrenBarn et @chngzm. C'est une section de commentaire qui a été écrite pour être conviviale à la génération de documentation. Rien à voir avec la structure de code ou python. Vous pouvez écrire '' Mary avait un :: petit :: agneau ''et ça marcherait bien! – kaza