Skip to main content

Python Language Server for the Language Server Protocol

Project description

Python Language Server

https://circleci.com/gh/palantir/python-language-server.svg?style=shield https://ci.appveyor.com/api/projects/status/mdacv6fnif7wonl0?svg=true https://img.shields.io/github/license/palantir/python-language-server.svg

A Python 2.7 and 3.4+ implementation of the Language Server Protocol.

Feature Providers

  • Jedi for Completions, Definitions, Hover, References, Signature Help, and Symbols

  • Pyflakes linter to detect various errors

  • McCabe linter for complexity checking

  • pycodestyle linter for style checking

  • pydocstyle linter for docstring style checking

  • YAPF for code formatting

3rd Party Plugins

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

Language Server Features

Auto Completion:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/auto-complete.gif

Code Linting with pycodestyle and pyflakes:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/linting.gif

Signature Help:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/signature-help.gif

Go to definition:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/goto-definition.gif

Hover:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/hover.gif

Find References:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/references.gif

Document Symbols:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/document-symbols.gif

Document Formatting:

https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/document-format.gif

Installation

pip install python-language-server

Development

To run the test suite:

pip install .[test] && tox

Develop against VS Code

The Python language server can be developed against a local instance of Visual Studio Code.

  1. Install VSCode for Mac

  2. From within VSCode View -> Command Palette, then type shell and run install 'code' command in PATH

# Setup a virtual env
virtualenv env
. env/bin/activate

# Install pyls
pip install .

# Install the vscode-client extension
cd vscode-client
npm install .

# Run VSCode which is configured to use pyls
# See the bottom of vscode-client/src/extension.ts for info
npm run vscode -- $PWD/../

Then to debug, click View -> Output and in the dropdown will be pyls. To refresh VSCode, press Cmd + r

License

This project is made available under the MIT License.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

python-language-server-0.10.0.tar.gz (42.3 kB view details)

Uploaded Source

File details

Details for the file python-language-server-0.10.0.tar.gz.

File metadata

File hashes

Hashes for python-language-server-0.10.0.tar.gz
Algorithm Hash digest
SHA256 4b5119e4bb331f7eb14bf4ead6123cc3479399d99b226a61d41033d259a1a08c
MD5 3da3587bb7f5c8ca7a8ddc050295d32e
BLAKE2b-256 f8726de35f458cfcfc5db81f672728d98ed4d097341d8139414c49eabd6eebcc

See more details on using hashes here.

Supported by

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