Skip to main content

Spyder extensions for the python-lsp-server

Project description

pyls-spyder

Project License - MIT pypi version conda version download count Downloads PyPI status PyLS-Spyder tests

Copyright © 2020– Spyder Project Contributors

Overview

Spyder extensions for the python-lsp-server (pylsp). This package provides Spyder-specific extras for the Language Server Protocol (LSP) on Python, such as document symbol searching and others.

Installing

To install pyls-spyder, you can use both conda or pip package managers:

# Using conda (Recommended)
conda install pyls-spyder -c spyder-ide

# Using pip
pip install pyls-spyder

Dependencies

This package depends on the python-lsp-server to integrate the Spyder-specific extensions.

Installing locally

To install and develop spyder-pyls locally, you will need to install the python-lsp-server:

# Using conda
conda install python-lsp-server

# Using pip
pip install python-lsp-server

Then, you can install the package locally using pip:

pip install -U -e .

Running tests

We use pytest to run tests as it follows:

pytest -x -v pyls_spyder/tests

Extended LSP calls

LSP method Spyder extensions
textDocument/documentSymbol Find code cells # %% and block comments # --
textDocument/foldingRange Return code cells # %% as code folding regions

Plugin configuration options

This plugin can be configured by using the key pyls_spyder when calling workspace/didChangeConfiguration on the pyls. Each configuration option is described below:

LSP method Configuration Key Type Description
textDocument/documentSymbol group_cells bool Enable/Disable code cell grouping according to the total number of leading percentages
enable_block_comments bool Enable/disable block comment detection

Changelog

Please see our CHANGELOG file to learn more about our new features and improvements.

Contribution guidelines

We follow PEP8 and PEP257 for all Python modules. We use MyPy type annotations for all functions and classes declared on this package. Feel free to send a PR or create an issue if you have any problem/question.

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

pyls-spyder-0.4.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

pyls_spyder-0.4.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file pyls-spyder-0.4.0.tar.gz.

File metadata

  • Download URL: pyls-spyder-0.4.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.8

File hashes

Hashes for pyls-spyder-0.4.0.tar.gz
Algorithm Hash digest
SHA256 45a321c83f64267d82907492c55199fccabda45bc872dd23bf1efd08edac1b0b
MD5 dabb2a391935002ccf318c99c09bd1fc
BLAKE2b-256 94e017ebfbc3cdd9d2bed54f4904672d8c766b5f48c930d699e20566061b6720

See more details on using hashes here.

File details

Details for the file pyls_spyder-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: pyls_spyder-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.8

File hashes

Hashes for pyls_spyder-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1505d975f866a343d0554b6dab41b53717f4b4bc6df450dfd7d48f889fe450b9
MD5 670afc9fa3421e705f26e01d0ee5aa19
BLAKE2b-256 d026d0975972af1f18c3bb02ec5889191cc09ebb982bcbe45438d90ca763f4ec

See more details on using hashes here.

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