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