Comment epydoc marche-t-il ?

Version imprimable

06/09/2010, 10h31
rambc

Comment epydoc marche-t-il ?

Bonjour,
je voulais savoir s'il vous parait compliqué de fabriquer un outil similaire à epydoc.

Je pensais faire truc un peu naîf qui parserait un fichier Python pour repérer les def et les class à la recherche de la structure du fichier, ainsi que les docstring ou les commentaires associés. Ensuite pour les importations, un peu d'introspection à la recherche des modules serait utilisé.

Pourquoi réinventer la roue ? epydoc a l'air un peu pénible à personnaliser, et le langages de documentantion utilisables trop simplistes (je me suis fabriqué un langage qui pourra supporter pas mal de choses comme des formules de maths, l'insertion d'images statique ou dynamique...).
J'aimerais faire un outil qui renvoie une structure de documentation, puis ensuite fabriquer des classes personnalisables facilement pour produire des documents de type LaTeX ou HTML ou d'un autre format non prévu par moi.
06/09/2010, 10h39
rambc

Je vaise essayer de "forker" le fichier docparser.py de epydoc. Ce sera toujours cela de gagner. Pour la suite, je vais faire, quand j'aurais du temps libre, un truc à ma sauce.
07/09/2010, 10h28
nardo47

Salut !

Pour parser un fichier python, tu peux aussi regarder le module ast (dans la std lib), qui te permet de construire l'Abstract Syntax Tree d'un code python et de le visiter (au sens du design pattern Visitor).

Sinon, j'ai aussi vu le module pydoc (dans la std lib aussi) qui devrait te mâcher pas mal de taf aussi mais, comme je viens de le découvrir, c'est peut-être une fausse piste.

A regarder si tes tentatives avec ton fork ne te donnent pas satisfaction.

Bon courage et tiens-nous au courant !
07/09/2010, 10h56
rambc

Bien vu pour ast, j'ai récupérer au passage ce lien.

Je garde cela sous le coude pour le moment où je me ferais un outil de documentation de mes codes.

Merci nardo47. :ccool:

J'ai testé le code donné en lien avec le fichier test.py ci-dessous :

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
#! /usr/bin/env python
#coding=utf-8
 
""" Docstring 1 """
 
def fonction(x, y=1):
    """Doc fonction"""
    x=3
# Un commentaire.
    z = x+y
    return z
 
print fonction(5,6)

Cela renvoie :

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
Module(
  ' Docstring 1 ',
  Stmt(
    Function(
      None,
      'fonction',
      ['x', 'y'],
      Const(1),
      0,
      'Doc fonction',
      Stmt(
        Assign(
          AssName('x', 'OP_ASSIGN'),
          Const(3)
        ),
        Assign(
          AssName('z', 'OP_ASSIGN'),
          Add(
            Name('x'),
            Name('y')
          )
        ),
        Return(
          Name('z')
        )
      )
    ),
    Printnl(
      CallFunc(
        Name('fonction'),
        Const(5),
        Const(6),
        None,
        None
      ),
      None
    )
  )
)

Il y a toutes les infos dont j'ai a priori besoin, et même plus. Moi qui cherhais aussi un moyen de traduire l'un de mes codes en JavaScript ou PhP, je vais peut-être pouvoir l'envisager sereinement grâce à ce module.

Je vais juste regarder de suite comment avoir une version Python 3 du code donné en lien.

07/09/2010, 11h40
rambc

Il y a aussi pyRegurgitator qui semble plus complet.
07/09/2010, 13h43
rambc

La suite ici.