Skip to main content

Python LSP Server

image image image image

A Python 3.7+ implementation of the Language Server Protocol. (Note: versions <1.4 should still work with Python 3.6)

Installation

The base language server requires Jedi to provide Completions, Definitions, Hover, References, Signature Help, and Symbols:

pip install python-lsp-server

If the respective dependencies are found, the following optional providers will be enabled:

  • Rope for Completions and renaming
  • Pyflakes linter to detect various errors
  • McCabe linter for complexity checking
  • pycodestyle linter for style checking
  • pydocstyle linter for docstring style checking (disabled by default)
  • autopep8 for code formatting
  • YAPF for code formatting (preferred over autopep8)

Optional providers can be installed using the extras syntax. To install YAPF formatting for example:

pip install "python-lsp-server[yapf]"

All optional providers can be installed using:

pip install "python-lsp-server[all]"

If you get an error similar to 'install_requires' must be a string or list of strings then please upgrade setuptools before trying again.

pip install -U setuptools

3rd Party Plugins

Installing these plugins will add extra functionality to the language server:

Please see the above repositories for examples on how to write plugins for the Python LSP Server.

cookiecutter-pylsp-plugin is a cookiecutter template for setting up a basic plugin project for python-lsp-server. It documents all the essentials you need to know to kick start your own plugin project.

Please file an issue if you require assistance writing a plugin.

Configuration

Configuration is loaded from zero or more configuration sources. Currently implemented are:

  • pycodestyle: discovered in ~/.config/pycodestyle, setup.cfg, tox.ini and pycodestyle.cfg.
  • flake8: discovered in ~/.config/flake8, setup.cfg, tox.ini and flake8.cfg

The default configuration source is pycodestyle. Change the pylsp.configurationSources setting to ['flake8'] in order to respect flake8 configuration instead.

Overall configuration is computed first from user configuration (in home directory), overridden by configuration passed in by the language client, and then overridden by configuration discovered in the workspace.

To enable pydocstyle for linting docstrings add the following setting in your LSP configuration: "pylsp.plugins.pydocstyle.enabled": true

All configuration options are described in CONFIGURATION.md.

LSP Server Features

  • Auto Completion
  • Code Linting
  • Signature Help
  • Go to definition
  • Hover
  • Find References
  • Document Symbols
  • Document Formatting
  • Code folding
  • Multiple workspaces

Development

To run the test suite:

pip install ".[test]" && pytest

After adding configuration options to schema.json, refresh the CONFIGURATION.md file with

python scripts/jsonschema2md.py pylsp/config/schema.json CONFIGURATION.md

License

This project is made available under the MIT License.

Metadata

Release files for python-lsp-server 1.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-lsp-server 1.4.0
File Size Uploaded Provenance Actions
python-lsp-server-1.4.0.tar.gz 75.4 kB Without provenance Details for python-lsp-server-1.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-lsp-server 1.4.0
File Interpreter ABI Platform Actions
python_lsp_server-1.4.0-py3-none-any.whl Python 3 none any Details for python_lsp_server-1.4.0-py3-none-any.whl

Total release size: 132.4 kB

Release files / python-lsp-server-1.4.0.tar.gz

Download URL python-lsp-server-1.4.0.tar.gz
Size 75.4 kB
Tags Source
SHA-256 checksum
How to use checksums
769142c07573f6b66e930cbd7c588b826082550bef6267bb0aec63e7b6260009
BLAKE2b-256 checksum
How to use checksums
0c8fcf2bb0cb3081dac811ce5c66ba0ad15634bdc3635b5de10c5e3b918feb68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/3.7.3 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.10

Release files / python_lsp_server-1.4.0-py3-none-any.whl

Download URL python_lsp_server-1.4.0-py3-none-any.whl
Size 56.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3160c97c6d1edd8456f262fc0e4aad6b322c0cfd1b58d322a41679e57787594d
BLAKE2b-256 checksum
How to use checksums
64c4747555eb427fa00f2aecdfeaf607e5c6491e8c512379e9815b217fdf2e22
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/3.7.3 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.10

Security for python-lsp-server 1.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.4.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page