0
|
1 |
'\" t
|
|
2 |
.\"
|
11
|
3 |
.\" Copyright 2010 Sun Microsystems, Inc. All rights reserved.
|
0
|
4 |
.\" Use is subject to license terms.
|
|
5 |
.\"
|
11
|
6 |
.\"ident "@(#)pyreverse.1.sunman 1.2 10/03/16 SMI"
|
0
|
7 |
.\"
|
|
8 |
|
|
9 |
.TH pyreverse 1 "August 18, 2008" pyreverse "User's Manual"
|
|
10 |
.SH NAME
|
|
11 |
pyreverse \- parse python sources files and extract diagrams from
|
|
12 |
them.
|
|
13 |
|
|
14 |
.SH SYNOPSIS
|
|
15 |
.B pyreverse
|
|
16 |
.I [options]
|
|
17 |
<modules>
|
|
18 |
|
|
19 |
.SH DESCRIPTION
|
|
20 |
.B pyreverse
|
|
21 |
is a python source analyzer. It parses a python packages and produces UML
|
|
22 |
diagrams in different output formats. (dot, all formats available for dot,
|
|
23 |
and vcg).
|
|
24 |
With different options, you can have fine tuning on what and how modules,
|
|
25 |
classes and attributes will be shown in the diagram.
|
|
26 |
You can combine several modules in one project (except with
|
|
27 |
.B -c
|
|
28 |
).
|
|
29 |
|
|
30 |
If no -c and no --diadefs option specified,
|
|
31 |
.B pyreverse
|
|
32 |
will create
|
|
33 |
- a diagram 'classes_<name>' for the classes in <modules> and
|
|
34 |
( if there is more than one module in <projects> )
|
|
35 |
- a diagram 'packages_<name>' for the package dependencies in <modules>
|
|
36 |
|
|
37 |
With -c <class>,
|
|
38 |
.B pyreverse
|
|
39 |
creates a diagram for that <class> with filename <class>.<format>.
|
|
40 |
You can do -c <class1> , -c <class2>.
|
|
41 |
|
|
42 |
.SH OPTIONS
|
|
43 |
|
|
44 |
.IP "-h, --help"
|
|
45 |
show this help message and exit
|
|
46 |
.IP "-p<name>, --project=<name>"
|
|
47 |
set project name to <name> if not using -c option. (default:'No Name')
|
|
48 |
.IP "-i<file>, --ignore=<file>"
|
|
49 |
add <file> (may be a directory) to the black list (not parsed)
|
|
50 |
.IP "-f<mode>, --filter-mode=<mode>"
|
|
51 |
filter attributes and functions according to <mode>. You can combine
|
|
52 |
modes using '+' like 'SPECIAL+OTHER'. Correct modes are :
|
|
53 |
- 'PUB_ONLY' : filter all non public attributes (default)
|
|
54 |
- 'ALL' : no filter
|
|
55 |
- 'SPECIAL' : filter Python special functions except constructor
|
|
56 |
- 'OTHER' : filter protected and private attributes [currentt: PUB_ONLY]
|
|
57 |
|
|
58 |
.IP "-d<file>, --diadefs=<file>"
|
|
59 |
create diagram according to the diagrams definitions in <file>
|
|
60 |
.IP "-c <class>, --class=<class>"
|
|
61 |
create a class diagram with all classes related to <class> [current: none]
|
|
62 |
the class must be in the file <modules>. By default, this will include all
|
|
63 |
ancestors and associated classes of <class> and include module names
|
|
64 |
(i.e. '-ASmy' ).
|
|
65 |
|
|
66 |
.IP -a <ancestor>, --show-ancestors=<ancestor>
|
|
67 |
show <ancestor> generations of ancestor classes not in <projects>
|
|
68 |
.IP -A, --all-ancestors=[yn]
|
|
69 |
show all ancestors off all classes in <projects> [current: none]
|
|
70 |
.IP -s <ass_level>, --show-associated=<associated>
|
|
71 |
show <ass_level> associated classes. <ass_level>=1 will only take classes
|
|
72 |
directly related to the classes in the project, while <ass_level>=2
|
|
73 |
will also take all classes related to those fecthed by<depth>=1.
|
|
74 |
.IP -S, --all-associated=[yn]
|
|
75 |
show recursively all associated off all associated classes [current: none]
|
|
76 |
|
|
77 |
.IP "-b, --builtin"
|
|
78 |
include builtin objects in representation of classes [current: False]
|
|
79 |
.IP "-m [yn], --module-names=[yn]"
|
|
80 |
include module name in representation of classes. This will include full
|
|
81 |
module path in the class name. [current: none]
|
|
82 |
|
|
83 |
.IP "-k, --only-classnames"
|
|
84 |
don't show attributes and methods in the class boxes;
|
|
85 |
this disables -f values [current: False]
|
|
86 |
|
|
87 |
.IP "-o <format>, --output=<format>"
|
|
88 |
create a *.<format> output file if format available. Available formats
|
|
89 |
are all formats that dot can produce and
|
|
90 |
.B vcg.
|
|
91 |
[default: dot]
|
|
92 |
|
|
93 |
.SH EXAMPLES
|
|
94 |
Here are some examples for command line options :
|
|
95 |
|
|
96 |
.IP "pyreverse <project> -a1 -s1 -m"
|
|
97 |
|
|
98 |
-a1 -s1 will include one level of ancestor and associated classes in the
|
|
99 |
diagram of the <project> modules, while -m will show the full module
|
|
100 |
path of each class. You can use the same way the
|
|
101 |
.B -a, -s, -A, -S
|
|
102 |
options.
|
|
103 |
Note that on class diagrams (using
|
|
104 |
.B -c
|
|
105 |
) -a and -s will rather reduce than enlarge your diagram.
|
|
106 |
|
|
107 |
.IP "pyreverse mod/foo.py mod/fee.py -k"
|
|
108 |
|
|
109 |
This is interesting if the diagram for <project>=mod is too complicated:
|
|
110 |
you can show only the class names (no attributes or methods, option -k);
|
|
111 |
or take only the modules you are interested in (here fee.py and foo.py).
|
|
112 |
|
|
113 |
.SH REQUIRES
|
|
114 |
Python
|
|
115 |
|
|
116 |
.SH "SEE ALSO"
|
|
117 |
.B dot(1), pylint(1)
|
|
118 |
|
|
119 |
.I http://www.logilab.org/pyreverse
|
|
120 |
|
|
121 |
.SH AUTHORS
|
|
122 |
Sylvain Thenault, Emile Anclin
|
|
123 |
|
|
124 |
This manpage was written by Emile Anclin <[email protected]>
|
|
125 |
|
|
126 |
.SH ATTRIBUTES
|
|
127 |
See
|
|
128 |
.BR attributes (5)
|
|
129 |
for descriptions of the following attributes:
|
|
130 |
.sp
|
|
131 |
.TS
|
|
132 |
box;
|
|
133 |
cbp-1 | cbp-1
|
|
134 |
l | l .
|
|
135 |
ATTRIBUTE TYPE ATTRIBUTE VALUE
|
|
136 |
=
|
11
|
137 |
Availability developer/python/pylint
|
0
|
138 |
=
|
|
139 |
Interface Stability Uncommitted
|
|
140 |
.TE
|
|
141 |
.SH NOTES
|
|
142 |
Documentation for pylint is available at http://www.logilab.org/project/pylint
|
|
143 |
|
|
144 |
Source for pylint is available on http://opensolaris.org.
|