1MYPY(1) User Commands MYPY(1)
2
3
4
6 mypy - manual page for mypy stubgen 0.942-dev
7
9 usage: stubgen [-h] [--py2] [more options, see -h]
10
11 [-m MODULE] [-p PACKAGE] [files ...]
12
13 Generate draft stubs for modules. Stubs are generated in directory
14 ./out, to avoid overriding files with manual changes. This directory is
15 assumed to exist.
16
17 positional arguments:
18 files generate stubs for given files or directories
19
20 options:
21 -h, --help
22 show this help message and exit
23
24 --py2 run in Python 2 mode (default: Python 3 mode)
25
26 --ignore-errors
27 ignore errors when trying to generate stubs for modules
28
29 --no-import
30 don't import the modules, just parse and analyze them (doesn't
31 work with C extension modules and might not respect __all__)
32
33 --parse-only
34 don't perform semantic analysis of sources, just parse them
35 (only applies to Python modules, might affect quality of stubs)
36
37 --include-private
38 generate stubs for objects and members considered private (sin‐
39 gle leading underscore and no trailing underscores)
40
41 --export-less
42 don't implicitly export all names imported from other modules in
43 the same package
44
45 -v, --verbose
46 show more verbose messages
47
48 -q, --quiet
49 show fewer messages
50
51 --doc-dir PATH
52 use .rst documentation in PATH (this may result in better stubs
53 in some cases; consider setting this to DIR/Python-X.Y.Z/Doc/li‐
54 brary)
55
56 --search-path PATH
57 specify module search directories, separated by ':' (currently
58 only used if --no-import is given)
59
60 --python-executable PATH
61 use Python interpreter at PATH (only works for Python 2 right
62 now)
63
64 -o PATH, --output PATH
65 change the output directory [default: out]
66
67 -m MODULE, --module MODULE
68 generate stub for module; can repeat for more modules
69
70 -p PACKAGE, --package PACKAGE
71 generate stubs for package recursively; can be repeated
72
73
74
75mypy stubgen 0.942-dev April 2022 MYPY(1)