Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lsp_client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
HoverRequest,
InitializeParams,
InitializeRequest,
InitializeResult,
InitializedNotification,
LanguageKind,
Location,
Expand All @@ -34,6 +35,7 @@
ResponseError,
ResponseMessage,
ServerCapabilities,
ServerInfo,
ShutdownRequest,
TextDocumentDidChangeNotification,
TextDocumentDidCloseNotification,
Expand Down Expand Up @@ -79,6 +81,7 @@
"HoverRequest",
"InitializeParams",
"InitializeRequest",
"InitializeResult",
"InitializedNotification",
"LSPClient",
"LSPErrorCodes",
Expand All @@ -93,6 +96,7 @@
"ResponseError",
"ResponseMessage",
"ServerCapabilities",
"ServerInfo",
"ShutdownRequest",
"TextDocumentDidChangeNotification",
"TextDocumentDidCloseNotification",
Expand Down
18 changes: 18 additions & 0 deletions lsp_client/protocol.py
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,24 @@ def __init__(self, **kwargs: Any) -> None:
super(InitializeRequest, self).__init__(**kwargs)


class ServerInfo(BaseModel):
"""Information about the server. @since 3.15.0"""

#: The name of the server as defined by the server.
name: str
#: The server's version as defined by the server.
version: str | None = None


class InitializeResult(BaseModel):
"""The result returned from an ``initialize`` request."""

#: The capabilities the language server provides.
capabilities: ServerCapabilities
#: Information about the server. @since 3.15.0
serverInfo: ServerInfo | None = None


class InitializedNotification(BaseNotification):
def __init__(self, **kwargs: Any) -> None:
kwargs["method"] = "initialized"
Expand Down
46 changes: 46 additions & 0 deletions tests/test_protocol.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
HoverRequest,
InitializeParams,
InitializeRequest,
InitializeResult,
InitializedNotification,
LanguageKind,
Location,
Expand All @@ -35,6 +36,7 @@
ResponseError,
ResponseMessage,
ServerCapabilities,
ServerInfo,
ShutdownRequest,
TextDocumentDidChangeNotification,
TextDocumentDidCloseNotification,
Expand Down Expand Up @@ -462,6 +464,50 @@ def test_server_capabilities_position_encoding_optional():
assert ServerCapabilities().model_dump(exclude_none=True) == {}


def test_initialize_result_minimal():
result = InitializeResult(capabilities=ServerCapabilities())
data = result.model_dump(exclude_none=True)
# Only capabilities is required; serverInfo is omitted when absent.
assert data == {"capabilities": {}}
assert "serverInfo" not in data


def test_initialize_result_with_server_info():
result = InitializeResult(
capabilities=ServerCapabilities(positionEncoding=PositionEncodingKind.UTF8),
serverInfo=ServerInfo(name="pyright", version="1.1.0"),
)
data = result.model_dump(exclude_none=True)
assert data == {
"capabilities": {"positionEncoding": "utf-8"},
"serverInfo": {"name": "pyright", "version": "1.1.0"},
}


def test_server_info_version_optional():
data = ServerInfo(name="gopls").model_dump(exclude_none=True)
assert data == {"name": "gopls"}


def test_server_info_requires_name():
with pytest.raises(ValidationError):
ServerInfo()


def test_initialize_result_parses_from_response_payload():
# A server's initialize response coerces into nested models.
result = InitializeResult.model_validate(
{
"capabilities": {"positionEncoding": "utf-16"},
"serverInfo": {"name": "rust-analyzer"},
}
)
assert result.capabilities.positionEncoding == PositionEncodingKind.UTF16
assert result.serverInfo is not None
assert result.serverInfo.name == "rust-analyzer"
assert result.serverInfo.version is None


def _range() -> Range:
return Range(start=Position(line=1, character=0), end=Position(line=1, character=8))

Expand Down
Loading