From fe795a145a0d7b666caf00d15abe6b22380168e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9F=D1=80=D0=B5=D0=B4=D1=80=D0=B0=D0=B3=20=D0=9D=D0=B8?= =?UTF-8?q?=D0=BA=D0=BE=D0=BB=D0=B8=D1=9B?= Date: Tue, 20 Aug 2024 17:46:55 +0200 Subject: [PATCH] Use generated types for python 38 (#2500) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * use generated types for python 3.8 * remove CompletionEditRange because it is no longer necessary * fix flake8 * LSP only supports TextEdits for WorkspaceChanges currently In the future we could remove the is_text_edit check when we add support for `AnnotatedTextEdit` and `SnippetTextEdit` * Implement activeParameter being `null` in 3.18 in which case the client should not higlight any parameter * cast langauge_id to LanguageKind * I should really setup flake8 locally * a * set "noActiveParameterSupport" to False * remove accidentally committed file * add space * remove noActiveParameterSupport": False * import on separate line * one import per line * change Enum to StrEnum * remove unused import * sort lines * remove casting * remove uint * fix detecting textEdits not applying because .get('newText') was falsy {'range': {'start': {'line': 1, 'character': 0}, 'end': {'line': 2, 'character': 0}}, 'newText': ''} * address type issue * allowed AnnotatedTextEdit * fix syntax --------- Co-authored-by: Rafał Chłodnicki Co-authored-by: Rafal Chlodnicki --- plugin/completion.py | 4 +- plugin/core/edit.py | 11 +- plugin/core/protocol.py | 9058 ++++++++++++++++----------------- plugin/core/signature_help.py | 3 +- plugin/core/views.py | 4 +- 5 files changed, 4515 insertions(+), 4565 deletions(-) diff --git a/plugin/completion.py b/plugin/completion.py index 5b1ad1c1f..21c13f9de 100644 --- a/plugin/completion.py +++ b/plugin/completion.py @@ -3,7 +3,7 @@ from .core.edit import apply_text_edits from .core.logging import debug from .core.promise import Promise -from .core.protocol import CompletionEditRange +from .core.protocol import EditRangeWithInsertReplace from .core.protocol import CompletionItem from .core.protocol import CompletionItemDefaults from .core.protocol import CompletionItemKind @@ -127,7 +127,7 @@ def is_range(val: Any) -> TypeGuard[Range]: return isinstance(val, dict) and 'start' in val and 'end' in val -def is_edit_range(val: Any) -> TypeGuard[CompletionEditRange]: +def is_edit_range(val: Any) -> TypeGuard[EditRangeWithInsertReplace]: return isinstance(val, dict) and 'insert' in val and 'replace' in val diff --git a/plugin/core/edit.py b/plugin/core/edit.py index f7f4fa24f..8665b35ed 100644 --- a/plugin/core/edit.py +++ b/plugin/core/edit.py @@ -1,14 +1,15 @@ from __future__ import annotations from .logging import debug +from .protocol import AnnotatedTextEdit from .protocol import Position from .protocol import TextEdit from .protocol import UINT_MAX from .protocol import WorkspaceEdit -from typing import Dict, List, Optional, Tuple +from typing import Dict, List, Optional, Tuple, Union import sublime -WorkspaceChanges = Dict[str, Tuple[List[TextEdit], Optional[int]]] +WorkspaceChanges = Dict[str, Tuple[List[Union[TextEdit, AnnotatedTextEdit]], Optional[int]]] def parse_workspace_edit(workspace_edit: WorkspaceEdit) -> WorkspaceChanges: @@ -24,7 +25,11 @@ def parse_workspace_edit(workspace_edit: WorkspaceEdit) -> WorkspaceChanges: uri = text_document['uri'] version = text_document.get('version') edits = document_change.get('edits') - changes.setdefault(uri, ([], version))[0].extend(edits) + for edit in edits: + if 'snippet' in edit: + debug('Ignoring unsupported SnippetTextEdit') + continue + changes.setdefault(uri, ([], version))[0].append(edit) else: raw_changes = workspace_edit.get('changes') if isinstance(raw_changes, dict): diff --git a/plugin/core/protocol.py b/plugin/core/protocol.py index 9cf429aec..69a440f72 100644 --- a/plugin/core/protocol.py +++ b/plugin/core/protocol.py @@ -220,7 +220,10 @@ class MessageType(IntEnum): Log = 4 """ A log message. """ Debug = 5 - """ A debug message. """ + """ A debug message. + + @since 3.18.0 + @proposed """ class TextDocumentSyncKind(IntEnum): @@ -360,6 +363,18 @@ class CodeActionKind(StrEnum): - Inline variable - Inline constant - ... """ + RefactorMove = 'refactor.move' + """ Base kind for refactoring move actions: `refactor.move` + + Example move actions: + + - Move a function to a new file + - Move a property between classes + - Move method to base class + - ... + + @since 3.18.0 + @proposed """ RefactorRewrite = 'refactor.rewrite' """ Base kind for refactoring rewrite actions: 'refactor.rewrite' @@ -384,9 +399,14 @@ class CodeActionKind(StrEnum): They should not suppress errors or perform unsafe fixes such as generating new types or classes. @since 3.15.0 """ + Notebook = 'notebook' + """ Base kind for all code actions applying to the entire notebook's scope. CodeActionKinds using + this should always begin with `notebook.` + + @since 3.18.0 """ -class TraceValues(StrEnum): +class TraceValue(StrEnum): Off = 'off' """ Turn tracing off. """ Messages = 'messages' @@ -407,14 +427,87 @@ class MarkupKind(StrEnum): """ Markdown is supported as a content format """ +class LanguageKind(StrEnum): + """ Predefined Language kinds + @since 3.18.0 + @proposed """ + ABAP = 'abap' + WindowsBat = 'bat' + BibTeX = 'bibtex' + Clojure = 'clojure' + Coffeescript = 'coffeescript' + C = 'c' + CPP = 'cpp' + CSharp = 'csharp' + CSS = 'css' + D = 'd' + """ @since 3.18.0 + @proposed """ + Delphi = 'pascal' + """ @since 3.18.0 + @proposed """ + Diff = 'diff' + Dart = 'dart' + Dockerfile = 'dockerfile' + Elixir = 'elixir' + Erlang = 'erlang' + FSharp = 'fsharp' + GitCommit = 'git-commit' + GitRebase = 'rebase' + Go = 'go' + Groovy = 'groovy' + Handlebars = 'handlebars' + Haskell = 'haskell' + HTML = 'html' + Ini = 'ini' + Java = 'java' + JavaScript = 'javascript' + JavaScriptReact = 'javascriptreact' + JSON = 'json' + LaTeX = 'latex' + Less = 'less' + Lua = 'lua' + Makefile = 'makefile' + Markdown = 'markdown' + ObjectiveC = 'objective-c' + ObjectiveCPP = 'objective-cpp' + Pascal = 'pascal' + """ @since 3.18.0 + @proposed """ + Perl = 'perl' + Perl6 = 'perl6' + PHP = 'php' + Powershell = 'powershell' + Pug = 'jade' + Python = 'python' + R = 'r' + Razor = 'razor' + Ruby = 'ruby' + Rust = 'rust' + SCSS = 'scss' + SASS = 'sass' + Scala = 'scala' + ShaderLab = 'shaderlab' + ShellScript = 'shellscript' + SQL = 'sql' + Swift = 'swift' + TypeScript = 'typescript' + TypeScriptReact = 'typescriptreact' + TeX = 'tex' + VisualBasic = 'vb' + XML = 'xml' + XSL = 'xsl' + YAML = 'yaml' + + class InlineCompletionTriggerKind(IntEnum): """ Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered. @since 3.18.0 @proposed """ - Invoked = 0 + Invoked = 1 """ Completion was triggered explicitly by a user gesture. """ - Automatic = 1 + Automatic = 2 """ Completion was triggered automatically while editing. """ @@ -632,7 +725,7 @@ class TokenFormat(StrEnum): @since 3.17.0 """ -PrepareRenameResult = Union['Range', '__PrepareRenameResult_Type_1', '__PrepareRenameResult_Type_2'] +PrepareRenameResult = Union['Range', 'PrepareRenamePlaceholder', 'PrepareRenameDefaultBehavior'] DocumentSelector = List['DocumentFilter'] """ A document selector is the combination of one or many document filters. @@ -651,11 +744,11 @@ class TokenFormat(StrEnum): @since 3.17.0 """ -TextDocumentContentChangeEvent = Union['__TextDocumentContentChangeEvent_Type_1', '__TextDocumentContentChangeEvent_Type_2'] +TextDocumentContentChangeEvent = Union['TextDocumentContentChangePartial', 'TextDocumentContentChangeWholeDocument'] """ An event describing a change to a text document. If only a text is provided it is considered to be the full content of the document. """ -MarkedString = Union[str, '__MarkedString_Type_1'] +MarkedString = Union[str, 'MarkedStringWithLanguage'] """ MarkedString can be used to render human readable text. It is either a markdown string or a code-block that provides a language and a code snippet. The language identifier is semantically equal to the optional language identifier in fenced code blocks in GitHub @@ -684,7 +777,7 @@ class TokenFormat(StrEnum): @since 3.17.0 """ -TextDocumentFilter = Union['__TextDocumentFilter_Type_1', '__TextDocumentFilter_Type_2', '__TextDocumentFilter_Type_3'] +TextDocumentFilter = Union['TextDocumentFilterLanguage', 'TextDocumentFilterScheme', 'TextDocumentFilterPattern'] """ A document filter denotes a document by different properties like the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}. @@ -702,7 +795,7 @@ class TokenFormat(StrEnum): @since 3.17.0 """ -NotebookDocumentFilter = Union['__NotebookDocumentFilter_Type_1', '__NotebookDocumentFilter_Type_2', '__NotebookDocumentFilter_Type_3'] +NotebookDocumentFilter = Union['NotebookDocumentFilterNotebookType', 'NotebookDocumentFilterScheme', 'NotebookDocumentFilterPattern'] """ A notebook document filter denotes a notebook document by different properties. The properties will be match against the notebook's URI (same as with documents) @@ -720,5298 +813,5150 @@ class TokenFormat(StrEnum): @since 3.17.0 """ +RegularExpressionEngineKind = str -ImplementationParams = TypedDict('ImplementationParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) - -Location = TypedDict('Location', { - 'uri': 'DocumentUri', - 'range': 'Range', -}) -""" Represents a location inside a resource, such as a line -inside a text file. """ +class ImplementationParams(TypedDict): + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class Location(TypedDict): + """ Represents a location inside a resource, such as a line + inside a text file. """ + uri: 'DocumentUri' + range: 'Range' + + +class ImplementationRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ + + +class TypeDefinitionParams(TypedDict): + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class TypeDefinitionRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ + + +class WorkspaceFolder(TypedDict): + """ A workspace folder inside a client. """ + uri: 'URI' + """ The associated URI for this workspace folder. """ + name: str + """ The name of the workspace folder. Used to refer to this + workspace folder in the user interface. """ + + +class DidChangeWorkspaceFoldersParams(TypedDict): + """ The parameters of a `workspace/didChangeWorkspaceFolders` notification. """ + event: 'WorkspaceFoldersChangeEvent' + """ The actual workspace folder change event. """ + + +class ConfigurationParams(TypedDict): + """ The parameters of a configuration request. """ + items: List['ConfigurationItem'] + + +class DocumentColorParams(TypedDict): + """ Parameters for a {@link DocumentColorRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class ColorInformation(TypedDict): + """ Represents a color range from a document. """ + range: 'Range' + """ The range in the document where this color appears. """ + color: 'Color' + """ The actual color value for this color range. """ + + +class DocumentColorRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ + + +class ColorPresentationParams(TypedDict): + """ Parameters for a {@link ColorPresentationRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + color: 'Color' + """ The color to request presentations for. """ + range: 'Range' + """ The range where the color would be inserted. Serves as a context. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class ColorPresentation(TypedDict): + label: str + """ The label of this color presentation. It will be shown on the color + picker header. By default this is also the text that is inserted when selecting + this color presentation. """ + textEdit: NotRequired['TextEdit'] + """ An {@link TextEdit edit} which is applied to a document when selecting + this presentation for the color. When `falsy` the {@link ColorPresentation.label label} + is used. """ + additionalTextEdits: NotRequired[List['TextEdit']] + """ An optional array of additional {@link TextEdit text edits} that are applied when + selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves. """ + + +class WorkDoneProgressOptions(TypedDict): + workDoneProgress: NotRequired[bool] + + +class TextDocumentRegistrationOptions(TypedDict): + """ General text document registration options. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + + +class FoldingRangeParams(TypedDict): + """ Parameters for a {@link FoldingRangeRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class FoldingRange(TypedDict): + """ Represents a folding range. To be valid, start and end line must be bigger than zero and smaller + than the number of lines in the document. Clients are free to ignore invalid ranges. """ + startLine: Uint + """ The zero-based start line of the range to fold. The folded area starts after the line's last character. + To be valid, the end must be zero or larger and smaller than the number of lines in the document. """ + startCharacter: NotRequired[Uint] + """ The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line. """ + endLine: Uint + """ The zero-based end line of the range to fold. The folded area ends with the line's last character. + To be valid, the end must be zero or larger and smaller than the number of lines in the document. """ + endCharacter: NotRequired[Uint] + """ The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line. """ + kind: NotRequired['FoldingRangeKind'] + """ Describes the kind of the folding range such as 'comment' or 'region'. The kind + is used to categorize folding ranges and used by commands like 'Fold all comments'. + See {@link FoldingRangeKind} for an enumeration of standardized kinds. """ + collapsedText: NotRequired[str] + """ The text that the client should show when the specified range is + collapsed. If not defined or not supported by the client, a default + will be chosen by the client. + + @since 3.17.0 """ -ImplementationRegistrationOptions = TypedDict('ImplementationRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) +class FoldingRangeRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -TypeDefinitionParams = TypedDict('TypeDefinitionParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) +class DeclarationParams(TypedDict): + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -TypeDefinitionRegistrationOptions = TypedDict('TypeDefinitionRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) +class DeclarationRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -WorkspaceFolder = TypedDict('WorkspaceFolder', { - # The associated URI for this workspace folder. - 'uri': 'URI', - # The name of the workspace folder. Used to refer to this - # workspace folder in the user interface. - 'name': str, -}) -""" A workspace folder inside a client. """ +class SelectionRangeParams(TypedDict): + """ A parameter literal used in selection range requests. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + positions: List['Position'] + """ The positions inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -DidChangeWorkspaceFoldersParams = TypedDict('DidChangeWorkspaceFoldersParams', { - # The actual workspace folder change event. - 'event': 'WorkspaceFoldersChangeEvent', -}) -""" The parameters of a `workspace/didChangeWorkspaceFolders` notification. """ +class SelectionRange(TypedDict): + """ A selection range represents a part of a selection hierarchy. A selection range + may have a parent selection range that contains it. """ + range: 'Range' + """ The {@link Range range} of this selection range. """ + parent: NotRequired['SelectionRange'] + """ The parent selection range containing this range. Therefore `parent.range` must contain `this.range`. """ -ConfigurationParams = TypedDict('ConfigurationParams', { - 'items': List['ConfigurationItem'], -}) -""" The parameters of a configuration request. """ +class SelectionRangeRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -DocumentColorParams = TypedDict('DocumentColorParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link DocumentColorRequest}. """ +class WorkDoneProgressCreateParams(TypedDict): + token: 'ProgressToken' + """ The token to be used to report progress. """ -ColorInformation = TypedDict('ColorInformation', { - # The range in the document where this color appears. - 'range': 'Range', - # The actual color value for this color range. - 'color': 'Color', -}) -""" Represents a color range from a document. """ +class WorkDoneProgressCancelParams(TypedDict): + token: 'ProgressToken' + """ The token to be used to report progress. """ -DocumentColorRegistrationOptions = TypedDict('DocumentColorRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) +class CallHierarchyPrepareParams(TypedDict): + """ The parameter of a `textDocument/prepareCallHierarchy` request. + @since 3.16.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -ColorPresentationParams = TypedDict('ColorPresentationParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The color to request presentations for. - 'color': 'Color', - # The range where the color would be inserted. Serves as a context. - 'range': 'Range', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link ColorPresentationRequest}. """ - - -ColorPresentation = TypedDict('ColorPresentation', { - # The label of this color presentation. It will be shown on the color - # picker header. By default this is also the text that is inserted when selecting - # this color presentation. - 'label': str, - # An {@link TextEdit edit} which is applied to a document when selecting - # this presentation for the color. When `falsy` the {@link ColorPresentation.label label} - # is used. - 'textEdit': NotRequired['TextEdit'], - # An optional array of additional {@link TextEdit text edits} that are applied when - # selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves. - 'additionalTextEdits': NotRequired[List['TextEdit']], -}) +class CallHierarchyItem(TypedDict): + """ Represents programming constructs like functions or constructors in the context + of call hierarchy. -WorkDoneProgressOptions = TypedDict('WorkDoneProgressOptions', { - 'workDoneProgress': NotRequired[bool], -}) + @since 3.16.0 """ + name: str + """ The name of this item. """ + kind: 'SymbolKind' + """ The kind of this item. """ + tags: NotRequired[List['SymbolTag']] + """ Tags for this item. """ + detail: NotRequired[str] + """ More detail for this item, e.g. the signature of a function. """ + uri: 'DocumentUri' + """ The resource identifier of this item. """ + range: 'Range' + """ The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code. """ + selectionRange: 'Range' + """ The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. + Must be contained by the {@link CallHierarchyItem.range `range`}. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved between a call hierarchy prepare and + incoming calls or outgoing calls requests. """ + + +class CallHierarchyRegistrationOptions(TypedDict): + """ Call hierarchy options used during static or dynamic registration. + @since 3.16.0 """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -TextDocumentRegistrationOptions = TypedDict('TextDocumentRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) -""" General text document registration options. """ +class CallHierarchyIncomingCallsParams(TypedDict): + """ The parameter of a `callHierarchy/incomingCalls` request. -FoldingRangeParams = TypedDict('FoldingRangeParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link FoldingRangeRequest}. """ - - -FoldingRange = TypedDict('FoldingRange', { - # The zero-based start line of the range to fold. The folded area starts after the line's last character. - # To be valid, the end must be zero or larger and smaller than the number of lines in the document. - 'startLine': Uint, - # The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line. - 'startCharacter': NotRequired[Uint], - # The zero-based end line of the range to fold. The folded area ends with the line's last character. - # To be valid, the end must be zero or larger and smaller than the number of lines in the document. - 'endLine': Uint, - # The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line. - 'endCharacter': NotRequired[Uint], - # Describes the kind of the folding range such as `comment' or 'region'. The kind - # is used to categorize folding ranges and used by commands like 'Fold all comments'. - # See {@link FoldingRangeKind} for an enumeration of standardized kinds. - 'kind': NotRequired['FoldingRangeKind'], - # The text that the client should show when the specified range is - # collapsed. If not defined or not supported by the client, a default - # will be chosen by the client. - # - # @since 3.17.0 - 'collapsedText': NotRequired[str], -}) -""" Represents a folding range. To be valid, start and end line must be bigger than zero and smaller -than the number of lines in the document. Clients are free to ignore invalid ranges. """ + @since 3.16.0 """ + item: 'CallHierarchyItem' + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -FoldingRangeRegistrationOptions = TypedDict('FoldingRangeRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], +CallHierarchyIncomingCall = TypedDict('CallHierarchyIncomingCall', { + # The item that makes the call. + 'from': 'CallHierarchyItem', + # The ranges at which the calls appear. This is relative to the caller + # denoted by {@link CallHierarchyIncomingCall.from `this.from`}. + 'fromRanges': List['Range'], }) +""" Represents an incoming call, e.g. a caller of a method or constructor. +@since 3.16.0 """ -DeclarationParams = TypedDict('DeclarationParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) +class CallHierarchyOutgoingCallsParams(TypedDict): + """ The parameter of a `callHierarchy/outgoingCalls` request. -DeclarationRegistrationOptions = TypedDict('DeclarationRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) + @since 3.16.0 """ + item: 'CallHierarchyItem' + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -SelectionRangeParams = TypedDict('SelectionRangeParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The positions inside the text document. - 'positions': List['Position'], - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" A parameter literal used in selection range requests. """ +class CallHierarchyOutgoingCall(TypedDict): + """ Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc. + @since 3.16.0 """ + to: 'CallHierarchyItem' + """ The item that is called. """ + fromRanges: List['Range'] + """ The range at which this item is called. This is the range relative to the caller, e.g the item + passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`} + and not {@link CallHierarchyOutgoingCall.to `this.to`}. """ + + +class SemanticTokensParams(TypedDict): + """ @since 3.16.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class SemanticTokens(TypedDict): + """ @since 3.16.0 """ + resultId: NotRequired[str] + """ An optional result id. If provided and clients support delta updating + the client will include the result id in the next semantic token request. + A server can then instead of computing all semantic tokens again simply + send a delta. """ + data: List[Uint] + """ The actual tokens. """ + + +class SemanticTokensPartialResult(TypedDict): + """ @since 3.16.0 """ + data: List[Uint] + + +class SemanticTokensRegistrationOptions(TypedDict): + """ @since 3.16.0 """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + legend: 'SemanticTokensLegend' + """ The legend used by the server """ + range: NotRequired[Union[bool, dict]] + """ Server supports providing semantic tokens for a specific range + of a document. """ + full: NotRequired[Union[bool, 'SemanticTokensFullDelta']] + """ Server supports providing semantic tokens for a full document. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ + + +class SemanticTokensDeltaParams(TypedDict): + """ @since 3.16.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + previousResultId: str + """ The result id of a previous response. The result Id can either point to a full response + or a delta response depending on what was received last. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class SemanticTokensDelta(TypedDict): + """ @since 3.16.0 """ + resultId: NotRequired[str] + edits: List['SemanticTokensEdit'] + """ The semantic token edits to transform a previous result into a new result. """ + + +class SemanticTokensDeltaPartialResult(TypedDict): + """ @since 3.16.0 """ + edits: List['SemanticTokensEdit'] + + +class SemanticTokensRangeParams(TypedDict): + """ @since 3.16.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + range: 'Range' + """ The range the semantic tokens are requested for. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class ShowDocumentParams(TypedDict): + """ Params to show a resource in the UI. -SelectionRange = TypedDict('SelectionRange', { - # The {@link Range range} of this selection range. - 'range': 'Range', - # The parent selection range containing this range. Therefore `parent.range` must contain `this.range`. - 'parent': NotRequired['SelectionRange'], -}) -""" A selection range represents a part of a selection hierarchy. A selection range -may have a parent selection range that contains it. """ + @since 3.16.0 """ + uri: 'URI' + """ The uri to show. """ + external: NotRequired[bool] + """ Indicates to show the resource in an external program. + To show, for example, `https://code.visualstudio.com/` + in the default WEB browser set `external` to `true`. """ + takeFocus: NotRequired[bool] + """ An optional property to indicate whether the editor + showing the document should take focus or not. + Clients might ignore this property if an external + program is started. """ + selection: NotRequired['Range'] + """ An optional selection range if the document is a text + document. Clients might ignore the property if an + external program is started or the file is not a text + file. """ + + +class ShowDocumentResult(TypedDict): + """ The result of a showDocument request. + @since 3.16.0 """ + success: bool + """ A boolean indicating if the show was successful. """ -SelectionRangeRegistrationOptions = TypedDict('SelectionRangeRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) +class LinkedEditingRangeParams(TypedDict): + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -WorkDoneProgressCreateParams = TypedDict('WorkDoneProgressCreateParams', { - # The token to be used to report progress. - 'token': 'ProgressToken', -}) +class LinkedEditingRanges(TypedDict): + """ The result of a linked editing range request. -WorkDoneProgressCancelParams = TypedDict('WorkDoneProgressCancelParams', { - # The token to be used to report progress. - 'token': 'ProgressToken', -}) + @since 3.16.0 """ + ranges: List['Range'] + """ A list of ranges that can be edited together. The ranges must have + identical length and contain identical text content. The ranges cannot overlap. """ + wordPattern: NotRequired[str] + """ An optional word pattern (regular expression) that describes valid contents for + the given ranges. If no pattern is provided, the client configuration's word + pattern will be used. """ -CallHierarchyPrepareParams = TypedDict('CallHierarchyPrepareParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" The parameter of a `textDocument/prepareCallHierarchy` request. +class LinkedEditingRangeRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -@since 3.16.0 """ +class CreateFilesParams(TypedDict): + """ The parameters sent in notifications/requests for user-initiated creation of + files. -CallHierarchyItem = TypedDict('CallHierarchyItem', { - # The name of this item. - 'name': str, - # The kind of this item. - 'kind': 'SymbolKind', - # Tags for this item. - 'tags': NotRequired[List['SymbolTag']], - # More detail for this item, e.g. the signature of a function. - 'detail': NotRequired[str], - # The resource identifier of this item. - 'uri': 'DocumentUri', - # The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code. - 'range': 'Range', - # The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. - # Must be contained by the {@link CallHierarchyItem.range `range`}. - 'selectionRange': 'Range', - # A data entry field that is preserved between a call hierarchy prepare and - # incoming calls or outgoing calls requests. - 'data': NotRequired['LSPAny'], -}) -""" Represents programming constructs like functions or constructors in the context -of call hierarchy. + @since 3.16.0 """ + files: List['FileCreate'] + """ An array of all files/folders created in this operation. """ + + +class WorkspaceEdit(TypedDict): + """ A workspace edit represents changes to many resources managed in the workspace. The edit + should either provide `changes` or `documentChanges`. If documentChanges are present + they are preferred over `changes` if the client can handle versioned document edits. + + Since version 3.13.0 a workspace edit can contain resource operations as well. If resource + operations are present clients need to execute the operations in the order in which they + are provided. So a workspace edit for example can consist of the following two changes: + (1) a create file a.txt and (2) a text document edit which insert text into file a.txt. + + An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will + cause failure of the operation. How the client recovers from the failure is described by + the client capability: `workspace.workspaceEdit.failureHandling` """ + changes: NotRequired[Dict['DocumentUri', List['TextEdit']]] + """ Holds changes to existing resources. """ + documentChanges: NotRequired[List[Union['TextDocumentEdit', 'CreateFile', 'RenameFile', 'DeleteFile']]] + """ Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes + are either an array of `TextDocumentEdit`s to express changes to n different text documents + where each text document edit addresses a specific version of a text document. Or it can contain + above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations. + + Whether a client supports versioned document edits is expressed via + `workspace.workspaceEdit.documentChanges` client capability. + + If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then + only plain `TextEdit`s using the `changes` property are supported. """ + changeAnnotations: NotRequired[Dict['ChangeAnnotationIdentifier', 'ChangeAnnotation']] + """ A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and + delete file / folder operations. + + Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`. -@since 3.16.0 """ + @since 3.16.0 """ -CallHierarchyRegistrationOptions = TypedDict('CallHierarchyRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Call hierarchy options used during static or dynamic registration. +class FileOperationRegistrationOptions(TypedDict): + """ The options to register for file operations. -@since 3.16.0 """ + @since 3.16.0 """ + filters: List['FileOperationFilter'] + """ The actual filters. """ -CallHierarchyIncomingCallsParams = TypedDict('CallHierarchyIncomingCallsParams', { - 'item': 'CallHierarchyItem', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameter of a `callHierarchy/incomingCalls` request. +class RenameFilesParams(TypedDict): + """ The parameters sent in notifications/requests for user-initiated renames of + files. -@since 3.16.0 """ + @since 3.16.0 """ + files: List['FileRename'] + """ An array of all files/folders renamed in this operation. When a folder is renamed, only + the folder will be included, and not its children. """ -CallHierarchyIncomingCall = TypedDict('CallHierarchyIncomingCall', { - # The item that makes the call. - 'from': 'CallHierarchyItem', - # The ranges at which the calls appear. This is relative to the caller - # denoted by {@link CallHierarchyIncomingCall.from `this.from`}. - 'fromRanges': List['Range'], -}) -""" Represents an incoming call, e.g. a caller of a method or constructor. +class DeleteFilesParams(TypedDict): + """ The parameters sent in notifications/requests for user-initiated deletes of + files. -@since 3.16.0 """ + @since 3.16.0 """ + files: List['FileDelete'] + """ An array of all files/folders deleted in this operation. """ -CallHierarchyOutgoingCallsParams = TypedDict('CallHierarchyOutgoingCallsParams', { - 'item': 'CallHierarchyItem', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameter of a `callHierarchy/outgoingCalls` request. +class MonikerParams(TypedDict): + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -@since 3.16.0 """ +class Moniker(TypedDict): + """ Moniker definition to match LSIF 0.5 moniker definition. -CallHierarchyOutgoingCall = TypedDict('CallHierarchyOutgoingCall', { - # The item that is called. - 'to': 'CallHierarchyItem', - # The range at which this item is called. This is the range relative to the caller, e.g the item - # passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`} - # and not {@link CallHierarchyOutgoingCall.to `this.to`}. - 'fromRanges': List['Range'], -}) -""" Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc. + @since 3.16.0 """ + scheme: str + """ The scheme of the moniker. For example tsc or .Net """ + identifier: str + """ The identifier of the moniker. The value is opaque in LSIF however + schema owners are allowed to define the structure if they want. """ + unique: 'UniquenessLevel' + """ The scope in which the moniker is unique """ + kind: NotRequired['MonikerKind'] + """ The moniker kind if known. """ -@since 3.16.0 """ +class MonikerRegistrationOptions(TypedDict): + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ -SemanticTokensParams = TypedDict('SemanticTokensParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" @since 3.16.0 """ +class TypeHierarchyPrepareParams(TypedDict): + """ The parameter of a `textDocument/prepareTypeHierarchy` request. -SemanticTokens = TypedDict('SemanticTokens', { - # An optional result id. If provided and clients support delta updating - # the client will include the result id in the next semantic token request. - # A server can then instead of computing all semantic tokens again simply - # send a delta. - 'resultId': NotRequired[str], - # The actual tokens. - 'data': List[Uint], -}) -""" @since 3.16.0 """ + @since 3.17.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -SemanticTokensPartialResult = TypedDict('SemanticTokensPartialResult', { - 'data': List[Uint], -}) -""" @since 3.16.0 """ - - -SemanticTokensRegistrationOptions = TypedDict('SemanticTokensRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The legend used by the server - 'legend': 'SemanticTokensLegend', - # Server supports providing semantic tokens for a specific range - # of a document. - 'range': NotRequired[Union[bool, dict]], - # Server supports providing semantic tokens for a full document. - 'full': NotRequired[Union[bool, '__SemanticTokensOptions_full_Type_1']], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" @since 3.16.0 """ - - -SemanticTokensDeltaParams = TypedDict('SemanticTokensDeltaParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The result id of a previous response. The result Id can either point to a full response - # or a delta response depending on what was received last. - 'previousResultId': str, - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" @since 3.16.0 """ +class TypeHierarchyItem(TypedDict): + """ @since 3.17.0 """ + name: str + """ The name of this item. """ + kind: 'SymbolKind' + """ The kind of this item. """ + tags: NotRequired[List['SymbolTag']] + """ Tags for this item. """ + detail: NotRequired[str] + """ More detail for this item, e.g. the signature of a function. """ + uri: 'DocumentUri' + """ The resource identifier of this item. """ + range: 'Range' + """ The range enclosing this symbol not including leading/trailing whitespace + but everything else, e.g. comments and code. """ + selectionRange: 'Range' + """ The range that should be selected and revealed when this symbol is being + picked, e.g. the name of a function. Must be contained by the + {@link TypeHierarchyItem.range `range`}. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved between a type hierarchy prepare and + supertypes or subtypes requests. It could also be used to identify the + type hierarchy in the server, helping improve the performance on + resolving supertypes and subtypes. """ + + +class TypeHierarchyRegistrationOptions(TypedDict): + """ Type hierarchy options used during static or dynamic registration. + @since 3.17.0 """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -SemanticTokensDelta = TypedDict('SemanticTokensDelta', { - 'resultId': NotRequired[str], - # The semantic token edits to transform a previous result into a new result. - 'edits': List['SemanticTokensEdit'], -}) -""" @since 3.16.0 """ +class TypeHierarchySupertypesParams(TypedDict): + """ The parameter of a `typeHierarchy/supertypes` request. -SemanticTokensDeltaPartialResult = TypedDict('SemanticTokensDeltaPartialResult', { - 'edits': List['SemanticTokensEdit'], -}) -""" @since 3.16.0 """ + @since 3.17.0 """ + item: 'TypeHierarchyItem' + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -SemanticTokensRangeParams = TypedDict('SemanticTokensRangeParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The range the semantic tokens are requested for. - 'range': 'Range', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" @since 3.16.0 """ - - -ShowDocumentParams = TypedDict('ShowDocumentParams', { - # The uri to show. - 'uri': 'URI', - # Indicates to show the resource in an external program. - # To show, for example, `https://code.visualstudio.com/` - # in the default WEB browser set `external` to `true`. - 'external': NotRequired[bool], - # An optional property to indicate whether the editor - # showing the document should take focus or not. - # Clients might ignore this property if an external - # program is started. - 'takeFocus': NotRequired[bool], - # An optional selection range if the document is a text - # document. Clients might ignore the property if an - # external program is started or the file is not a text - # file. - 'selection': NotRequired['Range'], -}) -""" Params to show a resource in the UI. +class TypeHierarchySubtypesParams(TypedDict): + """ The parameter of a `typeHierarchy/subtypes` request. -@since 3.16.0 """ + @since 3.17.0 """ + item: 'TypeHierarchyItem' + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -ShowDocumentResult = TypedDict('ShowDocumentResult', { - # A boolean indicating if the show was successful. - 'success': bool, -}) -""" The result of a showDocument request. +class InlineValueParams(TypedDict): + """ A parameter literal used in inline value requests. -@since 3.16.0 """ + @since 3.17.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + range: 'Range' + """ The document range for which inline values should be computed. """ + context: 'InlineValueContext' + """ Additional information about the context in which inline values were + requested. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -LinkedEditingRangeParams = TypedDict('LinkedEditingRangeParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) +class InlineValueRegistrationOptions(TypedDict): + """ Inline value options used during static or dynamic registration. + @since 3.17.0 """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -LinkedEditingRanges = TypedDict('LinkedEditingRanges', { - # A list of ranges that can be edited together. The ranges must have - # identical length and contain identical text content. The ranges cannot overlap. - 'ranges': List['Range'], - # An optional word pattern (regular expression) that describes valid contents for - # the given ranges. If no pattern is provided, the client configuration's word - # pattern will be used. - 'wordPattern': NotRequired[str], -}) -""" The result of a linked editing range request. -@since 3.16.0 """ +class InlayHintParams(TypedDict): + """ A parameter literal used in inlay hint requests. + @since 3.17.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + range: 'Range' + """ The document range for which inlay hints should be computed. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -LinkedEditingRangeRegistrationOptions = TypedDict('LinkedEditingRangeRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) +class InlayHint(TypedDict): + """ Inlay hint information. -CreateFilesParams = TypedDict('CreateFilesParams', { - # An array of all files/folders created in this operation. - 'files': List['FileCreate'], -}) -""" The parameters sent in notifications/requests for user-initiated creation of -files. + @since 3.17.0 """ + position: 'Position' + """ The position of this hint. + + If multiple hints have the same position, they will be shown in the order + they appear in the response. """ + label: Union[str, List['InlayHintLabelPart']] + """ The label of this hint. A human readable string or an array of + InlayHintLabelPart label parts. + + *Note* that neither the string nor the label part can be empty. """ + kind: NotRequired['InlayHintKind'] + """ The kind of this hint. Can be omitted in which case the client + should fall back to a reasonable default. """ + textEdits: NotRequired[List['TextEdit']] + """ Optional text edits that are performed when accepting this inlay hint. + + *Note* that edits are expected to change the document so that the inlay + hint (or its nearest variant) is now part of the document and the inlay + hint itself is now obsolete. """ + tooltip: NotRequired[Union[str, 'MarkupContent']] + """ The tooltip text when you hover over this item. """ + paddingLeft: NotRequired[bool] + """ Render padding before the hint. + + Note: Padding should use the editor's background color, not the + background color of the hint itself. That means padding can be used + to visually align/separate an inlay hint. """ + paddingRight: NotRequired[bool] + """ Render padding after the hint. + + Note: Padding should use the editor's background color, not the + background color of the hint itself. That means padding can be used + to visually align/separate an inlay hint. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved on an inlay hint between + a `textDocument/inlayHint` and a `inlayHint/resolve` request. """ + + +class InlayHintRegistrationOptions(TypedDict): + """ Inlay hint options used during static or dynamic registration. -@since 3.16.0 """ + @since 3.17.0 """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for an inlay hint item. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -WorkspaceEdit = TypedDict('WorkspaceEdit', { - # Holds changes to existing resources. - 'changes': NotRequired[Dict['DocumentUri', List['TextEdit']]], - # Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes - # are either an array of `TextDocumentEdit`s to express changes to n different text documents - # where each text document edit addresses a specific version of a text document. Or it can contain - # above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations. - # - # Whether a client supports versioned document edits is expressed via - # `workspace.workspaceEdit.documentChanges` client capability. - # - # If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then - # only plain `TextEdit`s using the `changes` property are supported. - 'documentChanges': NotRequired[List[Union['TextDocumentEdit', 'CreateFile', 'RenameFile', 'DeleteFile']]], - # A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and - # delete file / folder operations. - # - # Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`. - # - # @since 3.16.0 - 'changeAnnotations': NotRequired[Dict['ChangeAnnotationIdentifier', 'ChangeAnnotation']], -}) -""" A workspace edit represents changes to many resources managed in the workspace. The edit -should either provide `changes` or `documentChanges`. If documentChanges are present -they are preferred over `changes` if the client can handle versioned document edits. +class DocumentDiagnosticParams(TypedDict): + """ Parameters of the document diagnostic request. -Since version 3.13.0 a workspace edit can contain resource operations as well. If resource -operations are present clients need to execute the operations in the order in which they -are provided. So a workspace edit for example can consist of the following two changes: -(1) a create file a.txt and (2) a text document edit which insert text into file a.txt. + @since 3.17.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + identifier: NotRequired[str] + """ The additional identifier provided during registration. """ + previousResultId: NotRequired[str] + """ The result id of a previous response if provided. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class DocumentDiagnosticReportPartialResult(TypedDict): + """ A partial result for a document diagnostic report. -An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will -cause failure of the operation. How the client recovers from the failure is described by -the client capability: `workspace.workspaceEdit.failureHandling` """ + @since 3.17.0 """ + relatedDocuments: Dict['DocumentUri', Union['FullDocumentDiagnosticReport', 'UnchangedDocumentDiagnosticReport']] -FileOperationRegistrationOptions = TypedDict('FileOperationRegistrationOptions', { - # The actual filters. - 'filters': List['FileOperationFilter'], -}) -""" The options to register for file operations. +class DiagnosticServerCancellationData(TypedDict): + """ Cancellation data returned from a diagnostic request. -@since 3.16.0 """ + @since 3.17.0 """ + retriggerRequest: bool -RenameFilesParams = TypedDict('RenameFilesParams', { - # An array of all files/folders renamed in this operation. When a folder is renamed, only - # the folder will be included, and not its children. - 'files': List['FileRename'], -}) -""" The parameters sent in notifications/requests for user-initiated renames of -files. +class DiagnosticRegistrationOptions(TypedDict): + """ Diagnostic registration options. -@since 3.16.0 """ + @since 3.17.0 """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + identifier: NotRequired[str] + """ An optional identifier under which the diagnostics are + managed by the client. """ + interFileDependencies: bool + """ Whether the language has inter file dependencies meaning that + editing code in one file can result in a different diagnostic + set in another file. Inter file dependencies are common for + most programming languages and typically uncommon for linters. """ + workspaceDiagnostics: bool + """ The server provides support for workspace diagnostics as well. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ + + +class WorkspaceDiagnosticParams(TypedDict): + """ Parameters of the workspace diagnostic request. + @since 3.17.0 """ + identifier: NotRequired[str] + """ The additional identifier provided during registration. """ + previousResultIds: List['PreviousResultId'] + """ The currently known diagnostic reports with their + previous result ids. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -DeleteFilesParams = TypedDict('DeleteFilesParams', { - # An array of all files/folders deleted in this operation. - 'files': List['FileDelete'], -}) -""" The parameters sent in notifications/requests for user-initiated deletes of -files. -@since 3.16.0 """ +class WorkspaceDiagnosticReport(TypedDict): + """ A workspace diagnostic report. + @since 3.17.0 """ + items: List['WorkspaceDocumentDiagnosticReport'] -MonikerParams = TypedDict('MonikerParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) +class WorkspaceDiagnosticReportPartialResult(TypedDict): + """ A partial result for a workspace diagnostic report. -Moniker = TypedDict('Moniker', { - # The scheme of the moniker. For example tsc or .Net - 'scheme': str, - # The identifier of the moniker. The value is opaque in LSIF however - # schema owners are allowed to define the structure if they want. - 'identifier': str, - # The scope in which the moniker is unique - 'unique': 'UniquenessLevel', - # The moniker kind if known. - 'kind': NotRequired['MonikerKind'], -}) -""" Moniker definition to match LSIF 0.5 moniker definition. + @since 3.17.0 """ + items: List['WorkspaceDocumentDiagnosticReport'] -@since 3.16.0 """ +class DidOpenNotebookDocumentParams(TypedDict): + """ The params sent in an open notebook document notification. -MonikerRegistrationOptions = TypedDict('MonikerRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) + @since 3.17.0 """ + notebookDocument: 'NotebookDocument' + """ The notebook document that got opened. """ + cellTextDocuments: List['TextDocumentItem'] + """ The text documents that represent the content + of a notebook cell. """ -TypeHierarchyPrepareParams = TypedDict('TypeHierarchyPrepareParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" The parameter of a `textDocument/prepareTypeHierarchy` request. +class NotebookDocumentSyncRegistrationOptions(TypedDict): + """ Registration options specific to a notebook. -@since 3.17.0 """ + @since 3.17.0 """ + notebookSelector: List[Union['NotebookDocumentFilterWithNotebook', 'NotebookDocumentFilterWithCells']] + """ The notebooks to be synced """ + save: NotRequired[bool] + """ Whether save notification should be forwarded to + the server. Will only be honored if mode === `notebook`. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -TypeHierarchyItem = TypedDict('TypeHierarchyItem', { - # The name of this item. - 'name': str, - # The kind of this item. - 'kind': 'SymbolKind', - # Tags for this item. - 'tags': NotRequired[List['SymbolTag']], - # More detail for this item, e.g. the signature of a function. - 'detail': NotRequired[str], - # The resource identifier of this item. - 'uri': 'DocumentUri', - # The range enclosing this symbol not including leading/trailing whitespace - # but everything else, e.g. comments and code. - 'range': 'Range', - # The range that should be selected and revealed when this symbol is being - # picked, e.g. the name of a function. Must be contained by the - # {@link TypeHierarchyItem.range `range`}. - 'selectionRange': 'Range', - # A data entry field that is preserved between a type hierarchy prepare and - # supertypes or subtypes requests. It could also be used to identify the - # type hierarchy in the server, helping improve the performance on - # resolving supertypes and subtypes. - 'data': NotRequired['LSPAny'], -}) -""" @since 3.17.0 """ +class DidChangeNotebookDocumentParams(TypedDict): + """ The params sent in a change notebook document notification. + @since 3.17.0 """ + notebookDocument: 'VersionedNotebookDocumentIdentifier' + """ The notebook document that did change. The version number points + to the version after all provided changes have been applied. If + only the text document content of a cell changes the notebook version + doesn't necessarily have to change. """ + change: 'NotebookDocumentChangeEvent' + """ The actual changes to the notebook document. + + The changes describe single state changes to the notebook document. + So if there are two changes c1 (at array index 0) and c2 (at array + index 1) for a notebook in state S then c1 moves the notebook from + S to S' and c2 from S' to S''. So c1 is computed on the state S and + c2 is computed on the state S'. + + To mirror the content of a notebook using change events use the following approach: + - start with the same initial content + - apply the 'notebookDocument/didChange' notifications in the order you receive them. + - apply the `NotebookChangeEvent`s in a single notification in the order + you receive them. """ + + +class DidSaveNotebookDocumentParams(TypedDict): + """ The params sent in a save notebook document notification. -TypeHierarchyRegistrationOptions = TypedDict('TypeHierarchyRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Type hierarchy options used during static or dynamic registration. + @since 3.17.0 """ + notebookDocument: 'NotebookDocumentIdentifier' + """ The notebook document that got saved. """ -@since 3.17.0 """ +class DidCloseNotebookDocumentParams(TypedDict): + """ The params sent in a close notebook document notification. -TypeHierarchySupertypesParams = TypedDict('TypeHierarchySupertypesParams', { - 'item': 'TypeHierarchyItem', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameter of a `typeHierarchy/supertypes` request. + @since 3.17.0 """ + notebookDocument: 'NotebookDocumentIdentifier' + """ The notebook document that got closed. """ + cellTextDocuments: List['TextDocumentIdentifier'] + """ The text documents that represent the content + of a notebook cell that got closed. """ -@since 3.17.0 """ +class InlineCompletionParams(TypedDict): + """ A parameter literal used in inline completion requests. -TypeHierarchySubtypesParams = TypedDict('TypeHierarchySubtypesParams', { - 'item': 'TypeHierarchyItem', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameter of a `typeHierarchy/subtypes` request. + @since 3.18.0 + @proposed """ + context: 'InlineCompletionContext' + """ Additional information about the context in which inline completions were + requested. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -@since 3.17.0 """ +class InlineCompletionList(TypedDict): + """ Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor. -InlineValueParams = TypedDict('InlineValueParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The document range for which inline values should be computed. - 'range': 'Range', - # Additional information about the context in which inline values were - # requested. - 'context': 'InlineValueContext', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" A parameter literal used in inline value requests. + @since 3.18.0 + @proposed """ + items: List['InlineCompletionItem'] + """ The inline completion items """ -@since 3.17.0 """ +class InlineCompletionItem(TypedDict): + """ An inline completion item represents a text snippet that is proposed inline to complete text that is being typed. -InlineValueRegistrationOptions = TypedDict('InlineValueRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Inline value options used during static or dynamic registration. + @since 3.18.0 + @proposed """ + insertText: Union[str, 'StringValue'] + """ The text to replace the range with. Must be set. """ + filterText: NotRequired[str] + """ A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used. """ + range: NotRequired['Range'] + """ The range to replace. Must begin and end on the same line. """ + command: NotRequired['Command'] + """ An optional {@link Command} that is executed *after* inserting this completion. """ -@since 3.17.0 """ +class InlineCompletionRegistrationOptions(TypedDict): + """ Inline completion options used during static or dynamic registration. -InlayHintParams = TypedDict('InlayHintParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The document range for which inlay hints should be computed. - 'range': 'Range', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" A parameter literal used in inlay hint requests. + @since 3.18.0 + @proposed """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -@since 3.17.0 """ +class RegistrationParams(TypedDict): + registrations: List['Registration'] -InlayHint = TypedDict('InlayHint', { - # The position of this hint. - 'position': 'Position', - # The label of this hint. A human readable string or an array of - # InlayHintLabelPart label parts. - # - # *Note* that neither the string nor the label part can be empty. - 'label': Union[str, List['InlayHintLabelPart']], - # The kind of this hint. Can be omitted in which case the client - # should fall back to a reasonable default. - 'kind': NotRequired['InlayHintKind'], - # Optional text edits that are performed when accepting this inlay hint. - # - # *Note* that edits are expected to change the document so that the inlay - # hint (or its nearest variant) is now part of the document and the inlay - # hint itself is now obsolete. - 'textEdits': NotRequired[List['TextEdit']], - # The tooltip text when you hover over this item. - 'tooltip': NotRequired[Union[str, 'MarkupContent']], - # Render padding before the hint. - # - # Note: Padding should use the editor's background color, not the - # background color of the hint itself. That means padding can be used - # to visually align/separate an inlay hint. - 'paddingLeft': NotRequired[bool], - # Render padding after the hint. - # - # Note: Padding should use the editor's background color, not the - # background color of the hint itself. That means padding can be used - # to visually align/separate an inlay hint. - 'paddingRight': NotRequired[bool], - # A data entry field that is preserved on an inlay hint between - # a `textDocument/inlayHint` and a `inlayHint/resolve` request. - 'data': NotRequired['LSPAny'], -}) -""" Inlay hint information. -@since 3.17.0 """ +class UnregistrationParams(TypedDict): + unregisterations: List['Unregistration'] -InlayHintRegistrationOptions = TypedDict('InlayHintRegistrationOptions', { - # The server provides support to resolve additional - # information for an inlay hint item. - 'resolveProvider': NotRequired[bool], - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Inlay hint options used during static or dynamic registration. +class InitializeParams(TypedDict): + processId: Union[int, None] + """ The process Id of the parent process that started + the server. -@since 3.17.0 """ + Is `null` if the process has not been started by another process. + If the parent process is not alive then the server should exit. """ + clientInfo: NotRequired['ClientInfo'] + """ Information about the client + @since 3.15.0 """ + locale: NotRequired[str] + """ The locale the client is currently showing the user interface + in. This must not necessarily be the locale of the operating + system. -DocumentDiagnosticParams = TypedDict('DocumentDiagnosticParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The additional identifier provided during registration. - 'identifier': NotRequired[str], - # The result id of a previous response if provided. - 'previousResultId': NotRequired[str], - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters of the document diagnostic request. + Uses IETF language tags as the value's syntax + (See https://en.wikipedia.org/wiki/IETF_language_tag) -@since 3.17.0 """ + @since 3.16.0 """ + rootPath: NotRequired[Union[str, None]] + """ The rootPath of the workspace. Is null + if no folder is open. + + @deprecated in favour of rootUri. """ + rootUri: Union['DocumentUri', None] + """ The rootUri of the workspace. Is null if no + folder is open. If both `rootPath` and `rootUri` are set + `rootUri` wins. + + @deprecated in favour of workspaceFolders. """ + capabilities: 'ClientCapabilities' + """ The capabilities provided by the client (editor or tool) """ + initializationOptions: NotRequired['LSPAny'] + """ User provided initialization options. """ + trace: NotRequired['TraceValue'] + """ The initial trace setting. If omitted trace is disabled ('off'). """ + workspaceFolders: NotRequired[Union[List['WorkspaceFolder'], None]] + """ The workspace folders configured in the client when the server starts. + + This property is only available if the client supports workspace folders. + It can be `null` if the client supports workspace folders but none are + configured. + + @since 3.6.0 """ + + +class InitializeResult(TypedDict): + """ The result returned from an initialize request. """ + capabilities: 'ServerCapabilities' + """ The capabilities the language server provides. """ + serverInfo: NotRequired['ServerInfo'] + """ Information about the server. + @since 3.15.0 """ -DocumentDiagnosticReportPartialResult = TypedDict('DocumentDiagnosticReportPartialResult', { - 'relatedDocuments': Dict['DocumentUri', Union['FullDocumentDiagnosticReport', 'UnchangedDocumentDiagnosticReport']], -}) -""" A partial result for a document diagnostic report. -@since 3.17.0 """ +class InitializeError(TypedDict): + """ The data type of the ResponseError if the + initialize request fails. """ + retry: bool + """ Indicates whether the client execute the following retry logic: + (1) show the message provided by the ResponseError to the user + (2) user selects retry or cancel + (3) if user selected retry the initialize method is sent again. """ -DiagnosticServerCancellationData = TypedDict('DiagnosticServerCancellationData', { - 'retriggerRequest': bool, -}) -""" Cancellation data returned from a diagnostic request. +class InitializedParams(TypedDict): + pass -@since 3.17.0 """ +class DidChangeConfigurationParams(TypedDict): + """ The parameters of a change configuration notification. """ + settings: 'LSPAny' + """ The actual changed settings """ -DiagnosticRegistrationOptions = TypedDict('DiagnosticRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # An optional identifier under which the diagnostics are - # managed by the client. - 'identifier': NotRequired[str], - # Whether the language has inter file dependencies meaning that - # editing code in one file can result in a different diagnostic - # set in another file. Inter file dependencies are common for - # most programming languages and typically uncommon for linters. - 'interFileDependencies': bool, - # The server provides support for workspace diagnostics as well. - 'workspaceDiagnostics': bool, - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Diagnostic registration options. -@since 3.17.0 """ +class DidChangeConfigurationRegistrationOptions(TypedDict): + section: NotRequired[Union[str, List[str]]] -WorkspaceDiagnosticParams = TypedDict('WorkspaceDiagnosticParams', { - # The additional identifier provided during registration. - 'identifier': NotRequired[str], - # The currently known diagnostic reports with their - # previous result ids. - 'previousResultIds': List['PreviousResultId'], - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters of the workspace diagnostic request. +class ShowMessageParams(TypedDict): + """ The parameters of a notification message. """ + type: 'MessageType' + """ The message type. See {@link MessageType} """ + message: str + """ The actual message. """ -@since 3.17.0 """ +class ShowMessageRequestParams(TypedDict): + type: 'MessageType' + """ The message type. See {@link MessageType} """ + message: str + """ The actual message. """ + actions: NotRequired[List['MessageActionItem']] + """ The message action items to present. """ -WorkspaceDiagnosticReport = TypedDict('WorkspaceDiagnosticReport', { - 'items': List['WorkspaceDocumentDiagnosticReport'], -}) -""" A workspace diagnostic report. -@since 3.17.0 """ +class MessageActionItem(TypedDict): + title: str + """ A short title like 'Retry', 'Open Log' etc. """ -WorkspaceDiagnosticReportPartialResult = TypedDict('WorkspaceDiagnosticReportPartialResult', { - 'items': List['WorkspaceDocumentDiagnosticReport'], -}) -""" A partial result for a workspace diagnostic report. +class LogMessageParams(TypedDict): + """ The log message parameters. """ + type: 'MessageType' + """ The message type. See {@link MessageType} """ + message: str + """ The actual message. """ -@since 3.17.0 """ +class DidOpenTextDocumentParams(TypedDict): + """ The parameters sent in an open text document notification """ + textDocument: 'TextDocumentItem' + """ The document that was opened. """ -DidOpenNotebookDocumentParams = TypedDict('DidOpenNotebookDocumentParams', { - # The notebook document that got opened. - 'notebookDocument': 'NotebookDocument', - # The text documents that represent the content - # of a notebook cell. - 'cellTextDocuments': List['TextDocumentItem'], -}) -""" The params sent in an open notebook document notification. -@since 3.17.0 """ +class DidChangeTextDocumentParams(TypedDict): + """ The change text document notification's parameters. """ + textDocument: 'VersionedTextDocumentIdentifier' + """ The document that did change. The version number points + to the version after all provided content changes have + been applied. """ + contentChanges: List['TextDocumentContentChangeEvent'] + """ The actual content changes. The content changes describe single state changes + to the document. So if there are two content changes c1 (at array index 0) and + c2 (at array index 1) for a document in state S then c1 moves the document from + S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed + on the state S'. + To mirror the content of a document using change events use the following approach: + - start with the same initial content + - apply the 'textDocument/didChange' notifications in the order you receive them. + - apply the `TextDocumentContentChangeEvent`s in a single notification in the order + you receive them. """ -DidChangeNotebookDocumentParams = TypedDict('DidChangeNotebookDocumentParams', { - # The notebook document that did change. The version number points - # to the version after all provided changes have been applied. If - # only the text document content of a cell changes the notebook version - # doesn't necessarily have to change. - 'notebookDocument': 'VersionedNotebookDocumentIdentifier', - # The actual changes to the notebook document. - # - # The changes describe single state changes to the notebook document. - # So if there are two changes c1 (at array index 0) and c2 (at array - # index 1) for a notebook in state S then c1 moves the notebook from - # S to S' and c2 from S' to S''. So c1 is computed on the state S and - # c2 is computed on the state S'. - # - # To mirror the content of a notebook using change events use the following approach: - # - start with the same initial content - # - apply the 'notebookDocument/didChange' notifications in the order you receive them. - # - apply the `NotebookChangeEvent`s in a single notification in the order - # you receive them. - 'change': 'NotebookDocumentChangeEvent', -}) -""" The params sent in a change notebook document notification. -@since 3.17.0 """ +class TextDocumentChangeRegistrationOptions(TypedDict): + """ Describe options to be used when registered for text document change events. """ + syncKind: 'TextDocumentSyncKind' + """ How documents are synced to the server. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ -DidSaveNotebookDocumentParams = TypedDict('DidSaveNotebookDocumentParams', { - # The notebook document that got saved. - 'notebookDocument': 'NotebookDocumentIdentifier', -}) -""" The params sent in a save notebook document notification. +class DidCloseTextDocumentParams(TypedDict): + """ The parameters sent in a close text document notification """ + textDocument: 'TextDocumentIdentifier' + """ The document that was closed. """ -@since 3.17.0 """ +class DidSaveTextDocumentParams(TypedDict): + """ The parameters sent in a save text document notification """ + textDocument: 'TextDocumentIdentifier' + """ The document that was saved. """ + text: NotRequired[str] + """ Optional the content when saved. Depends on the includeText value + when the save notification was requested. """ -DidCloseNotebookDocumentParams = TypedDict('DidCloseNotebookDocumentParams', { - # The notebook document that got closed. - 'notebookDocument': 'NotebookDocumentIdentifier', - # The text documents that represent the content - # of a notebook cell that got closed. - 'cellTextDocuments': List['TextDocumentIdentifier'], -}) -""" The params sent in a close notebook document notification. -@since 3.17.0 """ +class TextDocumentSaveRegistrationOptions(TypedDict): + """ Save registration options. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + includeText: NotRequired[bool] + """ The client is supposed to include the content on save. """ -InlineCompletionParams = TypedDict('InlineCompletionParams', { - # Additional information about the context in which inline completions were - # requested. - 'context': 'InlineCompletionContext', - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" A parameter literal used in inline completion requests. +class WillSaveTextDocumentParams(TypedDict): + """ The parameters sent in a will save text document notification. """ + textDocument: 'TextDocumentIdentifier' + """ The document that will be saved. """ + reason: 'TextDocumentSaveReason' + """ The 'TextDocumentSaveReason'. """ -@since 3.18.0 -@proposed """ +class TextEdit(TypedDict): + """ A text edit applicable to a text document. """ + range: 'Range' + """ The range of the text document to be manipulated. To insert + text into a document create a range where start === end. """ + newText: str + """ The string to be inserted. For delete operations use an + empty string. """ -InlineCompletionList = TypedDict('InlineCompletionList', { - # The inline completion items - 'items': List['InlineCompletionItem'], -}) -""" Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor. -@since 3.18.0 -@proposed """ +class DidChangeWatchedFilesParams(TypedDict): + """ The watched files change notification's parameters. """ + changes: List['FileEvent'] + """ The actual file events. """ -InlineCompletionItem = TypedDict('InlineCompletionItem', { - # The text to replace the range with. Must be set. - 'insertText': Union[str, 'StringValue'], - # A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used. - 'filterText': NotRequired[str], - # The range to replace. Must begin and end on the same line. - 'range': NotRequired['Range'], - # An optional {@link Command} that is executed *after* inserting this completion. - 'command': NotRequired['Command'], -}) -""" An inline completion item represents a text snippet that is proposed inline to complete text that is being typed. +class DidChangeWatchedFilesRegistrationOptions(TypedDict): + """ Describe options to be used when registered for text document change events. """ + watchers: List['FileSystemWatcher'] + """ The watchers to register. """ + + +class PublishDiagnosticsParams(TypedDict): + """ The publish diagnostic notification's parameters. """ + uri: 'DocumentUri' + """ The URI for which diagnostic information is reported. """ + version: NotRequired[int] + """ Optional the version number of the document the diagnostics are published for. -@since 3.18.0 -@proposed """ + @since 3.15.0 """ + diagnostics: List['Diagnostic'] + """ An array of diagnostic information items. """ + + +class CompletionParams(TypedDict): + """ Completion parameters """ + context: NotRequired['CompletionContext'] + """ The completion context. This is only available it the client specifies + to send this using the client capability `textDocument.completion.contextSupport === true` """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class CompletionItem(TypedDict): + """ A completion item represents a text snippet that is + proposed to complete text that is being typed. """ + label: str + """ The label of this completion item. + + The label property is also by default the text that + is inserted when selecting this completion. + + If label details are provided the label itself should + be an unqualified name of the completion item. """ + labelDetails: NotRequired['CompletionItemLabelDetails'] + """ Additional details for the label + @since 3.17.0 """ + kind: NotRequired['CompletionItemKind'] + """ The kind of this completion item. Based of the kind + an icon is chosen by the editor. """ + tags: NotRequired[List['CompletionItemTag']] + """ Tags for this completion item. -InlineCompletionRegistrationOptions = TypedDict('InlineCompletionRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Inline completion options used during static or dynamic registration. + @since 3.15.0 """ + detail: NotRequired[str] + """ A human-readable string with additional information + about this item, like type or symbol information. """ + documentation: NotRequired[Union[str, 'MarkupContent']] + """ A human-readable string that represents a doc-comment. """ + deprecated: NotRequired[bool] + """ Indicates if this item is deprecated. + @deprecated Use `tags` instead. """ + preselect: NotRequired[bool] + """ Select this item when showing. + + *Note* that only one completion item can be selected and that the + tool / client decides which item that is. The rule is that the *first* + item of those that match best is selected. """ + sortText: NotRequired[str] + """ A string that should be used when comparing this item + with other items. When `falsy` the {@link CompletionItem.label label} + is used. """ + filterText: NotRequired[str] + """ A string that should be used when filtering a set of + completion items. When `falsy` the {@link CompletionItem.label label} + is used. """ + insertText: NotRequired[str] + """ A string that should be inserted into a document when selecting + this completion. When `falsy` the {@link CompletionItem.label label} + is used. + + The `insertText` is subject to interpretation by the client side. + Some tools might not take the string literally. For example + VS Code when code complete is requested in this example + `con` and a completion item with an `insertText` of + `console` is provided it will only insert `sole`. Therefore it is + recommended to use `textEdit` instead since it avoids additional client + side interpretation. """ + insertTextFormat: NotRequired['InsertTextFormat'] + """ The format of the insert text. The format applies to both the + `insertText` property and the `newText` property of a provided + `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`. + + Please note that the insertTextFormat doesn't apply to + `additionalTextEdits`. """ + insertTextMode: NotRequired['InsertTextMode'] + """ How whitespace and indentation is handled during completion + item insertion. If not provided the clients default value depends on + the `textDocument.completion.insertTextMode` client capability. -@since 3.18.0 -@proposed """ + @since 3.16.0 """ + textEdit: NotRequired[Union['TextEdit', 'InsertReplaceEdit']] + """ An {@link TextEdit edit} which is applied to a document when selecting + this completion. When an edit is provided the value of + {@link CompletionItem.insertText insertText} is ignored. + + Most editors support two different operations when accepting a completion + item. One is to insert a completion text and the other is to replace an + existing text with a completion text. Since this can usually not be + predetermined by a server it can report both ranges. Clients need to + signal support for `InsertReplaceEdits` via the + `textDocument.completion.insertReplaceSupport` client capability + property. + + *Note 1:* The text edit's range as well as both ranges from an insert + replace edit must be a [single line] and they must contain the position + at which completion has been requested. + *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range + must be a prefix of the edit's replace range, that means it must be + contained and starting at the same position. + + @since 3.16.0 additional type `InsertReplaceEdit` """ + textEditText: NotRequired[str] + """ The edit text used if the completion item is part of a CompletionList and + CompletionList defines an item default for the text edit range. + + Clients will only honor this property if they opt into completion list + item defaults using the capability `completionList.itemDefaults`. + + If not provided and a list's default range is provided the label + property is used as a text. + @since 3.17.0 """ + additionalTextEdits: NotRequired[List['TextEdit']] + """ An optional array of additional {@link TextEdit text edits} that are applied when + selecting this completion. Edits must not overlap (including the same insert position) + with the main {@link CompletionItem.textEdit edit} nor with themselves. + + Additional text edits should be used to change text unrelated to the current cursor position + (for example adding an import statement at the top of the file if the completion item will + insert an unqualified type). """ + commitCharacters: NotRequired[List[str]] + """ An optional set of characters that when pressed while this completion is active will accept it first and + then type that character. *Note* that all commit characters should have `length=1` and that superfluous + characters will be ignored. """ + command: NotRequired['Command'] + """ An optional {@link Command command} that is executed *after* inserting this completion. *Note* that + additional modifications to the current document should be described with the + {@link CompletionItem.additionalTextEdits additionalTextEdits}-property. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved on a completion item between a + {@link CompletionRequest} and a {@link CompletionResolveRequest}. """ + + +class CompletionList(TypedDict): + """ Represents a collection of {@link CompletionItem completion items} to be presented + in the editor. """ + isIncomplete: bool + """ This list it not complete. Further typing results in recomputing this list. + + Recomputed lists have all their items replaced (not appended) in the + incomplete completion sessions. """ + itemDefaults: NotRequired['CompletionItemDefaults'] + """ In many cases the items of an actual completion result share the same + value for properties like `commitCharacters` or the range of a text + edit. A completion list can therefore define item defaults which will + be used if a completion item itself doesn't specify the value. + + If a completion list specifies a default value and a completion item + also specifies a corresponding value the one from the item is used. + + Servers are only allowed to return default values if the client + signals support for this via the `completionList.itemDefaults` + capability. -RegistrationParams = TypedDict('RegistrationParams', { - 'registrations': List['Registration'], -}) + @since 3.17.0 """ + items: List['CompletionItem'] + """ The completion items. """ + + +class CompletionRegistrationOptions(TypedDict): + """ Registration options for a {@link CompletionRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + triggerCharacters: NotRequired[List[str]] + """ Most tools trigger completion request automatically without explicitly requesting + it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user + starts to type an identifier. For example if the user types `c` in a JavaScript file + code complete will automatically pop up present `console` besides others as a + completion item. Characters that make up identifiers don't need to be listed here. + + If code complete should automatically be trigger on characters not being valid inside + an identifier (for example `.` in JavaScript) list them in `triggerCharacters`. """ + allCommitCharacters: NotRequired[List[str]] + """ The list of all possible characters that commit a completion. This field can be used + if clients don't support individual commit characters per completion item. See + `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport` + + If a server provides both `allCommitCharacters` and commit characters on an individual + completion item the ones on the completion item win. + + @since 3.2.0 """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for a completion item. """ + completionItem: NotRequired['ServerCompletionItemOptions'] + """ The server supports the following `CompletionItem` specific + capabilities. + @since 3.17.0 """ -UnregistrationParams = TypedDict('UnregistrationParams', { - 'unregisterations': List['Unregistration'], -}) +class HoverParams(TypedDict): + """ Parameters for a {@link HoverRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -InitializeParams = TypedDict('InitializeParams', { - # The process Id of the parent process that started - # the server. - # - # Is `null` if the process has not been started by another process. - # If the parent process is not alive then the server should exit. - 'processId': Union[int, None], - # Information about the client - # - # @since 3.15.0 - 'clientInfo': NotRequired['___InitializeParams_clientInfo_Type_1'], - # The locale the client is currently showing the user interface - # in. This must not necessarily be the locale of the operating - # system. - # - # Uses IETF language tags as the value's syntax - # (See https://en.wikipedia.org/wiki/IETF_language_tag) - # - # @since 3.16.0 - 'locale': NotRequired[str], - # The rootPath of the workspace. Is null - # if no folder is open. - # - # @deprecated in favour of rootUri. - 'rootPath': NotRequired[Union[str, None]], - # The rootUri of the workspace. Is null if no - # folder is open. If both `rootPath` and `rootUri` are set - # `rootUri` wins. - # - # @deprecated in favour of workspaceFolders. - 'rootUri': Union['DocumentUri', None], - # The capabilities provided by the client (editor or tool) - 'capabilities': 'ClientCapabilities', - # User provided initialization options. - 'initializationOptions': NotRequired['LSPAny'], - # The initial trace setting. If omitted trace is disabled ('off'). - 'trace': NotRequired['TraceValues'], - # The workspace folders configured in the client when the server starts. - # - # This property is only available if the client supports workspace folders. - # It can be `null` if the client supports workspace folders but none are - # configured. - # - # @since 3.6.0 - 'workspaceFolders': NotRequired[Union[List['WorkspaceFolder'], None]], -}) +class Hover(TypedDict): + """ The result of a hover request. """ + contents: Union['MarkupContent', 'MarkedString', List['MarkedString']] + """ The hover's content """ + range: NotRequired['Range'] + """ An optional range inside the text document that is used to + visualize the hover, e.g. by changing the background color. """ -InitializeResult = TypedDict('InitializeResult', { - # The capabilities the language server provides. - 'capabilities': 'ServerCapabilities', - # Information about the server. - # - # @since 3.15.0 - 'serverInfo': NotRequired['__InitializeResult_serverInfo_Type_1'], -}) -""" The result returned from an initialize request. """ +class HoverRegistrationOptions(TypedDict): + """ Registration options for a {@link HoverRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ -InitializeError = TypedDict('InitializeError', { - # Indicates whether the client execute the following retry logic: - # (1) show the message provided by the ResponseError to the user - # (2) user selects retry or cancel - # (3) if user selected retry the initialize method is sent again. - 'retry': bool, -}) -""" The data type of the ResponseError if the -initialize request fails. """ +class SignatureHelpParams(TypedDict): + """ Parameters for a {@link SignatureHelpRequest}. """ + context: NotRequired['SignatureHelpContext'] + """ The signature help context. This is only available if the client specifies + to send this using the client capability `textDocument.signatureHelp.contextSupport === true` -InitializedParams = TypedDict('InitializedParams', { + @since 3.15.0 """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + + +class SignatureHelp(TypedDict): + """ Signature help represents the signature of something + callable. There can be multiple signature but only one + active and only one active parameter. """ + signatures: List['SignatureInformation'] + """ One or more signatures. """ + activeSignature: NotRequired[Uint] + """ The active signature. If omitted or the value lies outside the + range of `signatures` the value defaults to zero or is ignored if + the `SignatureHelp` has no signatures. + + Whenever possible implementors should make an active decision about + the active signature and shouldn't rely on a default value. + + In future version of the protocol this property might become + mandatory to better express this. """ + activeParameter: NotRequired[Union[Uint, None]] + """ The active parameter of the active signature. + + If `null`, no parameter of the signature is active (for example a named + argument that does not match any declared parameters). This is only valid + if the client specifies the client capability + `textDocument.signatureHelp.noActiveParameterSupport === true` + + If omitted or the value lies outside the range of + `signatures[activeSignature].parameters` defaults to 0 if the active + signature has parameters. + + If the active signature has no parameters it is ignored. + + In future version of the protocol this property might become + mandatory (but still nullable) to better express the active parameter if + the active signature does have any. """ + + +class SignatureHelpRegistrationOptions(TypedDict): + """ Registration options for a {@link SignatureHelpRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + triggerCharacters: NotRequired[List[str]] + """ List of characters that trigger signature help automatically. """ + retriggerCharacters: NotRequired[List[str]] + """ List of characters that re-trigger signature help. + + These trigger characters are only active when signature help is already showing. All trigger characters + are also counted as re-trigger characters. -}) + @since 3.15.0 """ -DidChangeConfigurationParams = TypedDict('DidChangeConfigurationParams', { - # The actual changed settings - 'settings': 'LSPAny', -}) -""" The parameters of a change configuration notification. """ +class DefinitionParams(TypedDict): + """ Parameters for a {@link DefinitionRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class DefinitionRegistrationOptions(TypedDict): + """ Registration options for a {@link DefinitionRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + + +class ReferenceParams(TypedDict): + """ Parameters for a {@link ReferencesRequest}. """ + context: 'ReferenceContext' + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class ReferenceRegistrationOptions(TypedDict): + """ Registration options for a {@link ReferencesRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + + +class DocumentHighlightParams(TypedDict): + """ Parameters for a {@link DocumentHighlightRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class DocumentHighlight(TypedDict): + """ A document highlight is a range inside a text document which deserves + special attention. Usually a document highlight is visualized by changing + the background color of its range. """ + range: 'Range' + """ The range this highlight applies to. """ + kind: NotRequired['DocumentHighlightKind'] + """ The highlight kind, default is {@link DocumentHighlightKind.Text text}. """ + + +class DocumentHighlightRegistrationOptions(TypedDict): + """ Registration options for a {@link DocumentHighlightRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + + +class DocumentSymbolParams(TypedDict): + """ Parameters for a {@link DocumentSymbolRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class SymbolInformation(TypedDict): + """ Represents information about programming constructs like variables, classes, + interfaces etc. """ + deprecated: NotRequired[bool] + """ Indicates if this symbol is deprecated. + + @deprecated Use tags instead """ + location: 'Location' + """ The location of this symbol. The location's range is used by a tool + to reveal the location in the editor. If the symbol is selected in the + tool the range's start information is used to position the cursor. So + the range usually spans more than the actual symbol's name and does + normally include things like visibility modifiers. + + The range doesn't have to denote a node range in the sense of an abstract + syntax tree. It can therefore not be used to re-construct a hierarchy of + the symbols. """ + name: str + """ The name of this symbol. """ + kind: 'SymbolKind' + """ The kind of this symbol. """ + tags: NotRequired[List['SymbolTag']] + """ Tags for this symbol. + @since 3.16.0 """ + containerName: NotRequired[str] + """ The name of the symbol containing this symbol. This information is for + user interface purposes (e.g. to render a qualifier in the user interface + if necessary). It can't be used to re-infer a hierarchy for the document + symbols. """ + + +class DocumentSymbol(TypedDict): + """ Represents programming constructs like variables, classes, interfaces etc. + that appear in a document. Document symbols can be hierarchical and they + have two ranges: one that encloses its definition and one that points to + its most interesting range, e.g. the range of an identifier. """ + name: str + """ The name of this symbol. Will be displayed in the user interface and therefore must not be + an empty string or a string only consisting of white spaces. """ + detail: NotRequired[str] + """ More detail for this symbol, e.g the signature of a function. """ + kind: 'SymbolKind' + """ The kind of this symbol. """ + tags: NotRequired[List['SymbolTag']] + """ Tags for this document symbol. -DidChangeConfigurationRegistrationOptions = TypedDict('DidChangeConfigurationRegistrationOptions', { - 'section': NotRequired[Union[str, List[str]]], -}) + @since 3.16.0 """ + deprecated: NotRequired[bool] + """ Indicates if this symbol is deprecated. + + @deprecated Use tags instead """ + range: 'Range' + """ The range enclosing this symbol not including leading/trailing whitespace but everything else + like comments. This information is typically used to determine if the clients cursor is + inside the symbol to reveal in the symbol in the UI. """ + selectionRange: 'Range' + """ The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. + Must be contained by the `range`. """ + children: NotRequired[List['DocumentSymbol']] + """ Children of this symbol, e.g. properties of a class. """ + + +class DocumentSymbolRegistrationOptions(TypedDict): + """ Registration options for a {@link DocumentSymbolRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + label: NotRequired[str] + """ A human-readable string that is shown when multiple outlines trees + are shown for the same document. + @since 3.16.0 """ -ShowMessageParams = TypedDict('ShowMessageParams', { - # The message type. See {@link MessageType} - 'type': 'MessageType', - # The actual message. - 'message': str, -}) -""" The parameters of a notification message. """ +class CodeActionParams(TypedDict): + """ The parameters of a {@link CodeActionRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The document in which the command was invoked. """ + range: 'Range' + """ The range for which the command was invoked. """ + context: 'CodeActionContext' + """ Context carrying additional information. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class Command(TypedDict): + """ Represents a reference to a command. Provides a title which + will be used to represent a command in the UI and, optionally, + an array of arguments which will be passed to the command handler + function when invoked. """ + title: str + """ Title of the command, like `save`. """ + tooltip: NotRequired[str] + """ An optional tooltip. -ShowMessageRequestParams = TypedDict('ShowMessageRequestParams', { - # The message type. See {@link MessageType} - 'type': 'MessageType', - # The actual message. - 'message': str, - # The message action items to present. - 'actions': NotRequired[List['MessageActionItem']], -}) + @since 3.18.0 + @proposed """ + command: str + """ The identifier of the actual command handler. """ + arguments: NotRequired[List['LSPAny']] + """ Arguments that the command handler should be + invoked with. """ -MessageActionItem = TypedDict('MessageActionItem', { - # A short title like 'Retry', 'Open Log' etc. - 'title': str, -}) +class CodeAction(TypedDict): + """ A code action represents a change that can be performed in code, e.g. to fix a problem or + to refactor code. + A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed. """ + title: str + """ A short, human-readable, title for this code action. """ + kind: NotRequired['CodeActionKind'] + """ The kind of the code action. -LogMessageParams = TypedDict('LogMessageParams', { - # The message type. See {@link MessageType} - 'type': 'MessageType', - # The actual message. - 'message': str, -}) -""" The log message parameters. """ + Used to filter code actions. """ + diagnostics: NotRequired[List['Diagnostic']] + """ The diagnostics that this code action resolves. """ + isPreferred: NotRequired[bool] + """ Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted + by keybindings. + A quick fix should be marked preferred if it properly addresses the underlying error. + A refactoring should be marked preferred if it is the most reasonable choice of actions to take. -DidOpenTextDocumentParams = TypedDict('DidOpenTextDocumentParams', { - # The document that was opened. - 'textDocument': 'TextDocumentItem', -}) -""" The parameters sent in an open text document notification """ - - -DidChangeTextDocumentParams = TypedDict('DidChangeTextDocumentParams', { - # The document that did change. The version number points - # to the version after all provided content changes have - # been applied. - 'textDocument': 'VersionedTextDocumentIdentifier', - # The actual content changes. The content changes describe single state changes - # to the document. So if there are two content changes c1 (at array index 0) and - # c2 (at array index 1) for a document in state S then c1 moves the document from - # S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed - # on the state S'. - # - # To mirror the content of a document using change events use the following approach: - # - start with the same initial content - # - apply the 'textDocument/didChange' notifications in the order you receive them. - # - apply the `TextDocumentContentChangeEvent`s in a single notification in the order - # you receive them. - 'contentChanges': List['TextDocumentContentChangeEvent'], -}) -""" The change text document notification's parameters. """ + @since 3.15.0 """ + disabled: NotRequired['CodeActionDisabled'] + """ Marks that the code action cannot currently be applied. + Clients should follow the following guidelines regarding disabled code actions: -TextDocumentChangeRegistrationOptions = TypedDict('TextDocumentChangeRegistrationOptions', { - # How documents are synced to the server. - 'syncKind': 'TextDocumentSyncKind', - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) -""" Describe options to be used when registered for text document change events. """ + - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) + code action menus. + - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type + of code action, such as refactorings. -DidCloseTextDocumentParams = TypedDict('DidCloseTextDocumentParams', { - # The document that was closed. - 'textDocument': 'TextDocumentIdentifier', -}) -""" The parameters sent in a close text document notification """ + - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions) + that auto applies a code action and only disabled code actions are returned, the client should show the user an + error message with `reason` in the editor. + @since 3.16.0 """ + edit: NotRequired['WorkspaceEdit'] + """ The workspace edit this code action performs. """ + command: NotRequired['Command'] + """ A command this code action executes. If a code action + provides an edit and a command, first the edit is + executed and then the command. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved on a code action between + a `textDocument/codeAction` and a `codeAction/resolve` request. -DidSaveTextDocumentParams = TypedDict('DidSaveTextDocumentParams', { - # The document that was saved. - 'textDocument': 'TextDocumentIdentifier', - # Optional the content when saved. Depends on the includeText value - # when the save notification was requested. - 'text': NotRequired[str], -}) -""" The parameters sent in a save text document notification """ + @since 3.16.0 """ -TextDocumentSaveRegistrationOptions = TypedDict('TextDocumentSaveRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # The client is supposed to include the content on save. - 'includeText': NotRequired[bool], -}) -""" Save registration options. """ +class CodeActionRegistrationOptions(TypedDict): + """ Registration options for a {@link CodeActionRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + codeActionKinds: NotRequired[List['CodeActionKind']] + """ CodeActionKinds that this server may return. + The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server + may list out every specific kind they provide. """ + documentation: NotRequired[List['CodeActionKindDocumentation']] + """ Static documentation for a class of code actions. -WillSaveTextDocumentParams = TypedDict('WillSaveTextDocumentParams', { - # The document that will be saved. - 'textDocument': 'TextDocumentIdentifier', - # The 'TextDocumentSaveReason'. - 'reason': 'TextDocumentSaveReason', -}) -""" The parameters sent in a will save text document notification. """ + Documentation from the provider should be shown in the code actions menu if either: + - Code actions of `kind` are requested by the editor. In this case, the editor will show the documentation that + most closely matches the requested code action kind. For example, if a provider has documentation for + both `Refactor` and `RefactorExtract`, when the user requests code actions for `RefactorExtract`, + the editor will use the documentation for `RefactorExtract` instead of the documentation for `Refactor`. -TextEdit = TypedDict('TextEdit', { - # The range of the text document to be manipulated. To insert - # text into a document create a range where start === end. - 'range': 'Range', - # The string to be inserted. For delete operations use an - # empty string. - 'newText': str, -}) -""" A text edit applicable to a text document. """ + - Any code actions of `kind` are returned by the provider. + At most one documentation entry should be shown per provider. -DidChangeWatchedFilesParams = TypedDict('DidChangeWatchedFilesParams', { - # The actual file events. - 'changes': List['FileEvent'], -}) -""" The watched files change notification's parameters. """ + @since 3.18.0 + @proposed """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for a code action. + @since 3.16.0 """ -DidChangeWatchedFilesRegistrationOptions = TypedDict('DidChangeWatchedFilesRegistrationOptions', { - # The watchers to register. - 'watchers': List['FileSystemWatcher'], -}) -""" Describe options to be used when registered for text document change events. """ - - -PublishDiagnosticsParams = TypedDict('PublishDiagnosticsParams', { - # The URI for which diagnostic information is reported. - 'uri': 'DocumentUri', - # Optional the version number of the document the diagnostics are published for. - # - # @since 3.15.0 - 'version': NotRequired[int], - # An array of diagnostic information items. - 'diagnostics': List['Diagnostic'], -}) -""" The publish diagnostic notification's parameters. """ - - -CompletionParams = TypedDict('CompletionParams', { - # The completion context. This is only available it the client specifies - # to send this using the client capability `textDocument.completion.contextSupport === true` - 'context': NotRequired['CompletionContext'], - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Completion parameters """ - - -CompletionItem = TypedDict('CompletionItem', { - # The label of this completion item. - # - # The label property is also by default the text that - # is inserted when selecting this completion. - # - # If label details are provided the label itself should - # be an unqualified name of the completion item. - 'label': str, - # Additional details for the label - # - # @since 3.17.0 - 'labelDetails': NotRequired['CompletionItemLabelDetails'], - # The kind of this completion item. Based of the kind - # an icon is chosen by the editor. - 'kind': NotRequired['CompletionItemKind'], - # Tags for this completion item. - # - # @since 3.15.0 - 'tags': NotRequired[List['CompletionItemTag']], - # A human-readable string with additional information - # about this item, like type or symbol information. - 'detail': NotRequired[str], - # A human-readable string that represents a doc-comment. - 'documentation': NotRequired[Union[str, 'MarkupContent']], - # Indicates if this item is deprecated. - # @deprecated Use `tags` instead. - 'deprecated': NotRequired[bool], - # Select this item when showing. - # - # *Note* that only one completion item can be selected and that the - # tool / client decides which item that is. The rule is that the *first* - # item of those that match best is selected. - 'preselect': NotRequired[bool], - # A string that should be used when comparing this item - # with other items. When `falsy` the {@link CompletionItem.label label} - # is used. - 'sortText': NotRequired[str], - # A string that should be used when filtering a set of - # completion items. When `falsy` the {@link CompletionItem.label label} - # is used. - 'filterText': NotRequired[str], - # A string that should be inserted into a document when selecting - # this completion. When `falsy` the {@link CompletionItem.label label} - # is used. - # - # The `insertText` is subject to interpretation by the client side. - # Some tools might not take the string literally. For example - # VS Code when code complete is requested in this example - # `con` and a completion item with an `insertText` of - # `console` is provided it will only insert `sole`. Therefore it is - # recommended to use `textEdit` instead since it avoids additional client - # side interpretation. - 'insertText': NotRequired[str], - # The format of the insert text. The format applies to both the - # `insertText` property and the `newText` property of a provided - # `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`. - # - # Please note that the insertTextFormat doesn't apply to - # `additionalTextEdits`. - 'insertTextFormat': NotRequired['InsertTextFormat'], - # How whitespace and indentation is handled during completion - # item insertion. If not provided the clients default value depends on - # the `textDocument.completion.insertTextMode` client capability. - # - # @since 3.16.0 - 'insertTextMode': NotRequired['InsertTextMode'], - # An {@link TextEdit edit} which is applied to a document when selecting - # this completion. When an edit is provided the value of - # {@link CompletionItem.insertText insertText} is ignored. - # - # Most editors support two different operations when accepting a completion - # item. One is to insert a completion text and the other is to replace an - # existing text with a completion text. Since this can usually not be - # predetermined by a server it can report both ranges. Clients need to - # signal support for `InsertReplaceEdits` via the - # `textDocument.completion.insertReplaceSupport` client capability - # property. - # - # *Note 1:* The text edit's range as well as both ranges from an insert - # replace edit must be a [single line] and they must contain the position - # at which completion has been requested. - # *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range - # must be a prefix of the edit's replace range, that means it must be - # contained and starting at the same position. - # - # @since 3.16.0 additional type `InsertReplaceEdit` - 'textEdit': NotRequired[Union['TextEdit', 'InsertReplaceEdit']], - # The edit text used if the completion item is part of a CompletionList and - # CompletionList defines an item default for the text edit range. - # - # Clients will only honor this property if they opt into completion list - # item defaults using the capability `completionList.itemDefaults`. - # - # If not provided and a list's default range is provided the label - # property is used as a text. - # - # @since 3.17.0 - 'textEditText': NotRequired[str], - # An optional array of additional {@link TextEdit text edits} that are applied when - # selecting this completion. Edits must not overlap (including the same insert position) - # with the main {@link CompletionItem.textEdit edit} nor with themselves. - # - # Additional text edits should be used to change text unrelated to the current cursor position - # (for example adding an import statement at the top of the file if the completion item will - # insert an unqualified type). - 'additionalTextEdits': NotRequired[List['TextEdit']], - # An optional set of characters that when pressed while this completion is active will accept it first and - # then type that character. *Note* that all commit characters should have `length=1` and that superfluous - # characters will be ignored. - 'commitCharacters': NotRequired[List[str]], - # An optional {@link Command command} that is executed *after* inserting this completion. *Note* that - # additional modifications to the current document should be described with the - # {@link CompletionItem.additionalTextEdits additionalTextEdits}-property. - 'command': NotRequired['Command'], - # A data entry field that is preserved on a completion item between a - # {@link CompletionRequest} and a {@link CompletionResolveRequest}. - 'data': NotRequired['LSPAny'], -}) -""" A completion item represents a text snippet that is -proposed to complete text that is being typed. """ - - -CompletionList = TypedDict('CompletionList', { - # This list it not complete. Further typing results in recomputing this list. - # - # Recomputed lists have all their items replaced (not appended) in the - # incomplete completion sessions. - 'isIncomplete': bool, - # In many cases the items of an actual completion result share the same - # value for properties like `commitCharacters` or the range of a text - # edit. A completion list can therefore define item defaults which will - # be used if a completion item itself doesn't specify the value. - # - # If a completion list specifies a default value and a completion item - # also specifies a corresponding value the one from the item is used. - # - # Servers are only allowed to return default values if the client - # signals support for this via the `completionList.itemDefaults` - # capability. - # - # @since 3.17.0 - 'itemDefaults': NotRequired['__CompletionList_itemDefaults_Type_1'], - # The completion items. - 'items': List['CompletionItem'], -}) -""" Represents a collection of {@link CompletionItem completion items} to be presented -in the editor. """ - - -CompletionRegistrationOptions = TypedDict('CompletionRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # Most tools trigger completion request automatically without explicitly requesting - # it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user - # starts to type an identifier. For example if the user types `c` in a JavaScript file - # code complete will automatically pop up present `console` besides others as a - # completion item. Characters that make up identifiers don't need to be listed here. - # - # If code complete should automatically be trigger on characters not being valid inside - # an identifier (for example `.` in JavaScript) list them in `triggerCharacters`. - 'triggerCharacters': NotRequired[List[str]], - # The list of all possible characters that commit a completion. This field can be used - # if clients don't support individual commit characters per completion item. See - # `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport` - # - # If a server provides both `allCommitCharacters` and commit characters on an individual - # completion item the ones on the completion item win. - # - # @since 3.2.0 - 'allCommitCharacters': NotRequired[List[str]], - # The server provides support to resolve additional - # information for a completion item. - 'resolveProvider': NotRequired[bool], - # The server supports the following `CompletionItem` specific - # capabilities. - # - # @since 3.17.0 - 'completionItem': NotRequired['__CompletionOptions_completionItem_Type_1'], -}) -""" Registration options for a {@link CompletionRequest}. """ +class WorkspaceSymbolParams(TypedDict): + """ The parameters of a {@link WorkspaceSymbolRequest}. """ + query: str + """ A query string to filter symbols by. Clients may send an empty + string here to request all symbols. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -HoverParams = TypedDict('HoverParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link HoverRequest}. """ +class WorkspaceSymbol(TypedDict): + """ A special workspace symbol that supports locations without a range. -Hover = TypedDict('Hover', { - # The hover's content - 'contents': Union['MarkupContent', 'MarkedString', List['MarkedString']], - # An optional range inside the text document that is used to - # visualize the hover, e.g. by changing the background color. - 'range': NotRequired['Range'], -}) -""" The result of a hover request. """ + See also SymbolInformation. + @since 3.17.0 """ + location: Union['Location', 'LocationUriOnly'] + """ The location of the symbol. Whether a server is allowed to + return a location without a range depends on the client + capability `workspace.symbol.resolveSupport`. + + See SymbolInformation#location for more details. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved on a workspace symbol between a + workspace symbol request and a workspace symbol resolve request. """ + name: str + """ The name of this symbol. """ + kind: 'SymbolKind' + """ The kind of this symbol. """ + tags: NotRequired[List['SymbolTag']] + """ Tags for this symbol. -HoverRegistrationOptions = TypedDict('HoverRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) -""" Registration options for a {@link HoverRequest}. """ - - -SignatureHelpParams = TypedDict('SignatureHelpParams', { - # The signature help context. This is only available if the client specifies - # to send this using the client capability `textDocument.signatureHelp.contextSupport === true` - # - # @since 3.15.0 - 'context': NotRequired['SignatureHelpContext'], - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link SignatureHelpRequest}. """ - - -SignatureHelp = TypedDict('SignatureHelp', { - # One or more signatures. - 'signatures': List['SignatureInformation'], - # The active signature. If omitted or the value lies outside the - # range of `signatures` the value defaults to zero or is ignored if - # the `SignatureHelp` has no signatures. - # - # Whenever possible implementors should make an active decision about - # the active signature and shouldn't rely on a default value. - # - # In future version of the protocol this property might become - # mandatory to better express this. - 'activeSignature': NotRequired[Uint], - # The active parameter of the active signature. If omitted or the value - # lies outside the range of `signatures[activeSignature].parameters` - # defaults to 0 if the active signature has parameters. If - # the active signature has no parameters it is ignored. - # In future version of the protocol this property might become - # mandatory to better express the active parameter if the - # active signature does have any. - 'activeParameter': NotRequired[Uint], -}) -""" Signature help represents the signature of something -callable. There can be multiple signature but only one -active and only one active parameter. """ - - -SignatureHelpRegistrationOptions = TypedDict('SignatureHelpRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # List of characters that trigger signature help automatically. - 'triggerCharacters': NotRequired[List[str]], - # List of characters that re-trigger signature help. - # - # These trigger characters are only active when signature help is already showing. All trigger characters - # are also counted as re-trigger characters. - # - # @since 3.15.0 - 'retriggerCharacters': NotRequired[List[str]], -}) -""" Registration options for a {@link SignatureHelpRequest}. """ - - -DefinitionParams = TypedDict('DefinitionParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link DefinitionRequest}. """ + @since 3.16.0 """ + containerName: NotRequired[str] + """ The name of the symbol containing this symbol. This information is for + user interface purposes (e.g. to render a qualifier in the user interface + if necessary). It can't be used to re-infer a hierarchy for the document + symbols. """ -DefinitionRegistrationOptions = TypedDict('DefinitionRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) -""" Registration options for a {@link DefinitionRequest}. """ - - -ReferenceParams = TypedDict('ReferenceParams', { - 'context': 'ReferenceContext', - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link ReferencesRequest}. """ +class WorkspaceSymbolRegistrationOptions(TypedDict): + """ Registration options for a {@link WorkspaceSymbolRequest}. """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for a workspace symbol. + @since 3.17.0 """ -ReferenceRegistrationOptions = TypedDict('ReferenceRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) -""" Registration options for a {@link ReferencesRequest}. """ - - -DocumentHighlightParams = TypedDict('DocumentHighlightParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link DocumentHighlightRequest}. """ +class CodeLensParams(TypedDict): + """ The parameters of a {@link CodeLensRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The document to request code lens for. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class CodeLens(TypedDict): + """ A code lens represents a {@link Command command} that should be shown along with + source text, like the number of references, a way to run tests, etc. + + A code lens is _unresolved_ when no command is associated to it. For performance + reasons the creation of a code lens and resolving should be done in two stages. """ + range: 'Range' + """ The range in which this code lens is valid. Should only span a single line. """ + command: NotRequired['Command'] + """ The command this code lens represents. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved on a code lens item between + a {@link CodeLensRequest} and a {@link CodeLensResolveRequest} """ + + +class CodeLensRegistrationOptions(TypedDict): + """ Registration options for a {@link CodeLensRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + resolveProvider: NotRequired[bool] + """ Code lens has a resolve provider as well. """ + + +class DocumentLinkParams(TypedDict): + """ The parameters of a {@link DocumentLinkRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The document to provide document links for. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ + + +class DocumentLink(TypedDict): + """ A document link is a range in a text document that links to an internal or external resource, like another + text document or a web site. """ + range: 'Range' + """ The range this link applies to. """ + target: NotRequired['URI'] + """ The uri this link points to. If missing a resolve request is sent later. """ + tooltip: NotRequired[str] + """ The tooltip text when you hover over this link. + + If a tooltip is provided, is will be displayed in a string that includes instructions on how to + trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, + user settings, and localization. -DocumentHighlight = TypedDict('DocumentHighlight', { - # The range this highlight applies to. - 'range': 'Range', - # The highlight kind, default is {@link DocumentHighlightKind.Text text}. - 'kind': NotRequired['DocumentHighlightKind'], -}) -""" A document highlight is a range inside a text document which deserves -special attention. Usually a document highlight is visualized by changing -the background color of its range. """ + @since 3.15.0 """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved on a document link between a + DocumentLinkRequest and a DocumentLinkResolveRequest. """ + + +class DocumentLinkRegistrationOptions(TypedDict): + """ Registration options for a {@link DocumentLinkRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + resolveProvider: NotRequired[bool] + """ Document links have a resolve provider as well. """ + + +class DocumentFormattingParams(TypedDict): + """ The parameters of a {@link DocumentFormattingRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The document to format. """ + options: 'FormattingOptions' + """ The format options. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + + +class DocumentFormattingRegistrationOptions(TypedDict): + """ Registration options for a {@link DocumentFormattingRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + + +class DocumentRangeFormattingParams(TypedDict): + """ The parameters of a {@link DocumentRangeFormattingRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The document to format. """ + range: 'Range' + """ The range to format """ + options: 'FormattingOptions' + """ The format options """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + + +class DocumentRangeFormattingRegistrationOptions(TypedDict): + """ Registration options for a {@link DocumentRangeFormattingRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + rangesSupport: NotRequired[bool] + """ Whether the server supports formatting multiple ranges at once. + @since 3.18.0 + @proposed """ -DocumentHighlightRegistrationOptions = TypedDict('DocumentHighlightRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) -""" Registration options for a {@link DocumentHighlightRequest}. """ +class DocumentRangesFormattingParams(TypedDict): + """ The parameters of a {@link DocumentRangesFormattingRequest}. -DocumentSymbolParams = TypedDict('DocumentSymbolParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" Parameters for a {@link DocumentSymbolRequest}. """ - - -SymbolInformation = TypedDict('SymbolInformation', { - # Indicates if this symbol is deprecated. - # - # @deprecated Use tags instead - 'deprecated': NotRequired[bool], - # The location of this symbol. The location's range is used by a tool - # to reveal the location in the editor. If the symbol is selected in the - # tool the range's start information is used to position the cursor. So - # the range usually spans more than the actual symbol's name and does - # normally include things like visibility modifiers. - # - # The range doesn't have to denote a node range in the sense of an abstract - # syntax tree. It can therefore not be used to re-construct a hierarchy of - # the symbols. - 'location': 'Location', - # The name of this symbol. - 'name': str, - # The kind of this symbol. - 'kind': 'SymbolKind', - # Tags for this symbol. - # - # @since 3.16.0 - 'tags': NotRequired[List['SymbolTag']], - # The name of the symbol containing this symbol. This information is for - # user interface purposes (e.g. to render a qualifier in the user interface - # if necessary). It can't be used to re-infer a hierarchy for the document - # symbols. - 'containerName': NotRequired[str], -}) -""" Represents information about programming constructs like variables, classes, -interfaces etc. """ - - -DocumentSymbol = TypedDict('DocumentSymbol', { - # The name of this symbol. Will be displayed in the user interface and therefore must not be - # an empty string or a string only consisting of white spaces. - 'name': str, - # More detail for this symbol, e.g the signature of a function. - 'detail': NotRequired[str], - # The kind of this symbol. - 'kind': 'SymbolKind', - # Tags for this document symbol. - # - # @since 3.16.0 - 'tags': NotRequired[List['SymbolTag']], - # Indicates if this symbol is deprecated. - # - # @deprecated Use tags instead - 'deprecated': NotRequired[bool], - # The range enclosing this symbol not including leading/trailing whitespace but everything else - # like comments. This information is typically used to determine if the clients cursor is - # inside the symbol to reveal in the symbol in the UI. - 'range': 'Range', - # The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. - # Must be contained by the `range`. - 'selectionRange': 'Range', - # Children of this symbol, e.g. properties of a class. - 'children': NotRequired[List['DocumentSymbol']], -}) -""" Represents programming constructs like variables, classes, interfaces etc. -that appear in a document. Document symbols can be hierarchical and they -have two ranges: one that encloses its definition and one that points to -its most interesting range, e.g. the range of an identifier. """ - - -DocumentSymbolRegistrationOptions = TypedDict('DocumentSymbolRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # A human-readable string that is shown when multiple outlines trees - # are shown for the same document. - # - # @since 3.16.0 - 'label': NotRequired[str], -}) -""" Registration options for a {@link DocumentSymbolRequest}. """ + @since 3.18.0 + @proposed """ + textDocument: 'TextDocumentIdentifier' + """ The document to format. """ + ranges: List['Range'] + """ The ranges to format """ + options: 'FormattingOptions' + """ The format options """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + + +class DocumentOnTypeFormattingParams(TypedDict): + """ The parameters of a {@link DocumentOnTypeFormattingRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The document to format. """ + position: 'Position' + """ The position around which the on type formatting should happen. + This is not necessarily the exact position where the character denoted + by the property `ch` got typed. """ + ch: str + """ The character that has been typed that triggered the formatting + on type request. That is not necessarily the last character that + got inserted into the document since the client could auto insert + characters as well (e.g. like automatic brace completion). """ + options: 'FormattingOptions' + """ The formatting options. """ + + +class DocumentOnTypeFormattingRegistrationOptions(TypedDict): + """ Registration options for a {@link DocumentOnTypeFormattingRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + firstTriggerCharacter: str + """ A character on which formatting should be triggered, like `{`. """ + moreTriggerCharacter: NotRequired[List[str]] + """ More trigger characters. """ + + +class RenameParams(TypedDict): + """ The parameters of a {@link RenameRequest}. """ + textDocument: 'TextDocumentIdentifier' + """ The document to rename. """ + position: 'Position' + """ The position at which this request was sent. """ + newName: str + """ The new name of the symbol. If the given name is not valid the + request must return a {@link ResponseError} with an + appropriate message set. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + + +class RenameRegistrationOptions(TypedDict): + """ Registration options for a {@link RenameRequest}. """ + documentSelector: Union['DocumentSelector', None] + """ A document selector to identify the scope of the registration. If set to null + the document selector provided on the client side will be used. """ + prepareProvider: NotRequired[bool] + """ Renames should be checked and tested before being executed. + + @since version 3.12.0 """ + + +class PrepareRenameParams(TypedDict): + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + + +class ExecuteCommandParams(TypedDict): + """ The parameters of a {@link ExecuteCommandRequest}. """ + command: str + """ The identifier of the actual command handler. """ + arguments: NotRequired[List['LSPAny']] + """ Arguments that the command should be invoked with. """ + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ + + +class ExecuteCommandRegistrationOptions(TypedDict): + """ Registration options for a {@link ExecuteCommandRequest}. """ + commands: List[str] + """ The commands to be executed on the server """ + + +class ApplyWorkspaceEditParams(TypedDict): + """ The parameters passed via an apply workspace edit request. """ + label: NotRequired[str] + """ An optional label of the workspace edit. This label is + presented in the user interface for example on an undo + stack to undo the workspace edit. """ + edit: 'WorkspaceEdit' + """ The edits to apply. """ + metadata: NotRequired['WorkspaceEditMetadata'] + """ Additional data about the edit. + @since 3.18.0 + @proposed """ -CodeActionParams = TypedDict('CodeActionParams', { - # The document in which the command was invoked. - 'textDocument': 'TextDocumentIdentifier', - # The range for which the command was invoked. - 'range': 'Range', - # Context carrying additional information. - 'context': 'CodeActionContext', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link CodeActionRequest}. """ +class ApplyWorkspaceEditResult(TypedDict): + """ The result returned from the apply workspace edit request. -Command = TypedDict('Command', { - # Title of the command, like `save`. - 'title': str, - # The identifier of the actual command handler. - 'command': str, - # Arguments that the command handler should be - # invoked with. - 'arguments': NotRequired[List['LSPAny']], -}) -""" Represents a reference to a command. Provides a title which -will be used to represent a command in the UI and, optionally, -an array of arguments which will be passed to the command handler -function when invoked. """ - - -CodeAction = TypedDict('CodeAction', { - # A short, human-readable, title for this code action. - 'title': str, - # The kind of the code action. - # - # Used to filter code actions. - 'kind': NotRequired['CodeActionKind'], - # The diagnostics that this code action resolves. - 'diagnostics': NotRequired[List['Diagnostic']], - # Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted - # by keybindings. - # - # A quick fix should be marked preferred if it properly addresses the underlying error. - # A refactoring should be marked preferred if it is the most reasonable choice of actions to take. - # - # @since 3.15.0 - 'isPreferred': NotRequired[bool], - # Marks that the code action cannot currently be applied. - # - # Clients should follow the following guidelines regarding disabled code actions: - # - # - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) - # code action menus. - # - # - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type - # of code action, such as refactorings. - # - # - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions) - # that auto applies a code action and only disabled code actions are returned, the client should show the user an - # error message with `reason` in the editor. - # - # @since 3.16.0 - 'disabled': NotRequired['__CodeAction_disabled_Type_1'], - # The workspace edit this code action performs. - 'edit': NotRequired['WorkspaceEdit'], - # A command this code action executes. If a code action - # provides an edit and a command, first the edit is - # executed and then the command. - 'command': NotRequired['Command'], - # A data entry field that is preserved on a code action between - # a `textDocument/codeAction` and a `codeAction/resolve` request. - # - # @since 3.16.0 - 'data': NotRequired['LSPAny'], -}) -""" A code action represents a change that can be performed in code, e.g. to fix a problem or -to refactor code. - -A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed. """ - - -CodeActionRegistrationOptions = TypedDict('CodeActionRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # CodeActionKinds that this server may return. - # - # The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server - # may list out every specific kind they provide. - 'codeActionKinds': NotRequired[List['CodeActionKind']], - # The server provides support to resolve additional - # information for a code action. - # - # @since 3.16.0 - 'resolveProvider': NotRequired[bool], -}) -""" Registration options for a {@link CodeActionRequest}. """ - - -WorkspaceSymbolParams = TypedDict('WorkspaceSymbolParams', { - # A query string to filter symbols by. Clients may send an empty - # string here to request all symbols. - 'query': str, - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link WorkspaceSymbolRequest}. """ - - -WorkspaceSymbol = TypedDict('WorkspaceSymbol', { - # The location of the symbol. Whether a server is allowed to - # return a location without a range depends on the client - # capability `workspace.symbol.resolveSupport`. - # - # See SymbolInformation#location for more details. - 'location': Union['Location', '__WorkspaceSymbol_location_Type_1'], - # A data entry field that is preserved on a workspace symbol between a - # workspace symbol request and a workspace symbol resolve request. - 'data': NotRequired['LSPAny'], - # The name of this symbol. - 'name': str, - # The kind of this symbol. - 'kind': 'SymbolKind', - # Tags for this symbol. - # - # @since 3.16.0 - 'tags': NotRequired[List['SymbolTag']], - # The name of the symbol containing this symbol. This information is for - # user interface purposes (e.g. to render a qualifier in the user interface - # if necessary). It can't be used to re-infer a hierarchy for the document - # symbols. - 'containerName': NotRequired[str], -}) -""" A special workspace symbol that supports locations without a range. + @since 3.17 renamed from ApplyWorkspaceEditResponse """ + applied: bool + """ Indicates whether the edit was applied or not. """ + failureReason: NotRequired[str] + """ An optional textual description for why the edit was not applied. + This may be used by the server for diagnostic logging or to provide + a suitable error for a request that triggered the edit. """ + failedChange: NotRequired[Uint] + """ Depending on the client's failure handling strategy `failedChange` might + contain the index of the change that failed. This property is only available + if the client signals a `failureHandlingStrategy` in its client capabilities. """ -See also SymbolInformation. -@since 3.17.0 """ +class WorkDoneProgressBegin(TypedDict): + kind: Literal['begin'] + title: str + """ Mandatory title of the progress operation. Used to briefly inform about + the kind of operation being performed. + Examples: "Indexing" or "Linking dependencies". """ + cancellable: NotRequired[bool] + """ Controls if a cancel button should show to allow the user to cancel the + long running operation. Clients that don't support cancellation are allowed + to ignore the setting. """ + message: NotRequired[str] + """ Optional, more detailed associated progress message. Contains + complementary information to the `title`. -WorkspaceSymbolRegistrationOptions = TypedDict('WorkspaceSymbolRegistrationOptions', { - # The server provides support to resolve additional - # information for a workspace symbol. - # - # @since 3.17.0 - 'resolveProvider': NotRequired[bool], -}) -""" Registration options for a {@link WorkspaceSymbolRequest}. """ + Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". + If unset, the previous progress message (if any) is still valid. """ + percentage: NotRequired[Uint] + """ Optional progress percentage to display (value 100 is considered 100%). + If not provided infinite progress is assumed and clients are allowed + to ignore the `percentage` value in subsequent in report notifications. + The value should be steadily rising. Clients are free to ignore values + that are not following this rule. The value range is [0, 100]. """ -CodeLensParams = TypedDict('CodeLensParams', { - # The document to request code lens for. - 'textDocument': 'TextDocumentIdentifier', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link CodeLensRequest}. """ +class WorkDoneProgressReport(TypedDict): + kind: Literal['report'] + cancellable: NotRequired[bool] + """ Controls enablement state of a cancel button. + + Clients that don't support cancellation or don't support controlling the button's + enablement state are allowed to ignore the property. """ + message: NotRequired[str] + """ Optional, more detailed associated progress message. Contains + complementary information to the `title`. + + Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". + If unset, the previous progress message (if any) is still valid. """ + percentage: NotRequired[Uint] + """ Optional progress percentage to display (value 100 is considered 100%). + If not provided infinite progress is assumed and clients are allowed + to ignore the `percentage` value in subsequent in report notifications. -CodeLens = TypedDict('CodeLens', { - # The range in which this code lens is valid. Should only span a single line. - 'range': 'Range', - # The command this code lens represents. - 'command': NotRequired['Command'], - # A data entry field that is preserved on a code lens item between - # a {@link CodeLensRequest} and a {@link CodeLensResolveRequest} - 'data': NotRequired['LSPAny'], -}) -""" A code lens represents a {@link Command command} that should be shown along with -source text, like the number of references, a way to run tests, etc. + The value should be steadily rising. Clients are free to ignore values + that are not following this rule. The value range is [0, 100] """ -A code lens is _unresolved_ when no command is associated to it. For performance -reasons the creation of a code lens and resolving should be done in two stages. """ +class WorkDoneProgressEnd(TypedDict): + kind: Literal['end'] + message: NotRequired[str] + """ Optional, a final message indicating to for example indicate the outcome + of the operation. """ -CodeLensRegistrationOptions = TypedDict('CodeLensRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # Code lens has a resolve provider as well. - 'resolveProvider': NotRequired[bool], -}) -""" Registration options for a {@link CodeLensRequest}. """ +class SetTraceParams(TypedDict): + value: 'TraceValue' -DocumentLinkParams = TypedDict('DocumentLinkParams', { - # The document to provide document links for. - 'textDocument': 'TextDocumentIdentifier', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link DocumentLinkRequest}. """ +class LogTraceParams(TypedDict): + message: str + verbose: NotRequired[str] -DocumentLink = TypedDict('DocumentLink', { - # The range this link applies to. - 'range': 'Range', - # The uri this link points to. If missing a resolve request is sent later. - 'target': NotRequired['URI'], - # The tooltip text when you hover over this link. - # - # If a tooltip is provided, is will be displayed in a string that includes instructions on how to - # trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, - # user settings, and localization. - # - # @since 3.15.0 - 'tooltip': NotRequired[str], - # A data entry field that is preserved on a document link between a - # DocumentLinkRequest and a DocumentLinkResolveRequest. - 'data': NotRequired['LSPAny'], -}) -""" A document link is a range in a text document that links to an internal or external resource, like another -text document or a web site. """ +class CancelParams(TypedDict): + id: Union[int, str] + """ The request id to cancel. """ -DocumentLinkRegistrationOptions = TypedDict('DocumentLinkRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # Document links have a resolve provider as well. - 'resolveProvider': NotRequired[bool], -}) -""" Registration options for a {@link DocumentLinkRequest}. """ +class ProgressParams(TypedDict): + token: 'ProgressToken' + """ The progress token provided by the client or server. """ + value: 'LSPAny' + """ The progress data. """ -DocumentFormattingParams = TypedDict('DocumentFormattingParams', { - # The document to format. - 'textDocument': 'TextDocumentIdentifier', - # The format options. - 'options': 'FormattingOptions', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link DocumentFormattingRequest}. """ +class TextDocumentPositionParams(TypedDict): + """ A parameter literal used in requests to pass a text document and a position inside that + document. """ + textDocument: 'TextDocumentIdentifier' + """ The text document. """ + position: 'Position' + """ The position inside the text document. """ -DocumentFormattingRegistrationOptions = TypedDict('DocumentFormattingRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], -}) -""" Registration options for a {@link DocumentFormattingRequest}. """ +class WorkDoneProgressParams(TypedDict): + workDoneToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report work done progress. """ -DocumentRangeFormattingParams = TypedDict('DocumentRangeFormattingParams', { - # The document to format. - 'textDocument': 'TextDocumentIdentifier', - # The range to format - 'range': 'Range', - # The format options - 'options': 'FormattingOptions', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link DocumentRangeFormattingRequest}. """ - - -DocumentRangeFormattingRegistrationOptions = TypedDict('DocumentRangeFormattingRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # Whether the server supports formatting multiple ranges at once. - # - # @since 3.18.0 - # @proposed - 'rangesSupport': NotRequired[bool], -}) -""" Registration options for a {@link DocumentRangeFormattingRequest}. """ - - -DocumentRangesFormattingParams = TypedDict('DocumentRangesFormattingParams', { - # The document to format. - 'textDocument': 'TextDocumentIdentifier', - # The ranges to format - 'ranges': List['Range'], - # The format options - 'options': 'FormattingOptions', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link DocumentRangesFormattingRequest}. - -@since 3.18.0 -@proposed """ - - -DocumentOnTypeFormattingParams = TypedDict('DocumentOnTypeFormattingParams', { - # The document to format. - 'textDocument': 'TextDocumentIdentifier', - # The position around which the on type formatting should happen. - # This is not necessarily the exact position where the character denoted - # by the property `ch` got typed. - 'position': 'Position', - # The character that has been typed that triggered the formatting - # on type request. That is not necessarily the last character that - # got inserted into the document since the client could auto insert - # characters as well (e.g. like automatic brace completion). - 'ch': str, - # The formatting options. - 'options': 'FormattingOptions', -}) -""" The parameters of a {@link DocumentOnTypeFormattingRequest}. """ +class PartialResultParams(TypedDict): + partialResultToken: NotRequired['ProgressToken'] + """ An optional token that a server can use to report partial results (e.g. streaming) to + the client. """ -DocumentOnTypeFormattingRegistrationOptions = TypedDict('DocumentOnTypeFormattingRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # A character on which formatting should be triggered, like `{`. - 'firstTriggerCharacter': str, - # More trigger characters. - 'moreTriggerCharacter': NotRequired[List[str]], -}) -""" Registration options for a {@link DocumentOnTypeFormattingRequest}. """ - - -RenameParams = TypedDict('RenameParams', { - # The document to rename. - 'textDocument': 'TextDocumentIdentifier', - # The position at which this request was sent. - 'position': 'Position', - # The new name of the symbol. If the given name is not valid the - # request must return a {@link ResponseError} with an - # appropriate message set. - 'newName': str, - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link RenameRequest}. """ +class LocationLink(TypedDict): + """ Represents the connection of two locations. Provides additional metadata over normal {@link Location locations}, + including an origin range. """ + originSelectionRange: NotRequired['Range'] + """ Span of the origin of this link. -RenameRegistrationOptions = TypedDict('RenameRegistrationOptions', { - # A document selector to identify the scope of the registration. If set to null - # the document selector provided on the client side will be used. - 'documentSelector': Union['DocumentSelector', None], - # Renames should be checked and tested before being executed. - # - # @since version 3.12.0 - 'prepareProvider': NotRequired[bool], -}) -""" Registration options for a {@link RenameRequest}. """ + Used as the underlined span for mouse interaction. Defaults to the word range at + the definition position. """ + targetUri: 'DocumentUri' + """ The target resource identifier of this link. """ + targetRange: 'Range' + """ The full target range of this link. If the target for example is a symbol then target range is the + range enclosing this symbol not including leading/trailing whitespace but everything else + like comments. This information is typically used to highlight the range in the editor. """ + targetSelectionRange: 'Range' + """ The range that should be selected and revealed when this link is being followed, e.g the name of a function. + Must be contained by the `targetRange`. See also `DocumentSymbol#range` """ -PrepareRenameParams = TypedDict('PrepareRenameParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) +class Range(TypedDict): + """ A range in a text document expressed as (zero-based) start and end positions. + If you want to specify a range that contains a line including the line ending + character(s) then use an end position denoting the start of the next line. + For example: + ```ts + { + start: { line: 5, character: 23 } + end : { line 6, character : 0 } + } + ``` """ + start: 'Position' + """ The range's start position. """ + end: 'Position' + """ The range's end position. """ -ExecuteCommandParams = TypedDict('ExecuteCommandParams', { - # The identifier of the actual command handler. - 'command': str, - # Arguments that the command should be invoked with. - 'arguments': NotRequired[List['LSPAny']], - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) -""" The parameters of a {@link ExecuteCommandRequest}. """ +class ImplementationOptions(TypedDict): + workDoneProgress: NotRequired[bool] -ExecuteCommandRegistrationOptions = TypedDict('ExecuteCommandRegistrationOptions', { - # The commands to be executed on the server - 'commands': List[str], -}) -""" Registration options for a {@link ExecuteCommandRequest}. """ +class StaticRegistrationOptions(TypedDict): + """ Static registration options to be returned in the initialize + request. """ + id: NotRequired[str] + """ The id used to register the request. The id can be used to deregister + the request again. See also Registration#id. """ -ApplyWorkspaceEditParams = TypedDict('ApplyWorkspaceEditParams', { - # An optional label of the workspace edit. This label is - # presented in the user interface for example on an undo - # stack to undo the workspace edit. - 'label': NotRequired[str], - # The edits to apply. - 'edit': 'WorkspaceEdit', -}) -""" The parameters passed via an apply workspace edit request. """ - - -ApplyWorkspaceEditResult = TypedDict('ApplyWorkspaceEditResult', { - # Indicates whether the edit was applied or not. - 'applied': bool, - # An optional textual description for why the edit was not applied. - # This may be used by the server for diagnostic logging or to provide - # a suitable error for a request that triggered the edit. - 'failureReason': NotRequired[str], - # Depending on the client's failure handling strategy `failedChange` might - # contain the index of the change that failed. This property is only available - # if the client signals a `failureHandlingStrategy` in its client capabilities. - 'failedChange': NotRequired[Uint], -}) -""" The result returned from the apply workspace edit request. - -@since 3.17 renamed from ApplyWorkspaceEditResponse """ - - -WorkDoneProgressBegin = TypedDict('WorkDoneProgressBegin', { - 'kind': Literal['begin'], - # Mandatory title of the progress operation. Used to briefly inform about - # the kind of operation being performed. - # - # Examples: "Indexing" or "Linking dependencies". - 'title': str, - # Controls if a cancel button should show to allow the user to cancel the - # long running operation. Clients that don't support cancellation are allowed - # to ignore the setting. - 'cancellable': NotRequired[bool], - # Optional, more detailed associated progress message. Contains - # complementary information to the `title`. - # - # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". - # If unset, the previous progress message (if any) is still valid. - 'message': NotRequired[str], - # Optional progress percentage to display (value 100 is considered 100%). - # If not provided infinite progress is assumed and clients are allowed - # to ignore the `percentage` value in subsequent in report notifications. - # - # The value should be steadily rising. Clients are free to ignore values - # that are not following this rule. The value range is [0, 100]. - 'percentage': NotRequired[Uint], -}) +class TypeDefinitionOptions(TypedDict): + workDoneProgress: NotRequired[bool] -WorkDoneProgressReport = TypedDict('WorkDoneProgressReport', { - 'kind': Literal['report'], - # Controls enablement state of a cancel button. - # - # Clients that don't support cancellation or don't support controlling the button's - # enablement state are allowed to ignore the property. - 'cancellable': NotRequired[bool], - # Optional, more detailed associated progress message. Contains - # complementary information to the `title`. - # - # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". - # If unset, the previous progress message (if any) is still valid. - 'message': NotRequired[str], - # Optional progress percentage to display (value 100 is considered 100%). - # If not provided infinite progress is assumed and clients are allowed - # to ignore the `percentage` value in subsequent in report notifications. - # - # The value should be steadily rising. Clients are free to ignore values - # that are not following this rule. The value range is [0, 100] - 'percentage': NotRequired[Uint], -}) +class WorkspaceFoldersChangeEvent(TypedDict): + """ The workspace folder change event. """ + added: List['WorkspaceFolder'] + """ The array of added workspace folders """ + removed: List['WorkspaceFolder'] + """ The array of the removed workspace folders """ -WorkDoneProgressEnd = TypedDict('WorkDoneProgressEnd', { - 'kind': Literal['end'], - # Optional, a final message indicating to for example indicate the outcome - # of the operation. - 'message': NotRequired[str], -}) +class ConfigurationItem(TypedDict): + scopeUri: NotRequired['URI'] + """ The scope to get the configuration section for. """ + section: NotRequired[str] + """ The configuration section asked for. """ -SetTraceParams = TypedDict('SetTraceParams', { - 'value': 'TraceValues', -}) +class TextDocumentIdentifier(TypedDict): + """ A literal to identify a text document in the client. """ + uri: 'DocumentUri' + """ The text document's uri. """ -LogTraceParams = TypedDict('LogTraceParams', { - 'message': str, - 'verbose': NotRequired[str], -}) +class Color(TypedDict): + """ Represents a color in RGBA space. """ + red: float + """ The red component of this color in the range [0-1]. """ + green: float + """ The green component of this color in the range [0-1]. """ + blue: float + """ The blue component of this color in the range [0-1]. """ + alpha: float + """ The alpha component of this color in the range [0-1]. """ -CancelParams = TypedDict('CancelParams', { - # The request id to cancel. - 'id': Union[int, str], -}) +class DocumentColorOptions(TypedDict): + workDoneProgress: NotRequired[bool] -ProgressParams = TypedDict('ProgressParams', { - # The progress token provided by the client or server. - 'token': 'ProgressToken', - # The progress data. - 'value': 'LSPAny', -}) +class FoldingRangeOptions(TypedDict): + workDoneProgress: NotRequired[bool] -TextDocumentPositionParams = TypedDict('TextDocumentPositionParams', { - # The text document. - 'textDocument': 'TextDocumentIdentifier', - # The position inside the text document. - 'position': 'Position', -}) -""" A parameter literal used in requests to pass a text document and a position inside that -document. """ +class DeclarationOptions(TypedDict): + workDoneProgress: NotRequired[bool] -WorkDoneProgressParams = TypedDict('WorkDoneProgressParams', { - # An optional token that a server can use to report work done progress. - 'workDoneToken': NotRequired['ProgressToken'], -}) +class Position(TypedDict): + """ Position in a text document expressed as zero-based line and character + offset. Prior to 3.17 the offsets were always based on a UTF-16 string + representation. So a string of the form `a𐐀b` the character offset of the + character `a` is 0, the character offset of `𐐀` is 1 and the character + offset of b is 3 since `𐐀` is represented using two code units in UTF-16. + Since 3.17 clients and servers can agree on a different string encoding + representation (e.g. UTF-8). The client announces it's supported encoding + via the client capability [`general.positionEncodings`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#clientCapabilities). + The value is an array of position encodings the client supports, with + decreasing preference (e.g. the encoding at index `0` is the most preferred + one). To stay backwards compatible the only mandatory encoding is UTF-16 + represented via the string `utf-16`. The server can pick one of the + encodings offered by the client and signals that encoding back to the + client via the initialize result's property + [`capabilities.positionEncoding`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#serverCapabilities). If the string value + `utf-16` is missing from the client's capability `general.positionEncodings` + servers can safely assume that the client supports UTF-16. If the server + omits the position encoding in its initialize result the encoding defaults + to the string value `utf-16`. Implementation considerations: since the + conversion from one encoding into another requires the content of the + file / line the conversion is best done where the file is read which is + usually on the server side. -PartialResultParams = TypedDict('PartialResultParams', { - # An optional token that a server can use to report partial results (e.g. streaming) to - # the client. - 'partialResultToken': NotRequired['ProgressToken'], -}) + Positions are line end character agnostic. So you can not specify a position + that denotes `\r|\n` or `\n|` where `|` represents the character offset. + @since 3.17.0 - support for negotiated position encoding. """ + line: Uint + """ Line position in a document (zero-based). -LocationLink = TypedDict('LocationLink', { - # Span of the origin of this link. - # - # Used as the underlined span for mouse interaction. Defaults to the word range at - # the definition position. - 'originSelectionRange': NotRequired['Range'], - # The target resource identifier of this link. - 'targetUri': 'DocumentUri', - # The full target range of this link. If the target for example is a symbol then target range is the - # range enclosing this symbol not including leading/trailing whitespace but everything else - # like comments. This information is typically used to highlight the range in the editor. - 'targetRange': 'Range', - # The range that should be selected and revealed when this link is being followed, e.g the name of a function. - # Must be contained by the `targetRange`. See also `DocumentSymbol#range` - 'targetSelectionRange': 'Range', -}) -""" Represents the connection of two locations. Provides additional metadata over normal {@link Location locations}, -including an origin range. """ + If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document. + If a line number is negative, it defaults to 0. """ + character: Uint + """ Character offset on a line in a document (zero-based). + The meaning of this offset is determined by the negotiated + `PositionEncodingKind`. -Range = TypedDict('Range', { - # The range's start position. - 'start': 'Position', - # The range's end position. - 'end': 'Position', -}) -""" A range in a text document expressed as (zero-based) start and end positions. + If the character value is greater than the line length it defaults back to the + line length. """ -If you want to specify a range that contains a line including the line ending -character(s) then use an end position denoting the start of the next line. -For example: -```ts -{ - start: { line: 5, character: 23 } - end : { line 6, character : 0 } -} -``` """ +class SelectionRangeOptions(TypedDict): + workDoneProgress: NotRequired[bool] -ImplementationOptions = TypedDict('ImplementationOptions', { - 'workDoneProgress': NotRequired[bool], -}) +class CallHierarchyOptions(TypedDict): + """ Call hierarchy options used during static registration. -StaticRegistrationOptions = TypedDict('StaticRegistrationOptions', { - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Static registration options to be returned in the initialize -request. """ + @since 3.16.0 """ + workDoneProgress: NotRequired[bool] -TypeDefinitionOptions = TypedDict('TypeDefinitionOptions', { - 'workDoneProgress': NotRequired[bool], -}) +class SemanticTokensOptions(TypedDict): + """ @since 3.16.0 """ + legend: 'SemanticTokensLegend' + """ The legend used by the server """ + range: NotRequired[Union[bool, dict]] + """ Server supports providing semantic tokens for a specific range + of a document. """ + full: NotRequired[Union[bool, 'SemanticTokensFullDelta']] + """ Server supports providing semantic tokens for a full document. """ + workDoneProgress: NotRequired[bool] -WorkspaceFoldersChangeEvent = TypedDict('WorkspaceFoldersChangeEvent', { - # The array of added workspace folders - 'added': List['WorkspaceFolder'], - # The array of the removed workspace folders - 'removed': List['WorkspaceFolder'], -}) -""" The workspace folder change event. """ +class SemanticTokensEdit(TypedDict): + """ @since 3.16.0 """ + start: Uint + """ The start offset of the edit. """ + deleteCount: Uint + """ The count of elements to remove. """ + data: NotRequired[List[Uint]] + """ The elements to insert. """ -ConfigurationItem = TypedDict('ConfigurationItem', { - # The scope to get the configuration section for. - 'scopeUri': NotRequired[str], - # The configuration section asked for. - 'section': NotRequired[str], -}) +class LinkedEditingRangeOptions(TypedDict): + workDoneProgress: NotRequired[bool] -TextDocumentIdentifier = TypedDict('TextDocumentIdentifier', { - # The text document's uri. - 'uri': 'DocumentUri', -}) -""" A literal to identify a text document in the client. """ - - -Color = TypedDict('Color', { - # The red component of this color in the range [0-1]. - 'red': float, - # The green component of this color in the range [0-1]. - 'green': float, - # The blue component of this color in the range [0-1]. - 'blue': float, - # The alpha component of this color in the range [0-1]. - 'alpha': float, -}) -""" Represents a color in RGBA space. """ +class FileCreate(TypedDict): + """ Represents information on a file/folder create. + @since 3.16.0 """ + uri: str + """ A file:// URI for the location of the file/folder being created. """ + + +class TextDocumentEdit(TypedDict): + """ Describes textual changes on a text document. A TextDocumentEdit describes all changes + on a document version Si and after they are applied move the document to version Si+1. + So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any + kind of ordering. However the edits must be non overlapping. """ + textDocument: 'OptionalVersionedTextDocumentIdentifier' + """ The text document to change. """ + edits: List[Union['TextEdit', 'AnnotatedTextEdit', 'SnippetTextEdit']] + """ The edits to be applied. + + @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a + client capability. + + @since 3.18.0 - support for SnippetTextEdit. This is guarded using a + client capability. """ + + +class CreateFile(TypedDict): + """ Create file operation. """ + kind: Literal['create'] + """ A create """ + uri: 'DocumentUri' + """ The resource to create. """ + options: NotRequired['CreateFileOptions'] + """ Additional options """ + annotationId: NotRequired['ChangeAnnotationIdentifier'] + """ An optional annotation identifier describing the operation. -DocumentColorOptions = TypedDict('DocumentColorOptions', { - 'workDoneProgress': NotRequired[bool], -}) + @since 3.16.0 """ -FoldingRangeOptions = TypedDict('FoldingRangeOptions', { - 'workDoneProgress': NotRequired[bool], -}) +class RenameFile(TypedDict): + """ Rename file operation """ + kind: Literal['rename'] + """ A rename """ + oldUri: 'DocumentUri' + """ The old (existing) location. """ + newUri: 'DocumentUri' + """ The new location. """ + options: NotRequired['RenameFileOptions'] + """ Rename options. """ + annotationId: NotRequired['ChangeAnnotationIdentifier'] + """ An optional annotation identifier describing the operation. + @since 3.16.0 """ -DeclarationOptions = TypedDict('DeclarationOptions', { - 'workDoneProgress': NotRequired[bool], -}) +class DeleteFile(TypedDict): + """ Delete file operation """ + kind: Literal['delete'] + """ A delete """ + uri: 'DocumentUri' + """ The file to delete. """ + options: NotRequired['DeleteFileOptions'] + """ Delete options. """ + annotationId: NotRequired['ChangeAnnotationIdentifier'] + """ An optional annotation identifier describing the operation. -Position = TypedDict('Position', { - # Line position in a document (zero-based). - # - # If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document. - # If a line number is negative, it defaults to 0. - 'line': Uint, - # Character offset on a line in a document (zero-based). - # - # The meaning of this offset is determined by the negotiated - # `PositionEncodingKind`. - # - # If the character value is greater than the line length it defaults back to the - # line length. - 'character': Uint, -}) -""" Position in a text document expressed as zero-based line and character -offset. Prior to 3.17 the offsets were always based on a UTF-16 string -representation. So a string of the form `a𐐀b` the character offset of the -character `a` is 0, the character offset of `𐐀` is 1 and the character -offset of b is 3 since `𐐀` is represented using two code units in UTF-16. -Since 3.17 clients and servers can agree on a different string encoding -representation (e.g. UTF-8). The client announces it's supported encoding -via the client capability [`general.positionEncodings`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#clientCapabilities). -The value is an array of position encodings the client supports, with -decreasing preference (e.g. the encoding at index `0` is the most preferred -one). To stay backwards compatible the only mandatory encoding is UTF-16 -represented via the string `utf-16`. The server can pick one of the -encodings offered by the client and signals that encoding back to the -client via the initialize result's property -[`capabilities.positionEncoding`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#serverCapabilities). If the string value -`utf-16` is missing from the client's capability `general.positionEncodings` -servers can safely assume that the client supports UTF-16. If the server -omits the position encoding in its initialize result the encoding defaults -to the string value `utf-16`. Implementation considerations: since the -conversion from one encoding into another requires the content of the -file / line the conversion is best done where the file is read which is -usually on the server side. - -Positions are line end character agnostic. So you can not specify a position -that denotes `\r|\n` or `\n|` where `|` represents the character offset. - -@since 3.17.0 - support for negotiated position encoding. """ - - -SelectionRangeOptions = TypedDict('SelectionRangeOptions', { - 'workDoneProgress': NotRequired[bool], -}) + @since 3.16.0 """ -CallHierarchyOptions = TypedDict('CallHierarchyOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Call hierarchy options used during static registration. +class ChangeAnnotation(TypedDict): + """ Additional information that describes document changes. -@since 3.16.0 """ + @since 3.16.0 """ + label: str + """ A human-readable string describing the actual change. The string + is rendered prominent in the user interface. """ + needsConfirmation: NotRequired[bool] + """ A flag which indicates that user confirmation is needed + before applying the change. """ + description: NotRequired[str] + """ A human-readable string which is rendered less prominent in + the user interface. """ -SemanticTokensOptions = TypedDict('SemanticTokensOptions', { - # The legend used by the server - 'legend': 'SemanticTokensLegend', - # Server supports providing semantic tokens for a specific range - # of a document. - 'range': NotRequired[Union[bool, dict]], - # Server supports providing semantic tokens for a full document. - 'full': NotRequired[Union[bool, '__SemanticTokensOptions_full_Type_2']], - 'workDoneProgress': NotRequired[bool], -}) -""" @since 3.16.0 """ +class FileOperationFilter(TypedDict): + """ A filter to describe in which file operation requests or notifications + the server is interested in receiving. + @since 3.16.0 """ + scheme: NotRequired[str] + """ A Uri scheme like `file` or `untitled`. """ + pattern: 'FileOperationPattern' + """ The actual file operation pattern. """ -SemanticTokensEdit = TypedDict('SemanticTokensEdit', { - # The start offset of the edit. - 'start': Uint, - # The count of elements to remove. - 'deleteCount': Uint, - # The elements to insert. - 'data': NotRequired[List[Uint]], -}) -""" @since 3.16.0 """ +class FileRename(TypedDict): + """ Represents information on a file/folder rename. -LinkedEditingRangeOptions = TypedDict('LinkedEditingRangeOptions', { - 'workDoneProgress': NotRequired[bool], -}) + @since 3.16.0 """ + oldUri: str + """ A file:// URI for the original location of the file/folder being renamed. """ + newUri: str + """ A file:// URI for the new location of the file/folder being renamed. """ -FileCreate = TypedDict('FileCreate', { - # A file:// URI for the location of the file/folder being created. - 'uri': str, -}) -""" Represents information on a file/folder create. +class FileDelete(TypedDict): + """ Represents information on a file/folder delete. -@since 3.16.0 """ + @since 3.16.0 """ + uri: str + """ A file:// URI for the location of the file/folder being deleted. """ -TextDocumentEdit = TypedDict('TextDocumentEdit', { - # The text document to change. - 'textDocument': 'OptionalVersionedTextDocumentIdentifier', - # The edits to be applied. - # - # @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a - # client capability. - 'edits': List[Union['TextEdit', 'AnnotatedTextEdit']], -}) -""" Describes textual changes on a text document. A TextDocumentEdit describes all changes -on a document version Si and after they are applied move the document to version Si+1. -So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any -kind of ordering. However the edits must be non overlapping. """ - - -CreateFile = TypedDict('CreateFile', { - # A create - 'kind': Literal['create'], - # The resource to create. - 'uri': 'DocumentUri', - # Additional options - 'options': NotRequired['CreateFileOptions'], - # An optional annotation identifier describing the operation. - # - # @since 3.16.0 - 'annotationId': NotRequired['ChangeAnnotationIdentifier'], -}) -""" Create file operation. """ - - -RenameFile = TypedDict('RenameFile', { - # A rename - 'kind': Literal['rename'], - # The old (existing) location. - 'oldUri': 'DocumentUri', - # The new location. - 'newUri': 'DocumentUri', - # Rename options. - 'options': NotRequired['RenameFileOptions'], - # An optional annotation identifier describing the operation. - # - # @since 3.16.0 - 'annotationId': NotRequired['ChangeAnnotationIdentifier'], -}) -""" Rename file operation """ - - -DeleteFile = TypedDict('DeleteFile', { - # A delete - 'kind': Literal['delete'], - # The file to delete. - 'uri': 'DocumentUri', - # Delete options. - 'options': NotRequired['DeleteFileOptions'], - # An optional annotation identifier describing the operation. - # - # @since 3.16.0 - 'annotationId': NotRequired['ChangeAnnotationIdentifier'], -}) -""" Delete file operation """ - - -ChangeAnnotation = TypedDict('ChangeAnnotation', { - # A human-readable string describing the actual change. The string - # is rendered prominent in the user interface. - 'label': str, - # A flag which indicates that user confirmation is needed - # before applying the change. - 'needsConfirmation': NotRequired[bool], - # A human-readable string which is rendered less prominent in - # the user interface. - 'description': NotRequired[str], -}) -""" Additional information that describes document changes. +class MonikerOptions(TypedDict): + workDoneProgress: NotRequired[bool] -@since 3.16.0 """ +class TypeHierarchyOptions(TypedDict): + """ Type hierarchy options used during static registration. -FileOperationFilter = TypedDict('FileOperationFilter', { - # A Uri scheme like `file` or `untitled`. - 'scheme': NotRequired[str], - # The actual file operation pattern. - 'pattern': 'FileOperationPattern', -}) -""" A filter to describe in which file operation requests or notifications -the server is interested in receiving. + @since 3.17.0 """ + workDoneProgress: NotRequired[bool] -@since 3.16.0 """ +class InlineValueContext(TypedDict): + """ @since 3.17.0 """ + frameId: int + """ The stack frame (as a DAP Id) where the execution has stopped. """ + stoppedLocation: 'Range' + """ The document range where execution has stopped. + Typically the end position of the range denotes the line where the inline values are shown. """ -FileRename = TypedDict('FileRename', { - # A file:// URI for the original location of the file/folder being renamed. - 'oldUri': str, - # A file:// URI for the new location of the file/folder being renamed. - 'newUri': str, -}) -""" Represents information on a file/folder rename. -@since 3.16.0 """ +class InlineValueText(TypedDict): + """ Provide inline value as text. + @since 3.17.0 """ + range: 'Range' + """ The document range for which the inline value applies. """ + text: str + """ The text of the inline value. """ -FileDelete = TypedDict('FileDelete', { - # A file:// URI for the location of the file/folder being deleted. - 'uri': str, -}) -""" Represents information on a file/folder delete. -@since 3.16.0 """ +class InlineValueVariableLookup(TypedDict): + """ Provide inline value through a variable lookup. + If only a range is specified, the variable name will be extracted from the underlying document. + An optional variable name can be used to override the extracted name. + @since 3.17.0 """ + range: 'Range' + """ The document range for which the inline value applies. + The range is used to extract the variable name from the underlying document. """ + variableName: NotRequired[str] + """ If specified the name of the variable to look up. """ + caseSensitiveLookup: bool + """ How to perform the lookup. """ -MonikerOptions = TypedDict('MonikerOptions', { - 'workDoneProgress': NotRequired[bool], -}) +class InlineValueEvaluatableExpression(TypedDict): + """ Provide an inline value through an expression evaluation. + If only a range is specified, the expression will be extracted from the underlying document. + An optional expression can be used to override the extracted expression. -TypeHierarchyOptions = TypedDict('TypeHierarchyOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Type hierarchy options used during static registration. + @since 3.17.0 """ + range: 'Range' + """ The document range for which the inline value applies. + The range is used to extract the evaluatable expression from the underlying document. """ + expression: NotRequired[str] + """ If specified the expression overrides the extracted expression. """ -@since 3.17.0 """ +class InlineValueOptions(TypedDict): + """ Inline value options used during static registration. -InlineValueContext = TypedDict('InlineValueContext', { - # The stack frame (as a DAP Id) where the execution has stopped. - 'frameId': int, - # The document range where execution has stopped. - # Typically the end position of the range denotes the line where the inline values are shown. - 'stoppedLocation': 'Range', -}) -""" @since 3.17.0 """ + @since 3.17.0 """ + workDoneProgress: NotRequired[bool] -InlineValueText = TypedDict('InlineValueText', { - # The document range for which the inline value applies. - 'range': 'Range', - # The text of the inline value. - 'text': str, -}) -""" Provide inline value as text. +class InlayHintLabelPart(TypedDict): + """ An inlay hint label part allows for interactive and composite labels + of inlay hints. -@since 3.17.0 """ + @since 3.17.0 """ + value: str + """ The value of this label part. """ + tooltip: NotRequired[Union[str, 'MarkupContent']] + """ The tooltip text when you hover over this label part. Depending on + the client capability `inlayHint.resolveSupport` clients might resolve + this property late using the resolve request. """ + location: NotRequired['Location'] + """ An optional source code location that represents this + label part. + + The editor will use this location for the hover and for code navigation + features: This part will become a clickable link that resolves to the + definition of the symbol at the given location (not necessarily the + location itself), it shows the hover that shows at the given location, + and it shows a context menu with further code navigation commands. + + Depending on the client capability `inlayHint.resolveSupport` clients + might resolve this property late using the resolve request. """ + command: NotRequired['Command'] + """ An optional command for this label part. + + Depending on the client capability `inlayHint.resolveSupport` clients + might resolve this property late using the resolve request. """ + + +class MarkupContent(TypedDict): + """ A `MarkupContent` literal represents a string value which content is interpreted base on its + kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds. + + If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues. + See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting + + Here is an example how such a string can be constructed using JavaScript / TypeScript: + ```ts + let markdown: MarkdownContent = { + kind: MarkupKind.Markdown, + value: [ + '# Header', + 'Some text', + '```typescript', + 'someCode();', + '```' + ].join('\n') + }; + ``` + + *Please Note* that clients might sanitize the return markdown. A client could decide to + remove HTML from the markdown to avoid script execution. """ + kind: 'MarkupKind' + """ The type of the Markup """ + value: str + """ The content itself """ + + +class InlayHintOptions(TypedDict): + """ Inlay hint options used during static registration. + @since 3.17.0 """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for an inlay hint item. """ + workDoneProgress: NotRequired[bool] -InlineValueVariableLookup = TypedDict('InlineValueVariableLookup', { - # The document range for which the inline value applies. - # The range is used to extract the variable name from the underlying document. - 'range': 'Range', - # If specified the name of the variable to look up. - 'variableName': NotRequired[str], - # How to perform the lookup. - 'caseSensitiveLookup': bool, -}) -""" Provide inline value through a variable lookup. -If only a range is specified, the variable name will be extracted from the underlying document. -An optional variable name can be used to override the extracted name. -@since 3.17.0 """ +class RelatedFullDocumentDiagnosticReport(TypedDict): + """ A full diagnostic report with a set of related documents. + @since 3.17.0 """ + relatedDocuments: NotRequired[Dict['DocumentUri', Union['FullDocumentDiagnosticReport', 'UnchangedDocumentDiagnosticReport']]] + """ Diagnostics of related documents. This information is useful + in programming languages where code in a file A can generate + diagnostics in a file B which A depends on. An example of + such a language is C/C++ where marco definitions in a file + a.cpp and result in errors in a header file b.hpp. -InlineValueEvaluatableExpression = TypedDict('InlineValueEvaluatableExpression', { - # The document range for which the inline value applies. - # The range is used to extract the evaluatable expression from the underlying document. - 'range': 'Range', - # If specified the expression overrides the extracted expression. - 'expression': NotRequired[str], -}) -""" Provide an inline value through an expression evaluation. -If only a range is specified, the expression will be extracted from the underlying document. -An optional expression can be used to override the extracted expression. + @since 3.17.0 """ + kind: Literal['full'] + """ A full document diagnostic report. """ + resultId: NotRequired[str] + """ An optional result id. If provided it will + be sent on the next diagnostic request for the + same document. """ + items: List['Diagnostic'] + """ The actual items. """ -@since 3.17.0 """ +class RelatedUnchangedDocumentDiagnosticReport(TypedDict): + """ An unchanged diagnostic report with a set of related documents. -InlineValueOptions = TypedDict('InlineValueOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Inline value options used during static registration. + @since 3.17.0 """ + relatedDocuments: NotRequired[Dict['DocumentUri', Union['FullDocumentDiagnosticReport', 'UnchangedDocumentDiagnosticReport']]] + """ Diagnostics of related documents. This information is useful + in programming languages where code in a file A can generate + diagnostics in a file B which A depends on. An example of + such a language is C/C++ where marco definitions in a file + a.cpp and result in errors in a header file b.hpp. -@since 3.17.0 """ + @since 3.17.0 """ + kind: Literal['unchanged'] + """ A document diagnostic report indicating + no changes to the last result. A server can + only return `unchanged` if result ids are + provided. """ + resultId: str + """ A result id which will be sent on the next + diagnostic request for the same document. """ -InlayHintLabelPart = TypedDict('InlayHintLabelPart', { - # The value of this label part. - 'value': str, - # The tooltip text when you hover over this label part. Depending on - # the client capability `inlayHint.resolveSupport` clients might resolve - # this property late using the resolve request. - 'tooltip': NotRequired[Union[str, 'MarkupContent']], - # An optional source code location that represents this - # label part. - # - # The editor will use this location for the hover and for code navigation - # features: This part will become a clickable link that resolves to the - # definition of the symbol at the given location (not necessarily the - # location itself), it shows the hover that shows at the given location, - # and it shows a context menu with further code navigation commands. - # - # Depending on the client capability `inlayHint.resolveSupport` clients - # might resolve this property late using the resolve request. - 'location': NotRequired['Location'], - # An optional command for this label part. - # - # Depending on the client capability `inlayHint.resolveSupport` clients - # might resolve this property late using the resolve request. - 'command': NotRequired['Command'], -}) -""" An inlay hint label part allows for interactive and composite labels -of inlay hints. +class FullDocumentDiagnosticReport(TypedDict): + """ A diagnostic report with a full set of problems. -@since 3.17.0 """ + @since 3.17.0 """ + kind: Literal['full'] + """ A full document diagnostic report. """ + resultId: NotRequired[str] + """ An optional result id. If provided it will + be sent on the next diagnostic request for the + same document. """ + items: List['Diagnostic'] + """ The actual items. """ -MarkupContent = TypedDict('MarkupContent', { - # The type of the Markup - 'kind': 'MarkupKind', - # The content itself - 'value': str, -}) -""" A `MarkupContent` literal represents a string value which content is interpreted base on its -kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds. - -If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues. -See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting - -Here is an example how such a string can be constructed using JavaScript / TypeScript: -```ts -let markdown: MarkdownContent = { - kind: MarkupKind.Markdown, - value: [ - '# Header', - 'Some text', - '```typescript', - 'someCode();', - '```' - ].join('\n') -}; -``` +class UnchangedDocumentDiagnosticReport(TypedDict): + """ A diagnostic report indicating that the last returned + report is still accurate. -*Please Note* that clients might sanitize the return markdown. A client could decide to -remove HTML from the markdown to avoid script execution. """ + @since 3.17.0 """ + kind: Literal['unchanged'] + """ A document diagnostic report indicating + no changes to the last result. A server can + only return `unchanged` if result ids are + provided. """ + resultId: str + """ A result id which will be sent on the next + diagnostic request for the same document. """ -InlayHintOptions = TypedDict('InlayHintOptions', { - # The server provides support to resolve additional - # information for an inlay hint item. - 'resolveProvider': NotRequired[bool], - 'workDoneProgress': NotRequired[bool], -}) -""" Inlay hint options used during static registration. +class DiagnosticOptions(TypedDict): + """ Diagnostic options. -@since 3.17.0 """ + @since 3.17.0 """ + identifier: NotRequired[str] + """ An optional identifier under which the diagnostics are + managed by the client. """ + interFileDependencies: bool + """ Whether the language has inter file dependencies meaning that + editing code in one file can result in a different diagnostic + set in another file. Inter file dependencies are common for + most programming languages and typically uncommon for linters. """ + workspaceDiagnostics: bool + """ The server provides support for workspace diagnostics as well. """ + workDoneProgress: NotRequired[bool] + + +class PreviousResultId(TypedDict): + """ A previous result id in a workspace pull request. + @since 3.17.0 """ + uri: 'DocumentUri' + """ The URI for which the client knowns a + result id. """ + value: str + """ The value of the previous result id. """ -RelatedFullDocumentDiagnosticReport = TypedDict('RelatedFullDocumentDiagnosticReport', { - # Diagnostics of related documents. This information is useful - # in programming languages where code in a file A can generate - # diagnostics in a file B which A depends on. An example of - # such a language is C/C++ where marco definitions in a file - # a.cpp and result in errors in a header file b.hpp. - # - # @since 3.17.0 - 'relatedDocuments': NotRequired[Dict['DocumentUri', Union['FullDocumentDiagnosticReport', 'UnchangedDocumentDiagnosticReport']]], - # A full document diagnostic report. - 'kind': Literal['full'], - # An optional result id. If provided it will - # be sent on the next diagnostic request for the - # same document. - 'resultId': NotRequired[str], - # The actual items. - 'items': List['Diagnostic'], -}) -""" A full diagnostic report with a set of related documents. -@since 3.17.0 """ +class NotebookDocument(TypedDict): + """ A notebook document. + @since 3.17.0 """ + uri: 'URI' + """ The notebook document's uri. """ + notebookType: str + """ The type of the notebook. """ + version: int + """ The version number of this document (it will increase after each + change, including undo/redo). """ + metadata: NotRequired['LSPObject'] + """ Additional metadata stored with the notebook + document. + + Note: should always be an object literal (e.g. LSPObject) """ + cells: List['NotebookCell'] + """ The cells of a notebook. """ + + +class TextDocumentItem(TypedDict): + """ An item to transfer a text document from the client to the + server. """ + uri: 'DocumentUri' + """ The text document's uri. """ + languageId: 'LanguageKind' + """ The text document's language identifier. """ + version: int + """ The version number of this document (it will increase after each + change, including undo/redo). """ + text: str + """ The content of the opened text document. """ + + +class NotebookDocumentSyncOptions(TypedDict): + """ Options specific to a notebook plus its cells + to be synced to the server. + + If a selector provides a notebook document + filter but no cell selector all cells of a + matching notebook document will be synced. + + If a selector provides no notebook document + filter but only a cell selector all notebook + document that contain at least one matching + cell will be synced. -RelatedUnchangedDocumentDiagnosticReport = TypedDict('RelatedUnchangedDocumentDiagnosticReport', { - # Diagnostics of related documents. This information is useful - # in programming languages where code in a file A can generate - # diagnostics in a file B which A depends on. An example of - # such a language is C/C++ where marco definitions in a file - # a.cpp and result in errors in a header file b.hpp. - # - # @since 3.17.0 - 'relatedDocuments': NotRequired[Dict['DocumentUri', Union['FullDocumentDiagnosticReport', 'UnchangedDocumentDiagnosticReport']]], - # A document diagnostic report indicating - # no changes to the last result. A server can - # only return `unchanged` if result ids are - # provided. - 'kind': Literal['unchanged'], - # A result id which will be sent on the next - # diagnostic request for the same document. - 'resultId': str, -}) -""" An unchanged diagnostic report with a set of related documents. + @since 3.17.0 """ + notebookSelector: List[Union['NotebookDocumentFilterWithNotebook', 'NotebookDocumentFilterWithCells']] + """ The notebooks to be synced """ + save: NotRequired[bool] + """ Whether save notification should be forwarded to + the server. Will only be honored if mode === `notebook`. """ -@since 3.17.0 """ +class VersionedNotebookDocumentIdentifier(TypedDict): + """ A versioned notebook document identifier. -FullDocumentDiagnosticReport = TypedDict('FullDocumentDiagnosticReport', { - # A full document diagnostic report. - 'kind': Literal['full'], - # An optional result id. If provided it will - # be sent on the next diagnostic request for the - # same document. - 'resultId': NotRequired[str], - # The actual items. - 'items': List['Diagnostic'], -}) -""" A diagnostic report with a full set of problems. + @since 3.17.0 """ + version: int + """ The version number of this notebook document. """ + uri: 'URI' + """ The notebook document's uri. """ -@since 3.17.0 """ +class NotebookDocumentChangeEvent(TypedDict): + """ A change event for a notebook document. -UnchangedDocumentDiagnosticReport = TypedDict('UnchangedDocumentDiagnosticReport', { - # A document diagnostic report indicating - # no changes to the last result. A server can - # only return `unchanged` if result ids are - # provided. - 'kind': Literal['unchanged'], - # A result id which will be sent on the next - # diagnostic request for the same document. - 'resultId': str, -}) -""" A diagnostic report indicating that the last returned -report is still accurate. + @since 3.17.0 """ + metadata: NotRequired['LSPObject'] + """ The changed meta data if any. -@since 3.17.0 """ + Note: should always be an object literal (e.g. LSPObject) """ + cells: NotRequired['NotebookDocumentCellChanges'] + """ Changes to cells """ -DiagnosticOptions = TypedDict('DiagnosticOptions', { - # An optional identifier under which the diagnostics are - # managed by the client. - 'identifier': NotRequired[str], - # Whether the language has inter file dependencies meaning that - # editing code in one file can result in a different diagnostic - # set in another file. Inter file dependencies are common for - # most programming languages and typically uncommon for linters. - 'interFileDependencies': bool, - # The server provides support for workspace diagnostics as well. - 'workspaceDiagnostics': bool, - 'workDoneProgress': NotRequired[bool], -}) -""" Diagnostic options. +class NotebookDocumentIdentifier(TypedDict): + """ A literal to identify a notebook document in the client. -@since 3.17.0 """ + @since 3.17.0 """ + uri: 'URI' + """ The notebook document's uri. """ -PreviousResultId = TypedDict('PreviousResultId', { - # The URI for which the client knowns a - # result id. - 'uri': 'DocumentUri', - # The value of the previous result id. - 'value': str, -}) -""" A previous result id in a workspace pull request. +class InlineCompletionContext(TypedDict): + """ Provides information about the context in which an inline completion was requested. -@since 3.17.0 """ + @since 3.18.0 + @proposed """ + triggerKind: 'InlineCompletionTriggerKind' + """ Describes how the inline completion was triggered. """ + selectedCompletionInfo: NotRequired['SelectedCompletionInfo'] + """ Provides information about the currently selected item in the autocomplete widget if it is visible. """ -NotebookDocument = TypedDict('NotebookDocument', { - # The notebook document's uri. - 'uri': 'URI', - # The type of the notebook. - 'notebookType': str, - # The version number of this document (it will increase after each - # change, including undo/redo). - 'version': int, - # Additional metadata stored with the notebook - # document. - # - # Note: should always be an object literal (e.g. LSPObject) - 'metadata': NotRequired['LSPObject'], - # The cells of a notebook. - 'cells': List['NotebookCell'], -}) -""" A notebook document. +class StringValue(TypedDict): + """ A string value used as a snippet is a template which allows to insert text + and to control the editor cursor when insertion happens. -@since 3.17.0 """ + A snippet can define tab stops and placeholders with `$1`, `$2` + and `${3:foo}`. `$0` defines the final tab stop, it defaults to + the end of the snippet. Variables are defined with `$name` and + `${name:default value}`. + @since 3.18.0 + @proposed """ + kind: Literal['snippet'] + """ The kind of string value. """ + value: str + """ The snippet string. """ -TextDocumentItem = TypedDict('TextDocumentItem', { - # The text document's uri. - 'uri': 'DocumentUri', - # The text document's language identifier. - 'languageId': str, - # The version number of this document (it will increase after each - # change, including undo/redo). - 'version': int, - # The content of the opened text document. - 'text': str, -}) -""" An item to transfer a text document from the client to the -server. """ +class InlineCompletionOptions(TypedDict): + """ Inline completion options used during static registration. -VersionedNotebookDocumentIdentifier = TypedDict('VersionedNotebookDocumentIdentifier', { - # The version number of this notebook document. - 'version': int, - # The notebook document's uri. - 'uri': 'URI', -}) -""" A versioned notebook document identifier. + @since 3.18.0 + @proposed """ + workDoneProgress: NotRequired[bool] -@since 3.17.0 """ +class Registration(TypedDict): + """ General parameters to register for a notification or to register a provider. """ + id: str + """ The id used to register the request. The id can be used to deregister + the request again. """ + method: str + """ The method / capability to register for. """ + registerOptions: NotRequired['LSPAny'] + """ Options necessary for the registration. """ -NotebookDocumentChangeEvent = TypedDict('NotebookDocumentChangeEvent', { - # The changed meta data if any. - # - # Note: should always be an object literal (e.g. LSPObject) - 'metadata': NotRequired['LSPObject'], - # Changes to cells - 'cells': NotRequired['__NotebookDocumentChangeEvent_cells_Type_1'], -}) -""" A change event for a notebook document. -@since 3.17.0 """ +class Unregistration(TypedDict): + """ General parameters to unregister a request or notification. """ + id: str + """ The id used to unregister the request or notification. Usually an id + provided during the register request. """ + method: str + """ The method to unregister for. """ -NotebookDocumentIdentifier = TypedDict('NotebookDocumentIdentifier', { - # The notebook document's uri. - 'uri': 'URI', -}) -""" A literal to identify a notebook document in the client. +class WorkspaceFoldersInitializeParams(TypedDict): + workspaceFolders: NotRequired[Union[List['WorkspaceFolder'], None]] + """ The workspace folders configured in the client when the server starts. -@since 3.17.0 """ + This property is only available if the client supports workspace folders. + It can be `null` if the client supports workspace folders but none are + configured. + @since 3.6.0 """ -InlineCompletionContext = TypedDict('InlineCompletionContext', { - # Describes how the inline completion was triggered. - 'triggerKind': 'InlineCompletionTriggerKind', - # Provides information about the currently selected item in the autocomplete widget if it is visible. - 'selectedCompletionInfo': NotRequired['SelectedCompletionInfo'], -}) -""" Provides information about the context in which an inline completion was requested. -@since 3.18.0 -@proposed """ +class ServerCapabilities(TypedDict): + """ Defines the capabilities provided by a language + server. """ + positionEncoding: NotRequired['PositionEncodingKind'] + """ The position encoding the server picked from the encodings offered + by the client via the client capability `general.positionEncodings`. + If the client didn't provide any position encodings the only valid + value that a server can return is 'utf-16'. -StringValue = TypedDict('StringValue', { - # The kind of string value. - 'kind': Literal['snippet'], - # The snippet string. - 'value': str, -}) -""" A string value used as a snippet is a template which allows to insert text -and to control the editor cursor when insertion happens. + If omitted it defaults to 'utf-16'. -A snippet can define tab stops and placeholders with `$1`, `$2` -and `${3:foo}`. `$0` defines the final tab stop, it defaults to -the end of the snippet. Variables are defined with `$name` and -`${name:default value}`. + @since 3.17.0 """ + textDocumentSync: NotRequired[Union['TextDocumentSyncOptions', 'TextDocumentSyncKind']] + """ Defines how text documents are synced. Is either a detailed structure + defining each notification or for backwards compatibility the + TextDocumentSyncKind number. """ + notebookDocumentSync: NotRequired[Union['NotebookDocumentSyncOptions', 'NotebookDocumentSyncRegistrationOptions']] + """ Defines how notebook documents are synced. -@since 3.18.0 -@proposed """ + @since 3.17.0 """ + completionProvider: NotRequired['CompletionOptions'] + """ The server provides completion support. """ + hoverProvider: NotRequired[Union[bool, 'HoverOptions']] + """ The server provides hover support. """ + signatureHelpProvider: NotRequired['SignatureHelpOptions'] + """ The server provides signature help support. """ + declarationProvider: NotRequired[Union[bool, 'DeclarationOptions', 'DeclarationRegistrationOptions']] + """ The server provides Goto Declaration support. """ + definitionProvider: NotRequired[Union[bool, 'DefinitionOptions']] + """ The server provides goto definition support. """ + typeDefinitionProvider: NotRequired[Union[bool, 'TypeDefinitionOptions', 'TypeDefinitionRegistrationOptions']] + """ The server provides Goto Type Definition support. """ + implementationProvider: NotRequired[Union[bool, 'ImplementationOptions', 'ImplementationRegistrationOptions']] + """ The server provides Goto Implementation support. """ + referencesProvider: NotRequired[Union[bool, 'ReferenceOptions']] + """ The server provides find references support. """ + documentHighlightProvider: NotRequired[Union[bool, 'DocumentHighlightOptions']] + """ The server provides document highlight support. """ + documentSymbolProvider: NotRequired[Union[bool, 'DocumentSymbolOptions']] + """ The server provides document symbol support. """ + codeActionProvider: NotRequired[Union[bool, 'CodeActionOptions']] + """ The server provides code actions. CodeActionOptions may only be + specified if the client states that it supports + `codeActionLiteralSupport` in its initial `initialize` request. """ + codeLensProvider: NotRequired['CodeLensOptions'] + """ The server provides code lens. """ + documentLinkProvider: NotRequired['DocumentLinkOptions'] + """ The server provides document link support. """ + colorProvider: NotRequired[Union[bool, 'DocumentColorOptions', 'DocumentColorRegistrationOptions']] + """ The server provides color provider support. """ + workspaceSymbolProvider: NotRequired[Union[bool, 'WorkspaceSymbolOptions']] + """ The server provides workspace symbol support. """ + documentFormattingProvider: NotRequired[Union[bool, 'DocumentFormattingOptions']] + """ The server provides document formatting. """ + documentRangeFormattingProvider: NotRequired[Union[bool, 'DocumentRangeFormattingOptions']] + """ The server provides document range formatting. """ + documentOnTypeFormattingProvider: NotRequired['DocumentOnTypeFormattingOptions'] + """ The server provides document formatting on typing. """ + renameProvider: NotRequired[Union[bool, 'RenameOptions']] + """ The server provides rename support. RenameOptions may only be + specified if the client states that it supports + `prepareSupport` in its initial `initialize` request. """ + foldingRangeProvider: NotRequired[Union[bool, 'FoldingRangeOptions', 'FoldingRangeRegistrationOptions']] + """ The server provides folding provider support. """ + selectionRangeProvider: NotRequired[Union[bool, 'SelectionRangeOptions', 'SelectionRangeRegistrationOptions']] + """ The server provides selection range support. """ + executeCommandProvider: NotRequired['ExecuteCommandOptions'] + """ The server provides execute command support. """ + callHierarchyProvider: NotRequired[Union[bool, 'CallHierarchyOptions', 'CallHierarchyRegistrationOptions']] + """ The server provides call hierarchy support. + @since 3.16.0 """ + linkedEditingRangeProvider: NotRequired[Union[bool, 'LinkedEditingRangeOptions', 'LinkedEditingRangeRegistrationOptions']] + """ The server provides linked editing range support. -InlineCompletionOptions = TypedDict('InlineCompletionOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Inline completion options used during static registration. + @since 3.16.0 """ + semanticTokensProvider: NotRequired[Union['SemanticTokensOptions', 'SemanticTokensRegistrationOptions']] + """ The server provides semantic tokens support. -@since 3.18.0 -@proposed """ + @since 3.16.0 """ + monikerProvider: NotRequired[Union[bool, 'MonikerOptions', 'MonikerRegistrationOptions']] + """ The server provides moniker support. + @since 3.16.0 """ + typeHierarchyProvider: NotRequired[Union[bool, 'TypeHierarchyOptions', 'TypeHierarchyRegistrationOptions']] + """ The server provides type hierarchy support. -Registration = TypedDict('Registration', { - # The id used to register the request. The id can be used to deregister - # the request again. - 'id': str, - # The method / capability to register for. - 'method': str, - # Options necessary for the registration. - 'registerOptions': NotRequired['LSPAny'], -}) -""" General parameters to register for a notification or to register a provider. """ + @since 3.17.0 """ + inlineValueProvider: NotRequired[Union[bool, 'InlineValueOptions', 'InlineValueRegistrationOptions']] + """ The server provides inline values. + @since 3.17.0 """ + inlayHintProvider: NotRequired[Union[bool, 'InlayHintOptions', 'InlayHintRegistrationOptions']] + """ The server provides inlay hints. -Unregistration = TypedDict('Unregistration', { - # The id used to unregister the request or notification. Usually an id - # provided during the register request. - 'id': str, - # The method to unregister for. - 'method': str, -}) -""" General parameters to unregister a request or notification. """ - - -WorkspaceFoldersInitializeParams = TypedDict('WorkspaceFoldersInitializeParams', { - # The workspace folders configured in the client when the server starts. - # - # This property is only available if the client supports workspace folders. - # It can be `null` if the client supports workspace folders but none are - # configured. - # - # @since 3.6.0 - 'workspaceFolders': NotRequired[Union[List['WorkspaceFolder'], None]], -}) + @since 3.17.0 """ + diagnosticProvider: NotRequired[Union['DiagnosticOptions', 'DiagnosticRegistrationOptions']] + """ The server has support for pull model diagnostics. + @since 3.17.0 """ + inlineCompletionProvider: NotRequired[Union[bool, 'InlineCompletionOptions']] + """ Inline completion options used during static registration. -ServerCapabilities = TypedDict('ServerCapabilities', { - # The position encoding the server picked from the encodings offered - # by the client via the client capability `general.positionEncodings`. - # - # If the client didn't provide any position encodings the only valid - # value that a server can return is 'utf-16'. - # - # If omitted it defaults to 'utf-16'. - # - # @since 3.17.0 - 'positionEncoding': NotRequired['PositionEncodingKind'], - # Defines how text documents are synced. Is either a detailed structure - # defining each notification or for backwards compatibility the - # TextDocumentSyncKind number. - 'textDocumentSync': NotRequired[Union['TextDocumentSyncOptions', 'TextDocumentSyncKind']], - # Defines how notebook documents are synced. - # - # @since 3.17.0 - 'notebookDocumentSync': NotRequired[Union['NotebookDocumentSyncOptions', 'NotebookDocumentSyncRegistrationOptions']], - # The server provides completion support. - 'completionProvider': NotRequired['CompletionOptions'], - # The server provides hover support. - 'hoverProvider': NotRequired[Union[bool, 'HoverOptions']], - # The server provides signature help support. - 'signatureHelpProvider': NotRequired['SignatureHelpOptions'], - # The server provides Goto Declaration support. - 'declarationProvider': NotRequired[Union[bool, 'DeclarationOptions', 'DeclarationRegistrationOptions']], - # The server provides goto definition support. - 'definitionProvider': NotRequired[Union[bool, 'DefinitionOptions']], - # The server provides Goto Type Definition support. - 'typeDefinitionProvider': NotRequired[Union[bool, 'TypeDefinitionOptions', 'TypeDefinitionRegistrationOptions']], - # The server provides Goto Implementation support. - 'implementationProvider': NotRequired[Union[bool, 'ImplementationOptions', 'ImplementationRegistrationOptions']], - # The server provides find references support. - 'referencesProvider': NotRequired[Union[bool, 'ReferenceOptions']], - # The server provides document highlight support. - 'documentHighlightProvider': NotRequired[Union[bool, 'DocumentHighlightOptions']], - # The server provides document symbol support. - 'documentSymbolProvider': NotRequired[Union[bool, 'DocumentSymbolOptions']], - # The server provides code actions. CodeActionOptions may only be - # specified if the client states that it supports - # `codeActionLiteralSupport` in its initial `initialize` request. - 'codeActionProvider': NotRequired[Union[bool, 'CodeActionOptions']], - # The server provides code lens. - 'codeLensProvider': NotRequired['CodeLensOptions'], - # The server provides document link support. - 'documentLinkProvider': NotRequired['DocumentLinkOptions'], - # The server provides color provider support. - 'colorProvider': NotRequired[Union[bool, 'DocumentColorOptions', 'DocumentColorRegistrationOptions']], - # The server provides workspace symbol support. - 'workspaceSymbolProvider': NotRequired[Union[bool, 'WorkspaceSymbolOptions']], - # The server provides document formatting. - 'documentFormattingProvider': NotRequired[Union[bool, 'DocumentFormattingOptions']], - # The server provides document range formatting. - 'documentRangeFormattingProvider': NotRequired[Union[bool, 'DocumentRangeFormattingOptions']], - # The server provides document formatting on typing. - 'documentOnTypeFormattingProvider': NotRequired['DocumentOnTypeFormattingOptions'], - # The server provides rename support. RenameOptions may only be - # specified if the client states that it supports - # `prepareSupport` in its initial `initialize` request. - 'renameProvider': NotRequired[Union[bool, 'RenameOptions']], - # The server provides folding provider support. - 'foldingRangeProvider': NotRequired[Union[bool, 'FoldingRangeOptions', 'FoldingRangeRegistrationOptions']], - # The server provides selection range support. - 'selectionRangeProvider': NotRequired[Union[bool, 'SelectionRangeOptions', 'SelectionRangeRegistrationOptions']], - # The server provides execute command support. - 'executeCommandProvider': NotRequired['ExecuteCommandOptions'], - # The server provides call hierarchy support. - # - # @since 3.16.0 - 'callHierarchyProvider': NotRequired[Union[bool, 'CallHierarchyOptions', 'CallHierarchyRegistrationOptions']], - # The server provides linked editing range support. - # - # @since 3.16.0 - 'linkedEditingRangeProvider': NotRequired[Union[bool, 'LinkedEditingRangeOptions', 'LinkedEditingRangeRegistrationOptions']], - # The server provides semantic tokens support. - # - # @since 3.16.0 - 'semanticTokensProvider': NotRequired[Union['SemanticTokensOptions', 'SemanticTokensRegistrationOptions']], - # The server provides moniker support. - # - # @since 3.16.0 - 'monikerProvider': NotRequired[Union[bool, 'MonikerOptions', 'MonikerRegistrationOptions']], - # The server provides type hierarchy support. - # - # @since 3.17.0 - 'typeHierarchyProvider': NotRequired[Union[bool, 'TypeHierarchyOptions', 'TypeHierarchyRegistrationOptions']], - # The server provides inline values. - # - # @since 3.17.0 - 'inlineValueProvider': NotRequired[Union[bool, 'InlineValueOptions', 'InlineValueRegistrationOptions']], - # The server provides inlay hints. - # - # @since 3.17.0 - 'inlayHintProvider': NotRequired[Union[bool, 'InlayHintOptions', 'InlayHintRegistrationOptions']], - # The server has support for pull model diagnostics. - # - # @since 3.17.0 - 'diagnosticProvider': NotRequired[Union['DiagnosticOptions', 'DiagnosticRegistrationOptions']], - # Inline completion options used during static registration. - # - # @since 3.18.0 - # @proposed - 'inlineCompletionProvider': NotRequired[Union[bool, 'InlineCompletionOptions']], - # Workspace specific server capabilities. - 'workspace': NotRequired['__ServerCapabilities_workspace_Type_1'], - # Experimental server capabilities. - 'experimental': NotRequired['LSPAny'], -}) -""" Defines the capabilities provided by a language -server. """ + @since 3.18.0 + @proposed """ + workspace: NotRequired['WorkspaceOptions'] + """ Workspace specific server capabilities. """ + experimental: NotRequired['LSPAny'] + """ Experimental server capabilities. """ + + +class ServerInfo(TypedDict): + """ Information about the server + + @since 3.15.0 + @since 3.18.0 ServerInfo type name added. """ + name: str + """ The name of the server as defined by the server. """ + version: NotRequired[str] + """ The server's version as defined by the server. """ + + +class VersionedTextDocumentIdentifier(TypedDict): + """ A text document identifier to denote a specific version of a text document. """ + version: int + """ The version number of this document. """ + uri: 'DocumentUri' + """ The text document's uri. """ + + +class SaveOptions(TypedDict): + """ Save options. """ + includeText: NotRequired[bool] + """ The client is supposed to include the content on save. """ + + +class FileEvent(TypedDict): + """ An event describing a file change. """ + uri: 'DocumentUri' + """ The file's uri. """ + type: 'FileChangeType' + """ The change type. """ + + +class FileSystemWatcher(TypedDict): + globPattern: 'GlobPattern' + """ The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail. + + @since 3.17.0 support for relative patterns. """ + kind: NotRequired['WatchKind'] + """ The kind of events of interest. If omitted it defaults + to WatchKind.Create | WatchKind.Change | WatchKind.Delete + which is 7. """ + + +class Diagnostic(TypedDict): + """ Represents a diagnostic, such as a compiler error or warning. Diagnostic objects + are only valid in the scope of a resource. """ + range: 'Range' + """ The range at which the message applies """ + severity: NotRequired['DiagnosticSeverity'] + """ The diagnostic's severity. Can be omitted. If omitted it is up to the + client to interpret diagnostics as error, warning, info or hint. """ + code: NotRequired[Union[int, str]] + """ The diagnostic's code, which usually appear in the user interface. """ + codeDescription: NotRequired['CodeDescription'] + """ An optional property to describe the error code. + Requires the code field (above) to be present/not null. + @since 3.16.0 """ + source: NotRequired[str] + """ A human-readable string describing the source of this + diagnostic, e.g. 'typescript' or 'super lint'. It usually + appears in the user interface. """ + message: str + """ The diagnostic's message. It usually appears in the user interface """ + tags: NotRequired[List['DiagnosticTag']] + """ Additional metadata about the diagnostic. -VersionedTextDocumentIdentifier = TypedDict('VersionedTextDocumentIdentifier', { - # The version number of this document. - 'version': int, - # The text document's uri. - 'uri': 'DocumentUri', -}) -""" A text document identifier to denote a specific version of a text document. """ + @since 3.15.0 """ + relatedInformation: NotRequired[List['DiagnosticRelatedInformation']] + """ An array of related diagnostic information, e.g. when symbol-names within + a scope collide all definitions can be marked via this property. """ + data: NotRequired['LSPAny'] + """ A data entry field that is preserved between a `textDocument/publishDiagnostics` + notification and `textDocument/codeAction` request. + @since 3.16.0 """ -SaveOptions = TypedDict('SaveOptions', { - # The client is supposed to include the content on save. - 'includeText': NotRequired[bool], -}) -""" Save options. """ +class CompletionContext(TypedDict): + """ Contains additional information about the context in which a completion request is triggered. """ + triggerKind: 'CompletionTriggerKind' + """ How the completion was triggered. """ + triggerCharacter: NotRequired[str] + """ The trigger character (a single character) that has trigger code complete. + Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter` """ -FileEvent = TypedDict('FileEvent', { - # The file's uri. - 'uri': 'DocumentUri', - # The change type. - 'type': 'FileChangeType', -}) -""" An event describing a file change. """ - - -FileSystemWatcher = TypedDict('FileSystemWatcher', { - # The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail. - # - # @since 3.17.0 support for relative patterns. - 'globPattern': 'GlobPattern', - # The kind of events of interest. If omitted it defaults - # to WatchKind.Create | WatchKind.Change | WatchKind.Delete - # which is 7. - 'kind': NotRequired['WatchKind'], -}) +class CompletionItemLabelDetails(TypedDict): + """ Additional details for a completion item label. -Diagnostic = TypedDict('Diagnostic', { - # The range at which the message applies - 'range': 'Range', - # The diagnostic's severity. Can be omitted. If omitted it is up to the - # client to interpret diagnostics as error, warning, info or hint. - 'severity': NotRequired['DiagnosticSeverity'], - # The diagnostic's code, which usually appear in the user interface. - 'code': NotRequired[Union[int, str]], - # An optional property to describe the error code. - # Requires the code field (above) to be present/not null. - # - # @since 3.16.0 - 'codeDescription': NotRequired['CodeDescription'], - # A human-readable string describing the source of this - # diagnostic, e.g. 'typescript' or 'super lint'. It usually - # appears in the user interface. - 'source': NotRequired[str], - # The diagnostic's message. It usually appears in the user interface - 'message': str, - # Additional metadata about the diagnostic. - # - # @since 3.15.0 - 'tags': NotRequired[List['DiagnosticTag']], - # An array of related diagnostic information, e.g. when symbol-names within - # a scope collide all definitions can be marked via this property. - 'relatedInformation': NotRequired[List['DiagnosticRelatedInformation']], - # A data entry field that is preserved between a `textDocument/publishDiagnostics` - # notification and `textDocument/codeAction` request. - # - # @since 3.16.0 - 'data': NotRequired['LSPAny'], -}) -""" Represents a diagnostic, such as a compiler error or warning. Diagnostic objects -are only valid in the scope of a resource. """ + @since 3.17.0 """ + detail: NotRequired[str] + """ An optional string which is rendered less prominently directly after {@link CompletionItem.label label}, + without any spacing. Should be used for function signatures and type annotations. """ + description: NotRequired[str] + """ An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used + for fully qualified names and file paths. """ -CompletionContext = TypedDict('CompletionContext', { - # How the completion was triggered. - 'triggerKind': 'CompletionTriggerKind', - # The trigger character (a single character) that has trigger code complete. - # Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter` - 'triggerCharacter': NotRequired[str], -}) -""" Contains additional information about the context in which a completion request is triggered. """ +class InsertReplaceEdit(TypedDict): + """ A special text edit to provide an insert and a replace operation. + @since 3.16.0 """ + newText: str + """ The string to be inserted. """ + insert: 'Range' + """ The range if the insert is requested """ + replace: 'Range' + """ The range if the replace is requested. """ -CompletionItemLabelDetails = TypedDict('CompletionItemLabelDetails', { - # An optional string which is rendered less prominently directly after {@link CompletionItem.label label}, - # without any spacing. Should be used for function signatures and type annotations. - 'detail': NotRequired[str], - # An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used - # for fully qualified names and file paths. - 'description': NotRequired[str], -}) -""" Additional details for a completion item label. -@since 3.17.0 """ +class CompletionItemDefaults(TypedDict): + """ In many cases the items of an actual completion result share the same + value for properties like `commitCharacters` or the range of a text + edit. A completion list can therefore define item defaults which will + be used if a completion item itself doesn't specify the value. + If a completion list specifies a default value and a completion item + also specifies a corresponding value the one from the item is used. -InsertReplaceEdit = TypedDict('InsertReplaceEdit', { - # The string to be inserted. - 'newText': str, - # The range if the insert is requested - 'insert': 'Range', - # The range if the replace is requested. - 'replace': 'Range', -}) -""" A special text edit to provide an insert and a replace operation. + Servers are only allowed to return default values if the client + signals support for this via the `completionList.itemDefaults` + capability. -@since 3.16.0 """ + @since 3.17.0 """ + commitCharacters: NotRequired[List[str]] + """ A default commit character set. + @since 3.17.0 """ + editRange: NotRequired[Union['Range', 'EditRangeWithInsertReplace']] + """ A default edit range. -CompletionOptions = TypedDict('CompletionOptions', { - # Most tools trigger completion request automatically without explicitly requesting - # it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user - # starts to type an identifier. For example if the user types `c` in a JavaScript file - # code complete will automatically pop up present `console` besides others as a - # completion item. Characters that make up identifiers don't need to be listed here. - # - # If code complete should automatically be trigger on characters not being valid inside - # an identifier (for example `.` in JavaScript) list them in `triggerCharacters`. - 'triggerCharacters': NotRequired[List[str]], - # The list of all possible characters that commit a completion. This field can be used - # if clients don't support individual commit characters per completion item. See - # `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport` - # - # If a server provides both `allCommitCharacters` and commit characters on an individual - # completion item the ones on the completion item win. - # - # @since 3.2.0 - 'allCommitCharacters': NotRequired[List[str]], - # The server provides support to resolve additional - # information for a completion item. - 'resolveProvider': NotRequired[bool], - # The server supports the following `CompletionItem` specific - # capabilities. - # - # @since 3.17.0 - 'completionItem': NotRequired['__CompletionOptions_completionItem_Type_2'], - 'workDoneProgress': NotRequired[bool], -}) -""" Completion options. """ + @since 3.17.0 """ + insertTextFormat: NotRequired['InsertTextFormat'] + """ A default insert text format. + @since 3.17.0 """ + insertTextMode: NotRequired['InsertTextMode'] + """ A default insert text mode. -HoverOptions = TypedDict('HoverOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Hover options. """ - - -SignatureHelpContext = TypedDict('SignatureHelpContext', { - # Action that caused signature help to be triggered. - 'triggerKind': 'SignatureHelpTriggerKind', - # Character that caused signature help to be triggered. - # - # This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter` - 'triggerCharacter': NotRequired[str], - # `true` if signature help was already showing when it was triggered. - # - # Retriggers occurs when the signature help is already active and can be caused by actions such as - # typing a trigger character, a cursor move, or document content changes. - 'isRetrigger': bool, - # The currently active `SignatureHelp`. - # - # The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on - # the user navigating through available signatures. - 'activeSignatureHelp': NotRequired['SignatureHelp'], -}) -""" Additional information about the context in which a signature help request was triggered. - -@since 3.15.0 """ - - -SignatureInformation = TypedDict('SignatureInformation', { - # The label of this signature. Will be shown in - # the UI. - 'label': str, - # The human-readable doc-comment of this signature. Will be shown - # in the UI but can be omitted. - 'documentation': NotRequired[Union[str, 'MarkupContent']], - # The parameters of this signature. - 'parameters': NotRequired[List['ParameterInformation']], - # The index of the active parameter. - # - # If provided, this is used in place of `SignatureHelp.activeParameter`. - # - # @since 3.16.0 - 'activeParameter': NotRequired[Uint], -}) -""" Represents the signature of something callable. A signature -can have a label, like a function-name, a doc-comment, and -a set of parameters. """ - - -SignatureHelpOptions = TypedDict('SignatureHelpOptions', { - # List of characters that trigger signature help automatically. - 'triggerCharacters': NotRequired[List[str]], - # List of characters that re-trigger signature help. - # - # These trigger characters are only active when signature help is already showing. All trigger characters - # are also counted as re-trigger characters. - # - # @since 3.15.0 - 'retriggerCharacters': NotRequired[List[str]], - 'workDoneProgress': NotRequired[bool], -}) -""" Server Capabilities for a {@link SignatureHelpRequest}. """ + @since 3.17.0 """ + data: NotRequired['LSPAny'] + """ A default data value. + @since 3.17.0 """ -DefinitionOptions = TypedDict('DefinitionOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Server Capabilities for a {@link DefinitionRequest}. """ +class CompletionOptions(TypedDict): + """ Completion options. """ + triggerCharacters: NotRequired[List[str]] + """ Most tools trigger completion request automatically without explicitly requesting + it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user + starts to type an identifier. For example if the user types `c` in a JavaScript file + code complete will automatically pop up present `console` besides others as a + completion item. Characters that make up identifiers don't need to be listed here. + + If code complete should automatically be trigger on characters not being valid inside + an identifier (for example `.` in JavaScript) list them in `triggerCharacters`. """ + allCommitCharacters: NotRequired[List[str]] + """ The list of all possible characters that commit a completion. This field can be used + if clients don't support individual commit characters per completion item. See + `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport` + + If a server provides both `allCommitCharacters` and commit characters on an individual + completion item the ones on the completion item win. + + @since 3.2.0 """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for a completion item. """ + completionItem: NotRequired['ServerCompletionItemOptions'] + """ The server supports the following `CompletionItem` specific + capabilities. -ReferenceContext = TypedDict('ReferenceContext', { - # Include the declaration of the current symbol. - 'includeDeclaration': bool, -}) -""" Value-object that contains additional information when -requesting references. """ + @since 3.17.0 """ + workDoneProgress: NotRequired[bool] -ReferenceOptions = TypedDict('ReferenceOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Reference options. """ +class HoverOptions(TypedDict): + """ Hover options. """ + workDoneProgress: NotRequired[bool] -DocumentHighlightOptions = TypedDict('DocumentHighlightOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Provider options for a {@link DocumentHighlightRequest}. """ - - -BaseSymbolInformation = TypedDict('BaseSymbolInformation', { - # The name of this symbol. - 'name': str, - # The kind of this symbol. - 'kind': 'SymbolKind', - # Tags for this symbol. - # - # @since 3.16.0 - 'tags': NotRequired[List['SymbolTag']], - # The name of the symbol containing this symbol. This information is for - # user interface purposes (e.g. to render a qualifier in the user interface - # if necessary). It can't be used to re-infer a hierarchy for the document - # symbols. - 'containerName': NotRequired[str], -}) -""" A base for all symbol information. """ +class SignatureHelpContext(TypedDict): + """ Additional information about the context in which a signature help request was triggered. + @since 3.15.0 """ + triggerKind: 'SignatureHelpTriggerKind' + """ Action that caused signature help to be triggered. """ + triggerCharacter: NotRequired[str] + """ Character that caused signature help to be triggered. + + This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter` """ + isRetrigger: bool + """ `true` if signature help was already showing when it was triggered. + + Retriggers occurs when the signature help is already active and can be caused by actions such as + typing a trigger character, a cursor move, or document content changes. """ + activeSignatureHelp: NotRequired['SignatureHelp'] + """ The currently active `SignatureHelp`. + + The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on + the user navigating through available signatures. """ + + +class SignatureInformation(TypedDict): + """ Represents the signature of something callable. A signature + can have a label, like a function-name, a doc-comment, and + a set of parameters. """ + label: str + """ The label of this signature. Will be shown in + the UI. """ + documentation: NotRequired[Union[str, 'MarkupContent']] + """ The human-readable doc-comment of this signature. Will be shown + in the UI but can be omitted. """ + parameters: NotRequired[List['ParameterInformation']] + """ The parameters of this signature. """ + activeParameter: NotRequired[Union[Uint, None]] + """ The index of the active parameter. + + If `null`, no parameter of the signature is active (for example a named + argument that does not match any declared parameters). This is only valid + if the client specifies the client capability + `textDocument.signatureHelp.noActiveParameterSupport === true` + + If provided (or `null`), this is used in place of + `SignatureHelp.activeParameter`. -DocumentSymbolOptions = TypedDict('DocumentSymbolOptions', { - # A human-readable string that is shown when multiple outlines trees - # are shown for the same document. - # - # @since 3.16.0 - 'label': NotRequired[str], - 'workDoneProgress': NotRequired[bool], -}) -""" Provider options for a {@link DocumentSymbolRequest}. """ - - -CodeActionContext = TypedDict('CodeActionContext', { - # An array of diagnostics known on the client side overlapping the range provided to the - # `textDocument/codeAction` request. They are provided so that the server knows which - # errors are currently presented to the user for the given range. There is no guarantee - # that these accurately reflect the error state of the resource. The primary parameter - # to compute code actions is the provided range. - 'diagnostics': List['Diagnostic'], - # Requested kind of actions to return. - # - # Actions not of this kind are filtered out by the client before being shown. So servers - # can omit computing them. - 'only': NotRequired[List['CodeActionKind']], - # The reason why code actions were requested. - # - # @since 3.17.0 - 'triggerKind': NotRequired['CodeActionTriggerKind'], -}) -""" Contains additional diagnostic information about the context in which -a {@link CodeActionProvider.provideCodeActions code action} is run. """ - - -CodeActionOptions = TypedDict('CodeActionOptions', { - # CodeActionKinds that this server may return. - # - # The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server - # may list out every specific kind they provide. - 'codeActionKinds': NotRequired[List['CodeActionKind']], - # The server provides support to resolve additional - # information for a code action. - # - # @since 3.16.0 - 'resolveProvider': NotRequired[bool], - 'workDoneProgress': NotRequired[bool], -}) -""" Provider options for a {@link CodeActionRequest}. """ + @since 3.16.0 """ -WorkspaceSymbolOptions = TypedDict('WorkspaceSymbolOptions', { - # The server provides support to resolve additional - # information for a workspace symbol. - # - # @since 3.17.0 - 'resolveProvider': NotRequired[bool], - 'workDoneProgress': NotRequired[bool], -}) -""" Server capabilities for a {@link WorkspaceSymbolRequest}. """ +class SignatureHelpOptions(TypedDict): + """ Server Capabilities for a {@link SignatureHelpRequest}. """ + triggerCharacters: NotRequired[List[str]] + """ List of characters that trigger signature help automatically. """ + retriggerCharacters: NotRequired[List[str]] + """ List of characters that re-trigger signature help. + These trigger characters are only active when signature help is already showing. All trigger characters + are also counted as re-trigger characters. -CodeLensOptions = TypedDict('CodeLensOptions', { - # Code lens has a resolve provider as well. - 'resolveProvider': NotRequired[bool], - 'workDoneProgress': NotRequired[bool], -}) -""" Code Lens provider options of a {@link CodeLensRequest}. """ + @since 3.15.0 """ + workDoneProgress: NotRequired[bool] -DocumentLinkOptions = TypedDict('DocumentLinkOptions', { - # Document links have a resolve provider as well. - 'resolveProvider': NotRequired[bool], - 'workDoneProgress': NotRequired[bool], -}) -""" Provider options for a {@link DocumentLinkRequest}. """ - - -FormattingOptions = TypedDict('FormattingOptions', { - # Size of a tab in spaces. - 'tabSize': Uint, - # Prefer spaces over tabs. - 'insertSpaces': bool, - # Trim trailing whitespace on a line. - # - # @since 3.15.0 - 'trimTrailingWhitespace': NotRequired[bool], - # Insert a newline character at the end of the file if one does not exist. - # - # @since 3.15.0 - 'insertFinalNewline': NotRequired[bool], - # Trim all newlines after the final newline at the end of the file. - # - # @since 3.15.0 - 'trimFinalNewlines': NotRequired[bool], -}) -""" Value-object describing what options formatting should use. """ +class DefinitionOptions(TypedDict): + """ Server Capabilities for a {@link DefinitionRequest}. """ + workDoneProgress: NotRequired[bool] -DocumentFormattingOptions = TypedDict('DocumentFormattingOptions', { - 'workDoneProgress': NotRequired[bool], -}) -""" Provider options for a {@link DocumentFormattingRequest}. """ +class ReferenceContext(TypedDict): + """ Value-object that contains additional information when + requesting references. """ + includeDeclaration: bool + """ Include the declaration of the current symbol. """ -DocumentRangeFormattingOptions = TypedDict('DocumentRangeFormattingOptions', { - # Whether the server supports formatting multiple ranges at once. - # - # @since 3.18.0 - # @proposed - 'rangesSupport': NotRequired[bool], - 'workDoneProgress': NotRequired[bool], -}) -""" Provider options for a {@link DocumentRangeFormattingRequest}. """ +class ReferenceOptions(TypedDict): + """ Reference options. """ + workDoneProgress: NotRequired[bool] -DocumentOnTypeFormattingOptions = TypedDict('DocumentOnTypeFormattingOptions', { - # A character on which formatting should be triggered, like `{`. - 'firstTriggerCharacter': str, - # More trigger characters. - 'moreTriggerCharacter': NotRequired[List[str]], -}) -""" Provider options for a {@link DocumentOnTypeFormattingRequest}. """ +class DocumentHighlightOptions(TypedDict): + """ Provider options for a {@link DocumentHighlightRequest}. """ + workDoneProgress: NotRequired[bool] -RenameOptions = TypedDict('RenameOptions', { - # Renames should be checked and tested before being executed. - # - # @since version 3.12.0 - 'prepareProvider': NotRequired[bool], - 'workDoneProgress': NotRequired[bool], -}) -""" Provider options for a {@link RenameRequest}. """ +class BaseSymbolInformation(TypedDict): + """ A base for all symbol information. """ + name: str + """ The name of this symbol. """ + kind: 'SymbolKind' + """ The kind of this symbol. """ + tags: NotRequired[List['SymbolTag']] + """ Tags for this symbol. + @since 3.16.0 """ + containerName: NotRequired[str] + """ The name of the symbol containing this symbol. This information is for + user interface purposes (e.g. to render a qualifier in the user interface + if necessary). It can't be used to re-infer a hierarchy for the document + symbols. """ -ExecuteCommandOptions = TypedDict('ExecuteCommandOptions', { - # The commands to be executed on the server - 'commands': List[str], - 'workDoneProgress': NotRequired[bool], -}) -""" The server capabilities of a {@link ExecuteCommandRequest}. """ +class DocumentSymbolOptions(TypedDict): + """ Provider options for a {@link DocumentSymbolRequest}. """ + label: NotRequired[str] + """ A human-readable string that is shown when multiple outlines trees + are shown for the same document. -SemanticTokensLegend = TypedDict('SemanticTokensLegend', { - # The token types a server uses. - 'tokenTypes': List[str], - # The token modifiers a server uses. - 'tokenModifiers': List[str], -}) -""" @since 3.16.0 """ - - -OptionalVersionedTextDocumentIdentifier = TypedDict('OptionalVersionedTextDocumentIdentifier', { - # The version number of this document. If a versioned text document identifier - # is sent from the server to the client and the file is not open in the editor - # (the server has not received an open notification before) the server can send - # `null` to indicate that the version is unknown and the content on disk is the - # truth (as specified with document content ownership). - 'version': Union[int, None], - # The text document's uri. - 'uri': 'DocumentUri', -}) -""" A text document identifier to optionally denote a specific version of a text document. """ + @since 3.16.0 """ + workDoneProgress: NotRequired[bool] + + +class CodeActionContext(TypedDict): + """ Contains additional diagnostic information about the context in which + a {@link CodeActionProvider.provideCodeActions code action} is run. """ + diagnostics: List['Diagnostic'] + """ An array of diagnostics known on the client side overlapping the range provided to the + `textDocument/codeAction` request. They are provided so that the server knows which + errors are currently presented to the user for the given range. There is no guarantee + that these accurately reflect the error state of the resource. The primary parameter + to compute code actions is the provided range. """ + only: NotRequired[List['CodeActionKind']] + """ Requested kind of actions to return. + + Actions not of this kind are filtered out by the client before being shown. So servers + can omit computing them. """ + triggerKind: NotRequired['CodeActionTriggerKind'] + """ The reason why code actions were requested. + @since 3.17.0 """ -AnnotatedTextEdit = TypedDict('AnnotatedTextEdit', { - # The actual identifier of the change annotation - 'annotationId': 'ChangeAnnotationIdentifier', - # The range of the text document to be manipulated. To insert - # text into a document create a range where start === end. - 'range': 'Range', - # The string to be inserted. For delete operations use an - # empty string. - 'newText': str, -}) -""" A special text edit with an additional change annotation. -@since 3.16.0. """ +class CodeActionDisabled(TypedDict): + """ Captures why the code action is currently disabled. + + @since 3.18.0 """ + reason: str + """ Human readable description of why the code action is currently disabled. + + This is displayed in the code actions UI. """ + + +class CodeActionOptions(TypedDict): + """ Provider options for a {@link CodeActionRequest}. """ + codeActionKinds: NotRequired[List['CodeActionKind']] + """ CodeActionKinds that this server may return. + + The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server + may list out every specific kind they provide. """ + documentation: NotRequired[List['CodeActionKindDocumentation']] + """ Static documentation for a class of code actions. + + Documentation from the provider should be shown in the code actions menu if either: + + - Code actions of `kind` are requested by the editor. In this case, the editor will show the documentation that + most closely matches the requested code action kind. For example, if a provider has documentation for + both `Refactor` and `RefactorExtract`, when the user requests code actions for `RefactorExtract`, + the editor will use the documentation for `RefactorExtract` instead of the documentation for `Refactor`. + + - Any code actions of `kind` are returned by the provider. + + At most one documentation entry should be shown per provider. + + @since 3.18.0 + @proposed """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for a code action. + + @since 3.16.0 """ + workDoneProgress: NotRequired[bool] + + +class LocationUriOnly(TypedDict): + """ Location with only uri and does not include range. + + @since 3.18.0 """ + uri: 'DocumentUri' + + +class WorkspaceSymbolOptions(TypedDict): + """ Server capabilities for a {@link WorkspaceSymbolRequest}. """ + resolveProvider: NotRequired[bool] + """ The server provides support to resolve additional + information for a workspace symbol. + + @since 3.17.0 """ + workDoneProgress: NotRequired[bool] + + +class CodeLensOptions(TypedDict): + """ Code Lens provider options of a {@link CodeLensRequest}. """ + resolveProvider: NotRequired[bool] + """ Code lens has a resolve provider as well. """ + workDoneProgress: NotRequired[bool] + + +class DocumentLinkOptions(TypedDict): + """ Provider options for a {@link DocumentLinkRequest}. """ + resolveProvider: NotRequired[bool] + """ Document links have a resolve provider as well. """ + workDoneProgress: NotRequired[bool] + + +class FormattingOptions(TypedDict): + """ Value-object describing what options formatting should use. """ + tabSize: Uint + """ Size of a tab in spaces. """ + insertSpaces: bool + """ Prefer spaces over tabs. """ + trimTrailingWhitespace: NotRequired[bool] + """ Trim trailing whitespace on a line. + + @since 3.15.0 """ + insertFinalNewline: NotRequired[bool] + """ Insert a newline character at the end of the file if one does not exist. + + @since 3.15.0 """ + trimFinalNewlines: NotRequired[bool] + """ Trim all newlines after the final newline at the end of the file. + + @since 3.15.0 """ + + +class DocumentFormattingOptions(TypedDict): + """ Provider options for a {@link DocumentFormattingRequest}. """ + workDoneProgress: NotRequired[bool] + + +class DocumentRangeFormattingOptions(TypedDict): + """ Provider options for a {@link DocumentRangeFormattingRequest}. """ + rangesSupport: NotRequired[bool] + """ Whether the server supports formatting multiple ranges at once. + + @since 3.18.0 + @proposed """ + workDoneProgress: NotRequired[bool] + + +class DocumentOnTypeFormattingOptions(TypedDict): + """ Provider options for a {@link DocumentOnTypeFormattingRequest}. """ + firstTriggerCharacter: str + """ A character on which formatting should be triggered, like `{`. """ + moreTriggerCharacter: NotRequired[List[str]] + """ More trigger characters. """ + + +class RenameOptions(TypedDict): + """ Provider options for a {@link RenameRequest}. """ + prepareProvider: NotRequired[bool] + """ Renames should be checked and tested before being executed. + + @since version 3.12.0 """ + workDoneProgress: NotRequired[bool] + + +class PrepareRenamePlaceholder(TypedDict): + """ @since 3.18.0 """ + range: 'Range' + placeholder: str + + +class PrepareRenameDefaultBehavior(TypedDict): + """ @since 3.18.0 """ + defaultBehavior: bool + + +class ExecuteCommandOptions(TypedDict): + """ The server capabilities of a {@link ExecuteCommandRequest}. """ + commands: List[str] + """ The commands to be executed on the server """ + workDoneProgress: NotRequired[bool] + + +class WorkspaceEditMetadata(TypedDict): + """ Additional data about a workspace edit. + + @since 3.18.0 + @proposed """ + isRefactoring: NotRequired[bool] + """ Signal to the editor that this edit is a refactoring. """ + + +class SemanticTokensLegend(TypedDict): + """ @since 3.16.0 """ + tokenTypes: List[str] + """ The token types a server uses. """ + tokenModifiers: List[str] + """ The token modifiers a server uses. """ + + +class SemanticTokensFullDelta(TypedDict): + """ Semantic tokens options to support deltas for full documents + + @since 3.18.0 """ + delta: NotRequired[bool] + """ The server supports deltas for full documents. """ + + +class OptionalVersionedTextDocumentIdentifier(TypedDict): + """ A text document identifier to optionally denote a specific version of a text document. """ + version: Union[int, None] + """ The version number of this document. If a versioned text document identifier + is sent from the server to the client and the file is not open in the editor + (the server has not received an open notification before) the server can send + `null` to indicate that the version is unknown and the content on disk is the + truth (as specified with document content ownership). """ + uri: 'DocumentUri' + """ The text document's uri. """ + + +class AnnotatedTextEdit(TypedDict): + """ A special text edit with an additional change annotation. + + @since 3.16.0. """ + annotationId: 'ChangeAnnotationIdentifier' + """ The actual identifier of the change annotation """ + range: 'Range' + """ The range of the text document to be manipulated. To insert + text into a document create a range where start === end. """ + newText: str + """ The string to be inserted. For delete operations use an + empty string. """ + + +class SnippetTextEdit(TypedDict): + """ An interactive text edit. + + @since 3.18.0 + @proposed """ + range: 'Range' + """ The range of the text document to be manipulated. """ + snippet: 'StringValue' + """ The snippet to be inserted. """ + annotationId: NotRequired['ChangeAnnotationIdentifier'] + """ The actual identifier of the snippet edit. """ + + +class ResourceOperation(TypedDict): + """ A generic resource operation. """ + kind: str + """ The resource operation kind. """ + annotationId: NotRequired['ChangeAnnotationIdentifier'] + """ An optional annotation identifier describing the operation. + + @since 3.16.0 """ + + +class CreateFileOptions(TypedDict): + """ Options to create a file. """ + overwrite: NotRequired[bool] + """ Overwrite existing file. Overwrite wins over `ignoreIfExists` """ + ignoreIfExists: NotRequired[bool] + """ Ignore if exists. """ + + +class RenameFileOptions(TypedDict): + """ Rename file options """ + overwrite: NotRequired[bool] + """ Overwrite target if existing. Overwrite wins over `ignoreIfExists` """ + ignoreIfExists: NotRequired[bool] + """ Ignores if target exists. """ + + +class DeleteFileOptions(TypedDict): + """ Delete file options """ + recursive: NotRequired[bool] + """ Delete the content recursively if a folder is denoted. """ + ignoreIfNotExists: NotRequired[bool] + """ Ignore the operation if the file doesn't exist. """ + + +class FileOperationPattern(TypedDict): + """ A pattern to describe in which file operation requests or notifications + the server is interested in receiving. + + @since 3.16.0 """ + glob: str + """ The glob pattern to match. Glob patterns can have the following syntax: + - `*` to match one or more characters in a path segment + - `?` to match on one character in a path segment + - `**` to match any number of path segments, including none + - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files) + - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) + - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`) """ + matches: NotRequired['FileOperationPatternKind'] + """ Whether to match files or folders with this pattern. + + Matches both if undefined. """ + options: NotRequired['FileOperationPatternOptions'] + """ Additional options used during matching. """ + + +class WorkspaceFullDocumentDiagnosticReport(TypedDict): + """ A full document diagnostic report for a workspace diagnostic result. + + @since 3.17.0 """ + uri: 'DocumentUri' + """ The URI for which diagnostic information is reported. """ + version: Union[int, None] + """ The version number for which the diagnostics are reported. + If the document is not marked as open `null` can be provided. """ + kind: Literal['full'] + """ A full document diagnostic report. """ + resultId: NotRequired[str] + """ An optional result id. If provided it will + be sent on the next diagnostic request for the + same document. """ + items: List['Diagnostic'] + """ The actual items. """ + + +class WorkspaceUnchangedDocumentDiagnosticReport(TypedDict): + """ An unchanged document diagnostic report for a workspace diagnostic result. + + @since 3.17.0 """ + uri: 'DocumentUri' + """ The URI for which diagnostic information is reported. """ + version: Union[int, None] + """ The version number for which the diagnostics are reported. + If the document is not marked as open `null` can be provided. """ + kind: Literal['unchanged'] + """ A document diagnostic report indicating + no changes to the last result. A server can + only return `unchanged` if result ids are + provided. """ + resultId: str + """ A result id which will be sent on the next + diagnostic request for the same document. """ + + +class NotebookCell(TypedDict): + """ A notebook cell. + + A cell's document URI must be unique across ALL notebook + cells and can therefore be used to uniquely identify a + notebook cell or the cell's text document. + + @since 3.17.0 """ + kind: 'NotebookCellKind' + """ The cell's kind """ + document: 'DocumentUri' + """ The URI of the cell's text document + content. """ + metadata: NotRequired['LSPObject'] + """ Additional metadata stored with the cell. + + Note: should always be an object literal (e.g. LSPObject) """ + executionSummary: NotRequired['ExecutionSummary'] + """ Additional execution summary information + if supported by the client. """ + + +class NotebookDocumentFilterWithNotebook(TypedDict): + """ @since 3.18.0 """ + notebook: Union[str, 'NotebookDocumentFilter'] + """ The notebook to be synced If a string + value is provided it matches against the + notebook type. '*' matches every notebook. """ + cells: NotRequired[List['NotebookCellLanguage']] + """ The cells of the matching notebook to be synced. """ + + +class NotebookDocumentFilterWithCells(TypedDict): + """ @since 3.18.0 """ + notebook: NotRequired[Union[str, 'NotebookDocumentFilter']] + """ The notebook to be synced If a string + value is provided it matches against the + notebook type. '*' matches every notebook. """ + cells: List['NotebookCellLanguage'] + """ The cells of the matching notebook to be synced. """ + + +class NotebookDocumentCellChanges(TypedDict): + """ Cell changes to a notebook document. + + @since 3.18.0 """ + structure: NotRequired['NotebookDocumentCellChangeStructure'] + """ Changes to the cell structure to add or + remove cells. """ + data: NotRequired[List['NotebookCell']] + """ Changes to notebook cells properties like its + kind, execution summary or metadata. """ + textContent: NotRequired[List['NotebookDocumentCellContentChanges']] + """ Changes to the text content of notebook cells. """ + + +class SelectedCompletionInfo(TypedDict): + """ Describes the currently selected completion item. + + @since 3.18.0 + @proposed """ + range: 'Range' + """ The range that will be replaced if this completion item is accepted. """ + text: str + """ The text the range will be replaced with if this completion is accepted. """ + + +class ClientInfo(TypedDict): + """ Information about the client + + @since 3.15.0 + @since 3.18.0 ClientInfo type name added. """ + name: str + """ The name of the client as defined by the client. """ + version: NotRequired[str] + """ The client's version as defined by the client. """ + + +class ClientCapabilities(TypedDict): + """ Defines the capabilities provided by the client. """ + workspace: NotRequired['WorkspaceClientCapabilities'] + """ Workspace specific client capabilities. """ + textDocument: NotRequired['TextDocumentClientCapabilities'] + """ Text document specific client capabilities. """ + notebookDocument: NotRequired['NotebookDocumentClientCapabilities'] + """ Capabilities specific to the notebook document support. + + @since 3.17.0 """ + window: NotRequired['WindowClientCapabilities'] + """ Window specific client capabilities. """ + general: NotRequired['GeneralClientCapabilities'] + """ General client capabilities. + + @since 3.16.0 """ + experimental: NotRequired['LSPAny'] + """ Experimental client capabilities. """ + + +class TextDocumentSyncOptions(TypedDict): + openClose: NotRequired[bool] + """ Open and close notifications are sent to the server. If omitted open close notification should not + be sent. """ + change: NotRequired['TextDocumentSyncKind'] + """ Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full + and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None. """ + willSave: NotRequired[bool] + """ If present will save notifications are sent to the server. If omitted the notification should not be + sent. """ + willSaveWaitUntil: NotRequired[bool] + """ If present will save wait until requests are sent to the server. If omitted the request should not be + sent. """ + save: NotRequired[Union[bool, 'SaveOptions']] + """ If present save notifications are sent to the server. If omitted the notification should not be + sent. """ + + +class WorkspaceOptions(TypedDict): + """ Defines workspace specific capabilities of the server. + + @since 3.18.0 """ + workspaceFolders: NotRequired['WorkspaceFoldersServerCapabilities'] + """ The server supports workspace folder. + + @since 3.6.0 """ + fileOperations: NotRequired['FileOperationOptions'] + """ The server is interested in notifications/requests for operations on files. + + @since 3.16.0 """ + + +class TextDocumentContentChangePartial(TypedDict): + """ @since 3.18.0 """ + range: 'Range' + """ The range of the document that changed. """ + rangeLength: NotRequired[Uint] + """ The optional length of the range that got replaced. + + @deprecated use range instead. """ + text: str + """ The new text for the provided range. """ + + +class TextDocumentContentChangeWholeDocument(TypedDict): + """ @since 3.18.0 """ + text: str + """ The new text of the whole document. """ + + +class CodeDescription(TypedDict): + """ Structure to capture a description for an error code. + + @since 3.16.0 """ + href: 'URI' + """ An URI to open with more information about the diagnostic error. """ + + +class DiagnosticRelatedInformation(TypedDict): + """ Represents a related message and source code location for a diagnostic. This should be + used to point to code locations that cause or related to a diagnostics, e.g when duplicating + a symbol in a scope. """ + location: 'Location' + """ The location of this related diagnostic information. """ + message: str + """ The message of this related diagnostic information. """ + + +class EditRangeWithInsertReplace(TypedDict): + """ Edit range variant that includes ranges for insert and replace operations. + + @since 3.18.0 """ + insert: 'Range' + replace: 'Range' + + +class ServerCompletionItemOptions(TypedDict): + """ @since 3.18.0 """ + labelDetailsSupport: NotRequired[bool] + """ The server has support for completion item label + details (see also `CompletionItemLabelDetails`) when + receiving a completion item in a resolve call. + + @since 3.17.0 """ + + +class MarkedStringWithLanguage(TypedDict): + """ @since 3.18.0 + @deprecated use MarkupContent instead. """ + language: str + value: str + + +class ParameterInformation(TypedDict): + """ Represents a parameter of a callable-signature. A parameter can + have a label and a doc-comment. """ + label: Union[str, List[Union[Uint, Uint]]] + """ The label of this parameter information. + + Either a string or an inclusive start and exclusive end offsets within its containing + signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 + string representation as `Position` and `Range` does. + + To avoid ambiguities a server should use the [start, end] offset value instead of using + a substring. Whether a client support this is controlled via `labelOffsetSupport` client + capability. + + *Note*: a label of type string should be a substring of its containing signature label. + Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`. """ + documentation: NotRequired[Union[str, 'MarkupContent']] + """ The human-readable doc-comment of this parameter. Will be shown + in the UI but can be omitted. """ + + +class CodeActionKindDocumentation(TypedDict): + """ Documentation for a class of code actions. + + @since 3.18.0 + @proposed """ + kind: 'CodeActionKind' + """ The kind of the code action being documented. + + If the kind is generic, such as `CodeActionKind.Refactor`, the documentation will be shown whenever any + refactorings are returned. If the kind if more specific, such as `CodeActionKind.RefactorExtract`, the + documentation will only be shown when extract refactoring code actions are returned. """ + command: 'Command' + """ Command that is ued to display the documentation to the user. + + The title of this documentation code action is taken from {@linkcode Command.title} """ + + +class NotebookCellTextDocumentFilter(TypedDict): + """ A notebook cell text document filter denotes a cell text + document by different properties. + + @since 3.17.0 """ + notebook: Union[str, 'NotebookDocumentFilter'] + """ A filter that matches against the notebook + containing the notebook cell. If a string + value is provided it matches against the + notebook type. '*' matches every notebook. """ + language: NotRequired[str] + """ A language id like `python`. + + Will be matched against the language id of the + notebook cell document. '*' matches every language. """ + + +class FileOperationPatternOptions(TypedDict): + """ Matching options for the file operation pattern. + + @since 3.16.0 """ + ignoreCase: NotRequired[bool] + """ The pattern should be matched ignoring casing. """ + + +class ExecutionSummary(TypedDict): + executionOrder: Uint + """ A strict monotonically increasing value + indicating the execution order of a cell + inside a notebook. """ + success: NotRequired[bool] + """ Whether the execution was successful or + not if known by the client. """ + + +class NotebookCellLanguage(TypedDict): + """ @since 3.18.0 """ + language: str + + +class NotebookDocumentCellChangeStructure(TypedDict): + """ Structural changes to cells in a notebook document. + + @since 3.18.0 """ + array: 'NotebookCellArrayChange' + """ The change to the cell array. """ + didOpen: NotRequired[List['TextDocumentItem']] + """ Additional opened cell text documents. """ + didClose: NotRequired[List['TextDocumentIdentifier']] + """ Additional closed cell text documents. """ + + +class NotebookDocumentCellContentChanges(TypedDict): + """ Content changes to a cell in a notebook document. + + @since 3.18.0 """ + document: 'VersionedTextDocumentIdentifier' + changes: List['TextDocumentContentChangeEvent'] + + +class WorkspaceClientCapabilities(TypedDict): + """ Workspace specific client capabilities. """ + applyEdit: NotRequired[bool] + """ The client supports applying batch edits + to the workspace by supporting the request + 'workspace/applyEdit' """ + workspaceEdit: NotRequired['WorkspaceEditClientCapabilities'] + """ Capabilities specific to `WorkspaceEdit`s. """ + didChangeConfiguration: NotRequired['DidChangeConfigurationClientCapabilities'] + """ Capabilities specific to the `workspace/didChangeConfiguration` notification. """ + didChangeWatchedFiles: NotRequired['DidChangeWatchedFilesClientCapabilities'] + """ Capabilities specific to the `workspace/didChangeWatchedFiles` notification. """ + symbol: NotRequired['WorkspaceSymbolClientCapabilities'] + """ Capabilities specific to the `workspace/symbol` request. """ + executeCommand: NotRequired['ExecuteCommandClientCapabilities'] + """ Capabilities specific to the `workspace/executeCommand` request. """ + workspaceFolders: NotRequired[bool] + """ The client has support for workspace folders. + + @since 3.6.0 """ + configuration: NotRequired[bool] + """ The client supports `workspace/configuration` requests. + + @since 3.6.0 """ + semanticTokens: NotRequired['SemanticTokensWorkspaceClientCapabilities'] + """ Capabilities specific to the semantic token requests scoped to the + workspace. + + @since 3.16.0. """ + codeLens: NotRequired['CodeLensWorkspaceClientCapabilities'] + """ Capabilities specific to the code lens requests scoped to the + workspace. + + @since 3.16.0. """ + fileOperations: NotRequired['FileOperationClientCapabilities'] + """ The client has support for file notifications/requests for user operations on files. + + Since 3.16.0 """ + inlineValue: NotRequired['InlineValueWorkspaceClientCapabilities'] + """ Capabilities specific to the inline values requests scoped to the + workspace. + + @since 3.17.0. """ + inlayHint: NotRequired['InlayHintWorkspaceClientCapabilities'] + """ Capabilities specific to the inlay hint requests scoped to the + workspace. + + @since 3.17.0. """ + diagnostics: NotRequired['DiagnosticWorkspaceClientCapabilities'] + """ Capabilities specific to the diagnostic requests scoped to the + workspace. + + @since 3.17.0. """ + foldingRange: NotRequired['FoldingRangeWorkspaceClientCapabilities'] + """ Capabilities specific to the folding range requests scoped to the workspace. + + @since 3.18.0 + @proposed """ + + +class TextDocumentClientCapabilities(TypedDict): + """ Text document specific client capabilities. """ + synchronization: NotRequired['TextDocumentSyncClientCapabilities'] + """ Defines which synchronization capabilities the client supports. """ + completion: NotRequired['CompletionClientCapabilities'] + """ Capabilities specific to the `textDocument/completion` request. """ + hover: NotRequired['HoverClientCapabilities'] + """ Capabilities specific to the `textDocument/hover` request. """ + signatureHelp: NotRequired['SignatureHelpClientCapabilities'] + """ Capabilities specific to the `textDocument/signatureHelp` request. """ + declaration: NotRequired['DeclarationClientCapabilities'] + """ Capabilities specific to the `textDocument/declaration` request. + + @since 3.14.0 """ + definition: NotRequired['DefinitionClientCapabilities'] + """ Capabilities specific to the `textDocument/definition` request. """ + typeDefinition: NotRequired['TypeDefinitionClientCapabilities'] + """ Capabilities specific to the `textDocument/typeDefinition` request. + + @since 3.6.0 """ + implementation: NotRequired['ImplementationClientCapabilities'] + """ Capabilities specific to the `textDocument/implementation` request. + + @since 3.6.0 """ + references: NotRequired['ReferenceClientCapabilities'] + """ Capabilities specific to the `textDocument/references` request. """ + documentHighlight: NotRequired['DocumentHighlightClientCapabilities'] + """ Capabilities specific to the `textDocument/documentHighlight` request. """ + documentSymbol: NotRequired['DocumentSymbolClientCapabilities'] + """ Capabilities specific to the `textDocument/documentSymbol` request. """ + codeAction: NotRequired['CodeActionClientCapabilities'] + """ Capabilities specific to the `textDocument/codeAction` request. """ + codeLens: NotRequired['CodeLensClientCapabilities'] + """ Capabilities specific to the `textDocument/codeLens` request. """ + documentLink: NotRequired['DocumentLinkClientCapabilities'] + """ Capabilities specific to the `textDocument/documentLink` request. """ + colorProvider: NotRequired['DocumentColorClientCapabilities'] + """ Capabilities specific to the `textDocument/documentColor` and the + `textDocument/colorPresentation` request. + + @since 3.6.0 """ + formatting: NotRequired['DocumentFormattingClientCapabilities'] + """ Capabilities specific to the `textDocument/formatting` request. """ + rangeFormatting: NotRequired['DocumentRangeFormattingClientCapabilities'] + """ Capabilities specific to the `textDocument/rangeFormatting` request. """ + onTypeFormatting: NotRequired['DocumentOnTypeFormattingClientCapabilities'] + """ Capabilities specific to the `textDocument/onTypeFormatting` request. """ + rename: NotRequired['RenameClientCapabilities'] + """ Capabilities specific to the `textDocument/rename` request. """ + foldingRange: NotRequired['FoldingRangeClientCapabilities'] + """ Capabilities specific to the `textDocument/foldingRange` request. + + @since 3.10.0 """ + selectionRange: NotRequired['SelectionRangeClientCapabilities'] + """ Capabilities specific to the `textDocument/selectionRange` request. + + @since 3.15.0 """ + publishDiagnostics: NotRequired['PublishDiagnosticsClientCapabilities'] + """ Capabilities specific to the `textDocument/publishDiagnostics` notification. """ + callHierarchy: NotRequired['CallHierarchyClientCapabilities'] + """ Capabilities specific to the various call hierarchy requests. + + @since 3.16.0 """ + semanticTokens: NotRequired['SemanticTokensClientCapabilities'] + """ Capabilities specific to the various semantic token request. + + @since 3.16.0 """ + linkedEditingRange: NotRequired['LinkedEditingRangeClientCapabilities'] + """ Capabilities specific to the `textDocument/linkedEditingRange` request. + + @since 3.16.0 """ + moniker: NotRequired['MonikerClientCapabilities'] + """ Client capabilities specific to the `textDocument/moniker` request. + + @since 3.16.0 """ + typeHierarchy: NotRequired['TypeHierarchyClientCapabilities'] + """ Capabilities specific to the various type hierarchy requests. + + @since 3.17.0 """ + inlineValue: NotRequired['InlineValueClientCapabilities'] + """ Capabilities specific to the `textDocument/inlineValue` request. + + @since 3.17.0 """ + inlayHint: NotRequired['InlayHintClientCapabilities'] + """ Capabilities specific to the `textDocument/inlayHint` request. + + @since 3.17.0 """ + diagnostic: NotRequired['DiagnosticClientCapabilities'] + """ Capabilities specific to the diagnostic pull model. + + @since 3.17.0 """ + inlineCompletion: NotRequired['InlineCompletionClientCapabilities'] + """ Client capabilities specific to inline completions. + @since 3.18.0 + @proposed """ -ResourceOperation = TypedDict('ResourceOperation', { - # The resource operation kind. - 'kind': str, - # An optional annotation identifier describing the operation. - # - # @since 3.16.0 - 'annotationId': NotRequired['ChangeAnnotationIdentifier'], -}) -""" A generic resource operation. """ +class NotebookDocumentClientCapabilities(TypedDict): + """ Capabilities specific to the notebook document support. -CreateFileOptions = TypedDict('CreateFileOptions', { - # Overwrite existing file. Overwrite wins over `ignoreIfExists` - 'overwrite': NotRequired[bool], - # Ignore if exists. - 'ignoreIfExists': NotRequired[bool], -}) -""" Options to create a file. """ + @since 3.17.0 """ + synchronization: 'NotebookDocumentSyncClientCapabilities' + """ Capabilities specific to notebook document synchronization + @since 3.17.0 """ -RenameFileOptions = TypedDict('RenameFileOptions', { - # Overwrite target if existing. Overwrite wins over `ignoreIfExists` - 'overwrite': NotRequired[bool], - # Ignores if target exists. - 'ignoreIfExists': NotRequired[bool], -}) -""" Rename file options """ +class WindowClientCapabilities(TypedDict): + workDoneProgress: NotRequired[bool] + """ It indicates whether the client supports server initiated + progress using the `window/workDoneProgress/create` request. -DeleteFileOptions = TypedDict('DeleteFileOptions', { - # Delete the content recursively if a folder is denoted. - 'recursive': NotRequired[bool], - # Ignore the operation if the file doesn't exist. - 'ignoreIfNotExists': NotRequired[bool], -}) -""" Delete file options """ - - -FileOperationPattern = TypedDict('FileOperationPattern', { - # The glob pattern to match. Glob patterns can have the following syntax: - # - `*` to match one or more characters in a path segment - # - `?` to match on one character in a path segment - # - `**` to match any number of path segments, including none - # - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files) - # - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …) - # - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`) - 'glob': str, - # Whether to match files or folders with this pattern. - # - # Matches both if undefined. - 'matches': NotRequired['FileOperationPatternKind'], - # Additional options used during matching. - 'options': NotRequired['FileOperationPatternOptions'], -}) -""" A pattern to describe in which file operation requests or notifications -the server is interested in receiving. + The capability also controls Whether client supports handling + of progress notifications. If set servers are allowed to report a + `workDoneProgress` property in the request specific server + capabilities. -@since 3.16.0 """ + @since 3.15.0 """ + showMessage: NotRequired['ShowMessageRequestClientCapabilities'] + """ Capabilities specific to the showMessage request. + @since 3.16.0 """ + showDocument: NotRequired['ShowDocumentClientCapabilities'] + """ Capabilities specific to the showDocument request. -WorkspaceFullDocumentDiagnosticReport = TypedDict('WorkspaceFullDocumentDiagnosticReport', { - # The URI for which diagnostic information is reported. - 'uri': 'DocumentUri', - # The version number for which the diagnostics are reported. - # If the document is not marked as open `null` can be provided. - 'version': Union[int, None], - # A full document diagnostic report. - 'kind': Literal['full'], - # An optional result id. If provided it will - # be sent on the next diagnostic request for the - # same document. - 'resultId': NotRequired[str], - # The actual items. - 'items': List['Diagnostic'], -}) -""" A full document diagnostic report for a workspace diagnostic result. + @since 3.16.0 """ -@since 3.17.0 """ +class GeneralClientCapabilities(TypedDict): + """ General client capabilities. -WorkspaceUnchangedDocumentDiagnosticReport = TypedDict('WorkspaceUnchangedDocumentDiagnosticReport', { - # The URI for which diagnostic information is reported. - 'uri': 'DocumentUri', - # The version number for which the diagnostics are reported. - # If the document is not marked as open `null` can be provided. - 'version': Union[int, None], - # A document diagnostic report indicating - # no changes to the last result. A server can - # only return `unchanged` if result ids are - # provided. - 'kind': Literal['unchanged'], - # A result id which will be sent on the next - # diagnostic request for the same document. - 'resultId': str, -}) -""" An unchanged document diagnostic report for a workspace diagnostic result. + @since 3.16.0 """ + staleRequestSupport: NotRequired['StaleRequestSupportOptions'] + """ Client capability that signals how the client + handles stale requests (e.g. a request + for which the client will not process the response + anymore since the information is outdated). -@since 3.17.0 """ + @since 3.17.0 """ + regularExpressions: NotRequired['RegularExpressionsClientCapabilities'] + """ Client capabilities specific to regular expressions. + @since 3.16.0 """ + markdown: NotRequired['MarkdownClientCapabilities'] + """ Client capabilities specific to the client's markdown parser. -NotebookCell = TypedDict('NotebookCell', { - # The cell's kind - 'kind': 'NotebookCellKind', - # The URI of the cell's text document - # content. - 'document': 'DocumentUri', - # Additional metadata stored with the cell. - # - # Note: should always be an object literal (e.g. LSPObject) - 'metadata': NotRequired['LSPObject'], - # Additional execution summary information - # if supported by the client. - 'executionSummary': NotRequired['ExecutionSummary'], -}) -""" A notebook cell. + @since 3.16.0 """ + positionEncodings: NotRequired[List['PositionEncodingKind']] + """ The position encodings supported by the client. Client and server + have to agree on the same position encoding to ensure that offsets + (e.g. character position in a line) are interpreted the same on both + sides. -A cell's document URI must be unique across ALL notebook -cells and can therefore be used to uniquely identify a -notebook cell or the cell's text document. + To keep the protocol backwards compatible the following applies: if + the value 'utf-16' is missing from the array of position encodings + servers can assume that the client supports UTF-16. UTF-16 is + therefore a mandatory encoding. -@since 3.17.0 """ + If omitted it defaults to ['utf-16']. + Implementation considerations: since the conversion from one encoding + into another requires the content of the file / line the conversion + is best done where the file is read which is usually on the server + side. -NotebookCellArrayChange = TypedDict('NotebookCellArrayChange', { - # The start oftest of the cell that changed. - 'start': Uint, - # The deleted cells - 'deleteCount': Uint, - # The new cells, if any - 'cells': NotRequired[List['NotebookCell']], -}) -""" A change describing how to move a `NotebookCell` -array from state S to S'. + @since 3.17.0 """ -@since 3.17.0 """ +class WorkspaceFoldersServerCapabilities(TypedDict): + supported: NotRequired[bool] + """ The server has support for workspace folders """ + changeNotifications: NotRequired[Union[str, bool]] + """ Whether the server wants to receive workspace folder + change notifications. -SelectedCompletionInfo = TypedDict('SelectedCompletionInfo', { - # The range that will be replaced if this completion item is accepted. - 'range': 'Range', - # The text the range will be replaced with if this completion is accepted. - 'text': str, -}) -""" Describes the currently selected completion item. - -@since 3.18.0 -@proposed """ - - -ClientCapabilities = TypedDict('ClientCapabilities', { - # Workspace specific client capabilities. - 'workspace': NotRequired['WorkspaceClientCapabilities'], - # Text document specific client capabilities. - 'textDocument': NotRequired['TextDocumentClientCapabilities'], - # Capabilities specific to the notebook document support. - # - # @since 3.17.0 - 'notebookDocument': NotRequired['NotebookDocumentClientCapabilities'], - # Window specific client capabilities. - 'window': NotRequired['WindowClientCapabilities'], - # General client capabilities. - # - # @since 3.16.0 - 'general': NotRequired['GeneralClientCapabilities'], - # Experimental client capabilities. - 'experimental': NotRequired['LSPAny'], -}) -""" Defines the capabilities provided by the client. """ - - -TextDocumentSyncOptions = TypedDict('TextDocumentSyncOptions', { - # Open and close notifications are sent to the server. If omitted open close notification should not - # be sent. - 'openClose': NotRequired[bool], - # Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full - # and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None. - 'change': NotRequired['TextDocumentSyncKind'], - # If present will save notifications are sent to the server. If omitted the notification should not be - # sent. - 'willSave': NotRequired[bool], - # If present will save wait until requests are sent to the server. If omitted the request should not be - # sent. - 'willSaveWaitUntil': NotRequired[bool], - # If present save notifications are sent to the server. If omitted the notification should not be - # sent. - 'save': NotRequired[Union[bool, 'SaveOptions']], -}) + If a string is provided the string is treated as an ID + under which the notification is registered on the client + side. The ID can be used to unregister for these events + using the `client/unregisterCapability` request. """ -NotebookDocumentSyncOptions = TypedDict('NotebookDocumentSyncOptions', { - # The notebooks to be synced - 'notebookSelector': List[Union['__NotebookDocumentSyncOptions_notebookSelector_Type_1', '__NotebookDocumentSyncOptions_notebookSelector_Type_2']], - # Whether save notification should be forwarded to - # the server. Will only be honored if mode === `notebook`. - 'save': NotRequired[bool], -}) -""" Options specific to a notebook plus its cells -to be synced to the server. +class FileOperationOptions(TypedDict): + """ Options for notifications/requests for user operations on files. -If a selector provides a notebook document -filter but no cell selector all cells of a -matching notebook document will be synced. + @since 3.16.0 """ + didCreate: NotRequired['FileOperationRegistrationOptions'] + """ The server is interested in receiving didCreateFiles notifications. """ + willCreate: NotRequired['FileOperationRegistrationOptions'] + """ The server is interested in receiving willCreateFiles requests. """ + didRename: NotRequired['FileOperationRegistrationOptions'] + """ The server is interested in receiving didRenameFiles notifications. """ + willRename: NotRequired['FileOperationRegistrationOptions'] + """ The server is interested in receiving willRenameFiles requests. """ + didDelete: NotRequired['FileOperationRegistrationOptions'] + """ The server is interested in receiving didDeleteFiles file notifications. """ + willDelete: NotRequired['FileOperationRegistrationOptions'] + """ The server is interested in receiving willDeleteFiles file requests. """ + + +class RelativePattern(TypedDict): + """ A relative pattern is a helper to construct glob patterns that are matched + relatively to a base URI. The common value for a `baseUri` is a workspace + folder root, but it can be another absolute URI as well. -If a selector provides no notebook document -filter but only a cell selector all notebook -document that contain at least one matching -cell will be synced. + @since 3.17.0 """ + baseUri: Union['WorkspaceFolder', 'URI'] + """ A workspace folder or a base URI to which this pattern will be matched + against relatively. """ + pattern: 'Pattern' + """ The actual glob pattern; """ -@since 3.17.0 """ +class TextDocumentFilterLanguage(TypedDict): + """ A document filter where `language` is required field. -NotebookDocumentSyncRegistrationOptions = TypedDict('NotebookDocumentSyncRegistrationOptions', { - # The notebooks to be synced - 'notebookSelector': List[Union['__NotebookDocumentSyncOptions_notebookSelector_Type_3', '__NotebookDocumentSyncOptions_notebookSelector_Type_4']], - # Whether save notification should be forwarded to - # the server. Will only be honored if mode === `notebook`. - 'save': NotRequired[bool], - # The id used to register the request. The id can be used to deregister - # the request again. See also Registration#id. - 'id': NotRequired[str], -}) -""" Registration options specific to a notebook. + @since 3.18.0 """ + language: str + """ A language id, like `typescript`. """ + scheme: NotRequired[str] + """ A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. """ + pattern: NotRequired[str] + """ A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples. """ -@since 3.17.0 """ +class TextDocumentFilterScheme(TypedDict): + """ A document filter where `scheme` is required field. -WorkspaceFoldersServerCapabilities = TypedDict('WorkspaceFoldersServerCapabilities', { - # The server has support for workspace folders - 'supported': NotRequired[bool], - # Whether the server wants to receive workspace folder - # change notifications. - # - # If a string is provided the string is treated as an ID - # under which the notification is registered on the client - # side. The ID can be used to unregister for these events - # using the `client/unregisterCapability` request. - 'changeNotifications': NotRequired[Union[str, bool]], -}) + @since 3.18.0 """ + language: NotRequired[str] + """ A language id, like `typescript`. """ + scheme: str + """ A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. """ + pattern: NotRequired[str] + """ A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples. """ -FileOperationOptions = TypedDict('FileOperationOptions', { - # The server is interested in receiving didCreateFiles notifications. - 'didCreate': NotRequired['FileOperationRegistrationOptions'], - # The server is interested in receiving willCreateFiles requests. - 'willCreate': NotRequired['FileOperationRegistrationOptions'], - # The server is interested in receiving didRenameFiles notifications. - 'didRename': NotRequired['FileOperationRegistrationOptions'], - # The server is interested in receiving willRenameFiles requests. - 'willRename': NotRequired['FileOperationRegistrationOptions'], - # The server is interested in receiving didDeleteFiles file notifications. - 'didDelete': NotRequired['FileOperationRegistrationOptions'], - # The server is interested in receiving willDeleteFiles file requests. - 'willDelete': NotRequired['FileOperationRegistrationOptions'], -}) -""" Options for notifications/requests for user operations on files. +class TextDocumentFilterPattern(TypedDict): + """ A document filter where `pattern` is required field. -@since 3.16.0 """ + @since 3.18.0 """ + language: NotRequired[str] + """ A language id, like `typescript`. """ + scheme: NotRequired[str] + """ A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. """ + pattern: str + """ A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples. """ -CodeDescription = TypedDict('CodeDescription', { - # An URI to open with more information about the diagnostic error. - 'href': 'URI', -}) -""" Structure to capture a description for an error code. +class NotebookDocumentFilterNotebookType(TypedDict): + """ A notebook document filter where `notebookType` is required field. -@since 3.16.0 """ + @since 3.18.0 """ + notebookType: str + """ The type of the enclosing notebook. """ + scheme: NotRequired[str] + """ A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. """ + pattern: NotRequired[str] + """ A glob pattern. """ -DiagnosticRelatedInformation = TypedDict('DiagnosticRelatedInformation', { - # The location of this related diagnostic information. - 'location': 'Location', - # The message of this related diagnostic information. - 'message': str, -}) -""" Represents a related message and source code location for a diagnostic. This should be -used to point to code locations that cause or related to a diagnostics, e.g when duplicating -a symbol in a scope. """ - - -ParameterInformation = TypedDict('ParameterInformation', { - # The label of this parameter information. - # - # Either a string or an inclusive start and exclusive end offsets within its containing - # signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 - # string representation as `Position` and `Range` does. - # - # *Note*: a label of type string should be a substring of its containing signature label. - # Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`. - 'label': Union[str, List[Union[Uint, Uint]]], - # The human-readable doc-comment of this parameter. Will be shown - # in the UI but can be omitted. - 'documentation': NotRequired[Union[str, 'MarkupContent']], -}) -""" Represents a parameter of a callable-signature. A parameter can -have a label and a doc-comment. """ - - -NotebookCellTextDocumentFilter = TypedDict('NotebookCellTextDocumentFilter', { - # A filter that matches against the notebook - # containing the notebook cell. If a string - # value is provided it matches against the - # notebook type. '*' matches every notebook. - 'notebook': Union[str, 'NotebookDocumentFilter'], - # A language id like `python`. - # - # Will be matched against the language id of the - # notebook cell document. '*' matches every language. - 'language': NotRequired[str], -}) -""" A notebook cell text document filter denotes a cell text -document by different properties. +class NotebookDocumentFilterScheme(TypedDict): + """ A notebook document filter where `scheme` is required field. -@since 3.17.0 """ + @since 3.18.0 """ + notebookType: NotRequired[str] + """ The type of the enclosing notebook. """ + scheme: str + """ A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. """ + pattern: NotRequired[str] + """ A glob pattern. """ -FileOperationPatternOptions = TypedDict('FileOperationPatternOptions', { - # The pattern should be matched ignoring casing. - 'ignoreCase': NotRequired[bool], -}) -""" Matching options for the file operation pattern. +class NotebookDocumentFilterPattern(TypedDict): + """ A notebook document filter where `pattern` is required field. -@since 3.16.0 """ + @since 3.18.0 """ + notebookType: NotRequired[str] + """ The type of the enclosing notebook. """ + scheme: NotRequired[str] + """ A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. """ + pattern: str + """ A glob pattern. """ -ExecutionSummary = TypedDict('ExecutionSummary', { - # A strict monotonically increasing value - # indicating the execution order of a cell - # inside a notebook. - 'executionOrder': Uint, - # Whether the execution was successful or - # not if known by the client. - 'success': NotRequired[bool], -}) +class NotebookCellArrayChange(TypedDict): + """ A change describing how to move a `NotebookCell` + array from state S to S'. + @since 3.17.0 """ + start: Uint + """ The start oftest of the cell that changed. """ + deleteCount: Uint + """ The deleted cells """ + cells: NotRequired[List['NotebookCell']] + """ The new cells, if any """ + + +class WorkspaceEditClientCapabilities(TypedDict): + documentChanges: NotRequired[bool] + """ The client supports versioned document changes in `WorkspaceEdit`s """ + resourceOperations: NotRequired[List['ResourceOperationKind']] + """ The resource operations the client supports. Clients should at least + support 'create', 'rename' and 'delete' files and folders. + + @since 3.13.0 """ + failureHandling: NotRequired['FailureHandlingKind'] + """ The failure handling strategy of a client if applying the workspace edit + fails. + + @since 3.13.0 """ + normalizesLineEndings: NotRequired[bool] + """ Whether the client normalizes line endings to the client specific + setting. + If set to `true` the client will normalize line ending characters + in a workspace edit to the client-specified new line + character. -WorkspaceClientCapabilities = TypedDict('WorkspaceClientCapabilities', { - # The client supports applying batch edits - # to the workspace by supporting the request - # 'workspace/applyEdit' - 'applyEdit': NotRequired[bool], - # Capabilities specific to `WorkspaceEdit`s. - 'workspaceEdit': NotRequired['WorkspaceEditClientCapabilities'], - # Capabilities specific to the `workspace/didChangeConfiguration` notification. - 'didChangeConfiguration': NotRequired['DidChangeConfigurationClientCapabilities'], - # Capabilities specific to the `workspace/didChangeWatchedFiles` notification. - 'didChangeWatchedFiles': NotRequired['DidChangeWatchedFilesClientCapabilities'], - # Capabilities specific to the `workspace/symbol` request. - 'symbol': NotRequired['WorkspaceSymbolClientCapabilities'], - # Capabilities specific to the `workspace/executeCommand` request. - 'executeCommand': NotRequired['ExecuteCommandClientCapabilities'], - # The client has support for workspace folders. - # - # @since 3.6.0 - 'workspaceFolders': NotRequired[bool], - # The client supports `workspace/configuration` requests. - # - # @since 3.6.0 - 'configuration': NotRequired[bool], - # Capabilities specific to the semantic token requests scoped to the - # workspace. - # - # @since 3.16.0. - 'semanticTokens': NotRequired['SemanticTokensWorkspaceClientCapabilities'], - # Capabilities specific to the code lens requests scoped to the - # workspace. - # - # @since 3.16.0. - 'codeLens': NotRequired['CodeLensWorkspaceClientCapabilities'], - # The client has support for file notifications/requests for user operations on files. - # - # Since 3.16.0 - 'fileOperations': NotRequired['FileOperationClientCapabilities'], - # Capabilities specific to the inline values requests scoped to the - # workspace. - # - # @since 3.17.0. - 'inlineValue': NotRequired['InlineValueWorkspaceClientCapabilities'], - # Capabilities specific to the inlay hint requests scoped to the - # workspace. - # - # @since 3.17.0. - 'inlayHint': NotRequired['InlayHintWorkspaceClientCapabilities'], - # Capabilities specific to the diagnostic requests scoped to the - # workspace. - # - # @since 3.17.0. - 'diagnostics': NotRequired['DiagnosticWorkspaceClientCapabilities'], -}) -""" Workspace specific client capabilities. """ - - -TextDocumentClientCapabilities = TypedDict('TextDocumentClientCapabilities', { - # Defines which synchronization capabilities the client supports. - 'synchronization': NotRequired['TextDocumentSyncClientCapabilities'], - # Capabilities specific to the `textDocument/completion` request. - 'completion': NotRequired['CompletionClientCapabilities'], - # Capabilities specific to the `textDocument/hover` request. - 'hover': NotRequired['HoverClientCapabilities'], - # Capabilities specific to the `textDocument/signatureHelp` request. - 'signatureHelp': NotRequired['SignatureHelpClientCapabilities'], - # Capabilities specific to the `textDocument/declaration` request. - # - # @since 3.14.0 - 'declaration': NotRequired['DeclarationClientCapabilities'], - # Capabilities specific to the `textDocument/definition` request. - 'definition': NotRequired['DefinitionClientCapabilities'], - # Capabilities specific to the `textDocument/typeDefinition` request. - # - # @since 3.6.0 - 'typeDefinition': NotRequired['TypeDefinitionClientCapabilities'], - # Capabilities specific to the `textDocument/implementation` request. - # - # @since 3.6.0 - 'implementation': NotRequired['ImplementationClientCapabilities'], - # Capabilities specific to the `textDocument/references` request. - 'references': NotRequired['ReferenceClientCapabilities'], - # Capabilities specific to the `textDocument/documentHighlight` request. - 'documentHighlight': NotRequired['DocumentHighlightClientCapabilities'], - # Capabilities specific to the `textDocument/documentSymbol` request. - 'documentSymbol': NotRequired['DocumentSymbolClientCapabilities'], - # Capabilities specific to the `textDocument/codeAction` request. - 'codeAction': NotRequired['CodeActionClientCapabilities'], - # Capabilities specific to the `textDocument/codeLens` request. - 'codeLens': NotRequired['CodeLensClientCapabilities'], - # Capabilities specific to the `textDocument/documentLink` request. - 'documentLink': NotRequired['DocumentLinkClientCapabilities'], - # Capabilities specific to the `textDocument/documentColor` and the - # `textDocument/colorPresentation` request. - # - # @since 3.6.0 - 'colorProvider': NotRequired['DocumentColorClientCapabilities'], - # Capabilities specific to the `textDocument/formatting` request. - 'formatting': NotRequired['DocumentFormattingClientCapabilities'], - # Capabilities specific to the `textDocument/rangeFormatting` request. - 'rangeFormatting': NotRequired['DocumentRangeFormattingClientCapabilities'], - # Capabilities specific to the `textDocument/onTypeFormatting` request. - 'onTypeFormatting': NotRequired['DocumentOnTypeFormattingClientCapabilities'], - # Capabilities specific to the `textDocument/rename` request. - 'rename': NotRequired['RenameClientCapabilities'], - # Capabilities specific to the `textDocument/foldingRange` request. - # - # @since 3.10.0 - 'foldingRange': NotRequired['FoldingRangeClientCapabilities'], - # Capabilities specific to the `textDocument/selectionRange` request. - # - # @since 3.15.0 - 'selectionRange': NotRequired['SelectionRangeClientCapabilities'], - # Capabilities specific to the `textDocument/publishDiagnostics` notification. - 'publishDiagnostics': NotRequired['PublishDiagnosticsClientCapabilities'], - # Capabilities specific to the various call hierarchy requests. - # - # @since 3.16.0 - 'callHierarchy': NotRequired['CallHierarchyClientCapabilities'], - # Capabilities specific to the various semantic token request. - # - # @since 3.16.0 - 'semanticTokens': NotRequired['SemanticTokensClientCapabilities'], - # Capabilities specific to the `textDocument/linkedEditingRange` request. - # - # @since 3.16.0 - 'linkedEditingRange': NotRequired['LinkedEditingRangeClientCapabilities'], - # Client capabilities specific to the `textDocument/moniker` request. - # - # @since 3.16.0 - 'moniker': NotRequired['MonikerClientCapabilities'], - # Capabilities specific to the various type hierarchy requests. - # - # @since 3.17.0 - 'typeHierarchy': NotRequired['TypeHierarchyClientCapabilities'], - # Capabilities specific to the `textDocument/inlineValue` request. - # - # @since 3.17.0 - 'inlineValue': NotRequired['InlineValueClientCapabilities'], - # Capabilities specific to the `textDocument/inlayHint` request. - # - # @since 3.17.0 - 'inlayHint': NotRequired['InlayHintClientCapabilities'], - # Capabilities specific to the diagnostic pull model. - # - # @since 3.17.0 - 'diagnostic': NotRequired['DiagnosticClientCapabilities'], - # Client capabilities specific to inline completions. - # - # @since 3.18.0 - # @proposed - 'inlineCompletion': NotRequired['InlineCompletionClientCapabilities'], -}) -""" Text document specific client capabilities. """ + @since 3.16.0 """ + changeAnnotationSupport: NotRequired['ChangeAnnotationsSupportOptions'] + """ Whether the client in general supports change annotations on text edits, + create file, rename file and delete file changes. + @since 3.16.0 """ + metadataSupport: NotRequired[bool] + """ Whether the client supports `WorkspaceEditMetadata` in `WorkspaceEdit`s. -NotebookDocumentClientCapabilities = TypedDict('NotebookDocumentClientCapabilities', { - # Capabilities specific to notebook document synchronization - # - # @since 3.17.0 - 'synchronization': 'NotebookDocumentSyncClientCapabilities', -}) -""" Capabilities specific to the notebook document support. + @since 3.18.0 + @proposed """ + snippetEditSupport: NotRequired[bool] + """ Whether the client supports snippets as text edits. -@since 3.17.0 """ + @since 3.18.0 + @proposed """ -WindowClientCapabilities = TypedDict('WindowClientCapabilities', { - # It indicates whether the client supports server initiated - # progress using the `window/workDoneProgress/create` request. - # - # The capability also controls Whether client supports handling - # of progress notifications. If set servers are allowed to report a - # `workDoneProgress` property in the request specific server - # capabilities. - # - # @since 3.15.0 - 'workDoneProgress': NotRequired[bool], - # Capabilities specific to the showMessage request. - # - # @since 3.16.0 - 'showMessage': NotRequired['ShowMessageRequestClientCapabilities'], - # Capabilities specific to the showDocument request. - # - # @since 3.16.0 - 'showDocument': NotRequired['ShowDocumentClientCapabilities'], -}) +class DidChangeConfigurationClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Did change configuration notification supports dynamic registration. """ -GeneralClientCapabilities = TypedDict('GeneralClientCapabilities', { - # Client capability that signals how the client - # handles stale requests (e.g. a request - # for which the client will not process the response - # anymore since the information is outdated). - # - # @since 3.17.0 - 'staleRequestSupport': NotRequired['__GeneralClientCapabilities_staleRequestSupport_Type_1'], - # Client capabilities specific to regular expressions. - # - # @since 3.16.0 - 'regularExpressions': NotRequired['RegularExpressionsClientCapabilities'], - # Client capabilities specific to the client's markdown parser. - # - # @since 3.16.0 - 'markdown': NotRequired['MarkdownClientCapabilities'], - # The position encodings supported by the client. Client and server - # have to agree on the same position encoding to ensure that offsets - # (e.g. character position in a line) are interpreted the same on both - # sides. - # - # To keep the protocol backwards compatible the following applies: if - # the value 'utf-16' is missing from the array of position encodings - # servers can assume that the client supports UTF-16. UTF-16 is - # therefore a mandatory encoding. - # - # If omitted it defaults to ['utf-16']. - # - # Implementation considerations: since the conversion from one encoding - # into another requires the content of the file / line the conversion - # is best done where the file is read which is usually on the server - # side. - # - # @since 3.17.0 - 'positionEncodings': NotRequired[List['PositionEncodingKind']], -}) -""" General client capabilities. +class DidChangeWatchedFilesClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Did change watched files notification supports dynamic registration. Please note + that the current protocol doesn't support static configuration for file changes + from the server side. """ + relativePatternSupport: NotRequired[bool] + """ Whether the client has support for {@link RelativePattern relative pattern} + or not. -@since 3.16.0 """ + @since 3.17.0 """ -RelativePattern = TypedDict('RelativePattern', { - # A workspace folder or a base URI to which this pattern will be matched - # against relatively. - 'baseUri': Union['WorkspaceFolder', 'URI'], - # The actual glob pattern; - 'pattern': 'Pattern', -}) -""" A relative pattern is a helper to construct glob patterns that are matched -relatively to a base URI. The common value for a `baseUri` is a workspace -folder root, but it can be another absolute URI as well. +class WorkspaceSymbolClientCapabilities(TypedDict): + """ Client capabilities for a {@link WorkspaceSymbolRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Symbol request supports dynamic registration. """ + symbolKind: NotRequired['ClientSymbolKindOptions'] + """ Specific capabilities for the `SymbolKind` in the `workspace/symbol` request. """ + tagSupport: NotRequired['ClientSymbolTagOptions'] + """ The client supports tags on `SymbolInformation`. + Clients supporting tags have to handle unknown tags gracefully. -@since 3.17.0 """ + @since 3.16.0 """ + resolveSupport: NotRequired['ClientSymbolResolveOptions'] + """ The client support partial workspace symbols. The client will send the + request `workspaceSymbol/resolve` to the server to resolve additional + properties. + @since 3.17.0 """ -WorkspaceEditClientCapabilities = TypedDict('WorkspaceEditClientCapabilities', { - # The client supports versioned document changes in `WorkspaceEdit`s - 'documentChanges': NotRequired[bool], - # The resource operations the client supports. Clients should at least - # support 'create', 'rename' and 'delete' files and folders. - # - # @since 3.13.0 - 'resourceOperations': NotRequired[List['ResourceOperationKind']], - # The failure handling strategy of a client if applying the workspace edit - # fails. - # - # @since 3.13.0 - 'failureHandling': NotRequired['FailureHandlingKind'], - # Whether the client normalizes line endings to the client specific - # setting. - # If set to `true` the client will normalize line ending characters - # in a workspace edit to the client-specified new line - # character. - # - # @since 3.16.0 - 'normalizesLineEndings': NotRequired[bool], - # Whether the client in general supports change annotations on text edits, - # create file, rename file and delete file changes. - # - # @since 3.16.0 - 'changeAnnotationSupport': NotRequired['__WorkspaceEditClientCapabilities_changeAnnotationSupport_Type_1'], -}) +class ExecuteCommandClientCapabilities(TypedDict): + """ The client capabilities of a {@link ExecuteCommandRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Execute command supports dynamic registration. """ -DidChangeConfigurationClientCapabilities = TypedDict('DidChangeConfigurationClientCapabilities', { - # Did change configuration notification supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], -}) +class SemanticTokensWorkspaceClientCapabilities(TypedDict): + """ @since 3.16.0 """ + refreshSupport: NotRequired[bool] + """ Whether the client implementation supports a refresh request sent from + the server to the client. -DidChangeWatchedFilesClientCapabilities = TypedDict('DidChangeWatchedFilesClientCapabilities', { - # Did change watched files notification supports dynamic registration. Please note - # that the current protocol doesn't support static configuration for file changes - # from the server side. - 'dynamicRegistration': NotRequired[bool], - # Whether the client has support for {@link RelativePattern relative pattern} - # or not. - # - # @since 3.17.0 - 'relativePatternSupport': NotRequired[bool], -}) + Note that this event is global and will force the client to refresh all + semantic tokens currently shown. It should be used with absolute care + and is useful for situation where a server for example detects a project + wide change that requires such a calculation. """ -WorkspaceSymbolClientCapabilities = TypedDict('WorkspaceSymbolClientCapabilities', { - # Symbol request supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # Specific capabilities for the `SymbolKind` in the `workspace/symbol` request. - 'symbolKind': NotRequired['__WorkspaceSymbolClientCapabilities_symbolKind_Type_1'], - # The client supports tags on `SymbolInformation`. - # Clients supporting tags have to handle unknown tags gracefully. - # - # @since 3.16.0 - 'tagSupport': NotRequired['__WorkspaceSymbolClientCapabilities_tagSupport_Type_1'], - # The client support partial workspace symbols. The client will send the - # request `workspaceSymbol/resolve` to the server to resolve additional - # properties. - # - # @since 3.17.0 - 'resolveSupport': NotRequired['__WorkspaceSymbolClientCapabilities_resolveSupport_Type_1'], -}) -""" Client capabilities for a {@link WorkspaceSymbolRequest}. """ +class CodeLensWorkspaceClientCapabilities(TypedDict): + """ @since 3.16.0 """ + refreshSupport: NotRequired[bool] + """ Whether the client implementation supports a refresh request sent from the + server to the client. + Note that this event is global and will force the client to refresh all + code lenses currently shown. It should be used with absolute care and is + useful for situation where a server for example detect a project wide + change that requires such a calculation. """ -ExecuteCommandClientCapabilities = TypedDict('ExecuteCommandClientCapabilities', { - # Execute command supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], -}) -""" The client capabilities of a {@link ExecuteCommandRequest}. """ - - -SemanticTokensWorkspaceClientCapabilities = TypedDict('SemanticTokensWorkspaceClientCapabilities', { - # Whether the client implementation supports a refresh request sent from - # the server to the client. - # - # Note that this event is global and will force the client to refresh all - # semantic tokens currently shown. It should be used with absolute care - # and is useful for situation where a server for example detects a project - # wide change that requires such a calculation. - 'refreshSupport': NotRequired[bool], -}) -""" @since 3.16.0 """ - - -CodeLensWorkspaceClientCapabilities = TypedDict('CodeLensWorkspaceClientCapabilities', { - # Whether the client implementation supports a refresh request sent from the - # server to the client. - # - # Note that this event is global and will force the client to refresh all - # code lenses currently shown. It should be used with absolute care and is - # useful for situation where a server for example detect a project wide - # change that requires such a calculation. - 'refreshSupport': NotRequired[bool], -}) -""" @since 3.16.0 """ - - -FileOperationClientCapabilities = TypedDict('FileOperationClientCapabilities', { - # Whether the client supports dynamic registration for file requests/notifications. - 'dynamicRegistration': NotRequired[bool], - # The client has support for sending didCreateFiles notifications. - 'didCreate': NotRequired[bool], - # The client has support for sending willCreateFiles requests. - 'willCreate': NotRequired[bool], - # The client has support for sending didRenameFiles notifications. - 'didRename': NotRequired[bool], - # The client has support for sending willRenameFiles requests. - 'willRename': NotRequired[bool], - # The client has support for sending didDeleteFiles notifications. - 'didDelete': NotRequired[bool], - # The client has support for sending willDeleteFiles requests. - 'willDelete': NotRequired[bool], -}) -""" Capabilities relating to events from file operations by the user in the client. -These events do not come from the file system, they come from user operations -like renaming a file in the UI. +class FileOperationClientCapabilities(TypedDict): + """ Capabilities relating to events from file operations by the user in the client. -@since 3.16.0 """ + These events do not come from the file system, they come from user operations + like renaming a file in the UI. + @since 3.16.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether the client supports dynamic registration for file requests/notifications. """ + didCreate: NotRequired[bool] + """ The client has support for sending didCreateFiles notifications. """ + willCreate: NotRequired[bool] + """ The client has support for sending willCreateFiles requests. """ + didRename: NotRequired[bool] + """ The client has support for sending didRenameFiles notifications. """ + willRename: NotRequired[bool] + """ The client has support for sending willRenameFiles requests. """ + didDelete: NotRequired[bool] + """ The client has support for sending didDeleteFiles notifications. """ + willDelete: NotRequired[bool] + """ The client has support for sending willDeleteFiles requests. """ + + +class InlineValueWorkspaceClientCapabilities(TypedDict): + """ Client workspace capabilities specific to inline values. -InlineValueWorkspaceClientCapabilities = TypedDict('InlineValueWorkspaceClientCapabilities', { - # Whether the client implementation supports a refresh request sent from the - # server to the client. - # - # Note that this event is global and will force the client to refresh all - # inline values currently shown. It should be used with absolute care and is - # useful for situation where a server for example detects a project wide - # change that requires such a calculation. - 'refreshSupport': NotRequired[bool], -}) -""" Client workspace capabilities specific to inline values. + @since 3.17.0 """ + refreshSupport: NotRequired[bool] + """ Whether the client implementation supports a refresh request sent from the + server to the client. -@since 3.17.0 """ + Note that this event is global and will force the client to refresh all + inline values currently shown. It should be used with absolute care and is + useful for situation where a server for example detects a project wide + change that requires such a calculation. """ -InlayHintWorkspaceClientCapabilities = TypedDict('InlayHintWorkspaceClientCapabilities', { - # Whether the client implementation supports a refresh request sent from - # the server to the client. - # - # Note that this event is global and will force the client to refresh all - # inlay hints currently shown. It should be used with absolute care and - # is useful for situation where a server for example detects a project wide - # change that requires such a calculation. - 'refreshSupport': NotRequired[bool], -}) -""" Client workspace capabilities specific to inlay hints. +class InlayHintWorkspaceClientCapabilities(TypedDict): + """ Client workspace capabilities specific to inlay hints. -@since 3.17.0 """ + @since 3.17.0 """ + refreshSupport: NotRequired[bool] + """ Whether the client implementation supports a refresh request sent from + the server to the client. + Note that this event is global and will force the client to refresh all + inlay hints currently shown. It should be used with absolute care and + is useful for situation where a server for example detects a project wide + change that requires such a calculation. """ -DiagnosticWorkspaceClientCapabilities = TypedDict('DiagnosticWorkspaceClientCapabilities', { - # Whether the client implementation supports a refresh request sent from - # the server to the client. - # - # Note that this event is global and will force the client to refresh all - # pulled diagnostics currently shown. It should be used with absolute care and - # is useful for situation where a server for example detects a project wide - # change that requires such a calculation. - 'refreshSupport': NotRequired[bool], -}) -""" Workspace client capabilities specific to diagnostic pull requests. -@since 3.17.0 """ +class DiagnosticWorkspaceClientCapabilities(TypedDict): + """ Workspace client capabilities specific to diagnostic pull requests. + @since 3.17.0 """ + refreshSupport: NotRequired[bool] + """ Whether the client implementation supports a refresh request sent from + the server to the client. -TextDocumentSyncClientCapabilities = TypedDict('TextDocumentSyncClientCapabilities', { - # Whether text document synchronization supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # The client supports sending will save notifications. - 'willSave': NotRequired[bool], - # The client supports sending a will save request and - # waits for a response providing text edits which will - # be applied to the document before it is saved. - 'willSaveWaitUntil': NotRequired[bool], - # The client supports did save notifications. - 'didSave': NotRequired[bool], -}) + Note that this event is global and will force the client to refresh all + pulled diagnostics currently shown. It should be used with absolute care and + is useful for situation where a server for example detects a project wide + change that requires such a calculation. """ -CompletionClientCapabilities = TypedDict('CompletionClientCapabilities', { - # Whether completion supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # The client supports the following `CompletionItem` specific - # capabilities. - 'completionItem': NotRequired['__CompletionClientCapabilities_completionItem_Type_1'], - 'completionItemKind': NotRequired['__CompletionClientCapabilities_completionItemKind_Type_1'], - # Defines how the client handles whitespace and indentation - # when accepting a completion item that uses multi line - # text in either `insertText` or `textEdit`. - # - # @since 3.17.0 - 'insertTextMode': NotRequired['InsertTextMode'], - # The client supports to send additional context information for a - # `textDocument/completion` request. - 'contextSupport': NotRequired[bool], - # The client supports the following `CompletionList` specific - # capabilities. - # - # @since 3.17.0 - 'completionList': NotRequired['__CompletionClientCapabilities_completionList_Type_1'], -}) -""" Completion client capabilities """ +class FoldingRangeWorkspaceClientCapabilities(TypedDict): + """ Client workspace capabilities specific to folding ranges + @since 3.18.0 + @proposed """ + refreshSupport: NotRequired[bool] + """ Whether the client implementation supports a refresh request sent from the + server to the client. -HoverClientCapabilities = TypedDict('HoverClientCapabilities', { - # Whether hover supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # Client supports the following content formats for the content - # property. The order describes the preferred format of the client. - 'contentFormat': NotRequired[List['MarkupKind']], -}) + Note that this event is global and will force the client to refresh all + folding ranges currently shown. It should be used with absolute care and is + useful for situation where a server for example detects a project wide + change that requires such a calculation. + @since 3.18.0 + @proposed """ -SignatureHelpClientCapabilities = TypedDict('SignatureHelpClientCapabilities', { - # Whether signature help supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # The client supports the following `SignatureInformation` - # specific properties. - 'signatureInformation': NotRequired['__SignatureHelpClientCapabilities_signatureInformation_Type_1'], - # The client supports to send additional context information for a - # `textDocument/signatureHelp` request. A client that opts into - # contextSupport will also support the `retriggerCharacters` on - # `SignatureHelpOptions`. - # - # @since 3.15.0 - 'contextSupport': NotRequired[bool], -}) -""" Client Capabilities for a {@link SignatureHelpRequest}. """ +class TextDocumentSyncClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Whether text document synchronization supports dynamic registration. """ + willSave: NotRequired[bool] + """ The client supports sending will save notifications. """ + willSaveWaitUntil: NotRequired[bool] + """ The client supports sending a will save request and + waits for a response providing text edits which will + be applied to the document before it is saved. """ + didSave: NotRequired[bool] + """ The client supports did save notifications. """ + + +class CompletionClientCapabilities(TypedDict): + """ Completion client capabilities """ + dynamicRegistration: NotRequired[bool] + """ Whether completion supports dynamic registration. """ + completionItem: NotRequired['ClientCompletionItemOptions'] + """ The client supports the following `CompletionItem` specific + capabilities. """ + completionItemKind: NotRequired['ClientCompletionItemOptionsKind'] + insertTextMode: NotRequired['InsertTextMode'] + """ Defines how the client handles whitespace and indentation + when accepting a completion item that uses multi line + text in either `insertText` or `textEdit`. -DeclarationClientCapabilities = TypedDict('DeclarationClientCapabilities', { - # Whether declaration supports dynamic registration. If this is set to `true` - # the client supports the new `DeclarationRegistrationOptions` return value - # for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], - # The client supports additional metadata in the form of declaration links. - 'linkSupport': NotRequired[bool], -}) -""" @since 3.14.0 """ + @since 3.17.0 """ + contextSupport: NotRequired[bool] + """ The client supports to send additional context information for a + `textDocument/completion` request. """ + completionList: NotRequired['CompletionListCapabilities'] + """ The client supports the following `CompletionList` specific + capabilities. + @since 3.17.0 """ -DefinitionClientCapabilities = TypedDict('DefinitionClientCapabilities', { - # Whether definition supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # The client supports additional metadata in the form of definition links. - # - # @since 3.14.0 - 'linkSupport': NotRequired[bool], -}) -""" Client Capabilities for a {@link DefinitionRequest}. """ - - -TypeDefinitionClientCapabilities = TypedDict('TypeDefinitionClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `TypeDefinitionRegistrationOptions` return value - # for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], - # The client supports additional metadata in the form of definition links. - # - # Since 3.14.0 - 'linkSupport': NotRequired[bool], -}) -""" Since 3.6.0 """ - - -ImplementationClientCapabilities = TypedDict('ImplementationClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `ImplementationRegistrationOptions` return value - # for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], - # The client supports additional metadata in the form of definition links. - # - # @since 3.14.0 - 'linkSupport': NotRequired[bool], -}) -""" @since 3.6.0 """ +class HoverClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Whether hover supports dynamic registration. """ + contentFormat: NotRequired[List['MarkupKind']] + """ Client supports the following content formats for the content + property. The order describes the preferred format of the client. """ -ReferenceClientCapabilities = TypedDict('ReferenceClientCapabilities', { - # Whether references supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client Capabilities for a {@link ReferencesRequest}. """ +class SignatureHelpClientCapabilities(TypedDict): + """ Client Capabilities for a {@link SignatureHelpRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether signature help supports dynamic registration. """ + signatureInformation: NotRequired['ClientSignatureInformationOptions'] + """ The client supports the following `SignatureInformation` + specific properties. """ + contextSupport: NotRequired[bool] + """ The client supports to send additional context information for a + `textDocument/signatureHelp` request. A client that opts into + contextSupport will also support the `retriggerCharacters` on + `SignatureHelpOptions`. -DocumentHighlightClientCapabilities = TypedDict('DocumentHighlightClientCapabilities', { - # Whether document highlight supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client Capabilities for a {@link DocumentHighlightRequest}. """ - - -DocumentSymbolClientCapabilities = TypedDict('DocumentSymbolClientCapabilities', { - # Whether document symbol supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # Specific capabilities for the `SymbolKind` in the - # `textDocument/documentSymbol` request. - 'symbolKind': NotRequired['__DocumentSymbolClientCapabilities_symbolKind_Type_1'], - # The client supports hierarchical document symbols. - 'hierarchicalDocumentSymbolSupport': NotRequired[bool], - # The client supports tags on `SymbolInformation`. Tags are supported on - # `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true. - # Clients supporting tags have to handle unknown tags gracefully. - # - # @since 3.16.0 - 'tagSupport': NotRequired['__DocumentSymbolClientCapabilities_tagSupport_Type_1'], - # The client supports an additional label presented in the UI when - # registering a document symbol provider. - # - # @since 3.16.0 - 'labelSupport': NotRequired[bool], -}) -""" Client Capabilities for a {@link DocumentSymbolRequest}. """ - - -CodeActionClientCapabilities = TypedDict('CodeActionClientCapabilities', { - # Whether code action supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # The client support code action literals of type `CodeAction` as a valid - # response of the `textDocument/codeAction` request. If the property is not - # set the request can only return `Command` literals. - # - # @since 3.8.0 - 'codeActionLiteralSupport': NotRequired['__CodeActionClientCapabilities_codeActionLiteralSupport_Type_1'], - # Whether code action supports the `isPreferred` property. - # - # @since 3.15.0 - 'isPreferredSupport': NotRequired[bool], - # Whether code action supports the `disabled` property. - # - # @since 3.16.0 - 'disabledSupport': NotRequired[bool], - # Whether code action supports the `data` property which is - # preserved between a `textDocument/codeAction` and a - # `codeAction/resolve` request. - # - # @since 3.16.0 - 'dataSupport': NotRequired[bool], - # Whether the client supports resolving additional code action - # properties via a separate `codeAction/resolve` request. - # - # @since 3.16.0 - 'resolveSupport': NotRequired['__CodeActionClientCapabilities_resolveSupport_Type_1'], - # Whether the client honors the change annotations in - # text edits and resource operations returned via the - # `CodeAction#edit` property by for example presenting - # the workspace edit in the user interface and asking - # for confirmation. - # - # @since 3.16.0 - 'honorsChangeAnnotations': NotRequired[bool], -}) -""" The Client Capabilities of a {@link CodeActionRequest}. """ + @since 3.15.0 """ -CodeLensClientCapabilities = TypedDict('CodeLensClientCapabilities', { - # Whether code lens supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], -}) -""" The client capabilities of a {@link CodeLensRequest}. """ +class DeclarationClientCapabilities(TypedDict): + """ @since 3.14.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether declaration supports dynamic registration. If this is set to `true` + the client supports the new `DeclarationRegistrationOptions` return value + for the corresponding server capability as well. """ + linkSupport: NotRequired[bool] + """ The client supports additional metadata in the form of declaration links. """ -DocumentLinkClientCapabilities = TypedDict('DocumentLinkClientCapabilities', { - # Whether document link supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # Whether the client supports the `tooltip` property on `DocumentLink`. - # - # @since 3.15.0 - 'tooltipSupport': NotRequired[bool], -}) -""" The client capabilities of a {@link DocumentLinkRequest}. """ +class DefinitionClientCapabilities(TypedDict): + """ Client Capabilities for a {@link DefinitionRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether definition supports dynamic registration. """ + linkSupport: NotRequired[bool] + """ The client supports additional metadata in the form of definition links. + @since 3.14.0 """ -DocumentColorClientCapabilities = TypedDict('DocumentColorClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `DocumentColorRegistrationOptions` return value - # for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], -}) +class TypeDefinitionClientCapabilities(TypedDict): + """ Since 3.6.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `TypeDefinitionRegistrationOptions` return value + for the corresponding server capability as well. """ + linkSupport: NotRequired[bool] + """ The client supports additional metadata in the form of definition links. -DocumentFormattingClientCapabilities = TypedDict('DocumentFormattingClientCapabilities', { - # Whether formatting supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client capabilities of a {@link DocumentFormattingRequest}. """ + Since 3.14.0 """ -DocumentRangeFormattingClientCapabilities = TypedDict('DocumentRangeFormattingClientCapabilities', { - # Whether range formatting supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # Whether the client supports formatting multiple ranges at once. - # - # @since 3.18.0 - # @proposed - 'rangesSupport': NotRequired[bool], -}) -""" Client capabilities of a {@link DocumentRangeFormattingRequest}. """ +class ImplementationClientCapabilities(TypedDict): + """ @since 3.6.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `ImplementationRegistrationOptions` return value + for the corresponding server capability as well. """ + linkSupport: NotRequired[bool] + """ The client supports additional metadata in the form of definition links. + @since 3.14.0 """ -DocumentOnTypeFormattingClientCapabilities = TypedDict('DocumentOnTypeFormattingClientCapabilities', { - # Whether on type formatting supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client capabilities of a {@link DocumentOnTypeFormattingRequest}. """ - - -RenameClientCapabilities = TypedDict('RenameClientCapabilities', { - # Whether rename supports dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # Client supports testing for validity of rename operations - # before execution. - # - # @since 3.12.0 - 'prepareSupport': NotRequired[bool], - # Client supports the default behavior result. - # - # The value indicates the default behavior used by the - # client. - # - # @since 3.16.0 - 'prepareSupportDefaultBehavior': NotRequired['PrepareSupportDefaultBehavior'], - # Whether the client honors the change annotations in - # text edits and resource operations returned via the - # rename request's workspace edit by for example presenting - # the workspace edit in the user interface and asking - # for confirmation. - # - # @since 3.16.0 - 'honorsChangeAnnotations': NotRequired[bool], -}) +class ReferenceClientCapabilities(TypedDict): + """ Client Capabilities for a {@link ReferencesRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether references supports dynamic registration. """ -FoldingRangeClientCapabilities = TypedDict('FoldingRangeClientCapabilities', { - # Whether implementation supports dynamic registration for folding range - # providers. If this is set to `true` the client supports the new - # `FoldingRangeRegistrationOptions` return value for the corresponding - # server capability as well. - 'dynamicRegistration': NotRequired[bool], - # The maximum number of folding ranges that the client prefers to receive - # per document. The value serves as a hint, servers are free to follow the - # limit. - 'rangeLimit': NotRequired[Uint], - # If set, the client signals that it only supports folding complete lines. - # If set, client will ignore specified `startCharacter` and `endCharacter` - # properties in a FoldingRange. - 'lineFoldingOnly': NotRequired[bool], - # Specific options for the folding range kind. - # - # @since 3.17.0 - 'foldingRangeKind': NotRequired['__FoldingRangeClientCapabilities_foldingRangeKind_Type_1'], - # Specific options for the folding range. - # - # @since 3.17.0 - 'foldingRange': NotRequired['__FoldingRangeClientCapabilities_foldingRange_Type_1'], -}) +class DocumentHighlightClientCapabilities(TypedDict): + """ Client Capabilities for a {@link DocumentHighlightRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether document highlight supports dynamic registration. """ -SelectionRangeClientCapabilities = TypedDict('SelectionRangeClientCapabilities', { - # Whether implementation supports dynamic registration for selection range providers. If this is set to `true` - # the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server - # capability as well. - 'dynamicRegistration': NotRequired[bool], -}) +class DocumentSymbolClientCapabilities(TypedDict): + """ Client Capabilities for a {@link DocumentSymbolRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether document symbol supports dynamic registration. """ + symbolKind: NotRequired['ClientSymbolKindOptions'] + """ Specific capabilities for the `SymbolKind` in the + `textDocument/documentSymbol` request. """ + hierarchicalDocumentSymbolSupport: NotRequired[bool] + """ The client supports hierarchical document symbols. """ + tagSupport: NotRequired['ClientSymbolTagOptions'] + """ The client supports tags on `SymbolInformation`. Tags are supported on + `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true. + Clients supporting tags have to handle unknown tags gracefully. -PublishDiagnosticsClientCapabilities = TypedDict('PublishDiagnosticsClientCapabilities', { - # Whether the clients accepts diagnostics with related information. - 'relatedInformation': NotRequired[bool], - # Client supports the tag property to provide meta data about a diagnostic. - # Clients supporting tags have to handle unknown tags gracefully. - # - # @since 3.15.0 - 'tagSupport': NotRequired['__PublishDiagnosticsClientCapabilities_tagSupport_Type_1'], - # Whether the client interprets the version property of the - # `textDocument/publishDiagnostics` notification's parameter. - # - # @since 3.15.0 - 'versionSupport': NotRequired[bool], - # Client supports a codeDescription property - # - # @since 3.16.0 - 'codeDescriptionSupport': NotRequired[bool], - # Whether code action supports the `data` property which is - # preserved between a `textDocument/publishDiagnostics` and - # `textDocument/codeAction` request. - # - # @since 3.16.0 - 'dataSupport': NotRequired[bool], -}) -""" The publish diagnostic client capabilities. """ + @since 3.16.0 """ + labelSupport: NotRequired[bool] + """ The client supports an additional label presented in the UI when + registering a document symbol provider. + @since 3.16.0 """ -CallHierarchyClientCapabilities = TypedDict('CallHierarchyClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` - # return value for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], -}) -""" @since 3.16.0 """ - - -SemanticTokensClientCapabilities = TypedDict('SemanticTokensClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` - # return value for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], - # Which requests the client supports and might send to the server - # depending on the server's capability. Please note that clients might not - # show semantic tokens or degrade some of the user experience if a range - # or full request is advertised by the client but not provided by the - # server. If for example the client capability `requests.full` and - # `request.range` are both set to true but the server only provides a - # range provider the client might not render a minimap correctly or might - # even decide to not show any semantic tokens at all. - 'requests': '__SemanticTokensClientCapabilities_requests_Type_1', - # The token types that the client supports. - 'tokenTypes': List[str], - # The token modifiers that the client supports. - 'tokenModifiers': List[str], - # The token formats the clients supports. - 'formats': List['TokenFormat'], - # Whether the client supports tokens that can overlap each other. - 'overlappingTokenSupport': NotRequired[bool], - # Whether the client supports tokens that can span multiple lines. - 'multilineTokenSupport': NotRequired[bool], - # Whether the client allows the server to actively cancel a - # semantic token request, e.g. supports returning - # LSPErrorCodes.ServerCancelled. If a server does the client - # needs to retrigger the request. - # - # @since 3.17.0 - 'serverCancelSupport': NotRequired[bool], - # Whether the client uses semantic tokens to augment existing - # syntax tokens. If set to `true` client side created syntax - # tokens and semantic tokens are both used for colorization. If - # set to `false` the client only uses the returned semantic tokens - # for colorization. - # - # If the value is `undefined` then the client behavior is not - # specified. - # - # @since 3.17.0 - 'augmentsSyntaxTokens': NotRequired[bool], -}) -""" @since 3.16.0 """ +class CodeActionClientCapabilities(TypedDict): + """ The Client Capabilities of a {@link CodeActionRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether code action supports dynamic registration. """ + codeActionLiteralSupport: NotRequired['ClientCodeActionLiteralOptions'] + """ The client support code action literals of type `CodeAction` as a valid + response of the `textDocument/codeAction` request. If the property is not + set the request can only return `Command` literals. -LinkedEditingRangeClientCapabilities = TypedDict('LinkedEditingRangeClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` - # return value for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client capabilities for the linked editing range request. + @since 3.8.0 """ + isPreferredSupport: NotRequired[bool] + """ Whether code action supports the `isPreferred` property. -@since 3.16.0 """ + @since 3.15.0 """ + disabledSupport: NotRequired[bool] + """ Whether code action supports the `disabled` property. + @since 3.16.0 """ + dataSupport: NotRequired[bool] + """ Whether code action supports the `data` property which is + preserved between a `textDocument/codeAction` and a + `codeAction/resolve` request. -MonikerClientCapabilities = TypedDict('MonikerClientCapabilities', { - # Whether moniker supports dynamic registration. If this is set to `true` - # the client supports the new `MonikerRegistrationOptions` return value - # for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client capabilities specific to the moniker request. + @since 3.16.0 """ + resolveSupport: NotRequired['ClientCodeActionResolveOptions'] + """ Whether the client supports resolving additional code action + properties via a separate `codeAction/resolve` request. -@since 3.16.0 """ + @since 3.16.0 """ + honorsChangeAnnotations: NotRequired[bool] + """ Whether the client honors the change annotations in + text edits and resource operations returned via the + `CodeAction#edit` property by for example presenting + the workspace edit in the user interface and asking + for confirmation. + @since 3.16.0 """ + documentationSupport: NotRequired[bool] + """ Whether the client supports documentation for a class of + code actions. -TypeHierarchyClientCapabilities = TypedDict('TypeHierarchyClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` - # return value for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], -}) -""" @since 3.17.0 """ + @since 3.18.0 + @proposed """ -InlineValueClientCapabilities = TypedDict('InlineValueClientCapabilities', { - # Whether implementation supports dynamic registration for inline value providers. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client capabilities specific to inline values. +class CodeLensClientCapabilities(TypedDict): + """ The client capabilities of a {@link CodeLensRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether code lens supports dynamic registration. """ -@since 3.17.0 """ +class DocumentLinkClientCapabilities(TypedDict): + """ The client capabilities of a {@link DocumentLinkRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether document link supports dynamic registration. """ + tooltipSupport: NotRequired[bool] + """ Whether the client supports the `tooltip` property on `DocumentLink`. -InlayHintClientCapabilities = TypedDict('InlayHintClientCapabilities', { - # Whether inlay hints support dynamic registration. - 'dynamicRegistration': NotRequired[bool], - # Indicates which properties a client can resolve lazily on an inlay - # hint. - 'resolveSupport': NotRequired['__InlayHintClientCapabilities_resolveSupport_Type_1'], -}) -""" Inlay hint client capabilities. + @since 3.15.0 """ -@since 3.17.0 """ +class DocumentColorClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `DocumentColorRegistrationOptions` return value + for the corresponding server capability as well. """ -DiagnosticClientCapabilities = TypedDict('DiagnosticClientCapabilities', { - # Whether implementation supports dynamic registration. If this is set to `true` - # the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` - # return value for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], - # Whether the clients supports related documents for document diagnostic pulls. - 'relatedDocumentSupport': NotRequired[bool], -}) -""" Client capabilities specific to diagnostic pull requests. -@since 3.17.0 """ +class DocumentFormattingClientCapabilities(TypedDict): + """ Client capabilities of a {@link DocumentFormattingRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether formatting supports dynamic registration. """ -InlineCompletionClientCapabilities = TypedDict('InlineCompletionClientCapabilities', { - # Whether implementation supports dynamic registration for inline completion providers. - 'dynamicRegistration': NotRequired[bool], -}) -""" Client capabilities specific to inline completions. +class DocumentRangeFormattingClientCapabilities(TypedDict): + """ Client capabilities of a {@link DocumentRangeFormattingRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether range formatting supports dynamic registration. """ + rangesSupport: NotRequired[bool] + """ Whether the client supports formatting multiple ranges at once. -@since 3.18.0 -@proposed """ + @since 3.18.0 + @proposed """ -NotebookDocumentSyncClientCapabilities = TypedDict('NotebookDocumentSyncClientCapabilities', { - # Whether implementation supports dynamic registration. If this is - # set to `true` the client supports the new - # `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` - # return value for the corresponding server capability as well. - 'dynamicRegistration': NotRequired[bool], - # The client supports sending execution summary data per cell. - 'executionSummarySupport': NotRequired[bool], -}) -""" Notebook specific client capabilities. +class DocumentOnTypeFormattingClientCapabilities(TypedDict): + """ Client capabilities of a {@link DocumentOnTypeFormattingRequest}. """ + dynamicRegistration: NotRequired[bool] + """ Whether on type formatting supports dynamic registration. """ -@since 3.17.0 """ +class RenameClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Whether rename supports dynamic registration. """ + prepareSupport: NotRequired[bool] + """ Client supports testing for validity of rename operations + before execution. -ShowMessageRequestClientCapabilities = TypedDict('ShowMessageRequestClientCapabilities', { - # Capabilities specific to the `MessageActionItem` type. - 'messageActionItem': NotRequired['__ShowMessageRequestClientCapabilities_messageActionItem_Type_1'], -}) -""" Show message request client capabilities """ + @since 3.12.0 """ + prepareSupportDefaultBehavior: NotRequired['PrepareSupportDefaultBehavior'] + """ Client supports the default behavior result. + The value indicates the default behavior used by the + client. -ShowDocumentClientCapabilities = TypedDict('ShowDocumentClientCapabilities', { - # The client has support for the showDocument - # request. - 'support': bool, -}) -""" Client capabilities for the showDocument request. + @since 3.16.0 """ + honorsChangeAnnotations: NotRequired[bool] + """ Whether the client honors the change annotations in + text edits and resource operations returned via the + rename request's workspace edit by for example presenting + the workspace edit in the user interface and asking + for confirmation. -@since 3.16.0 """ + @since 3.16.0 """ -RegularExpressionsClientCapabilities = TypedDict('RegularExpressionsClientCapabilities', { - # The engine's name. - 'engine': str, - # The engine's version. - 'version': NotRequired[str], -}) -""" Client capabilities specific to regular expressions. +class FoldingRangeClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration for folding range + providers. If this is set to `true` the client supports the new + `FoldingRangeRegistrationOptions` return value for the corresponding + server capability as well. """ + rangeLimit: NotRequired[Uint] + """ The maximum number of folding ranges that the client prefers to receive + per document. The value serves as a hint, servers are free to follow the + limit. """ + lineFoldingOnly: NotRequired[bool] + """ If set, the client signals that it only supports folding complete lines. + If set, client will ignore specified `startCharacter` and `endCharacter` + properties in a FoldingRange. """ + foldingRangeKind: NotRequired['ClientFoldingRangeKindOptions'] + """ Specific options for the folding range kind. -@since 3.16.0 """ + @since 3.17.0 """ + foldingRange: NotRequired['ClientFoldingRangeOptions'] + """ Specific options for the folding range. + @since 3.17.0 """ -MarkdownClientCapabilities = TypedDict('MarkdownClientCapabilities', { - # The name of the parser. - 'parser': str, - # The version of the parser. - 'version': NotRequired[str], - # A list of HTML tags that the client allows / supports in - # Markdown. - # - # @since 3.17.0 - 'allowedTags': NotRequired[List[str]], -}) -""" Client capabilities specific to the used markdown parser. -@since 3.16.0 """ +class SelectionRangeClientCapabilities(TypedDict): + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration for selection range providers. If this is set to `true` + the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server + capability as well. """ -__CodeActionClientCapabilities_codeActionLiteralSupport_Type_1 = TypedDict('__CodeActionClientCapabilities_codeActionLiteralSupport_Type_1', { - # The code action kind is support with the following value - # set. - 'codeActionKind': '__CodeActionClientCapabilities_codeActionLiteralSupport_codeActionKind_Type_1', -}) +class PublishDiagnosticsClientCapabilities(TypedDict): + """ The publish diagnostic client capabilities. """ + versionSupport: NotRequired[bool] + """ Whether the client interprets the version property of the + `textDocument/publishDiagnostics` notification's parameter. + @since 3.15.0 """ + relatedInformation: NotRequired[bool] + """ Whether the clients accepts diagnostics with related information. """ + tagSupport: NotRequired['ClientDiagnosticsTagOptions'] + """ Client supports the tag property to provide meta data about a diagnostic. + Clients supporting tags have to handle unknown tags gracefully. -__CodeActionClientCapabilities_codeActionLiteralSupport_codeActionKind_Type_1 = TypedDict('__CodeActionClientCapabilities_codeActionLiteralSupport_codeActionKind_Type_1', { - # The code action kind values the client supports. When this - # property exists the client also guarantees that it will - # handle values outside its set gracefully and falls back - # to a default value when unknown. - 'valueSet': List['CodeActionKind'], -}) + @since 3.15.0 """ + codeDescriptionSupport: NotRequired[bool] + """ Client supports a codeDescription property + @since 3.16.0 """ + dataSupport: NotRequired[bool] + """ Whether code action supports the `data` property which is + preserved between a `textDocument/publishDiagnostics` and + `textDocument/codeAction` request. -__CodeActionClientCapabilities_resolveSupport_Type_1 = TypedDict('__CodeActionClientCapabilities_resolveSupport_Type_1', { - # The properties that a client can resolve lazily. - 'properties': List[str], -}) + @since 3.16.0 """ -__CodeAction_disabled_Type_1 = TypedDict('__CodeAction_disabled_Type_1', { - # Human readable description of why the code action is currently disabled. - # - # This is displayed in the code actions UI. - 'reason': str, -}) +class CallHierarchyClientCapabilities(TypedDict): + """ @since 3.16.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` + return value for the corresponding server capability as well. """ + + +class SemanticTokensClientCapabilities(TypedDict): + """ @since 3.16.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` + return value for the corresponding server capability as well. """ + requests: 'ClientSemanticTokensRequestOptions' + """ Which requests the client supports and might send to the server + depending on the server's capability. Please note that clients might not + show semantic tokens or degrade some of the user experience if a range + or full request is advertised by the client but not provided by the + server. If for example the client capability `requests.full` and + `request.range` are both set to true but the server only provides a + range provider the client might not render a minimap correctly or might + even decide to not show any semantic tokens at all. """ + tokenTypes: List[str] + """ The token types that the client supports. """ + tokenModifiers: List[str] + """ The token modifiers that the client supports. """ + formats: List['TokenFormat'] + """ The token formats the clients supports. """ + overlappingTokenSupport: NotRequired[bool] + """ Whether the client supports tokens that can overlap each other. """ + multilineTokenSupport: NotRequired[bool] + """ Whether the client supports tokens that can span multiple lines. """ + serverCancelSupport: NotRequired[bool] + """ Whether the client allows the server to actively cancel a + semantic token request, e.g. supports returning + LSPErrorCodes.ServerCancelled. If a server does the client + needs to retrigger the request. + @since 3.17.0 """ + augmentsSyntaxTokens: NotRequired[bool] + """ Whether the client uses semantic tokens to augment existing + syntax tokens. If set to `true` client side created syntax + tokens and semantic tokens are both used for colorization. If + set to `false` the client only uses the returned semantic tokens + for colorization. -__CompletionClientCapabilities_completionItemKind_Type_1 = TypedDict('__CompletionClientCapabilities_completionItemKind_Type_1', { - # The completion item kind values the client supports. When this - # property exists the client also guarantees that it will - # handle values outside its set gracefully and falls back - # to a default value when unknown. - # - # If this property is not present the client only supports - # the completion items kinds from `Text` to `Reference` as defined in - # the initial version of the protocol. - 'valueSet': NotRequired[List['CompletionItemKind']], -}) + If the value is `undefined` then the client behavior is not + specified. + @since 3.17.0 """ -__CompletionClientCapabilities_completionItem_Type_1 = TypedDict('__CompletionClientCapabilities_completionItem_Type_1', { - # Client supports snippets as insert text. - # - # A snippet can define tab stops and placeholders with `$1`, `$2` - # and `${3:foo}`. `$0` defines the final tab stop, it defaults to - # the end of the snippet. Placeholders with equal identifiers are linked, - # that is typing in one will update others too. - 'snippetSupport': NotRequired[bool], - # Client supports commit characters on a completion item. - 'commitCharactersSupport': NotRequired[bool], - # Client supports the following content formats for the documentation - # property. The order describes the preferred format of the client. - 'documentationFormat': NotRequired[List['MarkupKind']], - # Client supports the deprecated property on a completion item. - 'deprecatedSupport': NotRequired[bool], - # Client supports the preselect property on a completion item. - 'preselectSupport': NotRequired[bool], - # Client supports the tag property on a completion item. Clients supporting - # tags have to handle unknown tags gracefully. Clients especially need to - # preserve unknown tags when sending a completion item back to the server in - # a resolve call. - # - # @since 3.15.0 - 'tagSupport': NotRequired['__CompletionClientCapabilities_completionItem_tagSupport_Type_1'], - # Client support insert replace edit to control different behavior if a - # completion item is inserted in the text or should replace text. - # - # @since 3.16.0 - 'insertReplaceSupport': NotRequired[bool], - # Indicates which properties a client can resolve lazily on a completion - # item. Before version 3.16.0 only the predefined properties `documentation` - # and `details` could be resolved lazily. - # - # @since 3.16.0 - 'resolveSupport': NotRequired['__CompletionClientCapabilities_completionItem_resolveSupport_Type_1'], - # The client supports the `insertTextMode` property on - # a completion item to override the whitespace handling mode - # as defined by the client (see `insertTextMode`). - # - # @since 3.16.0 - 'insertTextModeSupport': NotRequired['__CompletionClientCapabilities_completionItem_insertTextModeSupport_Type_1'], - # The client has support for completion item label - # details (see also `CompletionItemLabelDetails`). - # - # @since 3.17.0 - 'labelDetailsSupport': NotRequired[bool], -}) +class LinkedEditingRangeClientCapabilities(TypedDict): + """ Client capabilities for the linked editing range request. -__CompletionClientCapabilities_completionItem_insertTextModeSupport_Type_1 = TypedDict('__CompletionClientCapabilities_completionItem_insertTextModeSupport_Type_1', { - 'valueSet': List['InsertTextMode'], -}) + @since 3.16.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` + return value for the corresponding server capability as well. """ -__CompletionClientCapabilities_completionItem_resolveSupport_Type_1 = TypedDict('__CompletionClientCapabilities_completionItem_resolveSupport_Type_1', { - # The properties that a client can resolve lazily. - 'properties': List[str], -}) +class MonikerClientCapabilities(TypedDict): + """ Client capabilities specific to the moniker request. + @since 3.16.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether moniker supports dynamic registration. If this is set to `true` + the client supports the new `MonikerRegistrationOptions` return value + for the corresponding server capability as well. """ -__CompletionClientCapabilities_completionItem_tagSupport_Type_1 = TypedDict('__CompletionClientCapabilities_completionItem_tagSupport_Type_1', { - # The tags supported by the client. - 'valueSet': List['CompletionItemTag'], -}) +class TypeHierarchyClientCapabilities(TypedDict): + """ @since 3.17.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` + return value for the corresponding server capability as well. """ -__CompletionClientCapabilities_completionList_Type_1 = TypedDict('__CompletionClientCapabilities_completionList_Type_1', { - # The client supports the following itemDefaults on - # a completion list. - # - # The value lists the supported property names of the - # `CompletionList.itemDefaults` object. If omitted - # no properties are supported. - # - # @since 3.17.0 - 'itemDefaults': NotRequired[List[str]], -}) +class InlineValueClientCapabilities(TypedDict): + """ Client capabilities specific to inline values. -__CompletionList_itemDefaults_Type_1 = TypedDict('__CompletionList_itemDefaults_Type_1', { - # A default commit character set. - # - # @since 3.17.0 - 'commitCharacters': NotRequired[List[str]], - # A default edit range. - # - # @since 3.17.0 - 'editRange': NotRequired[Union['Range', '__CompletionList_itemDefaults_editRange_Type_1']], - # A default insert text format. - # - # @since 3.17.0 - 'insertTextFormat': NotRequired['InsertTextFormat'], - # A default insert text mode. - # - # @since 3.17.0 - 'insertTextMode': NotRequired['InsertTextMode'], - # A default data value. - # - # @since 3.17.0 - 'data': NotRequired['LSPAny'], -}) + @since 3.17.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration for inline value providers. """ -__CompletionList_itemDefaults_editRange_Type_1 = TypedDict('__CompletionList_itemDefaults_editRange_Type_1', { - 'insert': 'Range', - 'replace': 'Range', -}) +class InlayHintClientCapabilities(TypedDict): + """ Inlay hint client capabilities. + @since 3.17.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether inlay hints support dynamic registration. """ + resolveSupport: NotRequired['ClientInlayHintResolveOptions'] + """ Indicates which properties a client can resolve lazily on an inlay + hint. """ -__CompletionOptions_completionItem_Type_1 = TypedDict('__CompletionOptions_completionItem_Type_1', { - # The server has support for completion item label - # details (see also `CompletionItemLabelDetails`) when - # receiving a completion item in a resolve call. - # - # @since 3.17.0 - 'labelDetailsSupport': NotRequired[bool], -}) +class DiagnosticClientCapabilities(TypedDict): + """ Client capabilities specific to diagnostic pull requests. -__CompletionOptions_completionItem_Type_2 = TypedDict('__CompletionOptions_completionItem_Type_2', { - # The server has support for completion item label - # details (see also `CompletionItemLabelDetails`) when - # receiving a completion item in a resolve call. - # - # @since 3.17.0 - 'labelDetailsSupport': NotRequired[bool], -}) + @since 3.17.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is set to `true` + the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` + return value for the corresponding server capability as well. """ + relatedDocumentSupport: NotRequired[bool] + """ Whether the clients supports related documents for document diagnostic pulls. """ + relatedInformation: NotRequired[bool] + """ Whether the clients accepts diagnostics with related information. """ + tagSupport: NotRequired['ClientDiagnosticsTagOptions'] + """ Client supports the tag property to provide meta data about a diagnostic. + Clients supporting tags have to handle unknown tags gracefully. + @since 3.15.0 """ + codeDescriptionSupport: NotRequired[bool] + """ Client supports a codeDescription property -__DocumentSymbolClientCapabilities_symbolKind_Type_1 = TypedDict('__DocumentSymbolClientCapabilities_symbolKind_Type_1', { - # The symbol kind values the client supports. When this - # property exists the client also guarantees that it will - # handle values outside its set gracefully and falls back - # to a default value when unknown. - # - # If this property is not present the client only supports - # the symbol kinds from `File` to `Array` as defined in - # the initial version of the protocol. - 'valueSet': NotRequired[List['SymbolKind']], -}) + @since 3.16.0 """ + dataSupport: NotRequired[bool] + """ Whether code action supports the `data` property which is + preserved between a `textDocument/publishDiagnostics` and + `textDocument/codeAction` request. + @since 3.16.0 """ -__DocumentSymbolClientCapabilities_tagSupport_Type_1 = TypedDict('__DocumentSymbolClientCapabilities_tagSupport_Type_1', { - # The tags supported by the client. - 'valueSet': List['SymbolTag'], -}) +class InlineCompletionClientCapabilities(TypedDict): + """ Client capabilities specific to inline completions. -__FoldingRangeClientCapabilities_foldingRangeKind_Type_1 = TypedDict('__FoldingRangeClientCapabilities_foldingRangeKind_Type_1', { - # The folding range kind values the client supports. When this - # property exists the client also guarantees that it will - # handle values outside its set gracefully and falls back - # to a default value when unknown. - 'valueSet': NotRequired[List['FoldingRangeKind']], -}) + @since 3.18.0 + @proposed """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration for inline completion providers. """ -__FoldingRangeClientCapabilities_foldingRange_Type_1 = TypedDict('__FoldingRangeClientCapabilities_foldingRange_Type_1', { - # If set, the client signals that it supports setting collapsedText on - # folding ranges to display custom labels instead of the default text. - # - # @since 3.17.0 - 'collapsedText': NotRequired[bool], -}) +class NotebookDocumentSyncClientCapabilities(TypedDict): + """ Notebook specific client capabilities. + @since 3.17.0 """ + dynamicRegistration: NotRequired[bool] + """ Whether implementation supports dynamic registration. If this is + set to `true` the client supports the new + `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` + return value for the corresponding server capability as well. """ + executionSummarySupport: NotRequired[bool] + """ The client supports sending execution summary data per cell. """ -__GeneralClientCapabilities_staleRequestSupport_Type_1 = TypedDict('__GeneralClientCapabilities_staleRequestSupport_Type_1', { - # The client will actively cancel the request. - 'cancel': bool, - # The list of requests for which the client - # will retry the request if it receives a - # response with error code `ContentModified` - 'retryOnContentModified': List[str], -}) +class ShowMessageRequestClientCapabilities(TypedDict): + """ Show message request client capabilities """ + messageActionItem: NotRequired['ClientShowMessageActionItemOptions'] + """ Capabilities specific to the `MessageActionItem` type. """ -__InitializeResult_serverInfo_Type_1 = TypedDict('__InitializeResult_serverInfo_Type_1', { - # The name of the server as defined by the server. - 'name': str, - # The server's version as defined by the server. - 'version': NotRequired[str], -}) +class ShowDocumentClientCapabilities(TypedDict): + """ Client capabilities for the showDocument request. -__InlayHintClientCapabilities_resolveSupport_Type_1 = TypedDict('__InlayHintClientCapabilities_resolveSupport_Type_1', { - # The properties that a client can resolve lazily. - 'properties': List[str], -}) + @since 3.16.0 """ + support: bool + """ The client has support for the showDocument + request. """ -__MarkedString_Type_1 = TypedDict('__MarkedString_Type_1', { - 'language': str, - 'value': str, -}) +class StaleRequestSupportOptions(TypedDict): + """ @since 3.18.0 """ + cancel: bool + """ The client will actively cancel the request. """ + retryOnContentModified: List[str] + """ The list of requests for which the client + will retry the request if it receives a + response with error code `ContentModified` """ -__NotebookDocumentChangeEvent_cells_Type_1 = TypedDict('__NotebookDocumentChangeEvent_cells_Type_1', { - # Changes to the cell structure to add or - # remove cells. - 'structure': NotRequired['__NotebookDocumentChangeEvent_cells_structure_Type_1'], - # Changes to notebook cells properties like its - # kind, execution summary or metadata. - 'data': NotRequired[List['NotebookCell']], - # Changes to the text content of notebook cells. - 'textContent': NotRequired[List['__NotebookDocumentChangeEvent_cells_textContent_Type_1']], -}) +class RegularExpressionsClientCapabilities(TypedDict): + """ Client capabilities specific to regular expressions. + @since 3.16.0 """ + engine: 'RegularExpressionEngineKind' + """ The engine's name. """ + version: NotRequired[str] + """ The engine's version. """ -__NotebookDocumentChangeEvent_cells_structure_Type_1 = TypedDict('__NotebookDocumentChangeEvent_cells_structure_Type_1', { - # The change to the cell array. - 'array': 'NotebookCellArrayChange', - # Additional opened cell text documents. - 'didOpen': NotRequired[List['TextDocumentItem']], - # Additional closed cell text documents. - 'didClose': NotRequired[List['TextDocumentIdentifier']], -}) +class MarkdownClientCapabilities(TypedDict): + """ Client capabilities specific to the used markdown parser. -__NotebookDocumentChangeEvent_cells_textContent_Type_1 = TypedDict('__NotebookDocumentChangeEvent_cells_textContent_Type_1', { - 'document': 'VersionedTextDocumentIdentifier', - 'changes': List['TextDocumentContentChangeEvent'], -}) + @since 3.16.0 """ + parser: str + """ The name of the parser. """ + version: NotRequired[str] + """ The version of the parser. """ + allowedTags: NotRequired[List[str]] + """ A list of HTML tags that the client allows / supports in + Markdown. + @since 3.17.0 """ -__NotebookDocumentFilter_Type_1 = TypedDict('__NotebookDocumentFilter_Type_1', { - # The type of the enclosing notebook. - 'notebookType': str, - # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. - 'scheme': NotRequired[str], - # A glob pattern. - 'pattern': NotRequired[str], -}) +class ChangeAnnotationsSupportOptions(TypedDict): + """ @since 3.18.0 """ + groupsOnLabel: NotRequired[bool] + """ Whether the client groups edits with equal labels into tree nodes, + for instance all edits labelled with "Changes in Strings" would + be a tree node. """ -__NotebookDocumentFilter_Type_2 = TypedDict('__NotebookDocumentFilter_Type_2', { - # The type of the enclosing notebook. - 'notebookType': NotRequired[str], - # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. - 'scheme': str, - # A glob pattern. - 'pattern': NotRequired[str], -}) +class ClientSymbolKindOptions(TypedDict): + """ @since 3.18.0 """ + valueSet: NotRequired[List['SymbolKind']] + """ The symbol kind values the client supports. When this + property exists the client also guarantees that it will + handle values outside its set gracefully and falls back + to a default value when unknown. -__NotebookDocumentFilter_Type_3 = TypedDict('__NotebookDocumentFilter_Type_3', { - # The type of the enclosing notebook. - 'notebookType': NotRequired[str], - # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. - 'scheme': NotRequired[str], - # A glob pattern. - 'pattern': str, -}) + If this property is not present the client only supports + the symbol kinds from `File` to `Array` as defined in + the initial version of the protocol. """ -__NotebookDocumentSyncOptions_notebookSelector_Type_1 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_Type_1', { - # The notebook to be synced If a string - # value is provided it matches against the - # notebook type. '*' matches every notebook. - 'notebook': Union[str, 'NotebookDocumentFilter'], - # The cells of the matching notebook to be synced. - 'cells': NotRequired[List['__NotebookDocumentSyncOptions_notebookSelector_cells_Type_1']], -}) +class ClientSymbolTagOptions(TypedDict): + """ @since 3.18.0 """ + valueSet: List['SymbolTag'] + """ The tags supported by the client. """ -__NotebookDocumentSyncOptions_notebookSelector_Type_2 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_Type_2', { - # The notebook to be synced If a string - # value is provided it matches against the - # notebook type. '*' matches every notebook. - 'notebook': NotRequired[Union[str, 'NotebookDocumentFilter']], - # The cells of the matching notebook to be synced. - 'cells': List['__NotebookDocumentSyncOptions_notebookSelector_cells_Type_2'], -}) +class ClientSymbolResolveOptions(TypedDict): + """ @since 3.18.0 """ + properties: List[str] + """ The properties that a client can resolve lazily. Usually + `location.range` """ -__NotebookDocumentSyncOptions_notebookSelector_Type_3 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_Type_3', { - # The notebook to be synced If a string - # value is provided it matches against the - # notebook type. '*' matches every notebook. - 'notebook': Union[str, 'NotebookDocumentFilter'], - # The cells of the matching notebook to be synced. - 'cells': NotRequired[List['__NotebookDocumentSyncOptions_notebookSelector_cells_Type_3']], -}) +class ClientCompletionItemOptions(TypedDict): + """ @since 3.18.0 """ + snippetSupport: NotRequired[bool] + """ Client supports snippets as insert text. + A snippet can define tab stops and placeholders with `$1`, `$2` + and `${3:foo}`. `$0` defines the final tab stop, it defaults to + the end of the snippet. Placeholders with equal identifiers are linked, + that is typing in one will update others too. """ + commitCharactersSupport: NotRequired[bool] + """ Client supports commit characters on a completion item. """ + documentationFormat: NotRequired[List['MarkupKind']] + """ Client supports the following content formats for the documentation + property. The order describes the preferred format of the client. """ + deprecatedSupport: NotRequired[bool] + """ Client supports the deprecated property on a completion item. """ + preselectSupport: NotRequired[bool] + """ Client supports the preselect property on a completion item. """ + tagSupport: NotRequired['CompletionItemTagOptions'] + """ Client supports the tag property on a completion item. Clients supporting + tags have to handle unknown tags gracefully. Clients especially need to + preserve unknown tags when sending a completion item back to the server in + a resolve call. -__NotebookDocumentSyncOptions_notebookSelector_Type_4 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_Type_4', { - # The notebook to be synced If a string - # value is provided it matches against the - # notebook type. '*' matches every notebook. - 'notebook': NotRequired[Union[str, 'NotebookDocumentFilter']], - # The cells of the matching notebook to be synced. - 'cells': List['__NotebookDocumentSyncOptions_notebookSelector_cells_Type_4'], -}) + @since 3.15.0 """ + insertReplaceSupport: NotRequired[bool] + """ Client support insert replace edit to control different behavior if a + completion item is inserted in the text or should replace text. + @since 3.16.0 """ + resolveSupport: NotRequired['ClientCompletionItemResolveOptions'] + """ Indicates which properties a client can resolve lazily on a completion + item. Before version 3.16.0 only the predefined properties `documentation` + and `details` could be resolved lazily. -__NotebookDocumentSyncOptions_notebookSelector_cells_Type_1 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_cells_Type_1', { - 'language': str, -}) + @since 3.16.0 """ + insertTextModeSupport: NotRequired['ClientCompletionItemInsertTextModeOptions'] + """ The client supports the `insertTextMode` property on + a completion item to override the whitespace handling mode + as defined by the client (see `insertTextMode`). + @since 3.16.0 """ + labelDetailsSupport: NotRequired[bool] + """ The client has support for completion item label + details (see also `CompletionItemLabelDetails`). -__NotebookDocumentSyncOptions_notebookSelector_cells_Type_2 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_cells_Type_2', { - 'language': str, -}) + @since 3.17.0 """ -__NotebookDocumentSyncOptions_notebookSelector_cells_Type_3 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_cells_Type_3', { - 'language': str, -}) +class ClientCompletionItemOptionsKind(TypedDict): + """ @since 3.18.0 """ + valueSet: NotRequired[List['CompletionItemKind']] + """ The completion item kind values the client supports. When this + property exists the client also guarantees that it will + handle values outside its set gracefully and falls back + to a default value when unknown. + If this property is not present the client only supports + the completion items kinds from `Text` to `Reference` as defined in + the initial version of the protocol. """ -__NotebookDocumentSyncOptions_notebookSelector_cells_Type_4 = TypedDict('__NotebookDocumentSyncOptions_notebookSelector_cells_Type_4', { - 'language': str, -}) +class CompletionListCapabilities(TypedDict): + """ The client supports the following `CompletionList` specific + capabilities. -__PrepareRenameResult_Type_1 = TypedDict('__PrepareRenameResult_Type_1', { - 'range': 'Range', - 'placeholder': str, -}) + @since 3.17.0 """ + itemDefaults: NotRequired[List[str]] + """ The client supports the following itemDefaults on + a completion list. + The value lists the supported property names of the + `CompletionList.itemDefaults` object. If omitted + no properties are supported. -__PrepareRenameResult_Type_2 = TypedDict('__PrepareRenameResult_Type_2', { - 'defaultBehavior': bool, -}) + @since 3.17.0 """ -__PublishDiagnosticsClientCapabilities_tagSupport_Type_1 = TypedDict('__PublishDiagnosticsClientCapabilities_tagSupport_Type_1', { - # The tags supported by the client. - 'valueSet': List['DiagnosticTag'], -}) +class ClientSignatureInformationOptions(TypedDict): + """ @since 3.18.0 """ + documentationFormat: NotRequired[List['MarkupKind']] + """ Client supports the following content formats for the documentation + property. The order describes the preferred format of the client. """ + parameterInformation: NotRequired['ClientSignatureParameterInformationOptions'] + """ Client capabilities specific to parameter information. """ + activeParameterSupport: NotRequired[bool] + """ The client supports the `activeParameter` property on `SignatureInformation` + literal. + @since 3.16.0 """ + noActiveParameterSupport: NotRequired[bool] + """ The client supports the `activeParameter` property on + `SignatureHelp`/`SignatureInformation` being set to `null` to + indicate that no parameter should be active. -__SemanticTokensClientCapabilities_requests_Type_1 = TypedDict('__SemanticTokensClientCapabilities_requests_Type_1', { - # The client will send the `textDocument/semanticTokens/range` request if - # the server provides a corresponding handler. - 'range': NotRequired[Union[bool, dict]], - # The client will send the `textDocument/semanticTokens/full` request if - # the server provides a corresponding handler. - 'full': NotRequired[Union[bool, '__SemanticTokensClientCapabilities_requests_full_Type_1']], -}) + @since 3.18.0 + @proposed """ -__SemanticTokensClientCapabilities_requests_full_Type_1 = TypedDict('__SemanticTokensClientCapabilities_requests_full_Type_1', { - # The client will send the `textDocument/semanticTokens/full/delta` request if - # the server provides a corresponding handler. - 'delta': NotRequired[bool], -}) +class ClientCodeActionLiteralOptions(TypedDict): + """ @since 3.18.0 """ + codeActionKind: 'ClientCodeActionKindOptions' + """ The code action kind is support with the following value + set. """ -__SemanticTokensOptions_full_Type_1 = TypedDict('__SemanticTokensOptions_full_Type_1', { - # The server supports deltas for full documents. - 'delta': NotRequired[bool], -}) +class ClientCodeActionResolveOptions(TypedDict): + """ @since 3.18.0 """ + properties: List[str] + """ The properties that a client can resolve lazily. """ -__SemanticTokensOptions_full_Type_2 = TypedDict('__SemanticTokensOptions_full_Type_2', { - # The server supports deltas for full documents. - 'delta': NotRequired[bool], -}) +class ClientFoldingRangeKindOptions(TypedDict): + """ @since 3.18.0 """ + valueSet: NotRequired[List['FoldingRangeKind']] + """ The folding range kind values the client supports. When this + property exists the client also guarantees that it will + handle values outside its set gracefully and falls back + to a default value when unknown. """ -__ServerCapabilities_workspace_Type_1 = TypedDict('__ServerCapabilities_workspace_Type_1', { - # The server supports workspace folder. - # - # @since 3.6.0 - 'workspaceFolders': NotRequired['WorkspaceFoldersServerCapabilities'], - # The server is interested in notifications/requests for operations on files. - # - # @since 3.16.0 - 'fileOperations': NotRequired['FileOperationOptions'], -}) +class ClientFoldingRangeOptions(TypedDict): + """ @since 3.18.0 """ + collapsedText: NotRequired[bool] + """ If set, the client signals that it supports setting collapsedText on + folding ranges to display custom labels instead of the default text. + @since 3.17.0 """ -__ShowMessageRequestClientCapabilities_messageActionItem_Type_1 = TypedDict('__ShowMessageRequestClientCapabilities_messageActionItem_Type_1', { - # Whether the client supports additional attributes which - # are preserved and send back to the server in the - # request's response. - 'additionalPropertiesSupport': NotRequired[bool], -}) +class DiagnosticsCapabilities(TypedDict): + """ General diagnostics capabilities for pull and push model. """ + relatedInformation: NotRequired[bool] + """ Whether the clients accepts diagnostics with related information. """ + tagSupport: NotRequired['ClientDiagnosticsTagOptions'] + """ Client supports the tag property to provide meta data about a diagnostic. + Clients supporting tags have to handle unknown tags gracefully. -__SignatureHelpClientCapabilities_signatureInformation_Type_1 = TypedDict('__SignatureHelpClientCapabilities_signatureInformation_Type_1', { - # Client supports the following content formats for the documentation - # property. The order describes the preferred format of the client. - 'documentationFormat': NotRequired[List['MarkupKind']], - # Client capabilities specific to parameter information. - 'parameterInformation': NotRequired['__SignatureHelpClientCapabilities_signatureInformation_parameterInformation_Type_1'], - # The client supports the `activeParameter` property on `SignatureInformation` - # literal. - # - # @since 3.16.0 - 'activeParameterSupport': NotRequired[bool], -}) + @since 3.15.0 """ + codeDescriptionSupport: NotRequired[bool] + """ Client supports a codeDescription property + @since 3.16.0 """ + dataSupport: NotRequired[bool] + """ Whether code action supports the `data` property which is + preserved between a `textDocument/publishDiagnostics` and + `textDocument/codeAction` request. -__SignatureHelpClientCapabilities_signatureInformation_parameterInformation_Type_1 = TypedDict('__SignatureHelpClientCapabilities_signatureInformation_parameterInformation_Type_1', { - # The client supports processing label offsets instead of a - # simple label string. - # - # @since 3.14.0 - 'labelOffsetSupport': NotRequired[bool], -}) + @since 3.16.0 """ -__TextDocumentContentChangeEvent_Type_1 = TypedDict('__TextDocumentContentChangeEvent_Type_1', { - # The range of the document that changed. - 'range': 'Range', - # The optional length of the range that got replaced. - # - # @deprecated use range instead. - 'rangeLength': NotRequired[Uint], - # The new text for the provided range. - 'text': str, -}) +class ClientSemanticTokensRequestOptions(TypedDict): + """ @since 3.18.0 """ + range: NotRequired[Union[bool, dict]] + """ The client will send the `textDocument/semanticTokens/range` request if + the server provides a corresponding handler. """ + full: NotRequired[Union[bool, 'ClientSemanticTokensRequestFullDelta']] + """ The client will send the `textDocument/semanticTokens/full` request if + the server provides a corresponding handler. """ -__TextDocumentContentChangeEvent_Type_2 = TypedDict('__TextDocumentContentChangeEvent_Type_2', { - # The new text of the whole document. - 'text': str, -}) +class ClientInlayHintResolveOptions(TypedDict): + """ @since 3.18.0 """ + properties: List[str] + """ The properties that a client can resolve lazily. """ -__TextDocumentFilter_Type_1 = TypedDict('__TextDocumentFilter_Type_1', { - # A language id, like `typescript`. - 'language': str, - # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. - 'scheme': NotRequired[str], - # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples. - 'pattern': NotRequired[str], -}) +class ClientShowMessageActionItemOptions(TypedDict): + """ @since 3.18.0 """ + additionalPropertiesSupport: NotRequired[bool] + """ Whether the client supports additional attributes which + are preserved and send back to the server in the + request's response. """ -__TextDocumentFilter_Type_2 = TypedDict('__TextDocumentFilter_Type_2', { - # A language id, like `typescript`. - 'language': NotRequired[str], - # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. - 'scheme': str, - # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples. - 'pattern': NotRequired[str], -}) +class CompletionItemTagOptions(TypedDict): + """ @since 3.18.0 """ + valueSet: List['CompletionItemTag'] + """ The tags supported by the client. """ -__TextDocumentFilter_Type_3 = TypedDict('__TextDocumentFilter_Type_3', { - # A language id, like `typescript`. - 'language': NotRequired[str], - # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`. - 'scheme': NotRequired[str], - # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples. - 'pattern': str, -}) +class ClientCompletionItemResolveOptions(TypedDict): + """ @since 3.18.0 """ + properties: List[str] + """ The properties that a client can resolve lazily. """ -__WorkspaceEditClientCapabilities_changeAnnotationSupport_Type_1 = TypedDict('__WorkspaceEditClientCapabilities_changeAnnotationSupport_Type_1', { - # Whether the client groups edits with equal labels into tree nodes, - # for instance all edits labelled with "Changes in Strings" would - # be a tree node. - 'groupsOnLabel': NotRequired[bool], -}) +class ClientCompletionItemInsertTextModeOptions(TypedDict): + """ @since 3.18.0 """ + valueSet: List['InsertTextMode'] -__WorkspaceSymbolClientCapabilities_resolveSupport_Type_1 = TypedDict('__WorkspaceSymbolClientCapabilities_resolveSupport_Type_1', { - # The properties that a client can resolve lazily. Usually - # `location.range` - 'properties': List[str], -}) +class ClientSignatureParameterInformationOptions(TypedDict): + """ @since 3.18.0 """ + labelOffsetSupport: NotRequired[bool] + """ The client supports processing label offsets instead of a + simple label string. + @since 3.14.0 """ -__WorkspaceSymbolClientCapabilities_symbolKind_Type_1 = TypedDict('__WorkspaceSymbolClientCapabilities_symbolKind_Type_1', { - # The symbol kind values the client supports. When this - # property exists the client also guarantees that it will - # handle values outside its set gracefully and falls back - # to a default value when unknown. - # - # If this property is not present the client only supports - # the symbol kinds from `File` to `Array` as defined in - # the initial version of the protocol. - 'valueSet': NotRequired[List['SymbolKind']], -}) +class ClientCodeActionKindOptions(TypedDict): + """ @since 3.18.0 """ + valueSet: List['CodeActionKind'] + """ The code action kind values the client supports. When this + property exists the client also guarantees that it will + handle values outside its set gracefully and falls back + to a default value when unknown. """ -__WorkspaceSymbolClientCapabilities_tagSupport_Type_1 = TypedDict('__WorkspaceSymbolClientCapabilities_tagSupport_Type_1', { - # The tags supported by the client. - 'valueSet': List['SymbolTag'], -}) +class ClientDiagnosticsTagOptions(TypedDict): + """ @since 3.18.0 """ + valueSet: List['DiagnosticTag'] + """ The tags supported by the client. """ -__WorkspaceSymbol_location_Type_1 = TypedDict('__WorkspaceSymbol_location_Type_1', { - 'uri': 'DocumentUri', -}) +class ClientSemanticTokensRequestFullDelta(TypedDict): + """ @since 3.18.0 """ + delta: NotRequired[bool] + """ The client will send the `textDocument/semanticTokens/full/delta` request if + the server provides a corresponding handler. """ -___InitializeParams_clientInfo_Type_1 = TypedDict('___InitializeParams_clientInfo_Type_1', { - # The name of the client as defined by the client. - 'name': str, - # The client's version as defined by the client. - 'version': NotRequired[str], -}) # AUTOGENERATED TYPES END @@ -6335,8 +6280,5 @@ def to_lsp(self) -> Position: 'session_name': str }) -CompletionItemDefaults = __CompletionList_itemDefaults_Type_1 -CompletionEditRange = __CompletionList_itemDefaults_editRange_Type_1 - # Temporary for backward compatibility with LSP packages. RangeLsp = Range diff --git a/plugin/core/signature_help.py b/plugin/core/signature_help.py index 84e0624ef..50eaf1a60 100644 --- a/plugin/core/signature_help.py +++ b/plugin/core/signature_help.py @@ -168,7 +168,8 @@ def _parameter_documentation(self, view: sublime.View, signature: SignatureInfor if not parameters: return None try: - parameter = parameters[signature.get("activeParameter", self._active_parameter_index)] + active_parameter = signature.get("activeParameter") + parameter = parameters[active_parameter or self._active_parameter_index] except IndexError: return None documentation = parameter.get("documentation") diff --git a/plugin/core/views.py b/plugin/core/views.py index b5374eeff..25798ce64 100644 --- a/plugin/core/views.py +++ b/plugin/core/views.py @@ -4,8 +4,8 @@ from .constants import SublimeKind from .css import css as lsp_css from .protocol import CodeAction -from .protocol import CodeActionKind from .protocol import CodeActionContext +from .protocol import CodeActionKind from .protocol import CodeActionParams from .protocol import CodeActionTriggerKind from .protocol import Color @@ -20,6 +20,7 @@ from .protocol import DidSaveTextDocumentParams from .protocol import DocumentColorParams from .protocol import DocumentUri +from .protocol import LanguageKind from .protocol import Location from .protocol import LocationLink from .protocol import MarkedString @@ -253,6 +254,7 @@ def entire_content_range(view: sublime.View) -> Range: def text_document_item(view: sublime.View, language_id: str) -> TextDocumentItem: + language_id = cast(LanguageKind, language_id) return { "uri": uri_from_view(view), "languageId": language_id,