Quelle est la meilleure façon de générer un diagramme UML à partir du code source Python ?

Question

Un collègue cherche à générer des diagrammes de classe UML à partir de tas de code source Python. Il est principalement intéressé par les relations d'héritage, et légèrement intéressé par les relations de composition, et ne se soucie pas beaucoup des attributs de classe qui ne sont que des primitives Python.

Le code source est assez simple et n'est pas terriblement mauvais - il ne fait pas de magie de métaclasses fantaisistes, par exemple. (Il date principalement de l'époque de Python 1.5.2, avec quelques saupoudrages de trucs "modernes" 2.3ish).

Quelle est la meilleure solution existante à recommander ?

Answer 1

Vous avez peut-être entendu parler de Pylint qui aide à la vérification statique du code Python. Peu de gens savent qu'il est livré avec un outil nommé Pyreverse qui dessine des diagrammes UML à partir du code python qu'il lit. Pyreverse utilise graphviz comme backend.

Il est utilisé comme suit :

pyreverse -o png -p yourpackage .

où le . peut également être un fichier unique.

Answer 2

Epydoc est un outil permettant de générer de la documentation API à partir du code source Python. Il génère également des diagrammes de classe UML, en utilisant Graphviz de manière fantaisiste. Voici un exemple de diagramme généré à partir du code source d'Epydoc lui-même.

Parce qu'Epydoc effectue à la fois l'introspection des objets et l'analyse des sources, il peut recueillir plus d'informations que les analyseurs de code statiques tels que Doxygen : il peut inspecter une bonne partie des classes et des fonctions générées dynamiquement, mais il peut aussi utiliser les commentaires ou les chaînes non assignées comme source de documentation, par exemple pour les variables et les attributs publics des classes.

Answer 3

Consultez cette liste de sept outils uml pour python

Answer 4

Certaines classes de programmes bien conçus peuvent être schématisées, mais dans le cas général, c'est impossible. Les objets Python peuvent être étendus au moment de l'exécution, et des objets de n'importe quel type peuvent être affectés à n'importe quelle variable d'instance. Pour déterminer les classes vers lesquelles un objet peut contenir des pointeurs (composition), il faudrait comprendre parfaitement le comportement d'exécution du programme.

Les capacités des métaclasses de Python signifient que le raisonnement sur la structure d'héritage nécessiterait également une compréhension complète du comportement d'exécution du programme.

Pour prouver que cela est impossible, vous affirmez que si un tel diagrammeur UML existait, alors vous pourriez prendre un programme arbitraire, convertir les instructions "halte" en instructions qui auraient un impact sur le diagramme UML, et utiliser le diagrammeur UML pour résoudre le problème de l'arrêt, ce qui, comme nous le savons, est impossible.

Answer 5

Si vous utilisez eclipse, peut-être PyUML . Je ne l'ai pas utilisé, cependant.