2008-08-18 16:34:27 +00:00
|
|
|
.TH PYREVERSE 1 "August 18, 2008" pyreverse "User's Manual"
|
|
|
|
.SH NAME
|
|
|
|
pyreverse \- parse python sources files and extract diagrams from
|
|
|
|
them.
|
|
|
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B pyreverse
|
2008-08-25 08:55:04 +00:00
|
|
|
.I {diagram|test|xmi}
|
2008-08-18 16:34:27 +00:00
|
|
|
.I [options]
|
|
|
|
<modules>
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.B pyreverse
|
2008-08-18 17:12:15 +00:00
|
|
|
is a python source analyzer. It can parse a python package and produce UML
|
|
|
|
diagrams in different output formats. (dot, all formats available for dot,
|
2008-08-25 08:55:04 +00:00
|
|
|
and vcg). (For now, the 'xmi' and 'tests' commands are not under developpement.)
|
2008-08-18 16:34:27 +00:00
|
|
|
|
2008-08-18 17:12:15 +00:00
|
|
|
With different options, you can have fine tuning on what and how modules,
|
|
|
|
classes and attributes will be shown in the diagram.
|
|
|
|
You can combine several modules in one project (except with
|
|
|
|
.B -c
|
|
|
|
).
|
2008-08-18 16:34:27 +00:00
|
|
|
|
|
|
|
.SH COMMON OPTIONS
|
|
|
|
|
|
|
|
.IP "-h, --help"
|
2008-08-18 17:12:15 +00:00
|
|
|
show this help message and exit
|
2008-08-18 16:34:27 +00:00
|
|
|
.IP "-p<name>, --project=<name>"
|
2008-08-18 17:12:15 +00:00
|
|
|
set project name to <name> if not using -c option. (default:'No Name')
|
2008-08-18 16:34:27 +00:00
|
|
|
.IP "-i<file>, --ignore=<file>"
|
2008-08-18 17:12:15 +00:00
|
|
|
add <file> (may be a directory) to the black list (not parsed)
|
2008-08-18 16:34:27 +00:00
|
|
|
.IP "-f<mode>, --filter-mode=<mode>"
|
2008-08-25 08:55:04 +00:00
|
|
|
filter attributes and functions according to <mode>. You can combine
|
2008-08-18 17:12:15 +00:00
|
|
|
modes using '+' like 'SPECIAL+OTHER'. Correct modes are :
|
2008-08-25 08:55:04 +00:00
|
|
|
'PUB_ONLY' filter all non public attributes (default)
|
|
|
|
'ALL' no filter
|
|
|
|
'SPECIAL' filter Python special functions except constructor
|
|
|
|
'OTHER' filter protected and private attributes
|
2008-08-18 16:34:27 +00:00
|
|
|
|
|
|
|
.IP "-d<file>, --diadefs=<file>"
|
|
|
|
create diagram according to the diagrams definitions in <file>
|
|
|
|
.IP "-c <class>, --class=<class>"
|
2008-08-18 17:12:15 +00:00
|
|
|
create a class diagram with all classes related to <class> [current: none]
|
|
|
|
the class must be in the file <modules>. By default, this will include all
|
|
|
|
ancestors of <class> and include module names (i.e. '-my' ).
|
|
|
|
.IP "-l <depth>, --search-level=<depth>"
|
2008-08-25 08:55:04 +00:00
|
|
|
In combination with
|
|
|
|
.B -c
|
|
|
|
, limit depth of search for associated classes [default: not limited].
|
|
|
|
For example, <depth>=1 will only take classes directly related to the classes
|
|
|
|
in the project, while <depth>=2 will also take all classes related to those
|
|
|
|
fecthed by<depth>=1.
|
2008-08-18 16:34:27 +00:00
|
|
|
.IP "-m [yn], --module-names=[yn]"
|
2008-08-25 08:55:04 +00:00
|
|
|
include module name in representation of classes [current: none]
|
2008-08-18 16:34:27 +00:00
|
|
|
.IP "-b [yn], --builtin=[yn]"
|
2008-08-25 08:55:04 +00:00
|
|
|
include builtin objects in representation of classes [current: none]
|
2008-08-18 16:34:27 +00:00
|
|
|
|
2008-08-25 08:55:04 +00:00
|
|
|
.SH PYREVERSE DIAGRAM
|
|
|
|
If no -c and no --diadefs option specified,
|
|
|
|
.B pyreverse diagram
|
|
|
|
will create
|
|
|
|
\- a diagram 'classes_<name>' for the classes in <modules> and
|
|
|
|
\- a diagram 'packages_<name>' for the packages in <modules>.
|
|
|
|
With -c,
|
|
|
|
.B pyreverse diagram
|
|
|
|
creates a diagram for each <class> with same name (adding an output file extension).
|
2008-08-18 16:34:27 +00:00
|
|
|
.IP "-o <format>, --output=<format>"
|
2008-08-25 08:55:04 +00:00
|
|
|
create a *.<format> output file if format available. Available formats
|
|
|
|
are all formats that dot can produce and
|
|
|
|
.B vcg.
|
|
|
|
[default: dot]
|
2008-08-18 16:34:27 +00:00
|
|
|
|
|
|
|
|
|
|
|
.SH REQUIRES
|
|
|
|
Python
|
|
|
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.B dot(1), pylint(1)
|
|
|
|
|
|
|
|
.I http://www.logilab.org/pyreverse
|
|
|
|
|
|
|
|
.SH AUTHORS
|
|
|
|
Sylvain Thenault, Emile Anclin
|
|
|
|
|
|
|
|
This manpage was written by Emile Anclin <emile.anclin@logilab.fr>
|