1MYPY(1) User Commands MYPY(1)
2
6 mypy - manual page for mypy 0.812-dev
7
9 usage: mypy [-h] [-v] [-V] [more options; see below]
10 [-m MODULE] [-p PACKAGE] [-c PROGRAM_TEXT] [files ...]
12 Mypy is a program that will type check your Python code.
14 Pass in any files or folders you want to type check. Mypy will recur‐
16 sively traverse any provided folders to find .py files:
17 $ mypy my_program.py my_src_folder
19 For more information on getting started, see:
21 - http://mypy.readthedocs.io/en/latest/getting_started.html
23 For more details on both running mypy and using the flags below, see:
25 - http://mypy.readthedocs.io/en/latest/running_mypy.html -
27 http://mypy.readthedocs.io/en/latest/command_line.html
28 You can also use a config file to configure mypy instead of using com‐
30 mand line flags. For more details, see:
31 - http://mypy.readthedocs.io/en/latest/config_file.html
33 Optional arguments:
35 -h, --help
36 Show this help message and exit
37 -v, --verbose
39 More verbose messages
40 -V, --version
42 Show program's version number and exit
43 Config file:
45 Use a config file instead of command line arguments. This is
46 useful if you are using many flags or want to set different op‐
47 tions per each module.
48 --config-file CONFIG_FILE
50 Configuration file, must have a [mypy] section (defaults to
51 mypy.ini, .mypy.ini, setup.cfg, ~/.config/mypy/config,
52 ~/.mypy.ini)
53 --warn-unused-configs
55 Warn about unused '[mypy-<pattern>]' config sections (inverse:
56 --no-warn-unused-configs)
57 Import discovery:
59 Configure how imports are discovered and followed.
60 --namespace-packages
62 Support namespace packages (PEP 420, __init__.pyless) (inverse:
63 --no-namespace-packages)
64 --ignore-missing-imports
66 Silently ignore imports of missing modules
67 --follow-imports {normal,silent,skip,error}
69 How to treat imports (default normal)
70 --python-executable EXECUTABLE
72 Python executable used for finding PEP 561 compliant installed
73 packages and stubs
74 --no-site-packages
76 Do not search for installed PEP 561 compliant packages
77 --no-silence-site-packages
79 Do not silence errors in PEP 561 compliant installed packages
80 Platform configuration:
82 Type check code assuming it will be run under certain runtime
83 conditions. By default, mypy assumes your code will be run us‐
84 ing the same operating system and Python version you are using
85 to run mypy itself.
86 --python-version x.y
88 Type check code assuming it will be running on Python x.y
89 -2, --py2
91 Use Python 2 mode (same as --python-version 2.7)
92 --platform PLATFORM
94 Type check special-cased code for the given OS platform (de‐
95 faults to sys.platform)
96 --always-true NAME
98 Additional variable to be considered True (may be repeated)
99 --always-false NAME
101 Additional variable to be considered False (may be repeated)
102 Disallow dynamic typing:
104 Disallow the use of the dynamic 'Any' type under certain condi‐
105 tions.
106 --disallow-any-unimported
108 Disallow Any types resulting from unfollowed imports
109 --disallow-any-expr
111 Disallow all expressions that have type Any
112 --disallow-any-decorated
114 Disallow functions that have Any in their signature after deco‐
115 rator transformation
116 --disallow-any-explicit
118 Disallow explicit Any in type positions
119 --disallow-any-generics
121 Disallow usage of generic types that do not specify explicit
122 type parameters (inverse: --allow-any-generics)
123 --disallow-subclassing-any
125 Disallow subclassing values of type 'Any' when defining classes
126 (inverse: --allow-subclassingany)
127 Untyped definitions and calls:
129 Configure how untyped definitions and calls are handled. Note:
130 by default, mypy ignores any untyped function definitions and
131 assumes any calls to such functions have a return type of 'Any'.
132 --disallow-untyped-calls
134 Disallow calling functions without type annotations from func‐
135 tions with type annotations (inverse: --allow-untyped-calls)
136 --disallow-untyped-defs
138 Disallow defining functions without type annotations or with in‐
139 complete type annotations (inverse: --allow-untyped-defs)
140 --disallow-incomplete-defs
142 Disallow defining functions with incomplete type annotations
143 (inverse: --allow-incomplete-defs)
144 --check-untyped-defs
146 Type check the interior of functions without type annotations
147 (inverse: --no-check-untyped-defs)
148 --disallow-untyped-decorators
150 Disallow decorating typed functions with untyped decorators (in‐
151 verse: --allow-untyped-decorators)
152 None and Optional handling:
154 Adjust how values of type 'None' are handled. For more context
155 on how mypy handles values of type 'None', see:
156 http://mypy.readthedocs.io/en/lat‐
157 est/kinds_of_types.html#no-strictoptional
158 --no-implicit-optional
160 Don't assume arguments with default values of None are Optional
161 (inverse: --implicit-optional)
162 --no-strict-optional
164 Disable strict Optional checks (inverse: --strictoptional)
165 Configuring warnings:
167 Detect code that is sound but redundant or problematic.
168 --warn-redundant-casts
170 Warn about casting an expression to its inferred type (inverse:
171 --no-warn-redundant-casts)
172 --warn-unused-ignores
174 Warn about unneeded '# type: ignore' comments (inverse:
175 --no-warn-unused-ignores)
176 --no-warn-no-return
178 Do not warn about functions that end without returning (inverse:
179 --warn-no-return)
180 --warn-return-any
182 Warn about returning values of type Any from nonAny typed func‐
183 tions (inverse: --no-warn-returnany)
184 --warn-unreachable
186 Warn about statements or expressions inferred to be unreachable
187 (inverse: --no-warn-unreachable)
188 Miscellaneous strictness flags:
190 --allow-untyped-globals
191 Suppress toplevel errors caused by missing annotations (inverse:
192 --disallow-untyped-globals)
193 --allow-redefinition
195 Allow unconditional variable redefinition with a new type (in‐
196 verse: --disallow-redefinition)
197 --no-implicit-reexport
199 Treat imports as private unless aliased (inverse: --implicit-re‐
200 export)
201 --strict-equality
203 Prohibit equality, identity, and container checks for non-over‐
204 lapping types (inverse: --no-strictequality)
205 --strict
207 Strict mode; enables the following flags: --warnunused-configs,
208 --disallow-any-generics, --disallow-subclassing-any, --disal‐
209 low-untypedcalls, --disallow-untyped-defs, --disallowincom‐
210 plete-defs, --check-untyped-defs, --disallowuntyped-decorators,
211 --no-implicit-optional, --warn-redundant-casts, --warn-un‐
212 used-ignores, --warn-return-any, --no-implicit-reexport,
213 --strict-equality
214 --disable-error-code NAME
216 Disable a specific error code
217 --enable-error-code NAME
219 Enable a specific error code
220 Configuring error messages:
222 Adjust the amount of detail shown in error messages.
223 --show-error-context
225 Precede errors with "note:" messages explaining context (in‐
226 verse: --hide-error-context)
227 --show-column-numbers
229 Show column numbers in error messages (inverse: --hide-col‐
230 umn-numbers)
231 --show-error-codes
233 Show error codes in error messages (inverse: --hide-error-codes)
234 --pretty
236 Use visually nicer output in error messages: Use soft word wrap,
237 show source code snippets, and show error location markers (in‐
238 verse: --no-pretty)
239 --no-color-output
241 Do not colorize error messages (inverse: --coloroutput)
242 --no-error-summary
244 Do not show error stats summary (inverse: --errorsummary)
245 --show-absolute-path
247 Show absolute paths to files (inverse: --hideabsolute-path)
248 Incremental mode:
250 Adjust how mypy incrementally type checks and caches modules.
251 Mypy caches type information about modules into a cache to let
252 you speed up future invocations of mypy. Also see mypy's daemon
253 mode: mypy.readthedocs.io/en/latest/mypy_daemon.html#mypy-daemon
254 --no-incremental
256 Disable module cache (inverse: --incremental)
257 --cache-dir DIR
259 Store module cache info in the given folder in incremental mode
260 (defaults to '.mypy_cache')
261 --sqlite-cache
263 Use a sqlite database to store the cache (inverse:
264 --no-sqlite-cache)
265 --cache-fine-grained
267 Include fine-grained dependency information in the cache for the
268 mypy daemon
269 --skip-version-check
271 Allow using cache written by older mypy version
272 --skip-cache-mtime-checks
274 Skip cache internal consistency checks based on mtime
275 Advanced options:
277 Debug and customize mypy internals.
278 --pdb Invoke pdb on fatal error
280 --show-traceback, --tb
282 Show traceback on fatal error
283 --raise-exceptions
285 Raise exception on fatal error
286 --custom-typing-module MODULE
288 Use a custom typing module
289 --custom-typeshed-dir DIR
291 Use the custom typeshed in DIR
292 --warn-incomplete-stub
294 Warn if missing type annotation in typeshed, only relevant with
295 --disallow-untyped-defs or --disallow-incomplete-defs enabled
296 (inverse: --nowarn-incomplete-stub)
297 --shadow-file SOURCE_FILE SHADOW_FILE
299 When encountering SOURCE_FILE, read and type check the contents
300 of SHADOW_FILE instead.
301 Report generation:
303 Generate a report in the specified format.
304 --any-exprs-report DIR
306 --cobertura-xml-report DIR
308 --html-report DIR
310 --linecount-report DIR
312 --linecoverage-report DIR
314 --lineprecision-report DIR
316 --txt-report DIR
318 --xml-report DIR
320 --xslt-html-report DIR
322 --xslt-txt-report DIR
324 Miscellaneous:
326 --junit-xml JUNIT_XML
327 Write junit.xml to the given file
328 --find-occurrences CLASS.MEMBER
330 Print out all usages of a class member (experimental)
331 --scripts-are-modules
333 Script x becomes module x instead of __main__
334 Running code:
336 Specify the code you want to type check. For more details, see
337 mypy.readthedocs.io/en/latest/running_mypy.html#running-mypy
338 --explicit-package-bases
340 Use current directory and MYPYPATH to determine module names of
341 files passed
342 --exclude PATTERN
344 Regular expression to match file names, directory names or paths
345 which mypy should ignore while recursively discovering files to
346 check, e.g. --exclude '/setup\.py$'
347 -m MODULE, --module MODULE
349 Type-check module; can repeat for more modules
350 -p PACKAGE, --package PACKAGE
352 Type-check package recursively; can be repeated
353 -c PROGRAM_TEXT, --command PROGRAM_TEXT
355 Type-check program passed in as string
356 files Type-check given files or directories
358 Environment variables:
360 Define MYPYPATH for additional module search path entries. De‐
361 fine MYPY_CACHE_DIR to override configuration cache_dir path.
362mypy 0.812-dev February 2021 MYPY(1)