Back to Extensions Directory
Read the complete README
@yaegassy/coc-pylsp
yaegassypylsp (python-lsp-server) extension for coc.nvim
Installation CommandVim prompt
:CocInstall @yaegassy/coc-pylsp
GitHub owner
yaegassyVersion
v0.13.0npm package
@yaegassy/coc-pylspRequirements
coc ^0.0.80
License
MIT
Repository
GitHubnpm latest published 2025-12-08Registry checked 2026-08-23Registry summary
Published Package Summary
coc-pylsp
pylsp (python-lsp-server) extension for coc.nvim.
Install
CocInstall:
:CocInstall @yaegassy/coc-pylsp
vim-plug:
Plug 'yaegassy/coc-pylsp', {'do': 'yarn install --frozen-lockfile'}
Detect: pylsp (python-lsp-server)
coc-pylsp detects and starts pylsp.
Priority to detect:
- pylsp.commandPath
- current python3/python environment (e.g. pylsp in venv)
- builtin pylsp (Installation commands are also provided)
Built-in install (pylsp and 3rd party plugins)
coc-pylsp allows you to create an extension-only "venv" and install "pylsp (python-lsp-server)" and "related tools" (e.g. pylsp-mypy).
By default, it is installed with pip install python-lsp-server[all]. (extras_require).
If you want to change "extras_require", please change the pylsp.builtin.installExtrasArgs setting
example:
- Example1:
"pylsp.builtin.installExtrasArgs": []pip install python-lsp-server
- Example2:
"pylsp.builtin.installExtrasArgs": ["all"]:pip install 'python-lsp-server[all]'
- Example3:
"pylsp.builtin.installExtrasArgs": ["yapf", "flake8"]:pip install 'python-lsp-server[yapf,flake8]'
It also supports the installation of "3rd Party Plugins".
- 3rd Party Plugins currently supported
By default, the installation of 3rd Party Plugins is "disabled".
To "enable" it, change each setting in coc-settings.json.
{
// snip...
"pylsp.builtin.enableInstallPylspMypy": true,
"pylsp.builtin.enableInstallPylsIsort": true,
"pylsp.builtin.enableInstallPythonLspBlack": true,
"pylsp.builtin.enableInstallPylspRope": true,
"pylsp.builtin.enableInstallPythonLspRuff": true,
// snip...
}
It is also possible to specify the version of the third party tool to be installed
{
// snip...
"pylsp.builtin.pylspMypyVersion": "0.5.2",
"pylsp.builtin.pylsIsortVersion": "0.2.2",
"pylsp.builtin.pythonLspBlackVersion": "1.0.1",
"pylsp.builtin.pylspRopeVersion": "0.1.10",
"pylsp.builtin.pythonLspRuffVersion": "1.0.5",
// snip...
}
The first time you use coc-pylsp, if pylsp is not detected, you will be prompted to do a built-in installation.
You can also run the installation command manually.
:CocCommand pylsp.builtin.install
python-lsp-ruff
If you enable python-lsp-ruff then you will probably want to disable the built-in pycodestyle,
pyflakes, mccabe and pyls_isort plugins, for example:
{
"pylsp.plugins.pycodestyle.enabled": false,
"pylsp.plugins.pyflakes.enabled": false
"pylsp.plugins.mccabe.enabled": false,
"pylsp.plugins.pyls_isort.enabled": false,
}
Although python-lsp-ruff tries to disable these automatically, they must be explicitly disabled
when using coc-pylsp.
Use tcp mode
To use the tcp mode, set pylsp.connectionMode to 'tcp'. Also, pylsp needs to be started in tcp mode separately.
coc-settings.json:
{
"pylsp.connectionMode": "tcp"
}
How to start pylsp in tcp mode:
# By default, host is 127.0.0.1 and port 2087 is set
pylsp --tcp
# Or specify any host (--host) and port (--port)
pylsp --tcp --host 127.0.0.1 --port 2087
Thanks
License
MIT
This extension is built with create-coc-extension
- pylsp (python-lsp-server) extension for coc.nvim
Activation Events
- onLanguage:python
Developer Resources
Want to build, test, or contribute to coc.nvim extensions? Explore our official SDK and testing toolkits.
Open Developer GuideVersion History
This published npm package does not include a history.md or changelog.md file. Browse its npm versions or repository releases for available release information.
Contributed Commands
All contributes.commands entries from the published package manifest for @yaegassy/coc-pylsp@0.13.0.
| Command (:CocCommand) | Description |
|---|---|
| pylsp.builtin.install | Install python lsp server and related tools |
| pylsp.installServer | (old command) Install python lsp server and related tools |
Configuration Schema
All contributes.configuration entries from the published package manifest, including each raw property schema for coc-settings.json.
pylsp.enableboolean
Enable coc-pylsp extension.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable coc-pylsp extension."
}pylsp.tcpHoststring
Specifies the host name to connect pylsp. This setting only works with connectionMode is 'tcp'.
Default: "127.0.0.1"
Raw JSON Schema
{
"type": "string",
"scope": "resource",
"default": "127.0.0.1",
"description": "Specifies the host name to connect pylsp. This setting only works with connectionMode is 'tcp'."
}pylsp.tcpPortnumber
Specifies the port to connect pylsp. This setting only works with connectionMode is 'tcp'.
Default: "2087"
Raw JSON Schema
{
"type": "number",
"scope": "resource",
"default": "2087",
"markdownDescription": "Specifies the port to connect pylsp. This setting only works with connectionMode is 'tcp'."
}pylsp.commandPathstring
Custom path to the pylsp command. ~ and $HOME, etc. can also be used. If not set, pylsp detected by the current python environment or extension venv's pylsp used will be used
Default: ""
Raw JSON Schema
{
"type": "string",
"default": "",
"description": "Custom path to the pylsp command. ~ and $HOME, etc. can also be used. If not set, pylsp detected by the current python environment or extension venv's pylsp used will be used"
}pylsp.trace.serverstring
Traces the communication between coc.nvim and the Python LSP Server.
Default: "off"
Raw JSON Schema
{
"enum": [
"off",
"messages",
"verbose"
],
"type": "string",
"default": "off",
"description": "Traces the communication between coc.nvim and the Python LSP Server."
}pylsp.connectionModestring
Controls the communication method to pylsp.
Default: "stdio"
Raw JSON Schema
{
"enum": [
"stdio",
"tcp"
],
"type": "string",
"scope": "resource",
"default": "stdio",
"enumDescriptions": [
"Use stdio to communicate with pylsp.",
"Use tcp to connect pylsp. You need to launch pylsp."
],
"markdownDescription": "Controls the communication method to pylsp."
}pylsp.rope.ropeFolderarray | null
The name of the folder in which rope stores project configurations and data. Pass `null` for not using such a folder at all.
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "The name of the folder in which rope stores project configurations and data. Pass `null` for not using such a folder at all.",
"uniqueItems": true
}pylsp.builtin.pythonPathstring
Python 3.x path (Absolute path) to be used for built-in install
Default: ""
Raw JSON Schema
{
"type": "string",
"default": "",
"description": "Python 3.x path (Absolute path) to be used for built-in install"
}pylsp.plugins.pylint.argsarray
Arguments to pass to pylint.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Arguments to pass to pylint.",
"uniqueItems": false
}pylsp.plugins.ruff.configstring | null
Path to optional `pyproject.toml` file.
Default: null
Raw JSON Schema
{
"type": [
"string",
null
],
"default": null,
"description": "Path to optional `pyproject.toml` file."
}pylsp.plugins.ruff.formatarray | null
List of error codes to fix during formatting. Empty by default, use `["I"]` here to get import sorting as part of formatting.
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "List of error codes to fix during formatting. Empty by default, use `[\"I\"]` here to get import sorting as part of formatting."
}pylsp.plugins.ruff.ignorearray | null
Error codes to ignore.
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "Error codes to ignore."
}pylsp.plugins.ruff.selectarray | null
List of error codes to enable.
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "List of error codes to enable."
}pylsp.signature.formatterstring | null
Formatter to use for reformatting signatures in docstrings.
Default: "black"
Raw JSON Schema
{
"enum": [
"black",
"ruff",
null
],
"type": [
"string",
"null"
],
"default": "black",
"description": "Formatter to use for reformatting signatures in docstrings."
}pylsp.configurationSourcesarray
List of configuration sources to use.
Default: ["pycodestyle"]
Raw JSON Schema
{
"type": "array",
"items": {
"enum": [
"pycodestyle",
"flake8"
],
"type": "string"
},
"default": [
"pycodestyle"
],
"description": "List of configuration sources to use.",
"uniqueItems": true
}pylsp.plugins.ruff.enabledboolean
Boolean to enable/disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Boolean to enable/disable the plugin."
}pylsp.plugins.ruff.excludearray | null
Exclude files from being checked by `ruff`.
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "Exclude files from being checked by `ruff`."
}pylsp.plugins.ruff.previewboolean
Boolean that enables/disables rules & fixes that are marked "preview" by `ruff`.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Boolean that enables/disables rules & fixes that are marked \"preview\" by `ruff`."
}pylsp.plugins.yapf.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.black.enabledboolean
Boolean to enable/disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Boolean to enable/disable the plugin."
}pylsp.plugins.black.previewboolean
A boolean to enable or disable black's --preview setting.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "A boolean to enable or disable black's --preview setting."
}pylsp.plugins.flake8.configstring | null
Path to the config file that will be the authoritative config source.
Default: null
Raw JSON Schema
{
"type": [
"string",
"null"
],
"default": null,
"description": "Path to the config file that will be the authoritative config source."
}pylsp.plugins.flake8.ignorearray
List of errors and warnings to ignore (or skip).
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of errors and warnings to ignore (or skip)."
}pylsp.plugins.flake8.selectarray | null
List of errors and warnings to enable.
Default: null
Raw JSON Schema
{
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"default": null,
"description": "List of errors and warnings to enable.",
"uniqueItems": true
}pylsp.plugins.jedi.env_varsobject | null
Define environment variables for jedi.Script and Jedi.names.
Default: null
Raw JSON Schema
{
"type": [
"object",
"null"
],
"default": null,
"description": "Define environment variables for jedi.Script and Jedi.names."
}pylsp.rope.extensionModulesstring | null
Builtin and c-extension modules that are allowed to be imported and inspected by rope.
Default: null
Raw JSON Schema
{
"type": [
"string",
null
],
"default": null,
"description": "Builtin and c-extension modules that are allowed to be imported and inspected by rope."
}pylsp.signature.line_lengthnumber
Maximum line length in signatures.
Default: 88
Raw JSON Schema
{
"type": "number",
"default": 88,
"description": "Maximum line length in signatures."
}pylsp.plugins.flake8.enabledboolean
Enable or disable the plugin.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable or disable the plugin."
}pylsp.plugins.flake8.excludearray
List of files or directories to exclude.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of files or directories to exclude."
}pylsp.plugins.mccabe.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.pylint.enabledboolean
Enable or disable the plugin.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable or disable the plugin."
}pylsp.plugins.flake8.filenamestring | null
Only check for filenames matching the patterns in this list.
Default: null
Raw JSON Schema
{
"type": [
"string",
"null"
],
"default": null,
"description": "Only check for filenames matching the patterns in this list."
}pylsp.plugins.preload.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.preload.modulesarray
List of modules to import on startup
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of modules to import on startup",
"uniqueItems": true
}pylsp.plugins.ruff.executablestring | null
Path to the ruff executable. Uses `os.executable -m "ruff"` by default.
Default: null
Raw JSON Schema
{
"type": [
"string",
null
],
"default": null,
"description": "Path to the ruff executable. Uses `os.executable -m \"ruff\"` by default."
}pylsp.plugins.ruff.lineLengthinteger | null
Set the line-length for length checks.
Default: null
Raw JSON Schema
{
"type": [
"integer",
null
],
"default": null,
"description": "Set the line-length for length checks."
}pylsp.plugins.ruff.severitiesobject | null
Dictionary of custom severity levels for specific codes.
Default: null
Raw JSON Schema
{
"type": [
"object",
"null"
],
"default": null,
"description": "Dictionary of custom severity levels for specific codes."
}pylsp.builtin.pylsIsortVersionstring
Version of pyls-isort for built-in install
Default: ""
Raw JSON Schema
{
"type": "string",
"default": "",
"description": "Version of pyls-isort for built-in install"
}pylsp.builtin.pylspMypyVersionstring
Version of pylsp-mypy for built-in install
Default: ""
Raw JSON Schema
{
"type": "string",
"default": "",
"description": "Version of pylsp-mypy for built-in install"
}pylsp.builtin.pylspRopeVersionstring
Version of pylsp-rope for built-in install
Default: ""
Raw JSON Schema
{
"type": "string",
"default": "",
"description": "Version of pylsp-rope for built-in install"
}pylsp.plugins.autopep8.enabledboolean
Enable or disable the plugin (disabling required to use `yapf`).
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin (disabling required to use `yapf`)."
}pylsp.plugins.jedi.environmentstring | null
Define environment for jedi.Script and Jedi.names.
Default: null
Raw JSON Schema
{
"type": [
"string",
"null"
],
"default": null,
"description": "Define environment for jedi.Script and Jedi.names."
}pylsp.plugins.jedi.extra_pathsarray
Define extra paths for jedi.Script.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Define extra paths for jedi.Script."
}pylsp.plugins.mccabe.thresholdinteger
The minimum threshold that triggers warnings about cyclomatic complexity.
Default: 15
Raw JSON Schema
{
"type": "integer",
"default": 15,
"description": "The minimum threshold that triggers warnings about cyclomatic complexity."
}pylsp.plugins.pydocstyle.matchstring
Check only files that exactly match the given regular expression; default is to match files that don't start with 'test_' but end with '.py'.
Default: "(?!test_).*\\.py"
Raw JSON Schema
{
"type": "string",
"default": "(?!test_).*\\.py",
"description": "Check only files that exactly match the given regular expression; default is to match files that don't start with 'test_' but end with '.py'."
}pylsp.plugins.pyflakes.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.ruff.unsafeFixesboolean
Boolean that enables/disables fixes that are marked "unsafe" by `ruff`.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Boolean that enables/disables fixes that are marked \"unsafe\" by `ruff`."
}pylsp.builtin.installExtrasArgsarray
Setting extras_require for built-in installation
Default: ["all"]
Raw JSON Schema
{
"type": "array",
"default": [
"all"
],
"description": "Setting extras_require for built-in installation"
}pylsp.plugins.black.line_lengthnumber
An integer that maps to black's max-line-length setting. Defaults to 88 (same as black's default). This can also be set through black's configuration files, which should be preferred for multi-user projects.
Default: 88
Raw JSON Schema
{
"type": "number",
"default": 88,
"description": "An integer that maps to black's max-line-length setting. Defaults to 88 (same as black's default). This can also be set through black's configuration files, which should be preferred for multi-user projects."
}pylsp.plugins.flake8.executablestring
Path to the flake8 executable.
Default: "flake8"
Raw JSON Schema
{
"type": "string",
"default": "flake8",
"description": "Path to the flake8 executable."
}pylsp.plugins.flake8.indentSizeinteger | null
Set indentation spaces.
Default: null
Raw JSON Schema
{
"type": [
"integer",
"null"
],
"default": null,
"description": "Set indentation spaces."
}pylsp.plugins.pydocstyle.ignorearray
Ignore errors and warnings
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Ignore errors and warnings",
"uniqueItems": true
}pylsp.plugins.pydocstyle.selectarray | null
Select errors and warnings
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "Select errors and warnings",
"uniqueItems": true
}pylsp.plugins.pylint.executablestring | null
Executable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3.
Default: null
Raw JSON Schema
{
"type": [
"string",
"null"
],
"default": null,
"description": "Executable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3."
}pylsp.plugins.ruff.extendIgnorearray | null
Same as ignore, but append to existing ignores.
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "Same as ignore, but append to existing ignores."
}pylsp.plugins.ruff.extendSelectarray | null
Same as select, but append to existing error codes.
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "Same as select, but append to existing error codes."
}pylsp.plugins.black.cache_configboolean
A boolean to enable black configuration caching.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "A boolean to enable black configuration caching."
}pylsp.plugins.flake8.hangClosingboolean | null
Hang closing bracket instead of matching indentation of opening bracket's line.
Default: null
Raw JSON Schema
{
"type": [
"boolean",
"null"
],
"default": null,
"description": "Hang closing bracket instead of matching indentation of opening bracket's line."
}pylsp.plugins.jedi_hover.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.pycodestyle.ignorearray
Ignore errors and warnings
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Ignore errors and warnings",
"uniqueItems": true
}pylsp.plugins.pycodestyle.selectarray | null
Select errors and warnings
Default: null
Raw JSON Schema
{
"type": [
"array",
null
],
"items": {
"type": "string"
},
"default": null,
"description": "Select errors and warnings",
"uniqueItems": true
}pylsp.plugins.pydocstyle.enabledboolean
Enable or disable the plugin.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable or disable the plugin."
}pylsp.plugins.ruff.formatEnabledboolean
Boolean to enable/disable the ruff formatter.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Boolean to enable/disable the ruff formatter."
}pylsp.plugins.ruff.perFileIgnoreobject | null
File-specific error codes to be ignored.
Default: null
Raw JSON Schema
{
"type": [
"object",
null
],
"default": null,
"description": "File-specific error codes to be ignored."
}pylsp.plugins.ruff.targetVersionstring | null
The minimum Python version to target.
Default: null
Raw JSON Schema
{
"type": [
"string",
null
],
"default": null,
"description": "The minimum Python version to target."
}pylsp.plugins.flake8.extendIgnorearray
List of errors and warnings to append to ignore list.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of errors and warnings to append to ignore list."
}pylsp.plugins.flake8.extendSelectarray
List of errors and warnings to append to select list.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of errors and warnings to append to select list."
}pylsp.plugins.pycodestyle.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.pycodestyle.excludearray
Exclude files or directories which match these patterns.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Exclude files or directories which match these patterns.",
"uniqueItems": true
}pylsp.plugins.pydocstyle.matchDirstring
Search only dirs that exactly match the given regular expression; default is to match dirs which do not begin with a dot.
Default: "[^\\.].*"
Raw JSON Schema
{
"type": "string",
"default": "[^\\.].*",
"description": "Search only dirs that exactly match the given regular expression; default is to match dirs which do not begin with a dot."
}pylsp.signature.include_docstringboolean
Include signature docstring.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Include signature docstring."
}pylsp.builtin.pythonLspRuffVersionstring
Version of python-lsp-ruff for built-in install
Default: ""
Raw JSON Schema
{
"type": "string",
"default": "",
"description": "Version of python-lsp-ruff for built-in install"
}pylsp.disableProgressNotificationsboolean
Disable the initialization and workdone progress notifications
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Disable the initialization and workdone progress notifications"
}pylsp.plugins.flake8.maxComplexityinteger | null
Maximum allowed complexity threshold.
Default: null
Raw JSON Schema
{
"type": [
"integer",
"null"
],
"default": null,
"description": "Maximum allowed complexity threshold."
}pylsp.plugins.flake8.maxLineLengthinteger | null
Maximum allowed line length for the entirety of this run.
Default: null
Raw JSON Schema
{
"type": [
"integer",
"null"
],
"default": null,
"description": "Maximum allowed line length for the entirety of this run."
}pylsp.plugins.jedi_symbols.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.pycodestyle.filenamearray
When parsing directories, only check filenames matching these patterns.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "When parsing directories, only check filenames matching these patterns.",
"uniqueItems": true
}pylsp.plugins.pydocstyle.addIgnorearray
Ignore errors and warnings in addition to the specified convention.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Ignore errors and warnings in addition to the specified convention.",
"uniqueItems": true
}pylsp.plugins.pydocstyle.addSelectarray
Select errors and warnings in addition to the specified convention.
Default: []
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Select errors and warnings in addition to the specified convention.",
"uniqueItems": true
}pylsp.builtin.pythonLspBlackVersionstring
Version of python-lsp-black for built-in install
Default: ""
Raw JSON Schema
{
"type": "string",
"default": "",
"description": "Version of python-lsp-black for built-in install"
}pylsp.plugins.flake8.perFileIgnoresarray
A pairing of filenames and violation codes that defines which violations to ignore in a particular file, for example: `["file_path.py:W305,W304"]`).
Default: []
Raw JSON Schema
{
"type": [
"array"
],
"items": {
"type": "string"
},
"default": [],
"description": "A pairing of filenames and violation codes that defines which violations to ignore in a particular file, for example: `[\"file_path.py:W305,W304\"]`)."
}pylsp.plugins.jedi_completion.eagerboolean
Resolve documentation and detail eagerly.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Resolve documentation and detail eagerly."
}pylsp.plugins.jedi_completion.fuzzyboolean
Enable fuzzy when requesting autocomplete.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable fuzzy when requesting autocomplete."
}pylsp.plugins.pydocstyle.conventionstring | null
Choose the basic list of checked errors by specifying an existing convention.
Default: null
Raw JSON Schema
{
"enum": [
"pep257",
"numpy",
"google",
null
],
"type": [
"string",
"null"
],
"default": null,
"description": "Choose the basic list of checked errors by specifying an existing convention."
}pylsp.plugins.rope_completion.eagerboolean
Resolve documentation and detail eagerly.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Resolve documentation and detail eagerly."
}pylsp.builtin.enableInstallPylsIsortboolean
Enable/Disable built-in install of pyls-isort
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable/Disable built-in install of pyls-isort"
}pylsp.builtin.enableInstallPylspMypyboolean
Enable/Disable built-in install of pylsp-mypy
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable/Disable built-in install of pylsp-mypy"
}pylsp.builtin.enableInstallPylspRopeboolean
Enable/Disable built-in install of pylsp-rope
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable/Disable built-in install of pylsp-rope"
}pylsp.plugins.pycodestyle.indentSizeinteger | null
Set indentation spaces.
Default: null
Raw JSON Schema
{
"type": [
"integer",
"null"
],
"default": null,
"description": "Set indentation spaces."
}pylsp.plugins.rope_autoimport.memoryboolean
Make the autoimport database memory only. Drastically increases startup time.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Make the autoimport database memory only. Drastically increases startup time."
}pylsp.plugins.jedi_completion.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.jedi_definition.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.jedi_references.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.jedi_symbols.all_scopesboolean
If True lists the names of all scopes instead of only the module namespace.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "If True lists the names of all scopes instead of only the module namespace."
}pylsp.plugins.pycodestyle.hangClosingboolean | null
Hang closing bracket instead of matching indentation of opening bracket's line.
Default: null
Raw JSON Schema
{
"type": [
"boolean",
"null"
],
"default": null,
"description": "Hang closing bracket instead of matching indentation of opening bracket's line."
}pylsp.plugins.rope_autoimport.enabledboolean
Enable or disable autoimport. If false, neither completions nor code actions are enabled. If true, the respective features can be enabled or disabled individually.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable or disable autoimport. If false, neither completions nor code actions are enabled. If true, the respective features can be enabled or disabled individually."
}pylsp.plugins.rope_completion.enabledboolean
Enable or disable the plugin.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable or disable the plugin."
}pylsp.plugins.jedi.auto_import_modulesarray
List of module names for jedi.settings.auto_import_modules.
Default: ["numpy"]
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [
"numpy"
],
"description": "List of module names for jedi.settings.auto_import_modules."
}pylsp.plugins.jedi_completion.cache_forarray
Modules for which labels and snippets should be cached.
Default: ["pandas","numpy","tensorflow","matplotlib"]
Raw JSON Schema
{
"type": "array",
"items": {
"type": "string"
},
"default": [
"pandas",
"numpy",
"tensorflow",
"matplotlib"
],
"description": "Modules for which labels and snippets should be cached."
}pylsp.plugins.pycodestyle.maxLineLengthinteger | null
Set maximum allowed line length.
Default: null
Raw JSON Schema
{
"type": [
"integer",
"null"
],
"default": null,
"description": "Set maximum allowed line length."
}pylsp.builtin.enableInstallPythonLspRuffboolean
Enable/Disable built-in install of pylsp-lsp-ruff
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable/Disable built-in install of pylsp-lsp-ruff"
}pylsp.builtin.enableInstallPythonLspBlackboolean
Enable/Disable built-in install of python-lsp-black
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Enable/Disable built-in install of python-lsp-black"
}pylsp.plugins.jedi.prioritize_extra_pathsboolean
Whether to place extra_paths at the beginning (true) or end (false) of `sys.path`
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Whether to place extra_paths at the beginning (true) or end (false) of `sys.path`"
}pylsp.plugins.jedi_signature_help.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.jedi_type_definition.enabledboolean
Enable or disable the plugin.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable the plugin."
}pylsp.plugins.jedi_completion.include_paramsboolean
Auto-completes methods and classes with tabstops for each parameter.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Auto-completes methods and classes with tabstops for each parameter."
}pylsp.plugins.jedi_definition.follow_importsboolean
The goto call will follow imports.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "The goto call will follow imports."
}pylsp.plugins.black.skip_magic_trailing_commaboolean
A boolean to enable or disable black's skip-magic-trailing-comma setting.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "A boolean to enable or disable black's skip-magic-trailing-comma setting."
}pylsp.plugins.black.skip_string_normalizationboolean
A boolean to enable or disable black's --skip-string-normalization setting.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "A boolean to enable or disable black's --skip-string-normalization setting."
}pylsp.plugins.jedi_completion.resolve_at_mostinteger
How many labels and snippets (at most) should be resolved?
Default: 25
Raw JSON Schema
{
"type": "integer",
"default": 25,
"description": "How many labels and snippets (at most) should be resolved?"
}pylsp.plugins.jedi_symbols.include_import_symbolsboolean
If True includes symbols imported from other libraries.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "If True includes symbols imported from other libraries."
}pylsp.plugins.rope_autoimport.completions.enabledboolean
Enable or disable autoimport completions.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable autoimport completions."
}pylsp.plugins.rope_autoimport.code_actions.enabledboolean
Enable or disable autoimport code actions (e.g. for quick fixes).
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Enable or disable autoimport code actions (e.g. for quick fixes)."
}pylsp.plugins.jedi_completion.include_class_objectsboolean
Adds class objects as a separate completion item.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Adds class objects as a separate completion item."
}pylsp.plugins.jedi_definition.follow_builtin_importsboolean
If follow_imports is True will decide if it follow builtin imports.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "If follow_imports is True will decide if it follow builtin imports."
}pylsp.plugins.jedi_completion.include_function_objectsboolean
Adds function objects as a separate completion item.
Default: false
Raw JSON Schema
{
"type": "boolean",
"default": false,
"description": "Adds function objects as a separate completion item."
}pylsp.plugins.jedi_definition.follow_builtin_definitionsboolean
Follow builtin and extension definitions to stubs.
Default: true
Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Follow builtin and extension definitions to stubs."
}