Provided by: mypy_0.761-1build1_all 
NAME
mypy - Optional static typing for Python
SYNOPSIS
mypy [-h] [-v] [-V] [-m MODULE] [-p PACKAGE] [-c PROGRAM_TEXT] [OPTIONS...] [FILES ...]
DESCRIPTION
Mypy is a static type checker for Python 3 and Python 2.7. If you sprinkle your code with
type annotations, mypy can type check your code and find common bugs. As mypy is a static
analyzer, or a lint-like tool, the type annotations are just hints for mypy and don’t
interfere when running your program. You run your program with a standard Python
interpreter, and the annotations are treated effectively as comments.
Using the Python 3 function annotation syntax (using the PEP 484 notation) or a
comment-based annotation syntax for Python 2 code, you will be able to efficiently
annotate your code and use mypy to check the code for common errors. Mypy has a powerful
and easy-to-use type system with modern features such as type inference, generics,
callable types, tuple types, union types, and structural subtyping.
Mypy is invoked with the paths the user needs to check:
$ mypy foo.py bar.py some_directory
The directories are checked recursively to find Python source files.
System Message: ERROR/3 (debian/mypy_options.rst:, line 3)
Unknown directive type "program".
.. program:: mypy
OPTIONS
This section documents mypy's command line interface. You can view a quick summary of the
available flags by running
:option:`mypy --help`
.
System Message: ERROR/3 (debian/mypy_options.rst:, line 8)
Unknown interpreted text role "option".
NOTE:
Command line flags are liable to change between releases.
Specifying what to type check
By default, you can specify what code you want mypy to type check by passing in the paths
to what you want to have type checked:
$ mypy foo.py bar.py some_directory
Note that directories are checked recursively.
Mypy also lets you specify what code to type check in several other ways. A short summary
of the relevant flags is included below: for full details, see running-mypy.
System Message: ERROR/3 (debian/mypy_options.rst:, line 30)
Unknown directive type "option".
.. option:: -m MODULE, --module MODULE
Asks mypy to type check the provided module. This flag may be
repeated multiple times.
Mypy *will not* recursively type check any submodules of the provided
module.
System Message: ERROR/3 (debian/mypy_options.rst:, line 38)
Unknown directive type "option".
.. option:: -p PACKAGE, --package PACKAGE
Asks mypy to type check the provided package. This flag may be
repeated multiple times.
Mypy *will* recursively type check any submodules of the provided
package. This flag is identical to :option:`--module` apart from this
behavior.
System Message: ERROR/3 (debian/mypy_options.rst:, line 47)
Unknown directive type "option".
.. option:: -c PROGRAM_TEXT, --command PROGRAM_TEXT
Asks mypy to type check the provided string as a program.
Optional arguments
System Message: ERROR/3 (debian/mypy_options.rst:, line 55)
Unknown directive type "option".
.. option:: -h, --help
Show help message and exit.
System Message: ERROR/3 (debian/mypy_options.rst:, line 59)
Unknown directive type "option".
.. option:: -v, --verbose
More verbose messages.
System Message: ERROR/3 (debian/mypy_options.rst:, line 63)
Unknown directive type "option".
.. option:: -V, --version
Show program's version number and exit.
Config file
System Message: ERROR/3 (debian/mypy_options.rst:, line 72)
Unknown directive type "option".
.. option:: --config-file CONFIG_FILE
This flag makes mypy read configuration settings from the given file.
By default settings are read from ``mypy.ini`` or ``setup.cfg`` in the
current directory, or ``.mypy.ini`` in the user's home directory.
Settings override mypy's built-in defaults and command line flags
can override settings.
Specifying :option:`--config-file= <--config-file>` (with no filename) will ignore *all*
config files.
See :ref:`config-file` for the syntax of configuration files.
System Message: ERROR/3 (debian/mypy_options.rst:, line 86)
Unknown directive type "option".
.. option:: --warn-unused-configs
This flag makes mypy warn about unused ``[mypy-<pattern>]`` config
file sections.
(This requires turning off incremental mode using :option:`--no-incremental`.)
Import discovery
The following flags customize how exactly mypy discovers and follows imports.
System Message: ERROR/3 (debian/mypy_options.rst:, line 101)
Unknown directive type "option".
.. option:: --namespace-packages
This flag enables import discovery to use namespace packages (see
:pep:`420`). In particular, this allows discovery of imported
packages that don't have an ``__init__.py`` (or ``__init__.pyi``)
file.
Namespace packages are found (using the PEP 420 rules, which
prefers "classic" packages over namespace packages) along the
module search path -- this is primarily set from the source files
passed on the command line, the ``MYPYPATH`` environment variable,
and the :ref:`mypy_path config option
<config-file-import-discovery>`.
Note that this only affects import discovery -- for modules and
packages explicitly passed on the command line, mypy still
searches for ``__init__.py[i]`` files in order to determine the
fully-qualified module/package name.
System Message: ERROR/3 (debian/mypy_options.rst:, line 120)
Unknown directive type "option".
.. option:: --ignore-missing-imports
This flag makes mypy ignore all missing imports. It is equivalent
to adding ``# type: ignore`` comments to all unresolved imports
within your codebase.
Note that this flag does *not* suppress errors about missing names
in successfully resolved modules. For example, if one has the
following files::
package/__init__.py
package/mod.py
Then mypy will generate the following errors with :option:`--ignore-missing-imports`:
.. code-block:: python
import package.unknown # No error, ignored
x = package.unknown.func() # OK. 'func' is assumed to be of type 'Any'
from package import unknown # No error, ignored
from package.mod import NonExisting # Error: Module has no attribute 'NonExisting'
For more details, see :ref:`ignore-missing-imports`.
System Message: ERROR/3 (debian/mypy_options.rst:, line 145)
Unknown directive type "option".
.. option:: --follow-imports {normal,silent,skip,error}
This flag adjusts how mypy follows imported modules that were not
explicitly passed in via the command line.
The default option is ``normal``: mypy will follow and type check
all modules. For more information on what the other options do,
see :ref:`Following imports <follow-imports>`.
System Message: ERROR/3 (debian/mypy_options.rst:, line 154)
Unknown directive type "option".
.. option:: --python-executable EXECUTABLE
This flag will have mypy collect type information from :pep:`561`
compliant packages installed for the Python executable ``EXECUTABLE``.
If not provided, mypy will use PEP 561 compliant packages installed for
the Python executable running mypy.
See :ref:`installed-packages` for more on making PEP 561 compliant packages.
System Message: ERROR/3 (debian/mypy_options.rst:, line 163)
Unknown directive type "option".
.. option:: --no-site-packages
This flag will disable searching for :pep:`561` compliant packages. This
will also disable searching for a usable Python executable.
Use this flag if mypy cannot find a Python executable for the version of
Python being checked, and you don't need to use PEP 561 typed packages.
Otherwise, use :option:`--python-executable`.
System Message: ERROR/3 (debian/mypy_options.rst:, line 172)
Unknown directive type "option".
.. option:: --no-silence-site-packages
By default, mypy will suppress any error messages generated within :pep:`561`
compliant packages. Adding this flag will disable this behavior.
Platform configuration
By default, mypy will assume that you intend to run your code using the same operating
system and Python version you are using to run mypy itself. The following flags let you
modify this behavior.
For more information on how to use these flags, see version_and_platform_checks.
System Message: ERROR/3 (debian/mypy_options.rst:, line 189)
Unknown directive type "option".
.. option:: --python-version X.Y
This flag will make mypy type check your code as if it were
run under Python version X.Y. Without this option, mypy will default to using
whatever version of Python is running mypy. Note that the :option:`-2` and
:option:`--py2` flags are aliases for :option:`--python-version 2.7 <--python-version>`.
This flag will attempt to find a Python executable of the corresponding
version to search for :pep:`561` compliant packages. If you'd like to
disable this, use the :option:`--no-site-packages` flag (see
:ref:`import-discovery` for more details).
System Message: ERROR/3 (debian/mypy_options.rst:, line 201)
Unknown directive type "option".
.. option:: -2, --py2
Equivalent to running :option:`--python-version 2.7 <--python-version>`.
System Message: ERROR/3 (debian/mypy_options.rst:, line 205)
Unknown directive type "option".
.. option:: --platform PLATFORM
This flag will make mypy type check your code as if it were
run under the given operating system. Without this option, mypy will
default to using whatever operating system you are currently using.
The ``PLATFORM`` parameter may be any string supported by
:py:data:`sys.platform`.
System Message: ERROR/3 (debian/mypy_options.rst:, line 216)
Unknown directive type "option".
.. option:: --always-true NAME
This flag will treat all variables named ``NAME`` as
compile-time constants that are always true. This flag may
be repeated.
System Message: ERROR/3 (debian/mypy_options.rst:, line 222)
Unknown directive type "option".
.. option:: --always-false NAME
This flag will treat all variables named ``NAME`` as
compile-time constants that are always false. This flag may
be repeated.
Disallow dynamic typing
The Any type is used represent a value that has a dynamic type <dynamic-typing>. The
--disallow-any family of flags will disallow various uses of the Any type in a module --
this lets us strategically disallow the use of dynamic typing in a controlled way.
The following options are available:
System Message: ERROR/3 (debian/mypy_options.rst:, line 240)
Unknown directive type "option".
.. option:: --disallow-any-unimported
This flag disallows usage of types that come from unfollowed imports
(such types become aliases for ``Any``). Unfollowed imports occur either
when the imported module does not exist or when :option:`--follow-imports=skip <--follow-imports>`
is set.
System Message: ERROR/3 (debian/mypy_options.rst:, line 247)
Unknown directive type "option".
.. option:: --disallow-any-expr
This flag disallows all expressions in the module that have type ``Any``.
If an expression of type ``Any`` appears anywhere in the module
mypy will output an error unless the expression is immediately
used as an argument to :py:func:`~typing.cast` or assigned to a variable with an
explicit type annotation.
In addition, declaring a variable of type ``Any``
or casting to type ``Any`` is not allowed. Note that calling functions
that take parameters of type ``Any`` is still allowed.
System Message: ERROR/3 (debian/mypy_options.rst:, line 259)
Unknown directive type "option".
.. option:: --disallow-any-decorated
This flag disallows functions that have ``Any`` in their signature
after decorator transformation.
System Message: ERROR/3 (debian/mypy_options.rst:, line 264)
Unknown directive type "option".
.. option:: --disallow-any-explicit
This flag disallows explicit ``Any`` in type positions such as type
annotations and generic type parameters.
System Message: ERROR/3 (debian/mypy_options.rst:, line 269)
Unknown directive type "option".
.. option:: --disallow-any-generics
This flag disallows usage of generic types that do not specify explicit
type parameters. Moreover, built-in collections (such as :py:class:`list` and
:py:class:`dict`) become disallowed as you should use their aliases from the :py:mod:`typing`
module (such as :py:class:`List[int] <typing.List>` and :py:class:`Dict[str, str] <typing.Dict>`).
System Message: ERROR/3 (debian/mypy_options.rst:, line 276)
Unknown directive type "option".
.. option:: --disallow-subclassing-any
This flag reports an error whenever a class subclasses a value of
type ``Any``. This may occur when the base class is imported from
a module that doesn't exist (when using
:option:`--ignore-missing-imports`) or is
ignored due to :option:`--follow-imports=skip <--follow-imports>` or a
``# type: ignore`` comment on the ``import`` statement.
Since the module is silenced, the imported class is given a type of ``Any``.
By default mypy will assume that the subclass correctly inherited
the base class even though that may not actually be the case. This
flag makes mypy raise an error instead.
Untyped definitions and calls
The following flags configure how mypy handles untyped function definitions or calls.
System Message: ERROR/3 (debian/mypy_options.rst:, line 299)
Unknown directive type "option".
.. option:: --disallow-untyped-calls
This flag reports an error whenever a function with type annotations
calls a function defined without annotations.
System Message: ERROR/3 (debian/mypy_options.rst:, line 304)
Unknown directive type "option".
.. option:: --disallow-untyped-defs
This flag reports an error whenever it encounters a function definition
without type annotations.
System Message: ERROR/3 (debian/mypy_options.rst:, line 309)
Unknown directive type "option".
.. option:: --disallow-incomplete-defs
This flag reports an error whenever it encounters a partly annotated
function definition.
System Message: ERROR/3 (debian/mypy_options.rst:, line 314)
Unknown directive type "option".
.. option:: --check-untyped-defs
This flag is less severe than the previous two options -- it type checks
the body of every function, regardless of whether it has type annotations.
(By default the bodies of functions without annotations are not type
checked.)
It will assume all arguments have type ``Any`` and always infer ``Any``
as the return type.
System Message: ERROR/3 (debian/mypy_options.rst:, line 324)
Unknown directive type "option".
.. option:: --disallow-untyped-decorators
This flag reports an error whenever a function with type annotations
is decorated with a decorator without annotations.
None and Optional handling
The following flags adjust how mypy handles values of type None. For more details, see
no_strict_optional.
System Message: ERROR/3 (debian/mypy_options.rst:, line 340)
Unknown directive type "option".
.. option:: --no-implicit-optional
This flag causes mypy to stop treating arguments with a ``None``
default value as having an implicit :py:data:`~typing.Optional` type.
For example, by default mypy will assume that the ``x`` parameter
is of type ``Optional[int]`` in the code snippet below since
the default parameter is ``None``:
.. code-block:: python
def foo(x: int = None) -> None:
print(x)
If this flag is set, the above snippet will no longer type check:
we must now explicitly indicate that the type is ``Optional[int]``:
.. code-block:: python
def foo(x: Optional[int] = None) -> None:
print(x)
System Message: ERROR/3 (debian/mypy_options.rst:, line 362)
Unknown directive type "option".
.. option:: --no-strict-optional
This flag disables strict checking of :py:data:`~typing.Optional`
types and ``None`` values. With this option, mypy doesn't
generally check the use of ``None`` values -- they are valid
everywhere. See :ref:`no_strict_optional` for more about this feature.
**Note:** Strict optional checking was enabled by default starting in
mypy 0.600, and in previous versions it had to be explicitly enabled
using ``--strict-optional`` (which is still accepted).
Configuring warnings
The follow flags enable warnings for code that is sound but is potentially problematic or
redundant in some way.
System Message: ERROR/3 (debian/mypy_options.rst:, line 382)
Unknown directive type "option".
.. option:: --warn-redundant-casts
This flag will make mypy report an error whenever your code uses
an unnecessary cast that can safely be removed.
System Message: ERROR/3 (debian/mypy_options.rst:, line 387)
Unknown directive type "option".
.. option:: --warn-unused-ignores
This flag will make mypy report an error whenever your code uses
a ``# type: ignore`` comment on a line that is not actually
generating an error message.
This flag, along with the :option:`--warn-redundant-casts` flag, are both
particularly useful when you are upgrading mypy. Previously,
you may have needed to add casts or ``# type: ignore`` annotations
to work around bugs in mypy or missing stubs for 3rd party libraries.
These two flags let you discover cases where either workarounds are
no longer necessary.
System Message: ERROR/3 (debian/mypy_options.rst:, line 401)
Unknown directive type "option".
.. option:: --no-warn-no-return
By default, mypy will generate errors when a function is missing
return statements in some execution paths. The only exceptions
are when:
- The function has a ``None`` or ``Any`` return type
- The function has an empty body or a body that is just
ellipsis (``...``). Empty functions are often used for
abstract methods.
Passing in :option:`--no-warn-no-return` will disable these error
messages in all cases.
System Message: ERROR/3 (debian/mypy_options.rst:, line 415)
Unknown directive type "option".
.. option:: --warn-return-any
This flag causes mypy to generate a warning when returning a value
with type ``Any`` from a function declared with a non-``Any`` return type.
System Message: ERROR/3 (debian/mypy_options.rst:, line 420)
Unknown directive type "option".
.. option:: --warn-unreachable
This flag will make mypy report an error whenever it encounters
code determined to be unreachable or redundant after performing type analysis.
This can be a helpful way of detecting certain kinds of bugs in your code.
For example, enabling this flag will make mypy report that the ``x > 7``
check is redundant and that the ``else`` block below is unreachable.
.. code-block:: python
def process(x: int) -> None:
# Error: Right operand of 'or' is never evaluated
if isinstance(x, int) or x > 7:
# Error: Unsupported operand types for + ("int" and "str")
print(x + "bad")
else:
# Error: 'Statement is unreachable' error
print(x + "bad")
To help prevent mypy from generating spurious warnings, the "Statement is
unreachable" warning will be silenced in exactly two cases:
1. When the unreachable statement is a ``raise`` statement, is an
``assert False`` statement, or calls a function that has the :py:data:`~typing.NoReturn`
return type hint. In other words, when the unreachable statement
throws an error or terminates the program in some way.
2. When the unreachable statement was *intentionally* marked as unreachable
using :ref:`version_and_platform_checks`.
.. note::
Mypy currently cannot detect and report unreachable or redundant code
inside any functions using :ref:`type-variable-value-restriction`.
This limitation will be removed in future releases of mypy.
Miscellaneous strictness flags
This section documents any other flags that do not neatly fall under any of the above
sections.
System Message: ERROR/3 (debian/mypy_options.rst:, line 464)
Unknown directive type "option".
.. option:: --allow-untyped-globals
This flag causes mypy to suppress errors caused by not being able to fully
infer the types of global and class variables.
System Message: ERROR/3 (debian/mypy_options.rst:, line 469)
Unknown directive type "option".
.. option:: --allow-redefinition
By default, mypy won't allow a variable to be redefined with an
unrelated type. This flag enables redefinion of a variable with an
arbitrary type *in some contexts*: only redefinitions within the
same block and nesting depth as the original definition are allowed.
Example where this can be useful:
.. code-block:: python
def process(items: List[str]) -> None:
# 'items' has type List[str]
items = [item.split() for item in items]
# 'items' now has type List[List[str]]
...
System Message: ERROR/3 (debian/mypy_options.rst:, line 485)
Unknown directive type "option".
.. option:: --no-implicit-reexport
By default, imported values to a module are treated as exported and mypy allows
other modules to import them. This flag changes the behavior to not re-export unless
the item is imported using from-as or is included in ``__all__``. Note this is
always treated as enabled for stub files. For example:
.. code-block:: python
# This won't re-export the value
from foo import bar
# This will re-export it as bar and allow other modules to import it
from foo import bar as bar
# This will also re-export bar
from foo import bar
__all__ = ['bar']
System Message: ERROR/3 (debian/mypy_options.rst:, line 503)
Unknown directive type "option".
.. option:: --strict-equality
By default, mypy allows always-false comparisons like ``42 == 'no'``.
Use this flag to prohibit such comparisons of non-overlapping types, and
similar identity and container checks:
.. code-block:: python
from typing import List, Text
items: List[int]
if 'some string' in items: # Error: non-overlapping container check!
...
text: Text
if text != b'other bytes': # Error: non-overlapping equality check!
...
assert text is not None # OK, check against None is allowed as a special case.
System Message: ERROR/3 (debian/mypy_options.rst:, line 523)
Unknown directive type "option".
.. option:: --strict
This flag mode enables all optional error checking flags. You can see the
list of flags enabled by strict mode in the full :option:`mypy --help` output.
Note: the exact list of flags enabled by running :option:`--strict` may change
over time.
Configuring error messages
The following flags let you adjust how much detail mypy displays in error messages.
System Message: ERROR/3 (debian/mypy_options.rst:, line 540)
Unknown directive type "option".
.. option:: --show-error-context
This flag will precede all errors with "note" messages explaining the
context of the error. For example, consider the following program:
.. code-block:: python
class Test:
def foo(self, x: int) -> int:
return x + "bar"
Mypy normally displays an error message that looks like this::
main.py:3: error: Unsupported operand types for + ("int" and "str")
If we enable this flag, the error message now looks like this::
main.py: note: In member "foo" of class "Test":
main.py:3: error: Unsupported operand types for + ("int" and "str")
System Message: ERROR/3 (debian/mypy_options.rst:, line 560)
Unknown directive type "option".
.. option:: --show-column-numbers
This flag will add column offsets to error messages.
For example, the following indicates an error in line 12, column 9
(note that column offsets are 0-based)::
main.py:12:9: error: Unsupported operand types for / ("int" and "str")
System Message: ERROR/3 (debian/mypy_options.rst:, line 568)
Unknown directive type "option".
.. option:: --show-error-codes
This flag will add an error code ``[<code>]`` to error messages. The error
code is shown after each error message::
prog.py:1: error: "str" has no attribute "trim" [attr-defined]
See :ref:`error-codes` for more information.
System Message: ERROR/3 (debian/mypy_options.rst:, line 577)
Unknown directive type "option".
.. option:: --pretty
Use visually nicer output in error messages: use soft word wrap,
show source code snippets, and show error location markers.
System Message: ERROR/3 (debian/mypy_options.rst:, line 582)
Unknown directive type "option".
.. option:: --no-color-output
This flag will disable color output in error messages, enabled by default.
System Message: ERROR/3 (debian/mypy_options.rst:, line 586)
Unknown directive type "option".
.. option:: --no-error-summary
This flag will disable error summary. By default mypy shows a summary line
including total number of errors, number of files with errors, and number
of files checked.
System Message: ERROR/3 (debian/mypy_options.rst:, line 592)
Unknown directive type "option".
.. option:: --show-absolute-path
Show absolute paths to files.
Incremental mode
By default, mypy will store type information into a cache. Mypy will use this information
to avoid unnecessary recomputation when it type checks your code again. This can help
speed up the type checking process, especially when most parts of your program have not
changed since the previous mypy run.
If you want to speed up how long it takes to recheck your code beyond what incremental
mode can offer, try running mypy in daemon mode <mypy_daemon>.
System Message: ERROR/3 (debian/mypy_options.rst:, line 612)
Unknown directive type "option".
.. option:: --no-incremental
This flag disables incremental mode: mypy will no longer reference
the cache when re-run.
Note that mypy will still write out to the cache even when
incremental mode is disabled: see the :option:`--cache-dir` flag below
for more details.
System Message: ERROR/3 (debian/mypy_options.rst:, line 621)
Unknown directive type "option".
.. option:: --cache-dir DIR
By default, mypy stores all cache data inside of a folder named
``.mypy_cache`` in the current directory. This flag lets you
change this folder. This flag can also be useful for controlling
cache use when using :ref:`remote caching <remote-cache>`.
This setting will override the ``MYPY_CACHE_DIR`` environment
variable if it is set.
Mypy will also always write to the cache even when incremental
mode is disabled so it can "warm up" the cache. To disable
writing to the cache, use ``--cache-dir=/dev/null`` (UNIX)
or ``--cache-dir=nul`` (Windows).
System Message: ERROR/3 (debian/mypy_options.rst:, line 636)
Unknown directive type "option".
.. option:: --sqlite-cache
Use an `SQLite`_ database to store the cache.
System Message: ERROR/3 (debian/mypy_options.rst:, line 640)
Unknown directive type "option".
.. option:: --cache-fine-grained
Include fine-grained dependency information in the cache for the mypy daemon.
System Message: ERROR/3 (debian/mypy_options.rst:, line 644)
Unknown directive type "option".
.. option:: --skip-version-check
By default, mypy will ignore cache data generated by a different
version of mypy. This flag disables that behavior.
System Message: ERROR/3 (debian/mypy_options.rst:, line 649)
Unknown directive type "option".
.. option:: --skip-cache-mtime-checks
Skip cache internal consistency checks based on mtime.
Advanced options
The following flags are useful mostly for people who are interested in developing or
debugging mypy internals.
System Message: ERROR/3 (debian/mypy_options.rst:, line 660)
Unknown directive type "option".
.. option:: --pdb
This flag will invoke the Python debugger when mypy encounters
a fatal error.
System Message: ERROR/3 (debian/mypy_options.rst:, line 665)
Unknown directive type "option".
.. option:: --show-traceback, --tb
If set, this flag will display a full traceback when mypy
encounters a fatal error.
System Message: ERROR/3 (debian/mypy_options.rst:, line 670)
Unknown directive type "option".
.. option:: --raise-exceptions
Raise exception on fatal error.
System Message: ERROR/3 (debian/mypy_options.rst:, line 674)
Unknown directive type "option".
.. option:: --custom-typing-module MODULE
This flag lets you use a custom module as a substitute for the
:py:mod:`typing` module.
System Message: ERROR/3 (debian/mypy_options.rst:, line 679)
Unknown directive type "option".
.. option:: --custom-typeshed-dir DIR
This flag specifies the directory where mypy looks for typeshed
stubs, instead of the typeshed that ships with mypy. This is
primarily intended to make it easier to test typeshed changes before
submitting them upstream, but also allows you to use a forked version of
typeshed.
System Message: ERROR/3 (debian/mypy_options.rst:, line 689)
Unknown directive type "option".
.. option:: --warn-incomplete-stub
This flag modifies both the :option:`--disallow-untyped-defs` and
:option:`--disallow-incomplete-defs` flags so they also report errors
if stubs in typeshed are missing type annotations or has incomplete
annotations. If both flags are missing, :option:`--warn-incomplete-stub`
also does nothing.
This flag is mainly intended to be used by people who want contribute
to typeshed and would like a convenient way to find gaps and omissions.
If you want mypy to report an error when your codebase *uses* an untyped
function, whether that function is defined in typeshed or not, use the
:option:`--disallow-untyped-calls` flag. See :ref:`untyped-definitions-and-calls`
for more details.
System Message: ERROR/3 (debian/mypy_options.rst:, line 707)
Unknown directive type "option".
.. option:: --shadow-file SOURCE_FILE SHADOW_FILE
When mypy is asked to type check ``SOURCE_FILE``, this flag makes mypy
read from and type check the contents of ``SHADOW_FILE`` instead. However,
diagnostics will continue to refer to ``SOURCE_FILE``.
Specifying this argument multiple times (``--shadow-file X1 Y1 --shadow-file X2 Y2``)
will allow mypy to perform multiple substitutions.
This allows tooling to create temporary files with helpful modifications
without having to change the source file in place. For example, suppose we
have a pipeline that adds ``reveal_type`` for certain variables.
This pipeline is run on ``original.py`` to produce ``temp.py``.
Running ``mypy --shadow-file original.py temp.py original.py`` will then
cause mypy to type check the contents of ``temp.py`` instead of ``original.py``,
but error messages will still reference ``original.py``.
Report generation
If these flags are set, mypy will generate a report in the specified format into the
specified directory.
System Message: ERROR/3 (debian/mypy_options.rst:, line 731)
Unknown directive type "option".
.. option:: --any-exprs-report DIR
Causes mypy to generate a text file report documenting how many
expressions of type ``Any`` are present within your codebase.
System Message: ERROR/3 (debian/mypy_options.rst:, line 736)
Unknown directive type "option".
.. option:: --cobertura-xml-report DIR
Causes mypy to generate a Cobertura XML type checking coverage report.
You must install the `lxml`_ library to generate this report.
System Message: ERROR/3 (debian/mypy_options.rst:, line 742)
Unknown directive type "option".
.. option:: --html-report / --xslt-html-report DIR
Causes mypy to generate an HTML type checking coverage report.
You must install the `lxml`_ library to generate this report.
System Message: ERROR/3 (debian/mypy_options.rst:, line 748)
Unknown directive type "option".
.. option:: --linecount-report DIR
Causes mypy to generate a text file report documenting the functions
and lines that are typed and untyped within your codebase.
System Message: ERROR/3 (debian/mypy_options.rst:, line 753)
Unknown directive type "option".
.. option:: --linecoverage-report DIR
Causes mypy to generate a JSON file that maps each source file's
absolute filename to a list of line numbers that belong to typed
functions in that file.
System Message: ERROR/3 (debian/mypy_options.rst:, line 759)
Unknown directive type "option".
.. option:: --lineprecision-report DIR
Causes mypy to generate a flat text file report with per-module
statistics of how many lines are typechecked etc.
System Message: ERROR/3 (debian/mypy_options.rst:, line 764)
Unknown directive type "option".
.. option:: --txt-report / --xslt-txt-report DIR
Causes mypy to generate a text file type checking coverage report.
You must install the `lxml`_ library to generate this report.
System Message: ERROR/3 (debian/mypy_options.rst:, line 770)
Unknown directive type "option".
.. option:: --xml-report DIR
Causes mypy to generate an XML type checking coverage report.
You must install the `lxml`_ library to generate this report.
Miscellaneous
System Message: ERROR/3 (debian/mypy_options.rst:, line 779)
Unknown directive type "option".
.. option:: --junit-xml JUNIT_XML
Causes mypy to generate a JUnit XML test result document with
type checking results. This can make it easier to integrate mypy
with continuous integration (CI) tools.
System Message: ERROR/3 (debian/mypy_options.rst:, line 785)
Unknown directive type "option".
.. option:: --find-occurrences CLASS.MEMBER
This flag will make mypy print out all usages of a class member
based on static type information. This feature is experimental.
System Message: ERROR/3 (debian/mypy_options.rst:, line 790)
Unknown directive type "option".
.. option:: --scripts-are-modules
This flag will give command line arguments that appear to be
scripts (i.e. files whose name does not end in ``.py``)
a module name derived from the script name rather than the fixed
name :py:mod:`__main__`.
This lets you check more than one script in a single mypy invocation.
(The default :py:mod:`__main__` is technically more correct, but if you
have many scripts that import a large package, the behavior enabled
by this flag is often more convenient.)
ENVIRONMENT
MYPYPATH
Additional module search path entries. The format is the same as the shell's $PATH:
one or more directory pathnames separated by colons.
SEE ALSO
dmypy(1)
Full documentation is available online at:
http://mypy.readthedocs.io/en/latest/getting_started.html or locally at:
/usr/share/doc/mypy/html (requires mypy-doc package).
AUTHOR
Jukka Lehtosalo and contributors
MYPY(1)