/vscode-mypy

Linting support for Python using the mypy linter.

Primary LanguagePythonMIT LicenseMIT

Mypy extension for Visual Studio Code

A Visual Studio Code extension with support for the mypy linter. The extension ships with mypy=1.5.0.

For more information on mypy, see https://www.mypy-lang.org/.

Note:

  • This extension is supported for all actively supported versions of the python language (i.e., python >= 3.8).
  • Minimum supported version of mypy is 1.0.0.

Usage

Once installed in Visual Studio Code, mypy will be automatically executed when you open a Python file.

If you want to disable mypy, you can disable this extension per workspace in Visual Studio Code.

Settings

Settings Default Description
mypy-type-checker.args [] Custom arguments passed to mypy. E.g "mypy-type-checker.args" = ["--config-file=<file>"]
mypy-type-checker.severity { "error": "Error", "note": "Information" } Controls mapping of severity from mypy to VS Code severity when displaying in the problems window. You can override specific mypy error codes { "error": "Error", "note": "Information", "name-defined": "Warning" }
mypy-type-checker.path [] Setting to provide custom mypy executable. This will slow down linting, since we will have to run mypy executable every time or file save or open. Example 1: ["~/global_env/mypy"] Example 2: ["conda", "run", "-n", "lint_env", "python", "-m", "mypy"]
mypy-type-checker.interpreter [] Path to a python interpreter to use to run the linter server.
mypy-type-checker.importStrategy useBundled Setting to choose where to load mypy from. useBundled picks mypy bundled with the extension. fromEnvironment uses mypy available in the environment.
mypy-type-checker.showNotifications off Setting to control when a notification is shown.
mypy-type-checker.reportingScope file (experimental) Setting to control if problems are reported for files open in the editor (file) or for the entire workspace (workspace).

Commands

Command Description
Mypy: Restart Server Force re-start the linter server.

Logging

From the command palette (View > Command Palette ...), run the Developer: Set Log Level... command. From the quick pick menu, select Mypy Type Checker extension from the Extension logs group. Then select the log level you want to set.