Mypy plugin for PYLSP

This is a plugin for the Python LSP Server, to make mypy output available directly in your IDE. pylsp-mypy uses mypy to help you write statically typed Python code. It, like mypy, requires Python 3.11 or newer.

Installation

Install into the same virtualenv as python-lsp-server itself.

pip install pylsp-mypy

Configuration

pylsp-mypy supports the use of pyproject.toml for configuration. This is the recommended way.

For more advanced usecases, it can also be configuered using configs provided directly to the LSP server. To use this prepend pylsp.plugins.pylsp_mypy. to any configuration key. For example strict becomes pylsp.plugins.pylsp_mypy.strict

The configuration keys are listed in the following.

Both mypy_command and dmypy_command could be used by a malicious repo to execute arbitrary code by looking at its source with this plugin active. Still users want this feature. For security reasons this is disabled by default. If you really want it and accept the risks, set the environment variable PYLSP_MYPY_ALLOW_DANGEROUS_CODE_EXECUTION in order to activate it.

Using a pyproject.toml for configuration, which is in fact the preferred way, your configuration could look like this:

[tool.pylsp-mypy]
enabled = true
live_mode = true
strict = true
exclude = ["tests/*"]

It should be roughly like this for a standard configuration:

[tool.pylsp-mypy]
enabled = true
live_mode = true
strict = false
exclude = ["tests/*"]

With dmypy enabled your config should look like this:

[tool.pylsp-mypy]
enabled = true
live_mode = false
dmypy = true
strict = false

With overrides specified (for example to tell mypy to use a different python than the currently active venv), your config could look like this:

[tool.pylsp-mypy]
enabled = true
overrides = ["--python-executable", "/home/me/bin/python", true]

With dmypy_status_file your config could look like this:

[tool.pylsp-mypy]
enabled = true
live_mode = false
dmypy = true
strict = false
dmypy_status_file = ".custom_dmypy_status_file.json"

With config_sub_paths your config could look like this:

[tool.pylsp-mypy]
enabled = true
config_sub_paths = [".config"]

With report_progress your config could look like this:

[tool.pylsp-mypy]
enabled = true
report_progress = true

With mypy_command your config could look like this:

[tool.pylsp-mypy]
enabled = true
mypy_command = ["poetry", "run", "mypy"]

With dmypy_command your config could look like this:

[tool.pylsp-mypy]
enabled = true
live_mode = false
dmypy = true
dmypy_command = ["/path/to/venv/bin/dmypy"]

Developing

Install development dependencies with (you might want to create a virtualenv first):

pip install -r requirements.txt

The project is formatted with black. You can either configure your IDE to automatically format code with it, run it manually (black .) or rely on pre-commit (see below) to format files on git commit.

The project is formatted with isort. You can either configure your IDE to automatically sort imports with it, run it manually (isort .) or rely on pre-commit (see below) to sort files on git commit.

The project uses a markdown test in order to assure uploadability to pypi: markdownlint as a pre-commit hook and in a GitHub workflow. This does not catch all errors.

This project uses pre-commit to enforce code-quality. After cloning the repository install the pre-commit hooks with:

pre-commit install

After that pre-commit will run all defined hooks on every git commit and keep you from committing if there are any errors.