What's the best way to generate a UML diagram from Python source code?

Question

A colleague is looking to generate UML class diagrams from heaps of Python source code. He's primarily interested in the inheritance relationships, and mildly interested in compositional relationships, and doesn't care much about class attributes that are just Python primitives.

The source code is pretty straightforward and not tremendously evil--it doesn't do any fancy metaclass magic, for example. (It's mostly from the days of Python 1.5.2, with some sprinklings of "modern" 2.3ish stuff.)

What's the best existing solution to recommend?

Mods did not find this question constructive. I(and many others who have favourited this) found it useful. So what? _that_ is not a bigger deal than this not being "constructive"! — yati sagade, Jul 31 '13 at 10:57
Not constructive because it will solicit debates, arguments, discussions ?????? Isn't that what we want ? This is a very relevant question.. — Bhushan, Jan 30 '14 at 00:52
@yatisagade if you note it was closed, not deleted (and with this many upvotes probably can practically never be deleted). Closing in just means it can't get new answers. — tacaswell, Apr 09 '14 at 15:50
@Bhushan No, we don't want discussion, we want question and answer pairs that have clear answers. It is not a judgement on it being an interesting question or a useful question, it is a matter of being on-topic for SO. Surely you agree that "What is the best editor?" (obs emacs) is not a constructive question, this question is of exactly the same mold. — tacaswell, Apr 09 '14 at 15:54
@tacaswell Some discussion is very relevant when it comes to refining questions into a Q&A format. — user32882, Sep 14 '19 at 12:32
@tacaswell I came here looking for "a" way to generate UML diagrams, not "the best" way, and I'm sure so have others. So instead of just closing it, mods could (should?) suggest alternative ways that fit better. That would be more constructive, wouldn't it? — antonimmo, Jul 03 '20 at 09:17
Instead of trying to get people to stop asking certain obviously normal questions, they should restructure their rules to allow these kindsa questions. Maybe just simply put them into an opinion section instead of just slapping a big NO to it? — wamster, Nov 18 '20 at 00:59
In case people are still looking for an easy solution as of 2021. Pycharm has Class Diagrams integrated: https://www.jetbrains.com/help/pycharm/viewing-diagram.html — Guido, Jul 29 '21 at 10:01
Yes, thank you! This question is still relevant in 2021. I checked out Pycharm and the class diagram capability looks great! However, just FYI, it is only available in the Pro version, not the free community version. — Gerhard, Sep 22 '21 at 01:27

score 228 · Answer 1 · edited Apr 21 '23 at 23:54

228

You may have heard of Pylint that helps statically checking Python code. Few people know that it comes with a tool named Pyreverse that draws UML diagrams from the Python code it reads. Pyreverse uses Graphviz as a backend.

It is used like this:

pyreverse -o png -p yourpackage .

where the . can also be a single file.

edited Apr 21 '23 at 23:54

ViRuSTriNiTy

5,017
2
32
58

answered Sep 26 '11 at 11:36

Nicolas Chauvat

2,313
1
13
2

1

do you know how to visualize private methods starting with "_" – gustavz Jun 29 '18 at 09:40
7

Unfortunately, pyreverse package diagrams are huge since everything is placed horizontally (more of a graphviz limitation, but still). Not useful for including in documents. – oarfish Oct 10 '18 at 16:44
1

@oarfish as a workaround, you can cherry pick the modules you want to include, and create several separate graphs. – jjmontes Apr 11 '19 at 22:15
5

should the obvious choice for the output type not be `-o pdf`? scalable, searchable. – schlimmchen Mar 01 '21 at 07:43
1

There are a lot of old links that point to manually downloading and installing an old version of pylint. The up-to-date version can be found through `pip install pylint` or `conda install pylint` if you have `conda-forge` as one of your channels. – Jim Pivarski Mar 05 '21 at 16:22
4

@gustavz Just pass the option `--filter-mode=ALL` – craymichael Jun 18 '21 at 18:42
1

Pyreverse seems dead since 2005. – Martin Thøgersen Aug 22 '22 at 15:31
1

link is broken , the docs are at https://pylint.pycqa.org/en/latest/pyreverse.html – Ashwin Kumar k Oct 24 '22 at 08:34

score 105 · Answer 2 · answered Nov 03 '08 at 23:26

105

Epydoc is a tool to generate API documentation from Python source code. It also generates UML class diagrams, using Graphviz in fancy ways. Here is an example of diagram generated from the source code of Epydoc itself.

Because Epydoc performs both object introspection and source parsing it can gather more informations respect to static code analysers such as Doxygen: it can inspect a fair amount of dynamically generated classes and functions, but can also use comments or unassigned strings as a documentation source, e.g. for variables and class public attributes.

answered Nov 03 '08 at 23:26

piro

13,378
5
34
38

Is there any way to have it output vector graphics instead of gifs? I found no documentation on that and the graphs are fairly useless for anything other than html doc. – oarfish Feb 22 '16 at 12:12
4

