1MYPY(1) User Commands MYPY(1)
2
3
4
6 mypy - manual page for mypy stubgen 1.7.1-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 --no-analysis, --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 Not compatible with --inspect)
35
36 --inspect-mode
37 import and inspect modules instead of parsing source code.This
38 is the default behavior for c modules and pyc-only packages, but
39 it is also useful for pure python modules with dynamically gen‐
40 erated members.
41
42 --include-private
43 generate stubs for objects and members considered private (sin‐
44 gle leading underscore and no trailing underscores)
45
46 --export-less
47 don't implicitly export all names imported from other modules in
48 the same package
49
50 --include-docstrings
51 include existing docstrings with the stubs
52
53 -v, --verbose
54 show more verbose messages
55
56 -q, --quiet
57 show fewer messages
58
59 --doc-dir PATH
60 use .rst documentation in PATH (this may result in better stubs
61 in some cases; consider setting this to DIR/Python-X.Y.Z/Doc/li‐
62 brary)
63
64 --search-path PATH
65 specify module search directories, separated by ':' (currently
66 only used if --no-import is given)
67
68 -o PATH, --output PATH
69 change the output directory [default: out]
70
71 -m MODULE, --module MODULE
72 generate stub for module; can repeat for more modules
73
74 -p PACKAGE, --package PACKAGE
75 generate stubs for package recursively; can be repeated
76
77
78
79mypy stubgen 1.7.1-dev November 2023 MYPY(1)