automatic error suppression for mypy
Project description
mypy-upgrade
Table of Contents
mypy-upgrade
is a command-line utility that provides automatic error
suppression for mypy
(analogous to pyre-upgrade
).
Given a type checking report from mypy,
mypy-upgrade
will silence the listed errors using error suppression
comments. For example, with the following output from mypy:
ase/utils/plotting.py:13: error: Incompatible default for argument "filename" (default has type "None", argument has type "str") [assignment]
mypy-upgrade
will place a # type: ignore[assignment]
comment at the
end of line 13 in ase/utils/plotting.py
. If error codes are not present in
the mypy
report (e.g., the hide-error-codes
flag is set when mypy
was
invoked), then a non-specific # type: ignore
comment will be added instead.
:warning: Warning:
mypy-check
must be run in the same directory thatmypy
was run.*
Basic Usage
There are two idioms for invocation. To silence all errors in a package, one can:
-
invoke
mypy-upgrade
in a "Pyre-like" fashionmypy -p my_package | mypy-upgrade -p my_package
-
create a
mypy
type checking report text filemypy -p my_package > mypy_report.txt
and then pass the file to
mypy-upgrade
mypy-upgrade --report mypy_report.txt -p my_package
:memo: Note: To ensure desired behaviour, packages and modules must be passed using their fully qualified names (e.g.,
my_package.my_module
).
Command-Line Options
You may want to include the error descriptions provided by mypy
in the
suppression comments so that you can fix them later.
mypy-upgrade --report mypy_report.txt -d -p MY_PACKAGE
Files and directories can also be passed as positional arguments:
mypy-upgrade --report mypy_report.txt path/to/my_package/ path/to/another_package/
mypy-upgrade --report mypy_report.txt path/to/a/module.py
For a full list of all options and their descriptions, run
mypy-upgrade --help
Quick Start
mypy-upgrade
can be installed via pip
.
python3 -m pip install mypy-upgrade
If you want to run the latest version of the code, you can install from the repo directly:
python3 -m pip install -U git+https://github.com/ugognw/mypy-upgrade.git
# or if you don't have 'git' installed
python3 -m pip install -U https://github.com/ugognw/mypy-upgrade/tree/development
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy_upgrade-0.0.1a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d255356bdd736f49a343ef29add0401c119a1ed16eac5bec31bb22bb2349631 |
|
MD5 | 096b489f0bc659167928770512d88a80 |
|
BLAKE2b-256 | a5ce3f4cce994483a9194c8b0e5ff01868fb05b6c93cddbaf93fcbf3c0cd4364 |