OS Manuals

/usr/bin/pyreverse

A static code analyser for Python 2 and 3

From pylint 4.1.3-r0 (os), captured 2026-11-05 by running pyreverse --help (exit 0). permalink

usage: pyreverse [options]

Create UML diagrams for classes and modules in <packages>.

options:
  -h, --help            show this help message and exit

Filtering and Scope:
  --filter-mode, -f <mode>
                        Filter attributes and functions according to <mode>. Correct modes are:
                        'PUB_ONLY' filter all non public attributes [DEFAULT], equivalent to
                        PRIVATE+SPECIAL 'ALL' no filter 'SPECIAL' filter Python special functions
                        except constructor 'OTHER' filter protected and private attributes
                        (default: PUB_ONLY)
  --class, -c <class>   Create a class diagram with all classes related to <class>; this uses by
                        default the options -ASmy (default: [])
  --show-ancestors, -a <ancestor>
                        Show <ancestor> generations of ancestor classes not in <projects>.
                        (default: None)
  --all-ancestors, -A   Show all ancestors of all classes in <projects>. (default: None)
  --show-associated, -s <association_level>
                        Show <association_level> levels of associated classes not in <projects>.
                        (default: None)
  --all-associated, -S  Show all classes associated with the target classes, including indirect
                        associations. (default: None)
  --show-builtin, -b    Include builtin objects in representation of classes. (default: False)
  --show-stdlib, -L     Include standard library objects in representation of classes. (default:
                        False)
  --max-depth <depth>   Maximum depth of packages/modules to include in the diagram, relative to
                        the deepest specified package. A depth of 0 shows only the specified
                        packages/modules, while 1 includes their immediate children, etc. When
                        specifying nested packages, depth is calculated from the deepest package
                        level. If not specified, all packages/modules in the hierarchy are shown.
                        (default: None)

Display Options:
  --module-names, -m <y or n>
                        Include module name in the representation of classes. (default: None)
  --only-classnames, -k
                        Don't show attributes and methods in the class boxes; this disables -f
                        values. (default: False)
  --no-standalone       Only show nodes with connections. (default: False)
  --no-signatures       Show method names without parameter lists or return type annotations.
                        (default: False)
  --colorized           Use colored output. Classes/modules of the same package get the same
                        color. (default: False)
  --max-color-depth <depth>
                        Use separate colors up to package depth of <depth>. Higher depths will
                        reuse colors. (default: 2)
  --color-palette <color1,color2,...>
                        Comma separated list of colors to use for the package depth coloring.
                        (default: ('#77AADD', '#99DDFF', '#44BB99', '#BBCC33', '#AAAA00',
                        '#EEDD88', '#EE8866', '#FFAABB', '#DDDDDD'))

Output Control:
  --output, -o <format>
                        Create a *.<format> output file if format is available. Available formats
                        are: .dot, .puml, .plantuml, .mmd, .html. Any other format will be tried
                        to be created by using the 'dot' command line tool, which requires a
                        graphviz installation. In this case, these additional formats are
                        available (see `Graphviz output formats
                        <https://graphviz.org/docs/outputs/>`_). (default: dot)
  --output-directory, -d <output_directory>
                        Set the output directory path. (default: )

Project Configuration:
  --ignore <file[,file...]>
                        Files or directories to be skipped. They should be base names, not paths.
                        (default: ('CVS',))
  --project, -p <project name>
                        Set the project name. This will later be appended to the output file
                        names. (default: )
  --source-roots <path>[,<path>...]
                        Add paths to the list of the source roots. Supports globbing patterns. The
                        source root is an absolute path or a path relative to the current working
                        directory used to determine a package namespace for modules located under
                        the source root. (default: ())
  --verbose             Makes pyreverse more verbose/talkative. Mostly useful for debugging.
                        (default: False)
Options (21)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--filter-mode, -f modeFilter attributes and functions according to <mode>.help
--class, -c classCreate a class diagram with all classes related to <class>;help
--show-ancestors, -a ancestorShow <ancestor> generations of ancestor classes not in <projects>.help
--all-ancestors, -AShow all ancestors of all classes in <projects>.help
--show-associated, -s association_levelShow <association_level> levels of associated classes not in <projects>.help
--all-associated, -SShow all classes associated with the target classes, including indirect associations.help
--show-builtin, -bInclude builtin objects in representation of classes.help
--show-stdlib, -LInclude standard library objects in representation of classes.help
--max-depth depthMaximum depth of packages/modules to include in the diagram, relative to the deepest specified package.help
--only-classnames, -kDon't show attributes and methods in the class boxes;help
--no-standaloneOnly show nodes with connections.help
--no-signaturesShow method names without parameter lists or return type annotations.help
--colorizedUse colored output.help
--max-color-depth depthUse separate colors up to package depth of <depth>.help
--color-palette color1Comma separated list of colors to use for the package depth coloring.help
--output, -o formatCreate a *.<format> output file if format is available.help
--output-directory, -d output_directorySet the output directory path.help
--ignore fileFiles or directories to be skipped.help
--source-roots pathAdd paths to the list of the source roots.help
--verboseMakes pyreverse more verbose/talkative.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.