Presently, `epydoc` seems unable to generate graphs. Check out this [bug report](https://sourceforge.net/p/epydoc/bugs/372/). – Luís de Sousa Jul 20 '16 at 14:38
31

doesn't work with python 3 – tomsv Mar 15 '17 at 13:07
1

I just tested with python 3.7.1 and could generate some diagrams – may Feb 06 '21 at 07:15
2

@may how did you use it? my python complained `print '\n' + msg.rstrip() + '\n'` `SyntaxError: Missing parentheses in call to 'print'. Did you mean print(...)?` – Pablo LION Dec 16 '21 at 00:26
@PabloLION Update print statement as : `print('\n' + msg.rstrip() + '\n')` – Muhammad Khuzaima Umair Aug 12 '22 at 11:16
Yea I know. This is the python3 syntax. `print` in Python2 doesn't need (). And this is why I found it weird that @may could use it. – Pablo LION Aug 13 '22 at 12:05

score 13 · Answer 3 · answered Nov 03 '08 at 22:19

13

Certain classes of well-behaved programs may be diagrammable, but in the general case, it can't be done. Python objects can be extended at run time, and objects of any type can be assigned to any instance variable. Figuring out what classes an object can contain pointers to (composition) would require a full understanding of the runtime behavior of the program.

Python's metaclass capabilities mean that reasoning about the inheritance structure would also require a full understanding of the runtime behavior of the program.

To prove that these are impossible, you argue that if such a UML diagrammer existed, then you could take an arbitrary program, convert "halt" statements into statements that would impact the UML diagram, and use the UML diagrammer to solve the halting problem, which as we know is impossible.

answered Nov 03 '08 at 22:19

Andru Luvisi

24,367
6
53
66

12

Some good things, but the halt-solving hand-waiving ruins it. Pathological cases are not the matter here. Well-behaved is enough. – ddaa Nov 03 '08 at 22:24
1

What do you mean, "hand-waiving"? I didn't write out the full proofs, but I gave enough information that anyone who has seen similar proofs could create them, one for composition and one for inheritance. – Andru Luvisi Nov 03 '08 at 22:31
22

Here's an analogy: diff/patch can fail in a lot of different ways, some of them trivial. It is still very useful in a lot of real world cases. In reasonable cases, diagramming inheritance is trivial. Delegation is more tricky, but feasible by type inference within the boundaries of a package. – ddaa Nov 03 '08 at 22:59

score 8 · Answer 4 · edited Nov 11 '21 at 15:04

8

If you use Eclipse, maybe PyUML. Haven't used it, though.

edited Nov 11 '21 at 15:04

bad_coder

11,289
20
44
72

answered Nov 03 '08 at 22:15

David Arcos

5,957
5
30
39

1

That's a really good suggestion, but FWIW I notice on the PyUML project site that they don't support Eclipse 3.4 (Ganymede) yet. I'll look forward to trying it when they work that out. – Bill Karwin Nov 03 '08 at 22:35
Did you happen to get PyUML work with 3.4? – anijhaw Feb 04 '11 at 03:27
3

The last commits to this project date back to 2009. It does not show up in the Marketplace and Eclipse is not to able to install it from the `.zip` archive. – Luís de Sousa Jul 20 '16 at 14:39

score 8 · Answer 5 · edited Jan 13 '20 at 11:29

8

It is worth mentioning Gaphor. A Python modelling/UML tool.

edited Jan 13 '20 at 11:29

Ahmed Rezk

301
1
4
10

answered Nov 04 '08 at 13:12

Ali Afshar

40,967
12
95
109

score 6 · Answer 6 · answered Dec 09 '11 at 12:21

6

vipera is a small application designer, and uml is included. You can see it in:

vipera

Best regards.

answered Dec 09 '11 at 12:21

Ángel Luis

61
1
1

score 5 · Answer 7 · answered Nov 04 '08 at 02:37

5

The SPE IDE has built-in UML creator. Just open the files in SPE and click on the UML tab.

I don't know how comprhensive it is for your needs, but it doesn't require any additional downloads or configurations to use.

answered Nov 04 '08 at 02:37

crystalattice

5,031
12
40
57

sadly it has stopped developping, but still works here ! (2013) – Abdelouahab Jun 04 '13 at 20:30

score 5 · Answer 8 · answered Nov 04 '08 at 21:53

5

Sparx's Enterprise Architect performs round-tripping of Python source. They have a free time-limited trial edition.

answered Nov 04 '08 at 21:53

chimp

1,823
9
14

score 5 · Answer 9 · answered Jul 07 '11 at 06:43

5

Umbrello does that too. in the menu go to Code -> import project and then point to the root deirectory of your project. then it reverses the code for ya...

answered Jul 07 '11 at 06:43

Hosane

915
9
19

do you know of a way to make Umbrello generate the complete class diagramm (and the relations between them, not just the classes by themselves - don't remember how that diagram is called) – vlad-ardelean Jun 24 '13 at 20:17
2

AAhh, you need to import the files and then when you drag and drop classes into the drawing area, the connections are automatically added. – Hosane Jun 28 '13 at 21:44

What's the best way to generate a UML diagram from Python source code?

9 Answers9

Linked

Related