Skip to main content

Python Language Server for the Language Server Protocol

Project description

Python LSP Server

image image image image

A Python 3.6+ implementation of the Language Server Protocol.

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. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-lsp-server-1.2.1.tar.gz (61.4 kB view details)

Uploaded Source

Built Distribution

python_lsp_server-1.2.1-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

Details for the file python-lsp-server-1.2.1.tar.gz.

File metadata

  • Download URL: python-lsp-server-1.2.1.tar.gz
  • Upload date:
  • Size: 61.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.7.3 pkginfo/1.6.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.5

File hashes

Hashes for python-lsp-server-1.2.1.tar.gz
Algorithm Hash digest
SHA256 fe10b8f1ef7cd4f5b4aafcb5e29a2bbd454459442d434bbe1af97d2f3a94f55c
MD5 beb220aec4763093eb341eff899d898d
BLAKE2b-256 09b5e8657cf68fed77eedfc7c32f05d9a53ab53c3d21a3536d7ff00b6fd8c3ea

See more details on using hashes here.

Provenance

File details

Details for the file python_lsp_server-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: python_lsp_server-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 54.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.7.3 pkginfo/1.6.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.8.5

File hashes

Hashes for python_lsp_server-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 587f2bcc2e3821cb608f90864f06d1cac77fba2ed93a8dcbfeef87fe1cea656a
MD5 797e26995e8ebd0e56f0998963292e48
BLAKE2b-256 65af544fc58a836e586adccee92b61b87a4a87b181164f23c9b0df345e28486f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page