Test: serialization and deserialization using `lsprotocol`

[karthiknadig]

Refs: #19300

• anyOS @mjbvz
• anyOS @luabud

Complexity: 2

Create Issue

---

lsprotocol is Python implementation of LSP types generated from published LSP model. In this test scenario you will install lsprotocol and try serializing and deserializing few types. The lsprotocol types in python were generated from https://github.com/microsoft/vscode-languageserver-node/blob/main/protocol/metaModel.json

Requirements

1. python version 3.7 or greater.

Steps

1. Create a virtual environment: python -m venv .venv
2. Activate your virtual environment.
3. Install lsprotocol: python -m pip install lsprotocol
4. import types and converters and try to structure (deserialize) and unstructure (serialize) code. See example below.

Pick some request, notification, or structure and try the following. In this example I use Diagnostic structure.

import json

from lsprotocol import converters, types

converter = converters.get_converter()

# test de-serialization
data = {
    "range": {
        "start": {"line": 0, "character": 0},
        "end": {"line": 0, "character": 0},
    },
    "message": "Missing module docstring",
    "severity": 3,
    "code": "C0114:missing-module-docstring",
    "source": "my_lint",
}
obj = converter.structure(data, types.Diagnostic)
print(type(obj)) # should print <class 'lsprotocol.types.Diagnostic'>

# test serialization
data = converter.unstructure(obj, types.Diagnostic)
print(json.dumps(data, indent=4)) # should look similar to `data` above. 

[mjbvz]

The code example works fine but I'm blocked on testing this more fully because I can't get python debugging working. I've selected the venv but f5 complains that it can't find lsprotocol. Running in the terminal works fine

[karthiknadig]

@mjbvz Does the extension show that you have the right environment selected?

[mjbvz]

Yes I believe it does

[karthiknadig]

@karrtikr Looks like in Matt's case python was aliased to global python. So, when he did python -m pip install lsprotocol it installed to the global environment. But our tooling uses absolute path to environment, so they all failed to detect.

[mjbvz]

Thanks @karthiknadig for the help! We were able to figure out python was aliased to the global python version, bypassing the venv version

I tested a few types and they all seemed to work. Was a little confused how to use enums at first before realizing I could use types.SymbolKind.MODULE.value (or just inline the constant for it)