1MYPY(1) User Commands MYPY(1)
2
3
4
6 mypy - manual page for mypy stubgen 1.4.0-dev
7
9 usage: stubgen [-h] [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 --ignore-errors
25 ignore errors when trying to generate stubs for modules
26
27 --no-import
28 don't import the modules, just parse and analyze them (doesn't
29 work with C extension modules and might not respect __all__)
30
31 --parse-only
32 don't perform semantic analysis of sources, just parse them
33 (only applies to Python modules, might affect quality of stubs)
34
35 --include-private
36 generate stubs for objects and members considered private (sin‐
37 gle leading underscore and no trailing underscores)
38
39 --export-less
40 don't implicitly export all names imported from other modules in
41 the same package
42
43 -v, --verbose
44 show more verbose messages
45
46 -q, --quiet
47 show fewer messages
48
49 --doc-dir PATH
50 use .rst documentation in PATH (this may result in better stubs
51 in some cases; consider setting this to DIR/Python-X.Y.Z/Doc/li‐
52 brary)
53
54 --search-path PATH
55 specify module search directories, separated by ':' (currently
56 only used if --no-import is given)
57
58 -o PATH, --output PATH
59 change the output directory [default: out]
60
61 -m MODULE, --module MODULE
62 generate stub for module; can repeat for more modules
63
64 -p PACKAGE, --package PACKAGE
65 generate stubs for package recursively; can be repeated
66
67
68
69mypy stubgen 1.4.0-dev June 2023 MYPY(1)