docstring avec ou sans indentation ?

**bruno_pages** · 31/03/2009, 12h21

Bonjour,

je développe la suite d'outils UML Bouml générant entre autre du Python

dans la version actuellement le générateur n'indente pas les docstring, j'ai fait ce choix pour que les indentations ne pollues le contenu de la chaine retournée par __doc__.

par exemple le commentaire de op1 n'est pas indenté, celui de op2 l'est dans cet exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
>>> class C:
...   def op1(self):
...     """commentaire
... sur plusieurs
... lignes"""
...     pass
...
...   def op2(self):
...     """commentaire
...     sur plusieurs
...     lignes"""
...     pass
...
>>> C.op1.__doc__
'commentaire\nsur plusieurs\nlignes'
>>> C.op2.__doc__
'commentaire\n    sur plusieurs\n    lignes'

le choix entre les deux est-il une affaire de goût, ou il y a une règle à suivre ?

[edit : déplacé dans une autre discussion]autre petite question : l'héritage multiple dans le cas d'une métaclasse a-t-il un sens (c.a.d. une classe hérite de type et d'au moins une autre classe) ?[/edit]

merci

Bruno

**kango** · 31/03/2009, 13h20

bonjour,

pour répondre à ta première question, en ce qui me concerne j'indente toujours les docstrings. Je trouve cela plus lisible dans le code source.

je n'utilise jamais directement la variable __doc__, je me sers en revanche plus souvent de la fonction help. Et à mon goût, je trouve cela aussi plus lisible si le docstring a été indenté.

je ne pense pas qu'il y ait de règles pour les docstrings (sauf peut être si on utilise un outil pour réaliser une documentation de codage depuis le code source et encore dans ce cas, je doute que la règle soit universelle)

En ce qui me concerne j'indente pour des raisons de goût.

pour la deuxième question, je n'ai pas les connaissances suffisantes pour y répondre.