Skip to main content

A pythonic generic language server (pronounced like 'pie glass')

Project description

PyPI Version !pyversions license Documentation Status

pygls: The Generic Language Server Framework

pygls (pronounced like "pie glass") is a pythonic generic implementation of the Language Server Protocol for use as a foundation for writing your own Language Servers in just a few lines of code.

Quickstart

from pygls.server import LanguageServer
from lsprotocol.types import (
    TEXT_DOCUMENT_COMPLETION,
    CompletionItem,
    CompletionList,
    CompletionParams,
)

server = LanguageServer("example-server", "v0.1")

@server.feature(TEXT_DOCUMENT_COMPLETION)
def completions(params: CompletionParams):
    items = []
    document = server.workspace.get_document(params.text_document.uri)
    current_line = document.lines[params.position.line].strip()
    if current_line.endswith("hello."):
        items = [
            CompletionItem(label="world"),
            CompletionItem(label="friend"),
        ]
    return CompletionList(is_incomplete=False, items=items)

server.start_io()

Which might look something like this when you trigger autocompletion in your editor:

completions

Docs and Tutorial

The full documentation and a tutorial are available at https://pygls.readthedocs.io/en/latest/.

Projects based on pygls

We keep a table of all known pygls implementations. Please submit a Pull Request with your own or any that you find are missing.

Alternatives

The main alternative to pygls is Microsoft's NodeJS-based Generic Language Server Framework. Being from Microsoft it is focussed on extending VSCode, although in theory it could be used to support any editor. So this is where pygls might be a better choice if you want to support more editors, as pygls is not focussed around VSCode.

There are also other Language Servers with "general" in their descriptons, or at least intentions. They are however only general in the sense of having powerful configuration. They achieve generality in so much as configuration is able to, as opposed to what programming (in pygls' case) can achieve.

Tests

  • poetry install --all-extras
  • poetry run test
  • poetry run test-pyodide

Contributing

Your contributions to pygls are most welcome ❤️ Please review the Contributing and Code of Conduct documents for how to get started.

Donating

Open Law Library is a 501(c)(3) tax exempt organization. Help us maintain our open source projects and open the law to all with sponsorship.

Supporters

We would like to give special thanks to the following supporters:

License

Apache-2.0

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

pygls-1.1.0.tar.gz (45.6 kB view details)

Uploaded Source

Built Distribution

pygls-1.1.0-py3-none-any.whl (53.8 kB view details)

Uploaded Python 3

File details

Details for the file pygls-1.1.0.tar.gz.

File metadata

  • Download URL: pygls-1.1.0.tar.gz
  • Upload date:
  • Size: 45.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.12.0rc3 Linux/6.5.4-403.asahi.fc40.aarch64+16k

File hashes

Hashes for pygls-1.1.0.tar.gz
Algorithm Hash digest
SHA256 eb19b818039d3d705ec8adbcdf5809a93af925f30cd7a3f3b7573479079ba00e
MD5 bc62d8f2aab76bb0f8ea048054f7fc86
BLAKE2b-256 101a4994d487a7295a7c834a81003b83b00b26086dbd3747699ed3eb20e73fcc

See more details on using hashes here.

File details

Details for the file pygls-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: pygls-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 53.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.12.0rc3 Linux/6.5.4-403.asahi.fc40.aarch64+16k

File hashes

Hashes for pygls-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70acb6fe0df1c8a17b7ce08daa0afdb4aedc6913a6a6696003e1434fda80a06e
MD5 adbc58e03d027e094d3d1287ae6c5d5a
BLAKE2b-256 8858b1430d34a6133eaf11a1927a15bc709cf8c8420c6fd7197da1bed25fe54a

See more details on using hashes here.

Supported by

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