autohooks-plugin-mypy

autohooks-plugin-mypy

An autohooks plugin for python code static typing check via mypy.

Installation

Install using pip

You can install the latest stable release of autohooks-plugin-mypy from the Python Package Index using pip:

python3 -m pip install autohooks-plugin-mypy

Install using poetry

It is highly encouraged to use poetry for maintaining your project's dependencies. Normally autohooks-plugin-mypy is installed as a development dependency.

poetry install

Usage

To activate the mypy autohooks plugin please add the following setting to your pyproject.toml file.

[tool.autohooks]
pre-commit = ["autohooks.plugins.mypy"]

By default, autohooks plugin mypy checks all files with a .py ending. If only files in a sub-directory or files with different endings should be formatted, just add the following setting:

[tool.autohooks]
pre-commit = ["autohooks.plugins.mypy"]

[tool.autohooks.plugins.mypy]
include = ['foo/*.py', '*.foo']

By default, autohooks plugin mypy executes mypy without any arguments. To change specific settings or to define a mypy config file the following plugin configuration can be used:

[tool.autohooks]
pre-commit = ["autohooks.plugins.mypy"]

[tool.autohooks.plugins.mypy]
arguments = ["--ignore-missing-imports", "--config-file=/path/to/.mypy.ini"]

Maintainer

This project is maintained by Greenbone AG.

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.

License

Copyright (C) 2021 Vincent Texier. Copyright (C) 2023 Greenbone AG

Licensed under the GNU General Public License v3.0 or later.