Extraire les numéros de ligne de toutes les docstrings?

Question

J'essaie d'extraire les numéros de ligne de début et de fin de toutes les docstrings dans un module Python. Y a-t-il une manière raisonnable de faire ceci sans regex?

Answer 1

Le meilleur moyen d'y parvenir est le module ast. En particulier, ast.get_docstring fait presque ce que vous voulez; elle renvoie le contenu du docstring plutôt que le nœud, mais vous pouvez utiliser le même algorithme pour trouver le noeud docstring et son emplacement:

root = ast.parse(''' 
def foo(): 
    """the foo function""" 
    pass 
''') 
for node in ast.walk(root): 
    if isinstance(node, (ast.FunctionDef, ast.ClassDef, ast.Module)): 
     if (node.body and isinstance(node.body[0], ast.Expr) and 
      isinstance(node.body[0].value, ast.Str)): 
      print node.lineno, node.body[0].value.lineno, node.body[0].value.s 

Bien que non documentée, la propriété lineno donne la dernière ligne d'un noeud , donc le lineno du nœud parent sera la première ligne de la docstring ou la ligne avant elle. Il ne semble pas y avoir un moyen facile de faire la différence entre un docstring commençant sur la même ligne que le mot-clé class ou def et sur la ligne suivante, en particulier si vous considérez les caractères de continuation de ligne (\).