anncheck
Check for missing annotations in Python. It's super fast compared to mypy, checking for missing annotations in sympy gave the following results:
| Benchmark | Query | Result | Execution time |
|---|---|---|---|
| MyPy | mypy --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs sympy |
Found 31037 errors in 1171 files (checked 1405 source files) | 88.32 s |
| Anncheck | anncheck sympy -r |
Found 128059 variables missing annotation(s) in 1197 files | 47.28 s |
| Anncheck Compact mode | anncheck sympy -r -c |
Found 128059 variables missing annotation(s) in 1197 files | 4.47 s |
It also has more options for annotation checking.
Installation
pip install anncheck
Usage
Usage: anncheck [OPTIONS] SRC...
Options:
-a, --include-asterisk Include variables starting with '*'. [default:
False]
-c, --compact Compact mode, displays file name and number of
missing annotations on a single line. [default:
False]
-d, --include-docstrings Anncheck doesn't check for functions inside
triple-quotes by default, set flag to do.
[default: False]
-e, --exclude-return Exclude return annotations. [default: False]
-n, --new-line Set flag to separate functions by an empty line.
[default: False]
-r, --recursive Set flag to recursively go into folders.
[default: False]
-m, --exclude-main Exclude functions defined in 'if __name__ ==
"__main__": ...' [default: False]
-p, --padding INTEGER Padding for line number. [default: 3]
--exclude-dunder Exclude dunder functions. [default: False]
--init-return Set flag to show if __init__ is missing a return
annotation. [default: False]
--match-function TEXT Only search functions matching regex. Note: Put
regex in quotes.
--match-variable TEXT Match variables with regex. Note: Put regex in
quotes.
--help Show this message and exit.
Metadata
Release files for anncheck 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| anncheck-1.3.0.tar.gz | 6.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| anncheck-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.1 kB
Release files / anncheck-1.3.0.tar.gz
| Download URL | anncheck-1.3.0.tar.gz |
|---|---|
| Size | 6.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42bc7a4e7b5e6d5c448a4e63a4334a6665e6d13133eacf734c72e85491a5cb29
|
|
BLAKE2b-256 checksum How to use checksums |
1520396f23f82fe0e706fa079a9e68a4eadede066adfc7d05a9ab96d6641a09f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6
|
Release files / anncheck-1.3.0-py3-none-any.whl
| Download URL | anncheck-1.3.0-py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a5d75c0286140f4df1b23457adb7153b3ea3d6bd0db466b37ddf82af0d4517a9
|
|
BLAKE2b-256 checksum How to use checksums |
3100e553df7ce262920edabebcbabc34f832b56d15866899e1a5f5edde33e00c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6
|