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.
Important
The next major version, pygls v2 is ready for testing. We encourage all existing server authors to try the migration guide and let us know how you get on!
from pygls.lsp.server import LanguageServer
from lsprotocol import types
server = LanguageServer("example-server", "v0.1")
@server.feature(types.TEXT_DOCUMENT_COMPLETION)
def completions(params: types.CompletionParams):
items = []
document = server.workspace.get_text_document(params.text_document.uri)
current_line = document.lines[params.position.line].strip()
if current_line.endswith("hello."):
items = [
types.CompletionItem(label="world"),
types.CompletionItem(label="friend"),
]
return types.CompletionList(is_incomplete=False, items=items)
server.start_io()Which might look something like this when you trigger autocompletion in your editor:
The full documentation and a tutorial are available at https://pygls.readthedocs.io/en/latest/.
We keep a table of all known pygls implementations. Please submit a Pull Request with your own or any that you find are missing.
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.
- https://github.com/iamcco/diagnostic-languageserver
- https://github.com/mattn/efm-langserver
- https://github.com/jose-elias-alvarez/null-ls.nvim (Neovim only)
All Pygls sub-tasks require the Poetry poe plugin: https://github.com/nat-n/poethepoet
poetry install --all-extraspoetry run poe testpoetry run poe test-pyodide
Your contributions to pygls are most welcome ❤️ Please review the Contributing and Code of Conduct documents for how to get started.
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.
We would like to give special thanks to the following supporters:
Apache-2.0