# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. # ****** THIS IS A GENERATED FILE, DO NOT EDIT. ****** # Steps to generate: # 1. Checkout https://github.com/microsoft/lsprotocol # 2. Install nox: `python -m pip install nox` # 3. Run command: `python -m nox --session build_lsp` import enum import functools from typing import Any, Dict, List, Optional, Tuple, Union import attrs from . import validators __lsp_version__ = "3.17.0" @enum.unique class SemanticTokenTypes(str, enum.Enum): """A set of predefined token types. This set is not fixed an clients can specify additional token types via the corresponding client capabilities. @since 3.16.0""" # Since: 3.16.0 Namespace = "namespace" Type = "type" """Represents a generic type. Acts as a fallback for types which can't be mapped to a specific type like class or enum.""" Class = "class" Enum = "enum" Interface = "interface" Struct = "struct" TypeParameter = "typeParameter" Parameter = "parameter" Variable = "variable" Property = "property" EnumMember = "enumMember" Event = "event" Function = "function" Method = "method" Macro = "macro" Keyword = "keyword" Modifier = "modifier" Comment = "comment" String = "string" Number = "number" Regexp = "regexp" Operator = "operator" Decorator = "decorator" """@since 3.17.0""" # Since: 3.17.0 @enum.unique class SemanticTokenModifiers(str, enum.Enum): """A set of predefined token modifiers. This set is not fixed an clients can specify additional token types via the corresponding client capabilities. @since 3.16.0""" # Since: 3.16.0 Declaration = "declaration" Definition = "definition" Readonly = "readonly" Static = "static" Deprecated = "deprecated" Abstract = "abstract" Async = "async" Modification = "modification" Documentation = "documentation" DefaultLibrary = "defaultLibrary" @enum.unique class DocumentDiagnosticReportKind(str, enum.Enum): """The document diagnostic report kinds. @since 3.17.0""" # Since: 3.17.0 Full = "full" """A diagnostic report with a full set of problems.""" Unchanged = "unchanged" """A report indicating that the last returned report is still accurate.""" class ErrorCodes(int, enum.Enum): """Predefined error codes.""" ParseError = -32700 InvalidRequest = -32600 MethodNotFound = -32601 InvalidParams = -32602 InternalError = -32603 ServerNotInitialized = -32002 """Error code indicating that a server received a notification or request before the server has received the `initialize` request.""" UnknownErrorCode = -32001 class LSPErrorCodes(int, enum.Enum): RequestFailed = -32803 """A request failed but it was syntactically correct, e.g the method name was known and the parameters were valid. The error message should contain human readable information about why the request failed. @since 3.17.0""" # Since: 3.17.0 ServerCancelled = -32802 """The server cancelled the request. This error code should only be used for requests that explicitly support being server cancellable. @since 3.17.0""" # Since: 3.17.0 ContentModified = -32801 """The server detected that the content of a document got modified outside normal conditions. A server should NOT send this error code if it detects a content change in it unprocessed messages. The result even computed on an older state might still be useful for the client. If a client decides that a result is not of any use anymore the client should cancel the request.""" RequestCancelled = -32800 """The client has canceled a request and a server as detected the cancel.""" @enum.unique class FoldingRangeKind(str, enum.Enum): """A set of predefined range kinds.""" Comment = "comment" """Folding range for a comment""" Imports = "imports" """Folding range for an import or include""" Region = "region" """Folding range for a region (e.g. `#region`)""" @enum.unique class SymbolKind(int, enum.Enum): """A symbol kind.""" File = 1 Module = 2 Namespace = 3 Package = 4 Class = 5 Method = 6 Property = 7 Field = 8 Constructor = 9 Enum = 10 Interface = 11 Function = 12 Variable = 13 Constant = 14 String = 15 Number = 16 Boolean = 17 Array = 18 Object = 19 Key = 20 Null = 21 EnumMember = 22 Struct = 23 Event = 24 Operator = 25 TypeParameter = 26 @enum.unique class SymbolTag(int, enum.Enum): """Symbol tags are extra annotations that tweak the rendering of a symbol. @since 3.16""" # Since: 3.16 Deprecated = 1 """Render a symbol as obsolete, usually using a strike-out.""" @enum.unique class UniquenessLevel(str, enum.Enum): """Moniker uniqueness level to define scope of the moniker. @since 3.16.0""" # Since: 3.16.0 Document = "document" """The moniker is only unique inside a document""" Project = "project" """The moniker is unique inside a project for which a dump got created""" Group = "group" """The moniker is unique inside the group to which a project belongs""" Scheme = "scheme" """The moniker is unique inside the moniker scheme.""" Global = "global" """The moniker is globally unique""" @enum.unique class MonikerKind(str, enum.Enum): """The moniker kind. @since 3.16.0""" # Since: 3.16.0 Import = "import" """The moniker represent a symbol that is imported into a project""" Export = "export" """The moniker represents a symbol that is exported from a project""" Local = "local" """The moniker represents a symbol that is local to a project (e.g. a local variable of a function, a class not visible outside the project, ...)""" @enum.unique class InlayHintKind(int, enum.Enum): """Inlay hint kinds. @since 3.17.0""" # Since: 3.17.0 Type = 1 """An inlay hint that for a type annotation.""" Parameter = 2 """An inlay hint that is for a parameter.""" @enum.unique class MessageType(int, enum.Enum): """The message type""" Error = 1 """An error message.""" Warning = 2 """A warning message.""" Info = 3 """An information message.""" Log = 4 """A log message.""" Debug = 5 """A debug message. @since 3.18.0""" # Since: 3.18.0 @enum.unique class TextDocumentSyncKind(int, enum.Enum): """Defines how the host (editor) should sync document changes to the language server.""" None_ = 0 """Documents should not be synced at all.""" Full = 1 """Documents are synced by always sending the full content of the document.""" Incremental = 2 """Documents are synced by sending the full content on open. After that only incremental updates to the document are send.""" @enum.unique class TextDocumentSaveReason(int, enum.Enum): """Represents reasons why a text document is saved.""" Manual = 1 """Manually triggered, e.g. by the user pressing save, by starting debugging, or by an API call.""" AfterDelay = 2 """Automatic after a delay.""" FocusOut = 3 """When the editor lost focus.""" @enum.unique class CompletionItemKind(int, enum.Enum): """The kind of a completion entry.""" Text = 1 Method = 2 Function = 3 Constructor = 4 Field = 5 Variable = 6 Class = 7 Interface = 8 Module = 9 Property = 10 Unit = 11 Value = 12 Enum = 13 Keyword = 14 Snippet = 15 Color = 16 File = 17 Reference = 18 Folder = 19 EnumMember = 20 Constant = 21 Struct = 22 Event = 23 Operator = 24 TypeParameter = 25 @enum.unique class CompletionItemTag(int, enum.Enum): """Completion item tags are extra annotations that tweak the rendering of a completion item. @since 3.15.0""" # Since: 3.15.0 Deprecated = 1 """Render a completion as obsolete, usually using a strike-out.""" @enum.unique class InsertTextFormat(int, enum.Enum): """Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.""" PlainText = 1 """The primary text to be inserted is treated as a plain string.""" Snippet = 2 """The primary text to be inserted is treated as a snippet. 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. See also: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#snippet_syntax""" @enum.unique class InsertTextMode(int, enum.Enum): """How whitespace and indentation is handled during completion item insertion. @since 3.16.0""" # Since: 3.16.0 AsIs = 1 """The insertion or replace strings is taken as it is. If the value is multi line the lines below the cursor will be inserted using the indentation defined in the string value. The client will not apply any kind of adjustments to the string.""" AdjustIndentation = 2 """The editor adjusts leading whitespace of new lines so that they match the indentation up to the cursor of the line for which the item is accepted. Consider a line like this: <2tabs><3tabs>foo. Accepting a multi line completion item is indented using 2 tabs and all following lines inserted will be indented using 2 tabs as well.""" @enum.unique class DocumentHighlightKind(int, enum.Enum): """A document highlight kind.""" Text = 1 """A textual occurrence.""" Read = 2 """Read-access of a symbol, like reading a variable.""" Write = 3 """Write-access of a symbol, like writing to a variable.""" @enum.unique class CodeActionKind(str, enum.Enum): """A set of predefined code action kinds""" Empty = "" """Empty kind.""" QuickFix = "quickfix" """Base kind for quickfix actions: 'quickfix'""" Refactor = "refactor" """Base kind for refactoring actions: 'refactor'""" RefactorExtract = "refactor.extract" """Base kind for refactoring extraction actions: 'refactor.extract' Example extract actions: - Extract method - Extract function - Extract variable - Extract interface from class - ...""" RefactorInline = "refactor.inline" """Base kind for refactoring inline actions: 'refactor.inline' Example inline actions: - Inline function - Inline variable - Inline constant - ...""" RefactorRewrite = "refactor.rewrite" """Base kind for refactoring rewrite actions: 'refactor.rewrite' Example rewrite actions: - Convert JavaScript function to class - Add or remove parameter - Encapsulate field - Make method static - Move method to base class - ...""" Source = "source" """Base kind for source actions: `source` Source code actions apply to the entire file.""" SourceOrganizeImports = "source.organizeImports" """Base kind for an organize imports source action: `source.organizeImports`""" SourceFixAll = "source.fixAll" """Base kind for auto-fix source actions: `source.fixAll`. Fix all actions automatically fix errors that have a clear fix that do not require user input. They should not suppress errors or perform unsafe fixes such as generating new types or classes. @since 3.15.0""" # Since: 3.15.0 @enum.unique class TraceValues(str, enum.Enum): Off = "off" """Turn tracing off.""" Messages = "messages" """Trace messages only.""" Verbose = "verbose" """Verbose message tracing.""" @enum.unique class MarkupKind(str, enum.Enum): """Describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`. Please note that `MarkupKinds` must not start with a `$`. This kinds are reserved for internal usage.""" PlainText = "plaintext" """Plain text is supported as a content format""" Markdown = "markdown" """Markdown is supported as a content format""" @enum.unique class InlineCompletionTriggerKind(int, enum.Enum): """Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed Invoked = 0 """Completion was triggered explicitly by a user gesture.""" Automatic = 1 """Completion was triggered automatically while editing.""" @enum.unique class PositionEncodingKind(str, enum.Enum): """A set of predefined position encoding kinds. @since 3.17.0""" # Since: 3.17.0 Utf8 = "utf-8" """Character offsets count UTF-8 code units (e.g. bytes).""" Utf16 = "utf-16" """Character offsets count UTF-16 code units. This is the default and must always be supported by servers""" Utf32 = "utf-32" """Character offsets count UTF-32 code units. Implementation note: these are the same as Unicode codepoints, so this `PositionEncodingKind` may also be used for an encoding-agnostic representation of character offsets.""" @enum.unique class FileChangeType(int, enum.Enum): """The file event type""" Created = 1 """The file got created.""" Changed = 2 """The file got changed.""" Deleted = 3 """The file got deleted.""" @enum.unique class WatchKind(int, enum.Enum): Create = 1 """Interested in create events.""" Change = 2 """Interested in change events""" Delete = 4 """Interested in delete events""" @enum.unique class DiagnosticSeverity(int, enum.Enum): """The diagnostic's severity.""" Error = 1 """Reports an error.""" Warning = 2 """Reports a warning.""" Information = 3 """Reports an information.""" Hint = 4 """Reports a hint.""" @enum.unique class DiagnosticTag(int, enum.Enum): """The diagnostic tags. @since 3.15.0""" # Since: 3.15.0 Unnecessary = 1 """Unused or unnecessary code. Clients are allowed to render diagnostics with this tag faded out instead of having an error squiggle.""" Deprecated = 2 """Deprecated or obsolete code. Clients are allowed to rendered diagnostics with this tag strike through.""" @enum.unique class CompletionTriggerKind(int, enum.Enum): """How a completion was triggered""" Invoked = 1 """Completion was triggered by typing an identifier (24x7 code complete), manual invocation (e.g Ctrl+Space) or via API.""" TriggerCharacter = 2 """Completion was triggered by a trigger character specified by the `triggerCharacters` properties of the `CompletionRegistrationOptions`.""" TriggerForIncompleteCompletions = 3 """Completion was re-triggered as current completion list is incomplete""" @enum.unique class SignatureHelpTriggerKind(int, enum.Enum): """How a signature help was triggered. @since 3.15.0""" # Since: 3.15.0 Invoked = 1 """Signature help was invoked manually by the user or by a command.""" TriggerCharacter = 2 """Signature help was triggered by a trigger character.""" ContentChange = 3 """Signature help was triggered by the cursor moving or by the document content changing.""" @enum.unique class CodeActionTriggerKind(int, enum.Enum): """The reason why code actions were requested. @since 3.17.0""" # Since: 3.17.0 Invoked = 1 """Code actions were explicitly requested by the user or by an extension.""" Automatic = 2 """Code actions were requested automatically. This typically happens when current selection in a file changes, but can also be triggered when file content changes.""" @enum.unique class FileOperationPatternKind(str, enum.Enum): """A pattern kind describing if a glob pattern matches a file a folder or both. @since 3.16.0""" # Since: 3.16.0 File = "file" """The pattern matches a file only.""" Folder = "folder" """The pattern matches a folder only.""" @enum.unique class NotebookCellKind(int, enum.Enum): """A notebook cell kind. @since 3.17.0""" # Since: 3.17.0 Markup = 1 """A markup-cell is formatted source that is used for display.""" Code = 2 """A code-cell is source code.""" @enum.unique class ResourceOperationKind(str, enum.Enum): Create = "create" """Supports creating new files and folders.""" Rename = "rename" """Supports renaming existing files and folders.""" Delete = "delete" """Supports deleting existing files and folders.""" @enum.unique class FailureHandlingKind(str, enum.Enum): Abort = "abort" """Applying the workspace change is simply aborted if one of the changes provided fails. All operations executed before the failing operation stay executed.""" Transactional = "transactional" """All operations are executed transactional. That means they either all succeed or no changes at all are applied to the workspace.""" TextOnlyTransactional = "textOnlyTransactional" """If the workspace edit contains only textual file changes they are executed transactional. If resource changes (create, rename or delete file) are part of the change the failure handling strategy is abort.""" Undo = "undo" """The client tries to undo the operations already executed. But there is no guarantee that this is succeeding.""" @enum.unique class PrepareSupportDefaultBehavior(int, enum.Enum): Identifier = 1 """The client's default behavior is to select the identifier according the to language's syntax rule.""" @enum.unique class TokenFormat(str, enum.Enum): Relative = "relative" class LSPObject: """LSP object definition. @since 3.17.0""" # Since: 3.17.0 pass Definition = Union["Location", List["Location"]] """The definition of a symbol represented as one or many {@link Location locations}. For most programming languages there is only one location at which a symbol is defined. Servers should prefer returning `DefinitionLink` over `Definition` if supported by the client.""" DefinitionLink = Union["LocationLink", "LocationLink"] """Information about where a symbol is defined. Provides additional metadata over normal {@link Location location} definitions, including the range of the defining symbol""" LSPArray = List["LSPAny"] """LSP arrays. @since 3.17.0""" # Since: 3.17.0 LSPAny = Union[Any, None] """The LSP any type. Please note that strictly speaking a property with the value `undefined` can't be converted into JSON preserving the property name. However for convenience it is allowed and assumed that all these properties are optional as well. @since 3.17.0""" # Since: 3.17.0 Declaration = Union["Location", List["Location"]] """The declaration of a symbol representation as one or many {@link Location locations}.""" DeclarationLink = Union["LocationLink", "LocationLink"] """Information about where a symbol is declared. Provides additional metadata over normal {@link Location location} declarations, including the range of the declaring symbol. Servers should prefer returning `DeclarationLink` over `Declaration` if supported by the client.""" InlineValue = Union[ "InlineValueText", "InlineValueVariableLookup", "InlineValueEvaluatableExpression" ] """Inline value information can be provided by different means: - directly as a text value (class InlineValueText). - as a name to use for a variable lookup (class InlineValueVariableLookup) - as an evaluatable expression (class InlineValueEvaluatableExpression) The InlineValue types combines all inline value types into one type. @since 3.17.0""" # Since: 3.17.0 DocumentDiagnosticReport = Union[ "RelatedFullDocumentDiagnosticReport", "RelatedUnchangedDocumentDiagnosticReport" ] """The result of a document diagnostic pull request. A report can either be a full report containing all diagnostics for the requested document or an unchanged report indicating that nothing has changed in terms of diagnostics in comparison to the last pull request. @since 3.17.0""" # Since: 3.17.0 @attrs.define class PrepareRenameResult_Type1: range: "Range" = attrs.field() placeholder: str = attrs.field(validator=attrs.validators.instance_of(str)) @attrs.define class PrepareRenameResult_Type2: default_behavior: bool = attrs.field(validator=attrs.validators.instance_of(bool)) PrepareRenameResult = Union[ "Range", "PrepareRenameResult_Type1", "PrepareRenameResult_Type2" ] DocumentSelector = List["DocumentFilter"] """A document selector is the combination of one or many document filters. @sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**/tsconfig.json' }]`; The use of a string as a document filter is deprecated @since 3.16.0.""" # Since: 3.16.0. ProgressToken = Union[int, str] ChangeAnnotationIdentifier = str """An identifier to refer to a change annotation stored with a workspace edit.""" WorkspaceDocumentDiagnosticReport = Union[ "WorkspaceFullDocumentDiagnosticReport", "WorkspaceUnchangedDocumentDiagnosticReport", ] """A workspace diagnostic document report. @since 3.17.0""" # Since: 3.17.0 @attrs.define class TextDocumentContentChangeEvent_Type1: range: "Range" = attrs.field() """The range of the document that changed.""" text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The new text for the provided range.""" range_length: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """The optional length of the range that got replaced. @deprecated use range instead.""" @attrs.define class TextDocumentContentChangeEvent_Type2: text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The new text of the whole document.""" TextDocumentContentChangeEvent = Union[ "TextDocumentContentChangeEvent_Type1", "TextDocumentContentChangeEvent_Type2" ] """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.""" @attrs.define class MarkedString_Type1: language: str = attrs.field(validator=attrs.validators.instance_of(str)) value: str = attrs.field(validator=attrs.validators.instance_of(str)) MarkedString = Union[str, "MarkedString_Type1"] """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 issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting The pair of a language and a value is an equivalent to markdown: ```${language} ${value} ``` Note that markdown strings will be sanitized - that means html will be escaped. @deprecated use MarkupContent instead.""" DocumentFilter = Union["TextDocumentFilter", "NotebookCellTextDocumentFilter"] """A document filter describes a top level text document or a notebook cell document. @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.""" # Since: 3.17.0 - proposed support for NotebookCellTextDocumentFilter. GlobPattern = Union["Pattern", "RelativePattern"] """The glob pattern. Either a string pattern or a relative pattern. @since 3.17.0""" # Since: 3.17.0 @attrs.define class TextDocumentFilter_Type1: language: str = attrs.field(validator=attrs.validators.instance_of(str)) """A language id, like `typescript`.""" scheme: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.""" pattern: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.""" @attrs.define class TextDocumentFilter_Type2: scheme: str = attrs.field(validator=attrs.validators.instance_of(str)) """A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.""" language: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A language id, like `typescript`.""" pattern: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.""" @attrs.define class TextDocumentFilter_Type3: pattern: str = attrs.field(validator=attrs.validators.instance_of(str)) """A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.""" language: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A language id, like `typescript`.""" scheme: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.""" TextDocumentFilter = Union[ "TextDocumentFilter_Type1", "TextDocumentFilter_Type2", "TextDocumentFilter_Type3" ] """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}. 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`) @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }` @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }` @since 3.17.0""" # Since: 3.17.0 @attrs.define class NotebookDocumentFilter_Type1: notebook_type: str = attrs.field(validator=attrs.validators.instance_of(str)) """The type of the enclosing notebook.""" scheme: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.""" pattern: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A glob pattern.""" @attrs.define class NotebookDocumentFilter_Type2: scheme: str = attrs.field(validator=attrs.validators.instance_of(str)) """A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.""" notebook_type: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The type of the enclosing notebook.""" pattern: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A glob pattern.""" @attrs.define class NotebookDocumentFilter_Type3: pattern: str = attrs.field(validator=attrs.validators.instance_of(str)) """A glob pattern.""" notebook_type: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The type of the enclosing notebook.""" scheme: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.""" NotebookDocumentFilter = Union[ "NotebookDocumentFilter_Type1", "NotebookDocumentFilter_Type2", "NotebookDocumentFilter_Type3", ] """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) @since 3.17.0""" # Since: 3.17.0 Pattern = str """The glob pattern to watch relative to the base path. 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 conditions (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`) @since 3.17.0""" # Since: 3.17.0 @attrs.define class TextDocumentPositionParams: """A parameter literal used in requests to pass a text document and a position inside that document.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" @attrs.define class WorkDoneProgressParams: work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class PartialResultParams: partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class ImplementationParams: text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class Location: """Represents a location inside a resource, such as a line inside a text file.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) range: "Range" = attrs.field() def __eq__(self, o: object) -> bool: if not isinstance(o, Location): return NotImplemented return (self.uri == o.uri) and (self.range == o.range) def __repr__(self) -> str: return f"{self.uri}:{self.range!r}" @attrs.define class TextDocumentRegistrationOptions: """General text document registration options.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" @attrs.define class WorkDoneProgressOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class ImplementationOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class StaticRegistrationOptions: """Static registration options to be returned in the initialize request.""" id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class ImplementationRegistrationOptions: document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class TypeDefinitionParams: text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class TypeDefinitionOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class TypeDefinitionRegistrationOptions: document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class WorkspaceFolder: """A workspace folder inside a client.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The associated URI for this workspace folder.""" name: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of the workspace folder. Used to refer to this workspace folder in the user interface.""" @attrs.define class DidChangeWorkspaceFoldersParams: """The parameters of a `workspace/didChangeWorkspaceFolders` notification.""" event: "WorkspaceFoldersChangeEvent" = attrs.field() """The actual workspace folder change event.""" @attrs.define class ConfigurationParams: """The parameters of a configuration request.""" items: List["ConfigurationItem"] = attrs.field() @attrs.define class DocumentColorParams: """Parameters for a {@link DocumentColorRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class ColorInformation: """Represents a color range from a document.""" range: "Range" = attrs.field() """The range in the document where this color appears.""" color: "Color" = attrs.field() """The actual color value for this color range.""" @attrs.define class DocumentColorOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentColorRegistrationOptions: document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class ColorPresentationParams: """Parameters for a {@link ColorPresentationRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" color: "Color" = attrs.field() """The color to request presentations for.""" range: "Range" = attrs.field() """The range where the color would be inserted. Serves as a context.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class ColorPresentation: label: str = attrs.field(validator=attrs.validators.instance_of(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.""" text_edit: Optional["TextEdit"] = attrs.field(default=None) """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.""" additional_text_edits: Optional[List["TextEdit"]] = attrs.field(default=None) """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.""" @attrs.define class FoldingRangeParams: """Parameters for a {@link FoldingRangeRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class FoldingRange: """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. """ start_line: int = attrs.field(validator=validators.uinteger_validator) """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.""" end_line: int = attrs.field(validator=validators.uinteger_validator) """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.""" start_character: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.""" end_character: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.""" kind: Optional[Union[FoldingRangeKind, str]] = attrs.field(default=None) """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.""" collapsed_text: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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""" # Since: 3.17.0 @attrs.define class FoldingRangeOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class FoldingRangeRegistrationOptions: document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class DeclarationParams: text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class DeclarationOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DeclarationRegistrationOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class SelectionRangeParams: """A parameter literal used in selection range requests.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" positions: List["Position"] = attrs.field() """The positions inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class SelectionRange: """A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.""" range: "Range" = attrs.field() """The {@link Range range} of this selection range.""" parent: Optional["SelectionRange"] = attrs.field(default=None) """The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.""" @attrs.define class SelectionRangeOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class SelectionRangeRegistrationOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class WorkDoneProgressCreateParams: token: ProgressToken = attrs.field() """The token to be used to report progress.""" @attrs.define class WorkDoneProgressCancelParams: token: ProgressToken = attrs.field() """The token to be used to report progress.""" @attrs.define class CallHierarchyPrepareParams: """The parameter of a `textDocument/prepareCallHierarchy` request. @since 3.16.0""" # Since: 3.16.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class CallHierarchyItem: """Represents programming constructs like functions or constructors in the context of call hierarchy. @since 3.16.0""" # Since: 3.16.0 name: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of this item.""" kind: SymbolKind = attrs.field() """The kind of this item.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The resource identifier of this item.""" range: "Range" = attrs.field() """The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.""" selection_range: "Range" = attrs.field() """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`}.""" tags: Optional[List[SymbolTag]] = attrs.field(default=None) """Tags for this item.""" detail: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """More detail for this item, e.g. the signature of a function.""" data: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved between a call hierarchy prepare and incoming calls or outgoing calls requests.""" @attrs.define class CallHierarchyOptions: """Call hierarchy options used during static registration. @since 3.16.0""" # Since: 3.16.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class CallHierarchyRegistrationOptions: """Call hierarchy options used during static or dynamic registration. @since 3.16.0""" # Since: 3.16.0 document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class CallHierarchyIncomingCallsParams: """The parameter of a `callHierarchy/incomingCalls` request. @since 3.16.0""" # Since: 3.16.0 item: CallHierarchyItem = attrs.field() work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class CallHierarchyIncomingCall: """Represents an incoming call, e.g. a caller of a method or constructor. @since 3.16.0""" # Since: 3.16.0 from_: CallHierarchyItem = attrs.field() """The item that makes the call.""" from_ranges: List["Range"] = attrs.field() """The ranges at which the calls appear. This is relative to the caller denoted by {@link CallHierarchyIncomingCall.from `this.from`}.""" @attrs.define class CallHierarchyOutgoingCallsParams: """The parameter of a `callHierarchy/outgoingCalls` request. @since 3.16.0""" # Since: 3.16.0 item: CallHierarchyItem = attrs.field() work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class CallHierarchyOutgoingCall: """Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc. @since 3.16.0""" # Since: 3.16.0 to: CallHierarchyItem = attrs.field() """The item that is called.""" from_ranges: List["Range"] = attrs.field() """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`}.""" @attrs.define class SemanticTokensParams: """@since 3.16.0""" # Since: 3.16.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class SemanticTokens: """@since 3.16.0""" # Since: 3.16.0 data: List[int] = attrs.field() """The actual tokens.""" result_id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" @attrs.define class SemanticTokensPartialResult: """@since 3.16.0""" # Since: 3.16.0 data: List[int] = attrs.field() @attrs.define class SemanticTokensOptionsFullType1: delta: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server supports deltas for full documents.""" @attrs.define class SemanticTokensOptions: """@since 3.16.0""" # Since: 3.16.0 legend: "SemanticTokensLegend" = attrs.field() """The legend used by the server""" range: Optional[Union[bool, Any]] = attrs.field(default=None) """Server supports providing semantic tokens for a specific range of a document.""" full: Optional[Union[bool, "SemanticTokensOptionsFullType1"]] = attrs.field( default=None ) """Server supports providing semantic tokens for a full document.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class SemanticTokensRegistrationOptionsFullType1: delta: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server supports deltas for full documents.""" @attrs.define class SemanticTokensRegistrationOptions: """@since 3.16.0""" # Since: 3.16.0 legend: "SemanticTokensLegend" = attrs.field() """The legend used by the server""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" range: Optional[Union[bool, Any]] = attrs.field(default=None) """Server supports providing semantic tokens for a specific range of a document.""" full: Optional[ Union[bool, "SemanticTokensRegistrationOptionsFullType1"] ] = attrs.field(default=None) """Server supports providing semantic tokens for a full document.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class SemanticTokensDeltaParams: """@since 3.16.0""" # Since: 3.16.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" previous_result_id: str = attrs.field(validator=attrs.validators.instance_of(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.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class SemanticTokensDelta: """@since 3.16.0""" # Since: 3.16.0 edits: List["SemanticTokensEdit"] = attrs.field() """The semantic token edits to transform a previous result into a new result.""" result_id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) @attrs.define class SemanticTokensDeltaPartialResult: """@since 3.16.0""" # Since: 3.16.0 edits: List["SemanticTokensEdit"] = attrs.field() @attrs.define class SemanticTokensRangeParams: """@since 3.16.0""" # Since: 3.16.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" range: "Range" = attrs.field() """The range the semantic tokens are requested for.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class ShowDocumentParams: """Params to show a resource in the UI. @since 3.16.0""" # Since: 3.16.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The uri to show.""" external: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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`.""" take_focus: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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: Optional["Range"] = attrs.field(default=None) """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.""" @attrs.define class ShowDocumentResult: """The result of a showDocument request. @since 3.16.0""" # Since: 3.16.0 success: bool = attrs.field(validator=attrs.validators.instance_of(bool)) """A boolean indicating if the show was successful.""" @attrs.define class LinkedEditingRangeParams: text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class LinkedEditingRanges: """The result of a linked editing range request. @since 3.16.0""" # Since: 3.16.0 ranges: List["Range"] = attrs.field() """A list of ranges that can be edited together. The ranges must have identical length and contain identical text content. The ranges cannot overlap.""" word_pattern: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" @attrs.define class LinkedEditingRangeOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class LinkedEditingRangeRegistrationOptions: document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class CreateFilesParams: """The parameters sent in notifications/requests for user-initiated creation of files. @since 3.16.0""" # Since: 3.16.0 files: List["FileCreate"] = attrs.field() """An array of all files/folders created in this operation.""" @attrs.define class WorkspaceEdit: """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: Optional[Dict[str, List["TextEdit"]]] = attrs.field(default=None) """Holds changes to existing resources.""" document_changes: Optional[ List[Union["TextDocumentEdit", "CreateFile", "RenameFile", "DeleteFile"]] ] = attrs.field(default=None) """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.""" change_annotations: Optional[ Dict[ChangeAnnotationIdentifier, "ChangeAnnotation"] ] = attrs.field(default=None) """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 @attrs.define class FileOperationRegistrationOptions: """The options to register for file operations. @since 3.16.0""" # Since: 3.16.0 filters: List["FileOperationFilter"] = attrs.field() """The actual filters.""" @attrs.define class RenameFilesParams: """The parameters sent in notifications/requests for user-initiated renames of files. @since 3.16.0""" # Since: 3.16.0 files: List["FileRename"] = attrs.field() """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.""" @attrs.define class DeleteFilesParams: """The parameters sent in notifications/requests for user-initiated deletes of files. @since 3.16.0""" # Since: 3.16.0 files: List["FileDelete"] = attrs.field() """An array of all files/folders deleted in this operation.""" @attrs.define class MonikerParams: text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class Moniker: """Moniker definition to match LSIF 0.5 moniker definition. @since 3.16.0""" # Since: 3.16.0 scheme: str = attrs.field(validator=attrs.validators.instance_of(str)) """The scheme of the moniker. For example tsc or .Net""" identifier: str = attrs.field(validator=attrs.validators.instance_of(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 = attrs.field() """The scope in which the moniker is unique""" kind: Optional[MonikerKind] = attrs.field(default=None) """The moniker kind if known.""" @attrs.define class MonikerOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class MonikerRegistrationOptions: document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class TypeHierarchyPrepareParams: """The parameter of a `textDocument/prepareTypeHierarchy` request. @since 3.17.0""" # Since: 3.17.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class TypeHierarchyItem: """@since 3.17.0""" # Since: 3.17.0 name: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of this item.""" kind: SymbolKind = attrs.field() """The kind of this item.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The resource identifier of this item.""" range: "Range" = attrs.field() """The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.""" selection_range: "Range" = attrs.field() """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`}.""" tags: Optional[List[SymbolTag]] = attrs.field(default=None) """Tags for this item.""" detail: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """More detail for this item, e.g. the signature of a function.""" data: Optional[LSPAny] = attrs.field(default=None) """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.""" @attrs.define class TypeHierarchyOptions: """Type hierarchy options used during static registration. @since 3.17.0""" # Since: 3.17.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class TypeHierarchyRegistrationOptions: """Type hierarchy options used during static or dynamic registration. @since 3.17.0""" # Since: 3.17.0 document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class TypeHierarchySupertypesParams: """The parameter of a `typeHierarchy/supertypes` request. @since 3.17.0""" # Since: 3.17.0 item: TypeHierarchyItem = attrs.field() work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class TypeHierarchySubtypesParams: """The parameter of a `typeHierarchy/subtypes` request. @since 3.17.0""" # Since: 3.17.0 item: TypeHierarchyItem = attrs.field() work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class InlineValueParams: """A parameter literal used in inline value requests. @since 3.17.0""" # Since: 3.17.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" range: "Range" = attrs.field() """The document range for which inline values should be computed.""" context: "InlineValueContext" = attrs.field() """Additional information about the context in which inline values were requested.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class InlineValueOptions: """Inline value options used during static registration. @since 3.17.0""" # Since: 3.17.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class InlineValueRegistrationOptions: """Inline value options used during static or dynamic registration. @since 3.17.0""" # Since: 3.17.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class InlayHintParams: """A parameter literal used in inlay hint requests. @since 3.17.0""" # Since: 3.17.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" range: "Range" = attrs.field() """The document range for which inlay hints should be computed.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class InlayHint: """Inlay hint information. @since 3.17.0""" # Since: 3.17.0 position: "Position" = attrs.field() """The position of this hint.""" label: Union[str, List["InlayHintLabelPart"]] = attrs.field() """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: Optional[InlayHintKind] = attrs.field(default=None) """The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.""" text_edits: Optional[List["TextEdit"]] = attrs.field(default=None) """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: Optional[Union[str, "MarkupContent"]] = attrs.field(default=None) """The tooltip text when you hover over this item.""" padding_left: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" padding_right: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved on an inlay hint between a `textDocument/inlayHint` and a `inlayHint/resolve` request.""" @attrs.define class InlayHintOptions: """Inlay hint options used during static registration. @since 3.17.0""" # Since: 3.17.0 resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for an inlay hint item.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class InlayHintRegistrationOptions: """Inlay hint options used during static or dynamic registration. @since 3.17.0""" # Since: 3.17.0 resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for an inlay hint item.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class DocumentDiagnosticParams: """Parameters of the document diagnostic request. @since 3.17.0""" # Since: 3.17.0 text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" identifier: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The additional identifier provided during registration.""" previous_result_id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The result id of a previous response if provided.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class DocumentDiagnosticReportPartialResult: """A partial result for a document diagnostic report. @since 3.17.0""" # Since: 3.17.0 related_documents: Dict[ str, Union["FullDocumentDiagnosticReport", "UnchangedDocumentDiagnosticReport"] ] = attrs.field() @attrs.define class DiagnosticServerCancellationData: """Cancellation data returned from a diagnostic request. @since 3.17.0""" # Since: 3.17.0 retrigger_request: bool = attrs.field(validator=attrs.validators.instance_of(bool)) @attrs.define class DiagnosticOptions: """Diagnostic options. @since 3.17.0""" # Since: 3.17.0 inter_file_dependencies: bool = attrs.field( validator=attrs.validators.instance_of(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.""" workspace_diagnostics: bool = attrs.field( validator=attrs.validators.instance_of(bool) ) """The server provides support for workspace diagnostics as well.""" identifier: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """An optional identifier under which the diagnostics are managed by the client.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DiagnosticRegistrationOptions: """Diagnostic registration options. @since 3.17.0""" # Since: 3.17.0 inter_file_dependencies: bool = attrs.field( validator=attrs.validators.instance_of(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.""" workspace_diagnostics: bool = attrs.field( validator=attrs.validators.instance_of(bool) ) """The server provides support for workspace diagnostics as well.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """An optional identifier under which the diagnostics are managed by the client.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class WorkspaceDiagnosticParams: """Parameters of the workspace diagnostic request. @since 3.17.0""" # Since: 3.17.0 previous_result_ids: List["PreviousResultId"] = attrs.field() """The currently known diagnostic reports with their previous result ids.""" identifier: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The additional identifier provided during registration.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class WorkspaceDiagnosticReport: """A workspace diagnostic report. @since 3.17.0""" # Since: 3.17.0 items: List[WorkspaceDocumentDiagnosticReport] = attrs.field() @attrs.define class WorkspaceDiagnosticReportPartialResult: """A partial result for a workspace diagnostic report. @since 3.17.0""" # Since: 3.17.0 items: List[WorkspaceDocumentDiagnosticReport] = attrs.field() @attrs.define class DidOpenNotebookDocumentParams: """The params sent in an open notebook document notification. @since 3.17.0""" # Since: 3.17.0 notebook_document: "NotebookDocument" = attrs.field() """The notebook document that got opened.""" cell_text_documents: List["TextDocumentItem"] = attrs.field() """The text documents that represent the content of a notebook cell.""" @attrs.define class DidChangeNotebookDocumentParams: """The params sent in a change notebook document notification. @since 3.17.0""" # Since: 3.17.0 notebook_document: "VersionedNotebookDocumentIdentifier" = attrs.field() """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" = attrs.field() """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.""" @attrs.define class DidSaveNotebookDocumentParams: """The params sent in a save notebook document notification. @since 3.17.0""" # Since: 3.17.0 notebook_document: "NotebookDocumentIdentifier" = attrs.field() """The notebook document that got saved.""" @attrs.define class DidCloseNotebookDocumentParams: """The params sent in a close notebook document notification. @since 3.17.0""" # Since: 3.17.0 notebook_document: "NotebookDocumentIdentifier" = attrs.field() """The notebook document that got closed.""" cell_text_documents: List["TextDocumentIdentifier"] = attrs.field() """The text documents that represent the content of a notebook cell that got closed.""" @attrs.define class InlineCompletionParams: """A parameter literal used in inline completion requests. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed context: "InlineCompletionContext" = attrs.field() """Additional information about the context in which inline completions were requested.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class InlineCompletionList: """Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed items: List["InlineCompletionItem"] = attrs.field() """The inline completion items""" @attrs.define class InlineCompletionItem: """An inline completion item represents a text snippet that is proposed inline to complete text that is being typed. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed insert_text: Union[str, "StringValue"] = attrs.field() """The text to replace the range with. Must be set.""" filter_text: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.""" range: Optional["Range"] = attrs.field(default=None) """The range to replace. Must begin and end on the same line.""" command: Optional["Command"] = attrs.field(default=None) """An optional {@link Command} that is executed *after* inserting this completion.""" @attrs.define class InlineCompletionOptions: """Inline completion options used during static registration. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class InlineCompletionRegistrationOptions: """Inline completion options used during static or dynamic registration. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class RegistrationParams: registrations: List["Registration"] = attrs.field() @attrs.define class UnregistrationParams: unregisterations: List["Unregistration"] = attrs.field() @attrs.define class InitializeParamsClientInfoType: name: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of the client as defined by the client.""" version: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The client's version as defined by the client.""" @attrs.define class _InitializeParams: """The initialize parameters""" capabilities: "ClientCapabilities" = attrs.field() """The capabilities provided by the client (editor or tool)""" process_id: Optional[Union[int, None]] = attrs.field(default=None) """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.""" client_info: Optional["InitializeParamsClientInfoType"] = attrs.field(default=None) """Information about the client @since 3.15.0""" # Since: 3.15.0 locale: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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""" # Since: 3.16.0 root_path: Optional[Union[str, None]] = attrs.field(default=None) """The rootPath of the workspace. Is null if no folder is open. @deprecated in favour of rootUri.""" root_uri: Optional[Union[str, None]] = attrs.field(default=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.""" initialization_options: Optional[LSPAny] = attrs.field(default=None) """User provided initialization options.""" trace: Optional[TraceValues] = attrs.field(default=None) """The initial trace setting. If omitted trace is disabled ('off').""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class WorkspaceFoldersInitializeParams: workspace_folders: Optional[Union[List[WorkspaceFolder], None]] = attrs.field( default=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""" # Since: 3.6.0 @attrs.define class InitializeParams: capabilities: "ClientCapabilities" = attrs.field() """The capabilities provided by the client (editor or tool)""" process_id: Optional[Union[int, None]] = attrs.field(default=None) """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.""" client_info: Optional["InitializeParamsClientInfoType"] = attrs.field(default=None) """Information about the client @since 3.15.0""" # Since: 3.15.0 locale: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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""" # Since: 3.16.0 root_path: Optional[Union[str, None]] = attrs.field(default=None) """The rootPath of the workspace. Is null if no folder is open. @deprecated in favour of rootUri.""" root_uri: Optional[Union[str, None]] = attrs.field(default=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.""" initialization_options: Optional[LSPAny] = attrs.field(default=None) """User provided initialization options.""" trace: Optional[TraceValues] = attrs.field(default=None) """The initial trace setting. If omitted trace is disabled ('off').""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" workspace_folders: Optional[Union[List[WorkspaceFolder], None]] = attrs.field( default=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""" # Since: 3.6.0 @attrs.define class InitializeResultServerInfoType: name: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of the server as defined by the server.""" version: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The server's version as defined by the server.""" @attrs.define class InitializeResult: """The result returned from an initialize request.""" capabilities: "ServerCapabilities" = attrs.field() """The capabilities the language server provides.""" server_info: Optional["InitializeResultServerInfoType"] = attrs.field(default=None) """Information about the server. @since 3.15.0""" # Since: 3.15.0 @attrs.define class InitializeError: """The data type of the ResponseError if the initialize request fails.""" retry: bool = attrs.field(validator=attrs.validators.instance_of(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.""" @attrs.define class InitializedParams: pass @attrs.define class DidChangeConfigurationParams: """The parameters of a change configuration notification.""" settings: LSPAny = attrs.field() """The actual changed settings""" @attrs.define class DidChangeConfigurationRegistrationOptions: section: Optional[Union[str, List[str]]] = attrs.field(default=None) @attrs.define class ShowMessageParams: """The parameters of a notification message.""" type: MessageType = attrs.field() """The message type. See {@link MessageType}""" message: str = attrs.field(validator=attrs.validators.instance_of(str)) """The actual message.""" @attrs.define class ShowMessageRequestParams: type: MessageType = attrs.field() """The message type. See {@link MessageType}""" message: str = attrs.field(validator=attrs.validators.instance_of(str)) """The actual message.""" actions: Optional[List["MessageActionItem"]] = attrs.field(default=None) """The message action items to present.""" @attrs.define class MessageActionItem: title: str = attrs.field(validator=attrs.validators.instance_of(str)) """A short title like 'Retry', 'Open Log' etc.""" @attrs.define class LogMessageParams: """The log message parameters.""" type: MessageType = attrs.field() """The message type. See {@link MessageType}""" message: str = attrs.field(validator=attrs.validators.instance_of(str)) """The actual message.""" @attrs.define class DidOpenTextDocumentParams: """The parameters sent in an open text document notification""" text_document: "TextDocumentItem" = attrs.field() """The document that was opened.""" @attrs.define class DidChangeTextDocumentParams: """The change text document notification's parameters.""" text_document: "VersionedTextDocumentIdentifier" = attrs.field() """The document that did change. The version number points to the version after all provided content changes have been applied.""" content_changes: List[TextDocumentContentChangeEvent] = attrs.field() """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.""" @attrs.define class TextDocumentChangeRegistrationOptions: """Describe options to be used when registered for text document change events.""" sync_kind: TextDocumentSyncKind = attrs.field() """How documents are synced to the server.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" @attrs.define class DidCloseTextDocumentParams: """The parameters sent in a close text document notification""" text_document: "TextDocumentIdentifier" = attrs.field() """The document that was closed.""" @attrs.define class DidSaveTextDocumentParams: """The parameters sent in a save text document notification""" text_document: "TextDocumentIdentifier" = attrs.field() """The document that was saved.""" text: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """Optional the content when saved. Depends on the includeText value when the save notification was requested.""" @attrs.define class SaveOptions: """Save options.""" include_text: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client is supposed to include the content on save.""" @attrs.define class TextDocumentSaveRegistrationOptions: """Save registration options.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" include_text: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client is supposed to include the content on save.""" @attrs.define class WillSaveTextDocumentParams: """The parameters sent in a will save text document notification.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document that will be saved.""" reason: TextDocumentSaveReason = attrs.field() """The 'TextDocumentSaveReason'.""" @attrs.define class TextEdit: """A text edit applicable to a text document.""" range: "Range" = attrs.field() """The range of the text document to be manipulated. To insert text into a document create a range where start === end.""" new_text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The string to be inserted. For delete operations use an empty string.""" @attrs.define class DidChangeWatchedFilesParams: """The watched files change notification's parameters.""" changes: List["FileEvent"] = attrs.field() """The actual file events.""" @attrs.define class DidChangeWatchedFilesRegistrationOptions: """Describe options to be used when registered for text document change events.""" watchers: List["FileSystemWatcher"] = attrs.field() """The watchers to register.""" @attrs.define class PublishDiagnosticsParams: """The publish diagnostic notification's parameters.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The URI for which diagnostic information is reported.""" diagnostics: List["Diagnostic"] = attrs.field() """An array of diagnostic information items.""" version: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.integer_validator), default=None ) """Optional the version number of the document the diagnostics are published for. @since 3.15.0""" # Since: 3.15.0 @attrs.define class CompletionParams: """Completion parameters""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" context: Optional["CompletionContext"] = attrs.field(default=None) """The completion context. This is only available it the client specifies to send this using the client capability `textDocument.completion.contextSupport === true`""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class CompletionItem: """A completion item represents a text snippet that is proposed to complete text that is being typed.""" label: str = attrs.field(validator=attrs.validators.instance_of(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.""" label_details: Optional["CompletionItemLabelDetails"] = attrs.field(default=None) """Additional details for the label @since 3.17.0""" # Since: 3.17.0 kind: Optional[CompletionItemKind] = attrs.field(default=None) """The kind of this completion item. Based of the kind an icon is chosen by the editor.""" tags: Optional[List[CompletionItemTag]] = attrs.field(default=None) """Tags for this completion item. @since 3.15.0""" # Since: 3.15.0 detail: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A human-readable string with additional information about this item, like type or symbol information.""" documentation: Optional[Union[str, "MarkupContent"]] = attrs.field(default=None) """A human-readable string that represents a doc-comment.""" deprecated: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Indicates if this item is deprecated. @deprecated Use `tags` instead.""" preselect: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" sort_text: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A string that should be used when comparing this item with other items. When `falsy` the {@link CompletionItem.label label} is used.""" filter_text: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A string that should be used when filtering a set of completion items. When `falsy` the {@link CompletionItem.label label} is used.""" insert_text: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" insert_text_format: Optional[InsertTextFormat] = attrs.field(default=None) """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`.""" insert_text_mode: Optional[InsertTextMode] = attrs.field(default=None) """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""" # Since: 3.16.0 text_edit: Optional[Union[TextEdit, "InsertReplaceEdit"]] = attrs.field( default=None ) """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`""" # Since: 3.16.0 additional type `InsertReplaceEdit` text_edit_text: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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""" # Since: 3.17.0 additional_text_edits: Optional[List[TextEdit]] = attrs.field(default=None) """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).""" commit_characters: Optional[List[str]] = attrs.field(default=None) """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: Optional["Command"] = attrs.field(default=None) """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: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved on a completion item between a {@link CompletionRequest} and a {@link CompletionResolveRequest}.""" @attrs.define class CompletionListItemDefaultsTypeEditRangeType1: insert: "Range" = attrs.field() replace: "Range" = attrs.field() @attrs.define class CompletionListItemDefaultsType: commit_characters: Optional[List[str]] = attrs.field(default=None) """A default commit character set. @since 3.17.0""" # Since: 3.17.0 edit_range: Optional[ Union["Range", "CompletionListItemDefaultsTypeEditRangeType1"] ] = attrs.field(default=None) """A default edit range. @since 3.17.0""" # Since: 3.17.0 insert_text_format: Optional[InsertTextFormat] = attrs.field(default=None) """A default insert text format. @since 3.17.0""" # Since: 3.17.0 insert_text_mode: Optional[InsertTextMode] = attrs.field(default=None) """A default insert text mode. @since 3.17.0""" # Since: 3.17.0 data: Optional[LSPAny] = attrs.field(default=None) """A default data value. @since 3.17.0""" # Since: 3.17.0 @attrs.define class CompletionList: """Represents a collection of {@link CompletionItem completion items} to be presented in the editor.""" is_incomplete: bool = attrs.field(validator=attrs.validators.instance_of(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.""" items: List[CompletionItem] = attrs.field() """The completion items.""" item_defaults: Optional["CompletionListItemDefaultsType"] = attrs.field( default=None ) """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""" # Since: 3.17.0 @attrs.define class CompletionOptionsCompletionItemType: label_details_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.17.0 @attrs.define class CompletionOptions: """Completion options.""" trigger_characters: Optional[List[str]] = attrs.field(default=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`.""" all_commit_characters: Optional[List[str]] = attrs.field(default=None) """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""" # Since: 3.2.0 resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for a completion item.""" completion_item: Optional["CompletionOptionsCompletionItemType"] = attrs.field( default=None ) """The server supports the following `CompletionItem` specific capabilities. @since 3.17.0""" # Since: 3.17.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class CompletionRegistrationOptionsCompletionItemType: label_details_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.17.0 @attrs.define class CompletionRegistrationOptions: """Registration options for a {@link CompletionRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" trigger_characters: Optional[List[str]] = attrs.field(default=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`.""" all_commit_characters: Optional[List[str]] = attrs.field(default=None) """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""" # Since: 3.2.0 resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for a completion item.""" completion_item: Optional[ "CompletionRegistrationOptionsCompletionItemType" ] = attrs.field(default=None) """The server supports the following `CompletionItem` specific capabilities. @since 3.17.0""" # Since: 3.17.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class HoverParams: """Parameters for a {@link HoverRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class Hover: """The result of a hover request.""" contents: Union["MarkupContent", MarkedString, List[MarkedString]] = attrs.field() """The hover's content""" range: Optional["Range"] = attrs.field(default=None) """An optional range inside the text document that is used to visualize the hover, e.g. by changing the background color.""" @attrs.define class HoverOptions: """Hover options.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class HoverRegistrationOptions: """Registration options for a {@link HoverRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class SignatureHelpParams: """Parameters for a {@link SignatureHelpRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" context: Optional["SignatureHelpContext"] = attrs.field(default=None) """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""" # Since: 3.15.0 work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class SignatureHelp: """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"] = attrs.field() """One or more signatures.""" active_signature: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """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.""" active_parameter: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """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.""" @attrs.define class SignatureHelpOptions: """Server Capabilities for a {@link SignatureHelpRequest}.""" trigger_characters: Optional[List[str]] = attrs.field(default=None) """List of characters that trigger signature help automatically.""" retrigger_characters: Optional[List[str]] = attrs.field(default=None) """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""" # Since: 3.15.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class SignatureHelpRegistrationOptions: """Registration options for a {@link SignatureHelpRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" trigger_characters: Optional[List[str]] = attrs.field(default=None) """List of characters that trigger signature help automatically.""" retrigger_characters: Optional[List[str]] = attrs.field(default=None) """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""" # Since: 3.15.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DefinitionParams: """Parameters for a {@link DefinitionRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class DefinitionOptions: """Server Capabilities for a {@link DefinitionRequest}.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DefinitionRegistrationOptions: """Registration options for a {@link DefinitionRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class ReferenceParams: """Parameters for a {@link ReferencesRequest}.""" context: "ReferenceContext" = attrs.field() text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class ReferenceOptions: """Reference options.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class ReferenceRegistrationOptions: """Registration options for a {@link ReferencesRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentHighlightParams: """Parameters for a {@link DocumentHighlightRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class DocumentHighlight: """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" = attrs.field() """The range this highlight applies to.""" kind: Optional[DocumentHighlightKind] = attrs.field(default=None) """The highlight kind, default is {@link DocumentHighlightKind.Text text}.""" @attrs.define class DocumentHighlightOptions: """Provider options for a {@link DocumentHighlightRequest}.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentHighlightRegistrationOptions: """Registration options for a {@link DocumentHighlightRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentSymbolParams: """Parameters for a {@link DocumentSymbolRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class BaseSymbolInformation: """A base for all symbol information.""" name: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of this symbol.""" kind: SymbolKind = attrs.field() """The kind of this symbol.""" tags: Optional[List[SymbolTag]] = attrs.field(default=None) """Tags for this symbol. @since 3.16.0""" # Since: 3.16.0 container_name: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" @attrs.define class SymbolInformation: """Represents information about programming constructs like variables, classes, interfaces etc.""" location: Location = attrs.field() """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 = attrs.field(validator=attrs.validators.instance_of(str)) """The name of this symbol.""" kind: SymbolKind = attrs.field() """The kind of this symbol.""" deprecated: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Indicates if this symbol is deprecated. @deprecated Use tags instead""" tags: Optional[List[SymbolTag]] = attrs.field(default=None) """Tags for this symbol. @since 3.16.0""" # Since: 3.16.0 container_name: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" @attrs.define class 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.""" name: str = attrs.field(validator=attrs.validators.instance_of(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.""" kind: SymbolKind = attrs.field() """The kind of this symbol.""" range: "Range" = attrs.field() """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.""" selection_range: "Range" = attrs.field() """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`.""" detail: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """More detail for this symbol, e.g the signature of a function.""" tags: Optional[List[SymbolTag]] = attrs.field(default=None) """Tags for this document symbol. @since 3.16.0""" # Since: 3.16.0 deprecated: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Indicates if this symbol is deprecated. @deprecated Use tags instead""" children: Optional[List["DocumentSymbol"]] = attrs.field(default=None) """Children of this symbol, e.g. properties of a class.""" @attrs.define class DocumentSymbolOptions: """Provider options for a {@link DocumentSymbolRequest}.""" label: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A human-readable string that is shown when multiple outlines trees are shown for the same document. @since 3.16.0""" # Since: 3.16.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentSymbolRegistrationOptions: """Registration options for a {@link DocumentSymbolRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A human-readable string that is shown when multiple outlines trees are shown for the same document. @since 3.16.0""" # Since: 3.16.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class CodeActionParams: """The parameters of a {@link CodeActionRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document in which the command was invoked.""" range: "Range" = attrs.field() """The range for which the command was invoked.""" context: "CodeActionContext" = attrs.field() """Context carrying additional information.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class Command: """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 = attrs.field(validator=attrs.validators.instance_of(str)) """Title of the command, like `save`.""" command: str = attrs.field(validator=attrs.validators.instance_of(str)) """The identifier of the actual command handler.""" arguments: Optional[List[LSPAny]] = attrs.field(default=None) """Arguments that the command handler should be invoked with.""" @attrs.define class CodeActionDisabledType: reason: str = attrs.field(validator=attrs.validators.instance_of(str)) """Human readable description of why the code action is currently disabled. This is displayed in the code actions UI.""" @attrs.define class CodeAction: """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 = attrs.field(validator=attrs.validators.instance_of(str)) """A short, human-readable, title for this code action.""" kind: Optional[Union[CodeActionKind, str]] = attrs.field(default=None) """The kind of the code action. Used to filter code actions.""" diagnostics: Optional[List["Diagnostic"]] = attrs.field(default=None) """The diagnostics that this code action resolves.""" is_preferred: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.15.0 disabled: Optional["CodeActionDisabledType"] = attrs.field(default=None) """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""" # Since: 3.16.0 edit: Optional[WorkspaceEdit] = attrs.field(default=None) """The workspace edit this code action performs.""" command: Optional[Command] = attrs.field(default=None) """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: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved on a code action between a `textDocument/codeAction` and a `codeAction/resolve` request. @since 3.16.0""" # Since: 3.16.0 @attrs.define class CodeActionOptions: """Provider options for a {@link CodeActionRequest}.""" code_action_kinds: Optional[List[Union[CodeActionKind, str]]] = attrs.field( default=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.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for a code action. @since 3.16.0""" # Since: 3.16.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class CodeActionRegistrationOptions: """Registration options for a {@link CodeActionRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" code_action_kinds: Optional[List[Union[CodeActionKind, str]]] = attrs.field( default=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.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for a code action. @since 3.16.0""" # Since: 3.16.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class WorkspaceSymbolParams: """The parameters of a {@link WorkspaceSymbolRequest}.""" query: str = attrs.field(validator=attrs.validators.instance_of(str)) """A query string to filter symbols by. Clients may send an empty string here to request all symbols.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class WorkspaceSymbolLocationType1: uri: str = attrs.field(validator=attrs.validators.instance_of(str)) @attrs.define class WorkspaceSymbol: """A special workspace symbol that supports locations without a range. See also SymbolInformation. @since 3.17.0""" # Since: 3.17.0 location: Union[Location, "WorkspaceSymbolLocationType1"] = attrs.field() """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.""" name: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of this symbol.""" kind: SymbolKind = attrs.field() """The kind of this symbol.""" data: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.""" tags: Optional[List[SymbolTag]] = attrs.field(default=None) """Tags for this symbol. @since 3.16.0""" # Since: 3.16.0 container_name: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" @attrs.define class WorkspaceSymbolOptions: """Server capabilities for a {@link WorkspaceSymbolRequest}.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for a workspace symbol. @since 3.17.0""" # Since: 3.17.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class WorkspaceSymbolRegistrationOptions: """Registration options for a {@link WorkspaceSymbolRequest}.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server provides support to resolve additional information for a workspace symbol. @since 3.17.0""" # Since: 3.17.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class CodeLensParams: """The parameters of a {@link CodeLensRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document to request code lens for.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class CodeLens: """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" = attrs.field() """The range in which this code lens is valid. Should only span a single line.""" command: Optional[Command] = attrs.field(default=None) """The command this code lens represents.""" data: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved on a code lens item between a {@link CodeLensRequest} and a {@link CodeLensResolveRequest}""" @attrs.define class CodeLensOptions: """Code Lens provider options of a {@link CodeLensRequest}.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Code lens has a resolve provider as well.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class CodeLensRegistrationOptions: """Registration options for a {@link CodeLensRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Code lens has a resolve provider as well.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentLinkParams: """The parameters of a {@link DocumentLinkRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document to provide document links for.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" partial_result_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report partial results (e.g. streaming) to the client.""" @attrs.define class DocumentLink: """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" = attrs.field() """The range this link applies to.""" target: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The uri this link points to. If missing a resolve request is sent later.""" tooltip: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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""" # Since: 3.15.0 data: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.""" @attrs.define class DocumentLinkOptions: """Provider options for a {@link DocumentLinkRequest}.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Document links have a resolve provider as well.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentLinkRegistrationOptions: """Registration options for a {@link DocumentLinkRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" resolve_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Document links have a resolve provider as well.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentFormattingParams: """The parameters of a {@link DocumentFormattingRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document to format.""" options: "FormattingOptions" = attrs.field() """The format options.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class DocumentFormattingOptions: """Provider options for a {@link DocumentFormattingRequest}.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentFormattingRegistrationOptions: """Registration options for a {@link DocumentFormattingRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentRangeFormattingParams: """The parameters of a {@link DocumentRangeFormattingRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document to format.""" range: "Range" = attrs.field() """The range to format""" options: "FormattingOptions" = attrs.field() """The format options""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class DocumentRangeFormattingOptions: """Provider options for a {@link DocumentRangeFormattingRequest}.""" ranges_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the server supports formatting multiple ranges at once. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentRangeFormattingRegistrationOptions: """Registration options for a {@link DocumentRangeFormattingRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" ranges_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the server supports formatting multiple ranges at once. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class DocumentRangesFormattingParams: """The parameters of a {@link DocumentRangesFormattingRequest}. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed text_document: "TextDocumentIdentifier" = attrs.field() """The document to format.""" ranges: List["Range"] = attrs.field() """The ranges to format""" options: "FormattingOptions" = attrs.field() """The format options""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class DocumentOnTypeFormattingParams: """The parameters of a {@link DocumentOnTypeFormattingRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document to format.""" position: "Position" = attrs.field() """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 = attrs.field(validator=attrs.validators.instance_of(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" = attrs.field() """The formatting options.""" @attrs.define class DocumentOnTypeFormattingOptions: """Provider options for a {@link DocumentOnTypeFormattingRequest}.""" first_trigger_character: str = attrs.field( validator=attrs.validators.instance_of(str) ) """A character on which formatting should be triggered, like `{`.""" more_trigger_character: Optional[List[str]] = attrs.field(default=None) """More trigger characters.""" @attrs.define class DocumentOnTypeFormattingRegistrationOptions: """Registration options for a {@link DocumentOnTypeFormattingRequest}.""" first_trigger_character: str = attrs.field( validator=attrs.validators.instance_of(str) ) """A character on which formatting should be triggered, like `{`.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" more_trigger_character: Optional[List[str]] = attrs.field(default=None) """More trigger characters.""" @attrs.define class RenameParams: """The parameters of a {@link RenameRequest}.""" text_document: "TextDocumentIdentifier" = attrs.field() """The document to rename.""" position: "Position" = attrs.field() """The position at which this request was sent.""" new_name: str = attrs.field(validator=attrs.validators.instance_of(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.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class RenameOptions: """Provider options for a {@link RenameRequest}.""" prepare_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Renames should be checked and tested before being executed. @since version 3.12.0""" # Since: version 3.12.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class RenameRegistrationOptions: """Registration options for a {@link RenameRequest}.""" document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" prepare_provider: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Renames should be checked and tested before being executed. @since version 3.12.0""" # Since: version 3.12.0 work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class PrepareRenameParams: text_document: "TextDocumentIdentifier" = attrs.field() """The text document.""" position: "Position" = attrs.field() """The position inside the text document.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class ExecuteCommandParams: """The parameters of a {@link ExecuteCommandRequest}.""" command: str = attrs.field(validator=attrs.validators.instance_of(str)) """The identifier of the actual command handler.""" arguments: Optional[List[LSPAny]] = attrs.field(default=None) """Arguments that the command should be invoked with.""" work_done_token: Optional[ProgressToken] = attrs.field(default=None) """An optional token that a server can use to report work done progress.""" @attrs.define class ExecuteCommandOptions: """The server capabilities of a {@link ExecuteCommandRequest}.""" commands: List[str] = attrs.field() """The commands to be executed on the server""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class ExecuteCommandRegistrationOptions: """Registration options for a {@link ExecuteCommandRequest}.""" commands: List[str] = attrs.field() """The commands to be executed on the server""" work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) @attrs.define class ApplyWorkspaceEditParams: """The parameters passed via an apply workspace edit request.""" edit: WorkspaceEdit = attrs.field() """The edits to apply.""" label: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" @attrs.define class ApplyWorkspaceEditResult: """The result returned from the apply workspace edit request. @since 3.17 renamed from ApplyWorkspaceEditResponse""" # Since: 3.17 renamed from ApplyWorkspaceEditResponse applied: bool = attrs.field(validator=attrs.validators.instance_of(bool)) """Indicates whether the edit was applied or not.""" failure_reason: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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.""" failed_change: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """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.""" @attrs.define class WorkDoneProgressBegin: title: str = attrs.field(validator=attrs.validators.instance_of(str)) """Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed. Examples: "Indexing" or "Linking dependencies".""" kind: str = attrs.field(validator=attrs.validators.in_(["begin"]), default="begin") cancellable: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """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].""" @attrs.define class WorkDoneProgressReport: kind: str = attrs.field( validator=attrs.validators.in_(["report"]), default="report" ) cancellable: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """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]""" @attrs.define class WorkDoneProgressEnd: kind: str = attrs.field(validator=attrs.validators.in_(["end"]), default="end") message: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """Optional, a final message indicating to for example indicate the outcome of the operation.""" @attrs.define class SetTraceParams: value: TraceValues = attrs.field() @attrs.define class LogTraceParams: message: str = attrs.field(validator=attrs.validators.instance_of(str)) verbose: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) @attrs.define class CancelParams: id: Union[int, str] = attrs.field() """The request id to cancel.""" @attrs.define class ProgressParams: token: ProgressToken = attrs.field() """The progress token provided by the client or server.""" value: LSPAny = attrs.field() """The progress data.""" @attrs.define class LocationLink: """Represents the connection of two locations. Provides additional metadata over normal {@link Location locations}, including an origin range.""" target_uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The target resource identifier of this link.""" target_range: "Range" = attrs.field() """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.""" target_selection_range: "Range" = attrs.field() """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`""" origin_selection_range: Optional["Range"] = attrs.field(default=None) """Span of the origin of this link. Used as the underlined span for mouse interaction. Defaults to the word range at the definition position.""" @attrs.define class Range: """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" = attrs.field() """The range's start position.""" end: "Position" = attrs.field() """The range's end position.""" def __eq__(self, o: object) -> bool: if not isinstance(o, Range): return NotImplemented return (self.start == o.start) and (self.end == o.end) def __repr__(self) -> str: return f"{self.start!r}-{self.end!r}" @attrs.define class WorkspaceFoldersChangeEvent: """The workspace folder change event.""" added: List[WorkspaceFolder] = attrs.field() """The array of added workspace folders""" removed: List[WorkspaceFolder] = attrs.field() """The array of the removed workspace folders""" @attrs.define class ConfigurationItem: scope_uri: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The scope to get the configuration section for.""" section: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The configuration section asked for.""" @attrs.define class TextDocumentIdentifier: """A literal to identify a text document in the client.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The text document's uri.""" @attrs.define class Color: """Represents a color in RGBA space.""" red: float = attrs.field(validator=attrs.validators.instance_of(float)) """The red component of this color in the range [0-1].""" green: float = attrs.field(validator=attrs.validators.instance_of(float)) """The green component of this color in the range [0-1].""" blue: float = attrs.field(validator=attrs.validators.instance_of(float)) """The blue component of this color in the range [0-1].""" alpha: float = attrs.field(validator=attrs.validators.instance_of(float)) """The alpha component of this color in the range [0-1].""" @attrs.define @functools.total_ordering class Position: """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.""" # Since: 3.17.0 - support for negotiated position encoding. line: int = attrs.field(validator=validators.uinteger_validator) """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.""" character: int = attrs.field(validator=validators.uinteger_validator) """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.""" def __eq__(self, o: object) -> bool: if not isinstance(o, Position): return NotImplemented return (self.line, self.character) == (o.line, o.character) def __gt__(self, o: "Position") -> bool: if not isinstance(o, Position): return NotImplemented return (self.line, self.character) > (o.line, o.character) def __repr__(self) -> str: return f"{self.line}:{self.character}" @attrs.define class SemanticTokensEdit: """@since 3.16.0""" # Since: 3.16.0 start: int = attrs.field(validator=validators.uinteger_validator) """The start offset of the edit.""" delete_count: int = attrs.field(validator=validators.uinteger_validator) """The count of elements to remove.""" data: Optional[List[int]] = attrs.field(default=None) """The elements to insert.""" @attrs.define class FileCreate: """Represents information on a file/folder create. @since 3.16.0""" # Since: 3.16.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """A file:// URI for the location of the file/folder being created.""" @attrs.define class TextDocumentEdit: """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.""" text_document: "OptionalVersionedTextDocumentIdentifier" = attrs.field() """The text document to change.""" edits: List[Union[TextEdit, "AnnotatedTextEdit"]] = attrs.field() """The edits to be applied. @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a client capability.""" # Since: 3.16.0 - support for AnnotatedTextEdit. This is guarded using aclient capability. @attrs.define class ResourceOperation: """A generic resource operation.""" kind: str = attrs.field(validator=attrs.validators.instance_of(str)) """The resource operation kind.""" annotation_id: Optional[ChangeAnnotationIdentifier] = attrs.field(default=None) """An optional annotation identifier describing the operation. @since 3.16.0""" # Since: 3.16.0 @attrs.define class CreateFile: """Create file operation.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The resource to create.""" kind: str = attrs.field( validator=attrs.validators.in_(["create"]), default="create" ) """A create""" options: Optional["CreateFileOptions"] = attrs.field(default=None) """Additional options""" annotation_id: Optional[ChangeAnnotationIdentifier] = attrs.field(default=None) """An optional annotation identifier describing the operation. @since 3.16.0""" # Since: 3.16.0 @attrs.define class RenameFile: """Rename file operation""" old_uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The old (existing) location.""" new_uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The new location.""" kind: str = attrs.field( validator=attrs.validators.in_(["rename"]), default="rename" ) """A rename""" options: Optional["RenameFileOptions"] = attrs.field(default=None) """Rename options.""" annotation_id: Optional[ChangeAnnotationIdentifier] = attrs.field(default=None) """An optional annotation identifier describing the operation. @since 3.16.0""" # Since: 3.16.0 @attrs.define class DeleteFile: """Delete file operation""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The file to delete.""" kind: str = attrs.field( validator=attrs.validators.in_(["delete"]), default="delete" ) """A delete""" options: Optional["DeleteFileOptions"] = attrs.field(default=None) """Delete options.""" annotation_id: Optional[ChangeAnnotationIdentifier] = attrs.field(default=None) """An optional annotation identifier describing the operation. @since 3.16.0""" # Since: 3.16.0 @attrs.define class ChangeAnnotation: """Additional information that describes document changes. @since 3.16.0""" # Since: 3.16.0 label: str = attrs.field(validator=attrs.validators.instance_of(str)) """A human-readable string describing the actual change. The string is rendered prominent in the user interface.""" needs_confirmation: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """A flag which indicates that user confirmation is needed before applying the change.""" description: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A human-readable string which is rendered less prominent in the user interface.""" @attrs.define class FileOperationFilter: """A filter to describe in which file operation requests or notifications the server is interested in receiving. @since 3.16.0""" # Since: 3.16.0 pattern: "FileOperationPattern" = attrs.field() """The actual file operation pattern.""" scheme: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A Uri scheme like `file` or `untitled`.""" @attrs.define class FileRename: """Represents information on a file/folder rename. @since 3.16.0""" # Since: 3.16.0 old_uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """A file:// URI for the original location of the file/folder being renamed.""" new_uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """A file:// URI for the new location of the file/folder being renamed.""" @attrs.define class FileDelete: """Represents information on a file/folder delete. @since 3.16.0""" # Since: 3.16.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """A file:// URI for the location of the file/folder being deleted.""" @attrs.define class InlineValueContext: """@since 3.17.0""" # Since: 3.17.0 frame_id: int = attrs.field(validator=validators.integer_validator) """The stack frame (as a DAP Id) where the execution has stopped.""" stopped_location: Range = attrs.field() """The document range where execution has stopped. Typically the end position of the range denotes the line where the inline values are shown.""" @attrs.define class InlineValueText: """Provide inline value as text. @since 3.17.0""" # Since: 3.17.0 range: Range = attrs.field() """The document range for which the inline value applies.""" text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The text of the inline value.""" @attrs.define class InlineValueVariableLookup: """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""" # Since: 3.17.0 range: Range = attrs.field() """The document range for which the inline value applies. The range is used to extract the variable name from the underlying document.""" case_sensitive_lookup: bool = attrs.field( validator=attrs.validators.instance_of(bool) ) """How to perform the lookup.""" variable_name: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """If specified the name of the variable to look up.""" @attrs.define class InlineValueEvaluatableExpression: """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""" # Since: 3.17.0 range: Range = attrs.field() """The document range for which the inline value applies. The range is used to extract the evaluatable expression from the underlying document.""" expression: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """If specified the expression overrides the extracted expression.""" @attrs.define class InlayHintLabelPart: """An inlay hint label part allows for interactive and composite labels of inlay hints. @since 3.17.0""" # Since: 3.17.0 value: str = attrs.field(validator=attrs.validators.instance_of(str)) """The value of this label part.""" tooltip: Optional[Union[str, "MarkupContent"]] = attrs.field(default=None) """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: Optional[Location] = attrs.field(default=None) """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: Optional[Command] = attrs.field(default=None) """An optional command for this label part. Depending on the client capability `inlayHint.resolveSupport` clients might resolve this property late using the resolve request.""" @attrs.define class MarkupContent: """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 = attrs.field() """The type of the Markup""" value: str = attrs.field(validator=attrs.validators.instance_of(str)) """The content itself""" @attrs.define class FullDocumentDiagnosticReport: """A diagnostic report with a full set of problems. @since 3.17.0""" # Since: 3.17.0 items: List["Diagnostic"] = attrs.field() """The actual items.""" kind: str = attrs.field(validator=attrs.validators.in_(["full"]), default="full") """A full document diagnostic report.""" result_id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """An optional result id. If provided it will be sent on the next diagnostic request for the same document.""" @attrs.define class RelatedFullDocumentDiagnosticReport: """A full diagnostic report with a set of related documents. @since 3.17.0""" # Since: 3.17.0 items: List["Diagnostic"] = attrs.field() """The actual items.""" related_documents: Optional[ Dict[ str, Union[FullDocumentDiagnosticReport, "UnchangedDocumentDiagnosticReport"], ] ] = attrs.field(default=None) """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: str = attrs.field(validator=attrs.validators.in_(["full"]), default="full") """A full document diagnostic report.""" result_id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """An optional result id. If provided it will be sent on the next diagnostic request for the same document.""" @attrs.define class UnchangedDocumentDiagnosticReport: """A diagnostic report indicating that the last returned report is still accurate. @since 3.17.0""" # Since: 3.17.0 result_id: str = attrs.field(validator=attrs.validators.instance_of(str)) """A result id which will be sent on the next diagnostic request for the same document.""" kind: str = attrs.field( validator=attrs.validators.in_(["unchanged"]), default="unchanged" ) """A document diagnostic report indicating no changes to the last result. A server can only return `unchanged` if result ids are provided.""" @attrs.define class RelatedUnchangedDocumentDiagnosticReport: """An unchanged diagnostic report with a set of related documents. @since 3.17.0""" # Since: 3.17.0 result_id: str = attrs.field(validator=attrs.validators.instance_of(str)) """A result id which will be sent on the next diagnostic request for the same document.""" related_documents: Optional[ Dict[ str, Union[FullDocumentDiagnosticReport, UnchangedDocumentDiagnosticReport] ] ] = attrs.field(default=None) """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: str = attrs.field( validator=attrs.validators.in_(["unchanged"]), default="unchanged" ) """A document diagnostic report indicating no changes to the last result. A server can only return `unchanged` if result ids are provided.""" @attrs.define class PreviousResultId: """A previous result id in a workspace pull request. @since 3.17.0""" # Since: 3.17.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The URI for which the client knowns a result id.""" value: str = attrs.field(validator=attrs.validators.instance_of(str)) """The value of the previous result id.""" @attrs.define class NotebookDocument: """A notebook document. @since 3.17.0""" # Since: 3.17.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The notebook document's uri.""" notebook_type: str = attrs.field(validator=attrs.validators.instance_of(str)) """The type of the notebook.""" version: int = attrs.field(validator=validators.integer_validator) """The version number of this document (it will increase after each change, including undo/redo).""" cells: List["NotebookCell"] = attrs.field() """The cells of a notebook.""" metadata: Optional[LSPObject] = attrs.field(default=None) """Additional metadata stored with the notebook document. Note: should always be an object literal (e.g. LSPObject)""" @attrs.define class TextDocumentItem: """An item to transfer a text document from the client to the server.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The text document's uri.""" language_id: str = attrs.field(validator=attrs.validators.instance_of(str)) """The text document's language identifier.""" version: int = attrs.field(validator=validators.integer_validator) """The version number of this document (it will increase after each change, including undo/redo).""" text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The content of the opened text document.""" @attrs.define class VersionedNotebookDocumentIdentifier: """A versioned notebook document identifier. @since 3.17.0""" # Since: 3.17.0 version: int = attrs.field(validator=validators.integer_validator) """The version number of this notebook document.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The notebook document's uri.""" @attrs.define class NotebookDocumentChangeEventCellsTypeStructureType: array: "NotebookCellArrayChange" = attrs.field() """The change to the cell array.""" did_open: Optional[List[TextDocumentItem]] = attrs.field(default=None) """Additional opened cell text documents.""" did_close: Optional[List[TextDocumentIdentifier]] = attrs.field(default=None) """Additional closed cell text documents.""" @attrs.define class NotebookDocumentChangeEventCellsTypeTextContentType: document: "VersionedTextDocumentIdentifier" = attrs.field() changes: List[TextDocumentContentChangeEvent] = attrs.field() @attrs.define class NotebookDocumentChangeEventCellsType: structure: Optional[ "NotebookDocumentChangeEventCellsTypeStructureType" ] = attrs.field(default=None) """Changes to the cell structure to add or remove cells.""" data: Optional[List["NotebookCell"]] = attrs.field(default=None) """Changes to notebook cells properties like its kind, execution summary or metadata.""" text_content: Optional[ List["NotebookDocumentChangeEventCellsTypeTextContentType"] ] = attrs.field(default=None) """Changes to the text content of notebook cells.""" @attrs.define class NotebookDocumentChangeEvent: """A change event for a notebook document. @since 3.17.0""" # Since: 3.17.0 metadata: Optional[LSPObject] = attrs.field(default=None) """The changed meta data if any. Note: should always be an object literal (e.g. LSPObject)""" cells: Optional["NotebookDocumentChangeEventCellsType"] = attrs.field(default=None) """Changes to cells""" @attrs.define class NotebookDocumentIdentifier: """A literal to identify a notebook document in the client. @since 3.17.0""" # Since: 3.17.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The notebook document's uri.""" @attrs.define class InlineCompletionContext: """Provides information about the context in which an inline completion was requested. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed trigger_kind: InlineCompletionTriggerKind = attrs.field() """Describes how the inline completion was triggered.""" selected_completion_info: Optional["SelectedCompletionInfo"] = attrs.field( default=None ) """Provides information about the currently selected item in the autocomplete widget if it is visible.""" @attrs.define class StringValue: """A string value used as a snippet is a template which allows to insert text and to control the editor cursor when insertion happens. 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""" # Since: 3.18.0 # Proposed value: str = attrs.field(validator=attrs.validators.instance_of(str)) """The snippet string.""" kind: str = attrs.field( validator=attrs.validators.in_(["snippet"]), default="snippet" ) """The kind of string value.""" @attrs.define class Registration: """General parameters to register for a notification or to register a provider.""" id: str = attrs.field(validator=attrs.validators.instance_of(str)) """The id used to register the request. The id can be used to deregister the request again.""" method: str = attrs.field(validator=attrs.validators.instance_of(str)) """The method / capability to register for.""" register_options: Optional[LSPAny] = attrs.field(default=None) """Options necessary for the registration.""" @attrs.define class Unregistration: """General parameters to unregister a request or notification.""" id: str = attrs.field(validator=attrs.validators.instance_of(str)) """The id used to unregister the request or notification. Usually an id provided during the register request.""" method: str = attrs.field(validator=attrs.validators.instance_of(str)) """The method to unregister for.""" @attrs.define class ServerCapabilitiesWorkspaceType: workspace_folders: Optional["WorkspaceFoldersServerCapabilities"] = attrs.field( default=None ) """The server supports workspace folder. @since 3.6.0""" # Since: 3.6.0 file_operations: Optional["FileOperationOptions"] = attrs.field(default=None) """The server is interested in notifications/requests for operations on files. @since 3.16.0""" # Since: 3.16.0 @attrs.define class ServerCapabilities: """Defines the capabilities provided by a language server.""" position_encoding: Optional[Union[PositionEncodingKind, str]] = attrs.field( default=None ) """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""" # Since: 3.17.0 text_document_sync: Optional[ Union["TextDocumentSyncOptions", TextDocumentSyncKind] ] = attrs.field(default=None) """Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number.""" notebook_document_sync: Optional[ Union["NotebookDocumentSyncOptions", "NotebookDocumentSyncRegistrationOptions"] ] = attrs.field(default=None) """Defines how notebook documents are synced. @since 3.17.0""" # Since: 3.17.0 completion_provider: Optional[CompletionOptions] = attrs.field(default=None) """The server provides completion support.""" hover_provider: Optional[Union[bool, HoverOptions]] = attrs.field(default=None) """The server provides hover support.""" signature_help_provider: Optional[SignatureHelpOptions] = attrs.field(default=None) """The server provides signature help support.""" declaration_provider: Optional[ Union[bool, DeclarationOptions, DeclarationRegistrationOptions] ] = attrs.field(default=None) """The server provides Goto Declaration support.""" definition_provider: Optional[Union[bool, DefinitionOptions]] = attrs.field( default=None ) """The server provides goto definition support.""" type_definition_provider: Optional[ Union[bool, TypeDefinitionOptions, TypeDefinitionRegistrationOptions] ] = attrs.field(default=None) """The server provides Goto Type Definition support.""" implementation_provider: Optional[ Union[bool, ImplementationOptions, ImplementationRegistrationOptions] ] = attrs.field(default=None) """The server provides Goto Implementation support.""" references_provider: Optional[Union[bool, ReferenceOptions]] = attrs.field( default=None ) """The server provides find references support.""" document_highlight_provider: Optional[ Union[bool, DocumentHighlightOptions] ] = attrs.field(default=None) """The server provides document highlight support.""" document_symbol_provider: Optional[ Union[bool, DocumentSymbolOptions] ] = attrs.field(default=None) """The server provides document symbol support.""" code_action_provider: Optional[Union[bool, CodeActionOptions]] = attrs.field( default=None ) """The server provides code actions. CodeActionOptions may only be specified if the client states that it supports `codeActionLiteralSupport` in its initial `initialize` request.""" code_lens_provider: Optional[CodeLensOptions] = attrs.field(default=None) """The server provides code lens.""" document_link_provider: Optional[DocumentLinkOptions] = attrs.field(default=None) """The server provides document link support.""" color_provider: Optional[ Union[bool, DocumentColorOptions, DocumentColorRegistrationOptions] ] = attrs.field(default=None) """The server provides color provider support.""" workspace_symbol_provider: Optional[ Union[bool, WorkspaceSymbolOptions] ] = attrs.field(default=None) """The server provides workspace symbol support.""" document_formatting_provider: Optional[ Union[bool, DocumentFormattingOptions] ] = attrs.field(default=None) """The server provides document formatting.""" document_range_formatting_provider: Optional[ Union[bool, DocumentRangeFormattingOptions] ] = attrs.field(default=None) """The server provides document range formatting.""" document_on_type_formatting_provider: Optional[ DocumentOnTypeFormattingOptions ] = attrs.field(default=None) """The server provides document formatting on typing.""" rename_provider: Optional[Union[bool, RenameOptions]] = attrs.field(default=None) """The server provides rename support. RenameOptions may only be specified if the client states that it supports `prepareSupport` in its initial `initialize` request.""" folding_range_provider: Optional[ Union[bool, FoldingRangeOptions, FoldingRangeRegistrationOptions] ] = attrs.field(default=None) """The server provides folding provider support.""" selection_range_provider: Optional[ Union[bool, SelectionRangeOptions, SelectionRangeRegistrationOptions] ] = attrs.field(default=None) """The server provides selection range support.""" execute_command_provider: Optional[ExecuteCommandOptions] = attrs.field( default=None ) """The server provides execute command support.""" call_hierarchy_provider: Optional[ Union[bool, CallHierarchyOptions, CallHierarchyRegistrationOptions] ] = attrs.field(default=None) """The server provides call hierarchy support. @since 3.16.0""" # Since: 3.16.0 linked_editing_range_provider: Optional[ Union[bool, LinkedEditingRangeOptions, LinkedEditingRangeRegistrationOptions] ] = attrs.field(default=None) """The server provides linked editing range support. @since 3.16.0""" # Since: 3.16.0 semantic_tokens_provider: Optional[ Union[SemanticTokensOptions, SemanticTokensRegistrationOptions] ] = attrs.field(default=None) """The server provides semantic tokens support. @since 3.16.0""" # Since: 3.16.0 moniker_provider: Optional[ Union[bool, MonikerOptions, MonikerRegistrationOptions] ] = attrs.field(default=None) """The server provides moniker support. @since 3.16.0""" # Since: 3.16.0 type_hierarchy_provider: Optional[ Union[bool, TypeHierarchyOptions, TypeHierarchyRegistrationOptions] ] = attrs.field(default=None) """The server provides type hierarchy support. @since 3.17.0""" # Since: 3.17.0 inline_value_provider: Optional[ Union[bool, InlineValueOptions, InlineValueRegistrationOptions] ] = attrs.field(default=None) """The server provides inline values. @since 3.17.0""" # Since: 3.17.0 inlay_hint_provider: Optional[ Union[bool, InlayHintOptions, InlayHintRegistrationOptions] ] = attrs.field(default=None) """The server provides inlay hints. @since 3.17.0""" # Since: 3.17.0 diagnostic_provider: Optional[ Union[DiagnosticOptions, DiagnosticRegistrationOptions] ] = attrs.field(default=None) """The server has support for pull model diagnostics. @since 3.17.0""" # Since: 3.17.0 inline_completion_provider: Optional[ Union[bool, InlineCompletionOptions] ] = attrs.field(default=None) """Inline completion options used during static registration. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed workspace: Optional["ServerCapabilitiesWorkspaceType"] = attrs.field(default=None) """Workspace specific server capabilities.""" experimental: Optional[LSPAny] = attrs.field(default=None) """Experimental server capabilities.""" @attrs.define class VersionedTextDocumentIdentifier: """A text document identifier to denote a specific version of a text document.""" version: int = attrs.field(validator=validators.integer_validator) """The version number of this document.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The text document's uri.""" @attrs.define class FileEvent: """An event describing a file change.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The file's uri.""" type: FileChangeType = attrs.field() """The change type.""" @attrs.define class FileSystemWatcher: glob_pattern: GlobPattern = attrs.field() """The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail. @since 3.17.0 support for relative patterns.""" # Since: 3.17.0 support for relative patterns. kind: Optional[Union[WatchKind, int]] = attrs.field(default=None) """The kind of events of interest. If omitted it defaults to WatchKind.Create | WatchKind.Change | WatchKind.Delete which is 7.""" @attrs.define class Diagnostic: """Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.""" range: Range = attrs.field() """The range at which the message applies""" message: str = attrs.field(validator=attrs.validators.instance_of(str)) """The diagnostic's message. It usually appears in the user interface""" severity: Optional[DiagnosticSeverity] = attrs.field(default=None) """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: Optional[Union[int, str]] = attrs.field(default=None) """The diagnostic's code, which usually appear in the user interface.""" code_description: Optional["CodeDescription"] = attrs.field(default=None) """An optional property to describe the error code. Requires the code field (above) to be present/not null. @since 3.16.0""" # Since: 3.16.0 source: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'. It usually appears in the user interface.""" tags: Optional[List[DiagnosticTag]] = attrs.field(default=None) """Additional metadata about the diagnostic. @since 3.15.0""" # Since: 3.15.0 related_information: Optional[List["DiagnosticRelatedInformation"]] = attrs.field( default=None ) """An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.""" data: Optional[LSPAny] = attrs.field(default=None) """A data entry field that is preserved between a `textDocument/publishDiagnostics` notification and `textDocument/codeAction` request. @since 3.16.0""" # Since: 3.16.0 @attrs.define class CompletionContext: """Contains additional information about the context in which a completion request is triggered.""" trigger_kind: CompletionTriggerKind = attrs.field() """How the completion was triggered.""" trigger_character: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The trigger character (a single character) that has trigger code complete. Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`""" @attrs.define class CompletionItemLabelDetails: """Additional details for a completion item label. @since 3.17.0""" # Since: 3.17.0 detail: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used for fully qualified names and file paths.""" @attrs.define class InsertReplaceEdit: """A special text edit to provide an insert and a replace operation. @since 3.16.0""" # Since: 3.16.0 new_text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The string to be inserted.""" insert: Range = attrs.field() """The range if the insert is requested""" replace: Range = attrs.field() """The range if the replace is requested.""" @attrs.define class SignatureHelpContext: """Additional information about the context in which a signature help request was triggered. @since 3.15.0""" # Since: 3.15.0 trigger_kind: SignatureHelpTriggerKind = attrs.field() """Action that caused signature help to be triggered.""" is_retrigger: bool = attrs.field(validator=attrs.validators.instance_of(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.""" trigger_character: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """Character that caused signature help to be triggered. This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`""" active_signature_help: Optional[SignatureHelp] = attrs.field(default=None) """The currently active `SignatureHelp`. The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on the user navigating through available signatures.""" @attrs.define class SignatureInformation: """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 = attrs.field(validator=attrs.validators.instance_of(str)) """The label of this signature. Will be shown in the UI.""" documentation: Optional[Union[str, MarkupContent]] = attrs.field(default=None) """The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.""" parameters: Optional[List["ParameterInformation"]] = attrs.field(default=None) """The parameters of this signature.""" active_parameter: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """The index of the active parameter. If provided, this is used in place of `SignatureHelp.activeParameter`. @since 3.16.0""" # Since: 3.16.0 @attrs.define class ReferenceContext: """Value-object that contains additional information when requesting references.""" include_declaration: bool = attrs.field( validator=attrs.validators.instance_of(bool) ) """Include the declaration of the current symbol.""" @attrs.define class CodeActionContext: """Contains additional diagnostic information about the context in which a {@link CodeActionProvider.provideCodeActions code action} is run.""" diagnostics: List[Diagnostic] = attrs.field() """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: Optional[List[Union[CodeActionKind, str]]] = attrs.field(default=None) """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.""" trigger_kind: Optional[CodeActionTriggerKind] = attrs.field(default=None) """The reason why code actions were requested. @since 3.17.0""" # Since: 3.17.0 @attrs.define class FormattingOptions: """Value-object describing what options formatting should use.""" tab_size: int = attrs.field(validator=validators.uinteger_validator) """Size of a tab in spaces.""" insert_spaces: bool = attrs.field(validator=attrs.validators.instance_of(bool)) """Prefer spaces over tabs.""" trim_trailing_whitespace: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Trim trailing whitespace on a line. @since 3.15.0""" # Since: 3.15.0 insert_final_newline: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Insert a newline character at the end of the file if one does not exist. @since 3.15.0""" # Since: 3.15.0 trim_final_newlines: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Trim all newlines after the final newline at the end of the file. @since 3.15.0""" # Since: 3.15.0 @attrs.define class SemanticTokensLegend: """@since 3.16.0""" # Since: 3.16.0 token_types: List[str] = attrs.field() """The token types a server uses.""" token_modifiers: List[str] = attrs.field() """The token modifiers a server uses.""" @attrs.define class OptionalVersionedTextDocumentIdentifier: """A text document identifier to optionally denote a specific version of a text document.""" uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The text document's uri.""" version: Optional[Union[int, None]] = attrs.field(default=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).""" @attrs.define class AnnotatedTextEdit: """A special text edit with an additional change annotation. @since 3.16.0.""" # Since: 3.16.0. annotation_id: ChangeAnnotationIdentifier = attrs.field() """The actual identifier of the change annotation""" range: Range = attrs.field() """The range of the text document to be manipulated. To insert text into a document create a range where start === end.""" new_text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The string to be inserted. For delete operations use an empty string.""" @attrs.define class CreateFileOptions: """Options to create a file.""" overwrite: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Overwrite existing file. Overwrite wins over `ignoreIfExists`""" ignore_if_exists: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Ignore if exists.""" @attrs.define class RenameFileOptions: """Rename file options""" overwrite: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Overwrite target if existing. Overwrite wins over `ignoreIfExists`""" ignore_if_exists: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Ignores if target exists.""" @attrs.define class DeleteFileOptions: """Delete file options""" recursive: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Delete the content recursively if a folder is denoted.""" ignore_if_not_exists: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Ignore the operation if the file doesn't exist.""" @attrs.define class FileOperationPattern: """A pattern to describe in which file operation requests or notifications the server is interested in receiving. @since 3.16.0""" # Since: 3.16.0 glob: str = attrs.field(validator=attrs.validators.instance_of(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: Optional[FileOperationPatternKind] = attrs.field(default=None) """Whether to match files or folders with this pattern. Matches both if undefined.""" options: Optional["FileOperationPatternOptions"] = attrs.field(default=None) """Additional options used during matching.""" @attrs.define class WorkspaceFullDocumentDiagnosticReport: """A full document diagnostic report for a workspace diagnostic result. @since 3.17.0""" # Since: 3.17.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The URI for which diagnostic information is reported.""" items: List[Diagnostic] = attrs.field() """The actual items.""" version: Optional[Union[int, None]] = attrs.field(default=None) """The version number for which the diagnostics are reported. If the document is not marked as open `null` can be provided.""" kind: str = attrs.field(validator=attrs.validators.in_(["full"]), default="full") """A full document diagnostic report.""" result_id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """An optional result id. If provided it will be sent on the next diagnostic request for the same document.""" @attrs.define class WorkspaceUnchangedDocumentDiagnosticReport: """An unchanged document diagnostic report for a workspace diagnostic result. @since 3.17.0""" # Since: 3.17.0 uri: str = attrs.field(validator=attrs.validators.instance_of(str)) """The URI for which diagnostic information is reported.""" result_id: str = attrs.field(validator=attrs.validators.instance_of(str)) """A result id which will be sent on the next diagnostic request for the same document.""" version: Optional[Union[int, None]] = attrs.field(default=None) """The version number for which the diagnostics are reported. If the document is not marked as open `null` can be provided.""" kind: str = attrs.field( validator=attrs.validators.in_(["unchanged"]), default="unchanged" ) """A document diagnostic report indicating no changes to the last result. A server can only return `unchanged` if result ids are provided.""" @attrs.define class NotebookCell: """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""" # Since: 3.17.0 kind: NotebookCellKind = attrs.field() """The cell's kind""" document: str = attrs.field(validator=attrs.validators.instance_of(str)) """The URI of the cell's text document content.""" metadata: Optional[LSPObject] = attrs.field(default=None) """Additional metadata stored with the cell. Note: should always be an object literal (e.g. LSPObject)""" execution_summary: Optional["ExecutionSummary"] = attrs.field(default=None) """Additional execution summary information if supported by the client.""" @attrs.define class NotebookCellArrayChange: """A change describing how to move a `NotebookCell` array from state S to S'. @since 3.17.0""" # Since: 3.17.0 start: int = attrs.field(validator=validators.uinteger_validator) """The start oftest of the cell that changed.""" delete_count: int = attrs.field(validator=validators.uinteger_validator) """The deleted cells""" cells: Optional[List[NotebookCell]] = attrs.field(default=None) """The new cells, if any""" @attrs.define class SelectedCompletionInfo: """Describes the currently selected completion item. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed range: Range = attrs.field() """The range that will be replaced if this completion item is accepted.""" text: str = attrs.field(validator=attrs.validators.instance_of(str)) """The text the range will be replaced with if this completion is accepted.""" @attrs.define class ClientCapabilities: """Defines the capabilities provided by the client.""" workspace: Optional["WorkspaceClientCapabilities"] = attrs.field(default=None) """Workspace specific client capabilities.""" text_document: Optional["TextDocumentClientCapabilities"] = attrs.field( default=None ) """Text document specific client capabilities.""" notebook_document: Optional["NotebookDocumentClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the notebook document support. @since 3.17.0""" # Since: 3.17.0 window: Optional["WindowClientCapabilities"] = attrs.field(default=None) """Window specific client capabilities.""" general: Optional["GeneralClientCapabilities"] = attrs.field(default=None) """General client capabilities. @since 3.16.0""" # Since: 3.16.0 experimental: Optional[LSPAny] = attrs.field(default=None) """Experimental client capabilities.""" @attrs.define class TextDocumentSyncOptions: open_close: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Open and close notifications are sent to the server. If omitted open close notification should not be sent.""" change: Optional[TextDocumentSyncKind] = attrs.field(default=None) """Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.""" will_save: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """If present will save notifications are sent to the server. If omitted the notification should not be sent.""" will_save_wait_until: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """If present will save wait until requests are sent to the server. If omitted the request should not be sent.""" save: Optional[Union[bool, SaveOptions]] = attrs.field(default=None) """If present save notifications are sent to the server. If omitted the notification should not be sent.""" @attrs.define class NotebookDocumentSyncOptionsNotebookSelectorType1CellsType: language: str = attrs.field(validator=attrs.validators.instance_of(str)) @attrs.define class NotebookDocumentSyncOptionsNotebookSelectorType1: notebook: Union[str, NotebookDocumentFilter] = attrs.field() """The notebook to be synced If a string value is provided it matches against the notebook type. '*' matches every notebook.""" cells: Optional[ List["NotebookDocumentSyncOptionsNotebookSelectorType1CellsType"] ] = attrs.field(default=None) """The cells of the matching notebook to be synced.""" @attrs.define class NotebookDocumentSyncOptionsNotebookSelectorType2CellsType: language: str = attrs.field(validator=attrs.validators.instance_of(str)) @attrs.define class NotebookDocumentSyncOptionsNotebookSelectorType2: cells: List[ "NotebookDocumentSyncOptionsNotebookSelectorType2CellsType" ] = attrs.field() """The cells of the matching notebook to be synced.""" notebook: Optional[Union[str, NotebookDocumentFilter]] = attrs.field(default=None) """The notebook to be synced If a string value is provided it matches against the notebook type. '*' matches every notebook.""" @attrs.define class NotebookDocumentSyncOptions: """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. @since 3.17.0""" # Since: 3.17.0 notebook_selector: List[ Union[ "NotebookDocumentSyncOptionsNotebookSelectorType1", "NotebookDocumentSyncOptionsNotebookSelectorType2", ] ] = attrs.field() """The notebooks to be synced""" save: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether save notification should be forwarded to the server. Will only be honored if mode === `notebook`.""" @attrs.define class NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1CellsType: language: str = attrs.field(validator=attrs.validators.instance_of(str)) @attrs.define class NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1: notebook: Union[str, NotebookDocumentFilter] = attrs.field() """The notebook to be synced If a string value is provided it matches against the notebook type. '*' matches every notebook.""" cells: Optional[ List["NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1CellsType"] ] = attrs.field(default=None) """The cells of the matching notebook to be synced.""" @attrs.define class NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2CellsType: language: str = attrs.field(validator=attrs.validators.instance_of(str)) @attrs.define class NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2: cells: List[ "NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2CellsType" ] = attrs.field() """The cells of the matching notebook to be synced.""" notebook: Optional[Union[str, NotebookDocumentFilter]] = attrs.field(default=None) """The notebook to be synced If a string value is provided it matches against the notebook type. '*' matches every notebook.""" @attrs.define class NotebookDocumentSyncRegistrationOptions: """Registration options specific to a notebook. @since 3.17.0""" # Since: 3.17.0 notebook_selector: List[ Union[ "NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1", "NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2", ] ] = attrs.field() """The notebooks to be synced""" save: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether save notification should be forwarded to the server. Will only be honored if mode === `notebook`.""" id: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The id used to register the request. The id can be used to deregister the request again. See also Registration#id.""" @attrs.define class WorkspaceFoldersServerCapabilities: supported: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The server has support for workspace folders""" change_notifications: Optional[Union[str, bool]] = attrs.field(default=None) """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.""" @attrs.define class FileOperationOptions: """Options for notifications/requests for user operations on files. @since 3.16.0""" # Since: 3.16.0 did_create: Optional[FileOperationRegistrationOptions] = attrs.field(default=None) """The server is interested in receiving didCreateFiles notifications.""" will_create: Optional[FileOperationRegistrationOptions] = attrs.field(default=None) """The server is interested in receiving willCreateFiles requests.""" did_rename: Optional[FileOperationRegistrationOptions] = attrs.field(default=None) """The server is interested in receiving didRenameFiles notifications.""" will_rename: Optional[FileOperationRegistrationOptions] = attrs.field(default=None) """The server is interested in receiving willRenameFiles requests.""" did_delete: Optional[FileOperationRegistrationOptions] = attrs.field(default=None) """The server is interested in receiving didDeleteFiles file notifications.""" will_delete: Optional[FileOperationRegistrationOptions] = attrs.field(default=None) """The server is interested in receiving willDeleteFiles file requests.""" @attrs.define class CodeDescription: """Structure to capture a description for an error code. @since 3.16.0""" # Since: 3.16.0 href: str = attrs.field(validator=attrs.validators.instance_of(str)) """An URI to open with more information about the diagnostic error.""" @attrs.define class DiagnosticRelatedInformation: """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 = attrs.field() """The location of this related diagnostic information.""" message: str = attrs.field(validator=attrs.validators.instance_of(str)) """The message of this related diagnostic information.""" @attrs.define class ParameterInformation: """Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.""" label: Union[str, Tuple[int, int]] = attrs.field() """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`.""" documentation: Optional[Union[str, MarkupContent]] = attrs.field(default=None) """The human-readable doc-comment of this parameter. Will be shown in the UI but can be omitted.""" @attrs.define class NotebookCellTextDocumentFilter: """A notebook cell text document filter denotes a cell text document by different properties. @since 3.17.0""" # Since: 3.17.0 notebook: Union[str, NotebookDocumentFilter] = attrs.field() """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: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """A language id like `python`. Will be matched against the language id of the notebook cell document. '*' matches every language.""" @attrs.define class FileOperationPatternOptions: """Matching options for the file operation pattern. @since 3.16.0""" # Since: 3.16.0 ignore_case: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The pattern should be matched ignoring casing.""" @attrs.define class ExecutionSummary: execution_order: int = attrs.field(validator=validators.uinteger_validator) """A strict monotonically increasing value indicating the execution order of a cell inside a notebook.""" success: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the execution was successful or not if known by the client.""" @attrs.define class WorkspaceClientCapabilities: """Workspace specific client capabilities.""" apply_edit: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'""" workspace_edit: Optional["WorkspaceEditClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to `WorkspaceEdit`s.""" did_change_configuration: Optional[ "DidChangeConfigurationClientCapabilities" ] = attrs.field(default=None) """Capabilities specific to the `workspace/didChangeConfiguration` notification.""" did_change_watched_files: Optional[ "DidChangeWatchedFilesClientCapabilities" ] = attrs.field(default=None) """Capabilities specific to the `workspace/didChangeWatchedFiles` notification.""" symbol: Optional["WorkspaceSymbolClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `workspace/symbol` request.""" execute_command: Optional["ExecuteCommandClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `workspace/executeCommand` request.""" workspace_folders: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for workspace folders. @since 3.6.0""" # Since: 3.6.0 configuration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports `workspace/configuration` requests. @since 3.6.0""" # Since: 3.6.0 semantic_tokens: Optional[ "SemanticTokensWorkspaceClientCapabilities" ] = attrs.field(default=None) """Capabilities specific to the semantic token requests scoped to the workspace. @since 3.16.0.""" # Since: 3.16.0. code_lens: Optional["CodeLensWorkspaceClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the code lens requests scoped to the workspace. @since 3.16.0.""" # Since: 3.16.0. file_operations: Optional["FileOperationClientCapabilities"] = attrs.field( default=None ) """The client has support for file notifications/requests for user operations on files. Since 3.16.0""" inline_value: Optional["InlineValueWorkspaceClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the inline values requests scoped to the workspace. @since 3.17.0.""" # Since: 3.17.0. inlay_hint: Optional["InlayHintWorkspaceClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the inlay hint requests scoped to the workspace. @since 3.17.0.""" # Since: 3.17.0. diagnostics: Optional["DiagnosticWorkspaceClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the diagnostic requests scoped to the workspace. @since 3.17.0.""" # Since: 3.17.0. @attrs.define class TextDocumentClientCapabilities: """Text document specific client capabilities.""" synchronization: Optional["TextDocumentSyncClientCapabilities"] = attrs.field( default=None ) """Defines which synchronization capabilities the client supports.""" completion: Optional["CompletionClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/completion` request.""" hover: Optional["HoverClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/hover` request.""" signature_help: Optional["SignatureHelpClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/signatureHelp` request.""" declaration: Optional["DeclarationClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/declaration` request. @since 3.14.0""" # Since: 3.14.0 definition: Optional["DefinitionClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/definition` request.""" type_definition: Optional["TypeDefinitionClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/typeDefinition` request. @since 3.6.0""" # Since: 3.6.0 implementation: Optional["ImplementationClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/implementation` request. @since 3.6.0""" # Since: 3.6.0 references: Optional["ReferenceClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/references` request.""" document_highlight: Optional["DocumentHighlightClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/documentHighlight` request.""" document_symbol: Optional["DocumentSymbolClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/documentSymbol` request.""" code_action: Optional["CodeActionClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/codeAction` request.""" code_lens: Optional["CodeLensClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/codeLens` request.""" document_link: Optional["DocumentLinkClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/documentLink` request.""" color_provider: Optional["DocumentColorClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/documentColor` and the `textDocument/colorPresentation` request. @since 3.6.0""" # Since: 3.6.0 formatting: Optional["DocumentFormattingClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/formatting` request.""" range_formatting: Optional[ "DocumentRangeFormattingClientCapabilities" ] = attrs.field(default=None) """Capabilities specific to the `textDocument/rangeFormatting` request.""" on_type_formatting: Optional[ "DocumentOnTypeFormattingClientCapabilities" ] = attrs.field(default=None) """Capabilities specific to the `textDocument/onTypeFormatting` request.""" rename: Optional["RenameClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/rename` request.""" folding_range: Optional["FoldingRangeClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/foldingRange` request. @since 3.10.0""" # Since: 3.10.0 selection_range: Optional["SelectionRangeClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/selectionRange` request. @since 3.15.0""" # Since: 3.15.0 publish_diagnostics: Optional["PublishDiagnosticsClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the `textDocument/publishDiagnostics` notification.""" call_hierarchy: Optional["CallHierarchyClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the various call hierarchy requests. @since 3.16.0""" # Since: 3.16.0 semantic_tokens: Optional["SemanticTokensClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the various semantic token request. @since 3.16.0""" # Since: 3.16.0 linked_editing_range: Optional[ "LinkedEditingRangeClientCapabilities" ] = attrs.field(default=None) """Capabilities specific to the `textDocument/linkedEditingRange` request. @since 3.16.0""" # Since: 3.16.0 moniker: Optional["MonikerClientCapabilities"] = attrs.field(default=None) """Client capabilities specific to the `textDocument/moniker` request. @since 3.16.0""" # Since: 3.16.0 type_hierarchy: Optional["TypeHierarchyClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the various type hierarchy requests. @since 3.17.0""" # Since: 3.17.0 inline_value: Optional["InlineValueClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/inlineValue` request. @since 3.17.0""" # Since: 3.17.0 inlay_hint: Optional["InlayHintClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the `textDocument/inlayHint` request. @since 3.17.0""" # Since: 3.17.0 diagnostic: Optional["DiagnosticClientCapabilities"] = attrs.field(default=None) """Capabilities specific to the diagnostic pull model. @since 3.17.0""" # Since: 3.17.0 inline_completion: Optional["InlineCompletionClientCapabilities"] = attrs.field( default=None ) """Client capabilities specific to inline completions. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed @attrs.define class NotebookDocumentClientCapabilities: """Capabilities specific to the notebook document support. @since 3.17.0""" # Since: 3.17.0 synchronization: "NotebookDocumentSyncClientCapabilities" = attrs.field() """Capabilities specific to notebook document synchronization @since 3.17.0""" # Since: 3.17.0 @attrs.define class WindowClientCapabilities: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.15.0 show_message: Optional["ShowMessageRequestClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the showMessage request. @since 3.16.0""" # Since: 3.16.0 show_document: Optional["ShowDocumentClientCapabilities"] = attrs.field( default=None ) """Capabilities specific to the showDocument request. @since 3.16.0""" # Since: 3.16.0 @attrs.define class GeneralClientCapabilitiesStaleRequestSupportType: cancel: bool = attrs.field(validator=attrs.validators.instance_of(bool)) """The client will actively cancel the request.""" retry_on_content_modified: List[str] = attrs.field() """The list of requests for which the client will retry the request if it receives a response with error code `ContentModified`""" @attrs.define class GeneralClientCapabilities: """General client capabilities. @since 3.16.0""" # Since: 3.16.0 stale_request_support: Optional[ "GeneralClientCapabilitiesStaleRequestSupportType" ] = attrs.field(default=None) """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 regular_expressions: Optional["RegularExpressionsClientCapabilities"] = attrs.field( default=None ) """Client capabilities specific to regular expressions. @since 3.16.0""" # Since: 3.16.0 markdown: Optional["MarkdownClientCapabilities"] = attrs.field(default=None) """Client capabilities specific to the client's markdown parser. @since 3.16.0""" # Since: 3.16.0 position_encodings: Optional[List[Union[PositionEncodingKind, str]]] = attrs.field( default=None ) """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""" # Since: 3.17.0 @attrs.define class RelativePattern: """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. @since 3.17.0""" # Since: 3.17.0 base_uri: Union[WorkspaceFolder, str] = attrs.field() """A workspace folder or a base URI to which this pattern will be matched against relatively.""" pattern: Pattern = attrs.field() """The actual glob pattern;""" @attrs.define class WorkspaceEditClientCapabilitiesChangeAnnotationSupportType: groups_on_label: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class WorkspaceEditClientCapabilities: document_changes: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports versioned document changes in `WorkspaceEdit`s""" resource_operations: Optional[List[ResourceOperationKind]] = attrs.field( default=None ) """The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders. @since 3.13.0""" # Since: 3.13.0 failure_handling: Optional[FailureHandlingKind] = attrs.field(default=None) """The failure handling strategy of a client if applying the workspace edit fails. @since 3.13.0""" # Since: 3.13.0 normalizes_line_endings: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.16.0 change_annotation_support: Optional[ "WorkspaceEditClientCapabilitiesChangeAnnotationSupportType" ] = attrs.field(default=None) """Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes. @since 3.16.0""" # Since: 3.16.0 @attrs.define class DidChangeConfigurationClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Did change configuration notification supports dynamic registration.""" @attrs.define class DidChangeWatchedFilesClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" relative_pattern_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client has support for {@link RelativePattern relative pattern} or not. @since 3.17.0""" # Since: 3.17.0 @attrs.define class WorkspaceSymbolClientCapabilitiesSymbolKindType: value_set: Optional[List[SymbolKind]] = attrs.field(default=None) """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.""" @attrs.define class WorkspaceSymbolClientCapabilitiesTagSupportType: value_set: List[SymbolTag] = attrs.field() """The tags supported by the client.""" @attrs.define class WorkspaceSymbolClientCapabilitiesResolveSupportType: properties: List[str] = attrs.field() """The properties that a client can resolve lazily. Usually `location.range`""" @attrs.define class WorkspaceSymbolClientCapabilities: """Client capabilities for a {@link WorkspaceSymbolRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Symbol request supports dynamic registration.""" symbol_kind: Optional[ "WorkspaceSymbolClientCapabilitiesSymbolKindType" ] = attrs.field(default=None) """Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.""" tag_support: Optional[ "WorkspaceSymbolClientCapabilitiesTagSupportType" ] = attrs.field(default=None) """The client supports tags on `SymbolInformation`. Clients supporting tags have to handle unknown tags gracefully. @since 3.16.0""" # Since: 3.16.0 resolve_support: Optional[ "WorkspaceSymbolClientCapabilitiesResolveSupportType" ] = attrs.field(default=None) """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""" # Since: 3.17.0 @attrs.define class ExecuteCommandClientCapabilities: """The client capabilities of a {@link ExecuteCommandRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Execute command supports dynamic registration.""" @attrs.define class SemanticTokensWorkspaceClientCapabilities: """@since 3.16.0""" # Since: 3.16.0 refresh_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class CodeLensWorkspaceClientCapabilities: """@since 3.16.0""" # Since: 3.16.0 refresh_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class FileOperationClientCapabilities: """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. @since 3.16.0""" # Since: 3.16.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client supports dynamic registration for file requests/notifications.""" did_create: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for sending didCreateFiles notifications.""" will_create: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for sending willCreateFiles requests.""" did_rename: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for sending didRenameFiles notifications.""" will_rename: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for sending willRenameFiles requests.""" did_delete: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for sending didDeleteFiles notifications.""" will_delete: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for sending willDeleteFiles requests.""" @attrs.define class InlineValueWorkspaceClientCapabilities: """Client workspace capabilities specific to inline values. @since 3.17.0""" # Since: 3.17.0 refresh_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class InlayHintWorkspaceClientCapabilities: """Client workspace capabilities specific to inlay hints. @since 3.17.0""" # Since: 3.17.0 refresh_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class DiagnosticWorkspaceClientCapabilities: """Workspace client capabilities specific to diagnostic pull requests. @since 3.17.0""" # Since: 3.17.0 refresh_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class TextDocumentSyncClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether text document synchronization supports dynamic registration.""" will_save: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports sending will save notifications.""" will_save_wait_until: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" did_save: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports did save notifications.""" @attrs.define class CompletionClientCapabilitiesCompletionItemTypeTagSupportType: value_set: List[CompletionItemTag] = attrs.field() """The tags supported by the client.""" @attrs.define class CompletionClientCapabilitiesCompletionItemTypeResolveSupportType: properties: List[str] = attrs.field() """The properties that a client can resolve lazily.""" @attrs.define class CompletionClientCapabilitiesCompletionItemTypeInsertTextModeSupportType: value_set: List[InsertTextMode] = attrs.field() @attrs.define class CompletionClientCapabilitiesCompletionItemType: snippet_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" commit_characters_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Client supports commit characters on a completion item.""" documentation_format: Optional[List[MarkupKind]] = attrs.field(default=None) """Client supports the following content formats for the documentation property. The order describes the preferred format of the client.""" deprecated_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Client supports the deprecated property on a completion item.""" preselect_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Client supports the preselect property on a completion item.""" tag_support: Optional[ "CompletionClientCapabilitiesCompletionItemTypeTagSupportType" ] = attrs.field(default=None) """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""" # Since: 3.15.0 insert_replace_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.16.0 resolve_support: Optional[ "CompletionClientCapabilitiesCompletionItemTypeResolveSupportType" ] = attrs.field(default=None) """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""" # Since: 3.16.0 insert_text_mode_support: Optional[ "CompletionClientCapabilitiesCompletionItemTypeInsertTextModeSupportType" ] = attrs.field(default=None) """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""" # Since: 3.16.0 label_details_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client has support for completion item label details (see also `CompletionItemLabelDetails`). @since 3.17.0""" # Since: 3.17.0 @attrs.define class CompletionClientCapabilitiesCompletionItemKindType: value_set: Optional[List[CompletionItemKind]] = attrs.field(default=None) """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.""" @attrs.define class CompletionClientCapabilitiesCompletionListType: item_defaults: Optional[List[str]] = attrs.field(default=None) """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""" # Since: 3.17.0 @attrs.define class CompletionClientCapabilities: """Completion client capabilities""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether completion supports dynamic registration.""" completion_item: Optional[ "CompletionClientCapabilitiesCompletionItemType" ] = attrs.field(default=None) """The client supports the following `CompletionItem` specific capabilities.""" completion_item_kind: Optional[ "CompletionClientCapabilitiesCompletionItemKindType" ] = attrs.field(default=None) insert_text_mode: Optional[InsertTextMode] = attrs.field(default=None) """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""" # Since: 3.17.0 context_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports to send additional context information for a `textDocument/completion` request.""" completion_list: Optional[ "CompletionClientCapabilitiesCompletionListType" ] = attrs.field(default=None) """The client supports the following `CompletionList` specific capabilities. @since 3.17.0""" # Since: 3.17.0 @attrs.define class HoverClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether hover supports dynamic registration.""" content_format: Optional[List[MarkupKind]] = attrs.field(default=None) """Client supports the following content formats for the content property. The order describes the preferred format of the client.""" @attrs.define class SignatureHelpClientCapabilitiesSignatureInformationTypeParameterInformationType: label_offset_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports processing label offsets instead of a simple label string. @since 3.14.0""" # Since: 3.14.0 @attrs.define class SignatureHelpClientCapabilitiesSignatureInformationType: documentation_format: Optional[List[MarkupKind]] = attrs.field(default=None) """Client supports the following content formats for the documentation property. The order describes the preferred format of the client.""" parameter_information: Optional[ "SignatureHelpClientCapabilitiesSignatureInformationTypeParameterInformationType" ] = attrs.field(default=None) """Client capabilities specific to parameter information.""" active_parameter_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports the `activeParameter` property on `SignatureInformation` literal. @since 3.16.0""" # Since: 3.16.0 @attrs.define class SignatureHelpClientCapabilities: """Client Capabilities for a {@link SignatureHelpRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether signature help supports dynamic registration.""" signature_information: Optional[ "SignatureHelpClientCapabilitiesSignatureInformationType" ] = attrs.field(default=None) """The client supports the following `SignatureInformation` specific properties.""" context_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.15.0 @attrs.define class DeclarationClientCapabilities: """@since 3.14.0""" # Since: 3.14.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" link_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports additional metadata in the form of declaration links.""" @attrs.define class DefinitionClientCapabilities: """Client Capabilities for a {@link DefinitionRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether definition supports dynamic registration.""" link_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports additional metadata in the form of definition links. @since 3.14.0""" # Since: 3.14.0 @attrs.define class TypeDefinitionClientCapabilities: """Since 3.6.0""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" link_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports additional metadata in the form of definition links. Since 3.14.0""" @attrs.define class ImplementationClientCapabilities: """@since 3.6.0""" # Since: 3.6.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" link_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports additional metadata in the form of definition links. @since 3.14.0""" # Since: 3.14.0 @attrs.define class ReferenceClientCapabilities: """Client Capabilities for a {@link ReferencesRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether references supports dynamic registration.""" @attrs.define class DocumentHighlightClientCapabilities: """Client Capabilities for a {@link DocumentHighlightRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether document highlight supports dynamic registration.""" @attrs.define class DocumentSymbolClientCapabilitiesSymbolKindType: value_set: Optional[List[SymbolKind]] = attrs.field(default=None) """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.""" @attrs.define class DocumentSymbolClientCapabilitiesTagSupportType: value_set: List[SymbolTag] = attrs.field() """The tags supported by the client.""" @attrs.define class DocumentSymbolClientCapabilities: """Client Capabilities for a {@link DocumentSymbolRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether document symbol supports dynamic registration.""" symbol_kind: Optional[ "DocumentSymbolClientCapabilitiesSymbolKindType" ] = attrs.field(default=None) """Specific capabilities for the `SymbolKind` in the `textDocument/documentSymbol` request.""" hierarchical_document_symbol_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports hierarchical document symbols.""" tag_support: Optional[ "DocumentSymbolClientCapabilitiesTagSupportType" ] = attrs.field(default=None) """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""" # Since: 3.16.0 label_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports an additional label presented in the UI when registering a document symbol provider. @since 3.16.0""" # Since: 3.16.0 @attrs.define class CodeActionClientCapabilitiesCodeActionLiteralSupportTypeCodeActionKindType: value_set: List[Union[CodeActionKind, str]] = attrs.field() """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.""" @attrs.define class CodeActionClientCapabilitiesCodeActionLiteralSupportType: code_action_kind: "CodeActionClientCapabilitiesCodeActionLiteralSupportTypeCodeActionKindType" = ( attrs.field() ) """The code action kind is support with the following value set.""" @attrs.define class CodeActionClientCapabilitiesResolveSupportType: properties: List[str] = attrs.field() """The properties that a client can resolve lazily.""" @attrs.define class CodeActionClientCapabilities: """The Client Capabilities of a {@link CodeActionRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether code action supports dynamic registration.""" code_action_literal_support: Optional[ "CodeActionClientCapabilitiesCodeActionLiteralSupportType" ] = attrs.field(default=None) """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""" # Since: 3.8.0 is_preferred_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether code action supports the `isPreferred` property. @since 3.15.0""" # Since: 3.15.0 disabled_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether code action supports the `disabled` property. @since 3.16.0""" # Since: 3.16.0 data_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether code action supports the `data` property which is preserved between a `textDocument/codeAction` and a `codeAction/resolve` request. @since 3.16.0""" # Since: 3.16.0 resolve_support: Optional[ "CodeActionClientCapabilitiesResolveSupportType" ] = attrs.field(default=None) """Whether the client supports resolving additional code action properties via a separate `codeAction/resolve` request. @since 3.16.0""" # Since: 3.16.0 honors_change_annotations: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.16.0 @attrs.define class CodeLensClientCapabilities: """The client capabilities of a {@link CodeLensRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether code lens supports dynamic registration.""" @attrs.define class DocumentLinkClientCapabilities: """The client capabilities of a {@link DocumentLinkRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether document link supports dynamic registration.""" tooltip_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client supports the `tooltip` property on `DocumentLink`. @since 3.15.0""" # Since: 3.15.0 @attrs.define class DocumentColorClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class DocumentFormattingClientCapabilities: """Client capabilities of a {@link DocumentFormattingRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether formatting supports dynamic registration.""" @attrs.define class DocumentRangeFormattingClientCapabilities: """Client capabilities of a {@link DocumentRangeFormattingRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether range formatting supports dynamic registration.""" ranges_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client supports formatting multiple ranges at once. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed @attrs.define class DocumentOnTypeFormattingClientCapabilities: """Client capabilities of a {@link DocumentOnTypeFormattingRequest}.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether on type formatting supports dynamic registration.""" @attrs.define class RenameClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether rename supports dynamic registration.""" prepare_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Client supports testing for validity of rename operations before execution. @since 3.12.0""" # Since: 3.12.0 prepare_support_default_behavior: Optional[ PrepareSupportDefaultBehavior ] = attrs.field(default=None) """Client supports the default behavior result. The value indicates the default behavior used by the client. @since 3.16.0""" # Since: 3.16.0 honors_change_annotations: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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 @attrs.define class FoldingRangeClientCapabilitiesFoldingRangeKindType: value_set: Optional[List[Union[FoldingRangeKind, str]]] = attrs.field(default=None) """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.""" @attrs.define class FoldingRangeClientCapabilitiesFoldingRangeType: collapsed_text: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.17.0 @attrs.define class FoldingRangeClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" range_limit: Optional[int] = attrs.field( validator=attrs.validators.optional(validators.uinteger_validator), default=None ) """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.""" line_folding_only: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" folding_range_kind: Optional[ "FoldingRangeClientCapabilitiesFoldingRangeKindType" ] = attrs.field(default=None) """Specific options for the folding range kind. @since 3.17.0""" # Since: 3.17.0 folding_range: Optional[ "FoldingRangeClientCapabilitiesFoldingRangeType" ] = attrs.field(default=None) """Specific options for the folding range. @since 3.17.0""" # Since: 3.17.0 @attrs.define class SelectionRangeClientCapabilities: dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class PublishDiagnosticsClientCapabilitiesTagSupportType: value_set: List[DiagnosticTag] = attrs.field() """The tags supported by the client.""" @attrs.define class PublishDiagnosticsClientCapabilities: """The publish diagnostic client capabilities.""" related_information: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the clients accepts diagnostics with related information.""" tag_support: Optional[ "PublishDiagnosticsClientCapabilitiesTagSupportType" ] = attrs.field(default=None) """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""" # Since: 3.15.0 version_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client interprets the version property of the `textDocument/publishDiagnostics` notification's parameter. @since 3.15.0""" # Since: 3.15.0 code_description_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Client supports a codeDescription property @since 3.16.0""" # Since: 3.16.0 data_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether code action supports the `data` property which is preserved between a `textDocument/publishDiagnostics` and `textDocument/codeAction` request. @since 3.16.0""" # Since: 3.16.0 @attrs.define class CallHierarchyClientCapabilities: """@since 3.16.0""" # Since: 3.16.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class SemanticTokensClientCapabilitiesRequestsTypeFullType1: delta: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client will send the `textDocument/semanticTokens/full/delta` request if the server provides a corresponding handler.""" @attrs.define class SemanticTokensClientCapabilitiesRequestsType: range: Optional[Union[bool, Any]] = attrs.field(default=None) """The client will send the `textDocument/semanticTokens/range` request if the server provides a corresponding handler.""" full: Optional[ Union[bool, "SemanticTokensClientCapabilitiesRequestsTypeFullType1"] ] = attrs.field(default=None) """The client will send the `textDocument/semanticTokens/full` request if the server provides a corresponding handler.""" @attrs.define class SemanticTokensClientCapabilities: """@since 3.16.0""" # Since: 3.16.0 requests: "SemanticTokensClientCapabilitiesRequestsType" = attrs.field() """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.""" token_types: List[str] = attrs.field() """The token types that the client supports.""" token_modifiers: List[str] = attrs.field() """The token modifiers that the client supports.""" formats: List[TokenFormat] = attrs.field() """The token formats the clients supports.""" dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" overlapping_token_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client supports tokens that can overlap each other.""" multiline_token_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client supports tokens that can span multiple lines.""" server_cancel_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.17.0 augments_syntax_tokens: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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""" # Since: 3.17.0 @attrs.define class LinkedEditingRangeClientCapabilities: """Client capabilities for the linked editing range request. @since 3.16.0""" # Since: 3.16.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class MonikerClientCapabilities: """Client capabilities specific to the moniker request. @since 3.16.0""" # Since: 3.16.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class TypeHierarchyClientCapabilities: """@since 3.17.0""" # Since: 3.17.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" @attrs.define class InlineValueClientCapabilities: """Client capabilities specific to inline values. @since 3.17.0""" # Since: 3.17.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether implementation supports dynamic registration for inline value providers.""" @attrs.define class InlayHintClientCapabilitiesResolveSupportType: properties: List[str] = attrs.field() """The properties that a client can resolve lazily.""" @attrs.define class InlayHintClientCapabilities: """Inlay hint client capabilities. @since 3.17.0""" # Since: 3.17.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether inlay hints support dynamic registration.""" resolve_support: Optional[ "InlayHintClientCapabilitiesResolveSupportType" ] = attrs.field(default=None) """Indicates which properties a client can resolve lazily on an inlay hint.""" @attrs.define class DiagnosticClientCapabilities: """Client capabilities specific to diagnostic pull requests. @since 3.17.0""" # Since: 3.17.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" related_document_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the clients supports related documents for document diagnostic pulls.""" @attrs.define class InlineCompletionClientCapabilities: """Client capabilities specific to inline completions. @since 3.18.0 @proposed""" # Since: 3.18.0 # Proposed dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether implementation supports dynamic registration for inline completion providers.""" @attrs.define class NotebookDocumentSyncClientCapabilities: """Notebook specific client capabilities. @since 3.17.0""" # Since: 3.17.0 dynamic_registration: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """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.""" execution_summary_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """The client supports sending execution summary data per cell.""" @attrs.define class ShowMessageRequestClientCapabilitiesMessageActionItemType: additional_properties_support: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) """Whether the client supports additional attributes which are preserved and send back to the server in the request's response.""" @attrs.define class ShowMessageRequestClientCapabilities: """Show message request client capabilities""" message_action_item: Optional[ "ShowMessageRequestClientCapabilitiesMessageActionItemType" ] = attrs.field(default=None) """Capabilities specific to the `MessageActionItem` type.""" @attrs.define class ShowDocumentClientCapabilities: """Client capabilities for the showDocument request. @since 3.16.0""" # Since: 3.16.0 support: bool = attrs.field(validator=attrs.validators.instance_of(bool)) """The client has support for the showDocument request.""" @attrs.define class RegularExpressionsClientCapabilities: """Client capabilities specific to regular expressions. @since 3.16.0""" # Since: 3.16.0 engine: str = attrs.field(validator=attrs.validators.instance_of(str)) """The engine's name.""" version: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The engine's version.""" @attrs.define class MarkdownClientCapabilities: """Client capabilities specific to the used markdown parser. @since 3.16.0""" # Since: 3.16.0 parser: str = attrs.field(validator=attrs.validators.instance_of(str)) """The name of the parser.""" version: Optional[str] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(str)), default=None, ) """The version of the parser.""" allowed_tags: Optional[List[str]] = attrs.field(default=None) """A list of HTML tags that the client allows / supports in Markdown. @since 3.17.0""" # Since: 3.17.0 @attrs.define class TextDocumentColorPresentationOptions: work_done_progress: Optional[bool] = attrs.field( validator=attrs.validators.optional(attrs.validators.instance_of(bool)), default=None, ) document_selector: Optional[Union[DocumentSelector, None]] = attrs.field( default=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.""" @attrs.define class ResponseError: code: int = attrs.field(validator=validators.integer_validator) """A number indicating the error type that occurred.""" message: str = attrs.field(validator=attrs.validators.instance_of(str)) """A string providing a short description of the error.""" data: Optional[LSPAny] = attrs.field(default=None) """A primitive or structured value that contains additional information about the error. Can be omitted.""" @attrs.define class ResponseErrorMessage: id: Optional[Union[int, str]] = attrs.field(default=None) """The request id where the error occurred.""" error: Optional[ResponseError] = attrs.field(default=None) """The error object in case a request fails.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentImplementationRequest: """A request to resolve the implementation locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Definition} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: ImplementationParams = attrs.field() method: str = "textDocument/implementation" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentImplementationResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[Definition, List[DefinitionLink], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentTypeDefinitionRequest: """A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Definition} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: TypeDefinitionParams = attrs.field() method: str = "textDocument/typeDefinition" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentTypeDefinitionResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[Definition, List[DefinitionLink], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWorkspaceFoldersRequest: """The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.""" id: Union[int, str] = attrs.field() """The request id.""" params: Optional[None] = attrs.field(default=None) method: str = "workspace/workspaceFolders" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWorkspaceFoldersResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[WorkspaceFolder], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") WorkspaceConfigurationParams = ConfigurationParams @attrs.define class WorkspaceConfigurationRequest: """The 'workspace/configuration' request is sent from the server to the client to fetch a certain configuration setting. This pull model replaces the old push model were the client signaled configuration change via an event. If the server still needs to react to configuration changes (since the server caches the result of `workspace/configuration` requests) the server should register for an empty configuration change event and empty the cache if such an event is received.""" id: Union[int, str] = attrs.field() """The request id.""" params: WorkspaceConfigurationParams = attrs.field() method: str = "workspace/configuration" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceConfigurationResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: List[LSPAny] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentColorRequest: """A request to list all color symbols found in a given text document. The request's parameter is of type {@link DocumentColorParams} the response is of type {@link ColorInformation ColorInformation[]} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentColorParams = attrs.field() method: str = "textDocument/documentColor" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentColorResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: List[ColorInformation] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentColorPresentationRequest: """A request to list all presentation for a color. The request's parameter is of type {@link ColorPresentationParams} the response is of type {@link ColorInformation ColorInformation[]} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: ColorPresentationParams = attrs.field() method: str = "textDocument/colorPresentation" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentColorPresentationResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: List[ColorPresentation] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentFoldingRangeRequest: """A request to provide folding ranges in a document. The request's parameter is of type {@link FoldingRangeParams}, the response is of type {@link FoldingRangeList} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: FoldingRangeParams = attrs.field() method: str = "textDocument/foldingRange" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentFoldingRangeResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[FoldingRange], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDeclarationRequest: """A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPositionParams} the response is of type {@link Declaration} or a typed array of {@link DeclarationLink} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: DeclarationParams = attrs.field() method: str = "textDocument/declaration" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDeclarationResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[Declaration, List[DeclarationLink], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSelectionRangeRequest: """A request to provide selection ranges in a document. The request's parameter is of type {@link SelectionRangeParams}, the response is of type {@link SelectionRange SelectionRange[]} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: SelectionRangeParams = attrs.field() method: str = "textDocument/selectionRange" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSelectionRangeResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[SelectionRange], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowWorkDoneProgressCreateRequest: """The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress reporting from the server.""" id: Union[int, str] = attrs.field() """The request id.""" params: WorkDoneProgressCreateParams = attrs.field() method: str = "window/workDoneProgress/create" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowWorkDoneProgressCreateResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentPrepareCallHierarchyRequest: """A request to result a `CallHierarchyItem` in a document at a given position. Can be used as an input to an incoming or outgoing call hierarchy. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: CallHierarchyPrepareParams = attrs.field() method: str = "textDocument/prepareCallHierarchy" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentPrepareCallHierarchyResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[CallHierarchyItem], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class CallHierarchyIncomingCallsRequest: """A request to resolve the incoming calls for a given `CallHierarchyItem`. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: CallHierarchyIncomingCallsParams = attrs.field() method: str = "callHierarchy/incomingCalls" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class CallHierarchyIncomingCallsResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[CallHierarchyIncomingCall], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class CallHierarchyOutgoingCallsRequest: """A request to resolve the outgoing calls for a given `CallHierarchyItem`. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: CallHierarchyOutgoingCallsParams = attrs.field() method: str = "callHierarchy/outgoingCalls" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class CallHierarchyOutgoingCallsResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[CallHierarchyOutgoingCall], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSemanticTokensFullRequest: """@since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: SemanticTokensParams = attrs.field() method: str = "textDocument/semanticTokens/full" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSemanticTokensFullResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[SemanticTokens, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSemanticTokensFullDeltaRequest: """@since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: SemanticTokensDeltaParams = attrs.field() method: str = "textDocument/semanticTokens/full/delta" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSemanticTokensFullDeltaResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[SemanticTokens, SemanticTokensDelta, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSemanticTokensRangeRequest: """@since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: SemanticTokensRangeParams = attrs.field() method: str = "textDocument/semanticTokens/range" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSemanticTokensRangeResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[SemanticTokens, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceSemanticTokensRefreshRequest: """@since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: Optional[None] = attrs.field(default=None) method: str = "workspace/semanticTokens/refresh" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceSemanticTokensRefreshResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowShowDocumentRequest: """A request to show a document. This request might open an external program depending on the value of the URI to open. For example a request to open `https://code.visualstudio.com/` will very likely open the URI in a WEB browser. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: ShowDocumentParams = attrs.field() method: str = "window/showDocument" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowShowDocumentResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: ShowDocumentResult = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentLinkedEditingRangeRequest: """A request to provide ranges that can be edited together. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: LinkedEditingRangeParams = attrs.field() method: str = "textDocument/linkedEditingRange" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentLinkedEditingRangeResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[LinkedEditingRanges, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWillCreateFilesRequest: """The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client. The request can return a `WorkspaceEdit` which will be applied to workspace before the files are created. Hence the `WorkspaceEdit` can not manipulate the content of the file to be created. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: CreateFilesParams = attrs.field() method: str = "workspace/willCreateFiles" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWillCreateFilesResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[WorkspaceEdit, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWillRenameFilesRequest: """The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: RenameFilesParams = attrs.field() method: str = "workspace/willRenameFiles" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWillRenameFilesResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[WorkspaceEdit, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWillDeleteFilesRequest: """The did delete files notification is sent from the client to the server when files were deleted from within the client. @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: DeleteFilesParams = attrs.field() method: str = "workspace/willDeleteFiles" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceWillDeleteFilesResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[WorkspaceEdit, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentMonikerRequest: """A request to get the moniker of a symbol at a given text document position. The request parameter is of type {@link TextDocumentPositionParams}. The response is of type {@link Moniker Moniker[]} or `null`.""" id: Union[int, str] = attrs.field() """The request id.""" params: MonikerParams = attrs.field() method: str = "textDocument/moniker" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentMonikerResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[Moniker], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentPrepareTypeHierarchyRequest: """A request to result a `TypeHierarchyItem` in a document at a given position. Can be used as an input to a subtypes or supertypes type hierarchy. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: TypeHierarchyPrepareParams = attrs.field() method: str = "textDocument/prepareTypeHierarchy" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentPrepareTypeHierarchyResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TypeHierarchyItem], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TypeHierarchySupertypesRequest: """A request to resolve the supertypes for a given `TypeHierarchyItem`. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: TypeHierarchySupertypesParams = attrs.field() method: str = "typeHierarchy/supertypes" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TypeHierarchySupertypesResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TypeHierarchyItem], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TypeHierarchySubtypesRequest: """A request to resolve the subtypes for a given `TypeHierarchyItem`. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: TypeHierarchySubtypesParams = attrs.field() method: str = "typeHierarchy/subtypes" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TypeHierarchySubtypesResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TypeHierarchyItem], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentInlineValueRequest: """A request to provide inline values in a document. The request's parameter is of type {@link InlineValueParams}, the response is of type {@link InlineValue InlineValue[]} or a Thenable that resolves to such. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: InlineValueParams = attrs.field() method: str = "textDocument/inlineValue" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentInlineValueResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[InlineValue], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceInlineValueRefreshRequest: """@since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: Optional[None] = attrs.field(default=None) method: str = "workspace/inlineValue/refresh" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceInlineValueRefreshResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentInlayHintRequest: """A request to provide inlay hints in a document. The request's parameter is of type {@link InlayHintsParams}, the response is of type {@link InlayHint InlayHint[]} or a Thenable that resolves to such. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: InlayHintParams = attrs.field() method: str = "textDocument/inlayHint" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentInlayHintResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[InlayHint], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class InlayHintResolveRequest: """A request to resolve additional properties for an inlay hint. The request's parameter is of type {@link InlayHint}, the response is of type {@link InlayHint} or a Thenable that resolves to such. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: InlayHint = attrs.field() method: str = "inlayHint/resolve" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class InlayHintResolveResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: InlayHint = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceInlayHintRefreshRequest: """@since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: Optional[None] = attrs.field(default=None) method: str = "workspace/inlayHint/refresh" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceInlayHintRefreshResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDiagnosticRequest: """The document diagnostic request definition. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentDiagnosticParams = attrs.field() method: str = "textDocument/diagnostic" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDiagnosticResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: DocumentDiagnosticReport = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDiagnosticRequest: """The workspace diagnostic request definition. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: WorkspaceDiagnosticParams = attrs.field() method: str = "workspace/diagnostic" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDiagnosticResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: WorkspaceDiagnosticReport = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDiagnosticRefreshRequest: """The diagnostic refresh request definition. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: Optional[None] = attrs.field(default=None) method: str = "workspace/diagnostic/refresh" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDiagnosticRefreshResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentInlineCompletionRequest: """A request to provide inline completions in a document. The request's parameter is of type {@link InlineCompletionParams}, the response is of type {@link InlineCompletion InlineCompletion[]} or a Thenable that resolves to such. @since 3.18.0 @proposed""" id: Union[int, str] = attrs.field() """The request id.""" params: InlineCompletionParams = attrs.field() method: str = "textDocument/inlineCompletion" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentInlineCompletionResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[InlineCompletionList, List[InlineCompletionItem], None] = attrs.field( default=None ) jsonrpc: str = attrs.field(default="2.0") @attrs.define class ClientRegisterCapabilityRequest: """The `client/registerCapability` request is sent from the server to the client to register a new capability handler on the client side.""" id: Union[int, str] = attrs.field() """The request id.""" params: RegistrationParams = attrs.field() method: str = "client/registerCapability" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class ClientRegisterCapabilityResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class ClientUnregisterCapabilityRequest: """The `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability handler on the client side.""" id: Union[int, str] = attrs.field() """The request id.""" params: UnregistrationParams = attrs.field() method: str = "client/unregisterCapability" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class ClientUnregisterCapabilityResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class InitializeRequest: """The initialize request is sent from the client to the server. It is sent once as the request after starting up the server. The requests parameter is of type {@link InitializeParams} the response if of type {@link InitializeResult} of a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: InitializeParams = attrs.field() method: str = "initialize" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class InitializeResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: InitializeResult = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class ShutdownRequest: """A shutdown request is sent from the client to the server. It is sent once when the client decides to shutdown the server. The only notification that is sent after a shutdown request is the exit event.""" id: Union[int, str] = attrs.field() """The request id.""" params: Optional[None] = attrs.field(default=None) method: str = "shutdown" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class ShutdownResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowShowMessageRequestRequest: """The show message request is sent from the server to the client to show a message and a set of options actions to the user.""" id: Union[int, str] = attrs.field() """The request id.""" params: ShowMessageRequestParams = attrs.field() method: str = "window/showMessageRequest" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowShowMessageRequestResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[MessageActionItem, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentWillSaveWaitUntilRequest: """A document will save request is sent from the client to the server before the document is actually saved. The request can return an array of TextEdits which will be applied to the text document before it is saved. Please note that clients might drop results if computing the text edits took too long or if a server constantly fails on this request. This is done to keep the save fast and reliable.""" id: Union[int, str] = attrs.field() """The request id.""" params: WillSaveTextDocumentParams = attrs.field() method: str = "textDocument/willSaveWaitUntil" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentWillSaveWaitUntilResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TextEdit], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentCompletionRequest: """Request to request completion at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of type {@link CompletionItem CompletionItem[]} or {@link CompletionList} or a Thenable that resolves to such. The request can delay the computation of the {@link CompletionItem.detail `detail`} and {@link CompletionItem.documentation `documentation`} properties to the `completionItem/resolve` request. However, properties that are needed for the initial sorting and filtering, like `sortText`, `filterText`, `insertText`, and `textEdit`, must not be changed during resolve.""" id: Union[int, str] = attrs.field() """The request id.""" params: CompletionParams = attrs.field() method: str = "textDocument/completion" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentCompletionResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[CompletionItem], CompletionList, None] = attrs.field( default=None ) jsonrpc: str = attrs.field(default="2.0") @attrs.define class CompletionItemResolveRequest: """Request to resolve additional information for a given completion item.The request's parameter is of type {@link CompletionItem} the response is of type {@link CompletionItem} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: CompletionItem = attrs.field() method: str = "completionItem/resolve" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class CompletionItemResolveResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: CompletionItem = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentHoverRequest: """Request to request hover information at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of type {@link Hover} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: HoverParams = attrs.field() method: str = "textDocument/hover" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentHoverResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[Hover, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSignatureHelpRequest: id: Union[int, str] = attrs.field() """The request id.""" params: SignatureHelpParams = attrs.field() method: str = "textDocument/signatureHelp" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentSignatureHelpResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[SignatureHelp, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDefinitionRequest: """A request to resolve the definition location of a symbol at a given text document position. The request's parameter is of type {@link TextDocumentPosition} the response is of either type {@link Definition} or a typed array of {@link DefinitionLink} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: DefinitionParams = attrs.field() method: str = "textDocument/definition" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDefinitionResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[Definition, List[DefinitionLink], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentReferencesRequest: """A request to resolve project-wide references for the symbol denoted by the given text document position. The request's parameter is of type {@link ReferenceParams} the response is of type {@link Location Location[]} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: ReferenceParams = attrs.field() method: str = "textDocument/references" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentReferencesResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[Location], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentHighlightRequest: """Request to resolve a {@link DocumentHighlight} for a given text document position. The request's parameter is of type {@link TextDocumentPosition} the request response is an array of type {@link DocumentHighlight} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentHighlightParams = attrs.field() method: str = "textDocument/documentHighlight" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentHighlightResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[DocumentHighlight], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentSymbolRequest: """A request to list all symbols found in a given text document. The request's parameter is of type {@link TextDocumentIdentifier} the response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentSymbolParams = attrs.field() method: str = "textDocument/documentSymbol" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentSymbolResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[SymbolInformation], List[DocumentSymbol], None] = attrs.field( default=None ) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentCodeActionRequest: """A request to provide commands for the given text document and range.""" id: Union[int, str] = attrs.field() """The request id.""" params: CodeActionParams = attrs.field() method: str = "textDocument/codeAction" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentCodeActionResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[Union[Command, CodeAction]], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class CodeActionResolveRequest: """Request to resolve additional information for a given code action.The request's parameter is of type {@link CodeAction} the response is of type {@link CodeAction} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: CodeAction = attrs.field() method: str = "codeAction/resolve" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class CodeActionResolveResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: CodeAction = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceSymbolRequest: """A request to list project-wide symbols matching the query string given by the {@link WorkspaceSymbolParams}. The response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable that resolves to such. @since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients need to advertise support for WorkspaceSymbols via the client capability `workspace.symbol.resolveSupport`.""" id: Union[int, str] = attrs.field() """The request id.""" params: WorkspaceSymbolParams = attrs.field() method: str = "workspace/symbol" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceSymbolResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[SymbolInformation], List[WorkspaceSymbol], None] = attrs.field( default=None ) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceSymbolResolveRequest: """A request to resolve the range inside the workspace symbol's location. @since 3.17.0""" id: Union[int, str] = attrs.field() """The request id.""" params: WorkspaceSymbol = attrs.field() method: str = "workspaceSymbol/resolve" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceSymbolResolveResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: WorkspaceSymbol = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentCodeLensRequest: """A request to provide code lens for the given text document.""" id: Union[int, str] = attrs.field() """The request id.""" params: CodeLensParams = attrs.field() method: str = "textDocument/codeLens" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentCodeLensResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[CodeLens], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class CodeLensResolveRequest: """A request to resolve a command for a given code lens.""" id: Union[int, str] = attrs.field() """The request id.""" params: CodeLens = attrs.field() method: str = "codeLens/resolve" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class CodeLensResolveResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: CodeLens = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceCodeLensRefreshRequest: """A request to refresh all code actions @since 3.16.0""" id: Union[int, str] = attrs.field() """The request id.""" params: Optional[None] = attrs.field(default=None) method: str = "workspace/codeLens/refresh" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceCodeLensRefreshResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: None = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentLinkRequest: """A request to provide document links""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentLinkParams = attrs.field() method: str = "textDocument/documentLink" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDocumentLinkResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[DocumentLink], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class DocumentLinkResolveRequest: """Request to resolve additional information for a given document link. The request's parameter is of type {@link DocumentLink} the response is of type {@link DocumentLink} or a Thenable that resolves to such.""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentLink = attrs.field() method: str = "documentLink/resolve" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class DocumentLinkResolveResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: DocumentLink = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentFormattingRequest: """A request to format a whole document.""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentFormattingParams = attrs.field() method: str = "textDocument/formatting" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentFormattingResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TextEdit], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentRangeFormattingRequest: """A request to format a range in a document.""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentRangeFormattingParams = attrs.field() method: str = "textDocument/rangeFormatting" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentRangeFormattingResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TextEdit], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentRangesFormattingRequest: """A request to format ranges in a document. @since 3.18.0 @proposed""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentRangesFormattingParams = attrs.field() method: str = "textDocument/rangesFormatting" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentRangesFormattingResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TextEdit], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentOnTypeFormattingRequest: """A request to format a document on type.""" id: Union[int, str] = attrs.field() """The request id.""" params: DocumentOnTypeFormattingParams = attrs.field() method: str = "textDocument/onTypeFormatting" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentOnTypeFormattingResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[List[TextEdit], None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentRenameRequest: """A request to rename a symbol.""" id: Union[int, str] = attrs.field() """The request id.""" params: RenameParams = attrs.field() method: str = "textDocument/rename" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentRenameResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[WorkspaceEdit, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentPrepareRenameRequest: """A request to test and perform the setup necessary for a rename. @since 3.16 - support for default behavior""" id: Union[int, str] = attrs.field() """The request id.""" params: PrepareRenameParams = attrs.field() method: str = "textDocument/prepareRename" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentPrepareRenameResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[PrepareRenameResult, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceExecuteCommandRequest: """A request send from the client to the server to execute a command. The request might return a workspace edit which the client will apply to the workspace.""" id: Union[int, str] = attrs.field() """The request id.""" params: ExecuteCommandParams = attrs.field() method: str = "workspace/executeCommand" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceExecuteCommandResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: Union[LSPAny, None] = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceApplyEditRequest: """A request sent from the server to the client to modified certain resources.""" id: Union[int, str] = attrs.field() """The request id.""" params: ApplyWorkspaceEditParams = attrs.field() method: str = "workspace/applyEdit" """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceApplyEditResponse: id: Optional[Union[int, str]] = attrs.field() """The request id.""" result: ApplyWorkspaceEditResult = attrs.field(default=None) jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDidChangeWorkspaceFoldersNotification: """The `workspace/didChangeWorkspaceFolders` notification is sent from the client to the server when the workspace folder configuration changes.""" params: DidChangeWorkspaceFoldersParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["workspace/didChangeWorkspaceFolders"]), default="workspace/didChangeWorkspaceFolders", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowWorkDoneProgressCancelNotification: """The `window/workDoneProgress/cancel` notification is sent from the client to the server to cancel a progress initiated on the server side.""" params: WorkDoneProgressCancelParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["window/workDoneProgress/cancel"]), default="window/workDoneProgress/cancel", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDidCreateFilesNotification: """The did create files notification is sent from the client to the server when files were created from within the client. @since 3.16.0""" params: CreateFilesParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["workspace/didCreateFiles"]), default="workspace/didCreateFiles", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDidRenameFilesNotification: """The did rename files notification is sent from the client to the server when files were renamed from within the client. @since 3.16.0""" params: RenameFilesParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["workspace/didRenameFiles"]), default="workspace/didRenameFiles", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDidDeleteFilesNotification: """The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client. @since 3.16.0""" params: DeleteFilesParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["workspace/didDeleteFiles"]), default="workspace/didDeleteFiles", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class NotebookDocumentDidOpenNotification: """A notification sent when a notebook opens. @since 3.17.0""" params: DidOpenNotebookDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["notebookDocument/didOpen"]), default="notebookDocument/didOpen", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class NotebookDocumentDidChangeNotification: params: DidChangeNotebookDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["notebookDocument/didChange"]), default="notebookDocument/didChange", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class NotebookDocumentDidSaveNotification: """A notification sent when a notebook document is saved. @since 3.17.0""" params: DidSaveNotebookDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["notebookDocument/didSave"]), default="notebookDocument/didSave", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class NotebookDocumentDidCloseNotification: """A notification sent when a notebook closes. @since 3.17.0""" params: DidCloseNotebookDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["notebookDocument/didClose"]), default="notebookDocument/didClose", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class InitializedNotification: """The initialized notification is sent from the client to the server after the client is fully initialized and the server is allowed to send requests from the server to the client.""" params: InitializedParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["initialized"]), default="initialized", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class ExitNotification: """The exit event is sent from the client to the server to ask the server to exit its process.""" params: Optional[None] = attrs.field(default=None) method: str = attrs.field( validator=attrs.validators.in_(["exit"]), default="exit", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDidChangeConfigurationNotification: """The configuration change notification is sent from the client to the server when the client's configuration has changed. The notification contains the changed configuration as defined by the language client.""" params: DidChangeConfigurationParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["workspace/didChangeConfiguration"]), default="workspace/didChangeConfiguration", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowShowMessageNotification: """The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.""" params: ShowMessageParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["window/showMessage"]), default="window/showMessage", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WindowLogMessageNotification: """The log message notification is sent from the server to the client to ask the client to log a particular message.""" params: LogMessageParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["window/logMessage"]), default="window/logMessage", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TelemetryEventNotification: """The telemetry event notification is sent from the server to the client to ask the client to log telemetry data.""" params: LSPAny = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["telemetry/event"]), default="telemetry/event", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDidOpenNotification: """The document open notification is sent from the client to the server to signal newly opened text documents. The document's truth is now managed by the client and the server must not try to read the document's truth using the document's uri. Open in this sense means it is managed by the client. It doesn't necessarily mean that its content is presented in an editor. An open notification must not be sent more than once without a corresponding close notification send before. This means open and close notification must be balanced and the max open count is one.""" params: DidOpenTextDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["textDocument/didOpen"]), default="textDocument/didOpen", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDidChangeNotification: """The document change notification is sent from the client to the server to signal changes to a text document.""" params: DidChangeTextDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["textDocument/didChange"]), default="textDocument/didChange", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDidCloseNotification: """The document close notification is sent from the client to the server when the document got closed in the client. The document's truth now exists where the document's uri points to (e.g. if the document's uri is a file uri the truth now exists on disk). As with the open notification the close notification is about managing the document's content. Receiving a close notification doesn't mean that the document was open in an editor before. A close notification requires a previous open notification to be sent.""" params: DidCloseTextDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["textDocument/didClose"]), default="textDocument/didClose", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentDidSaveNotification: """The document save notification is sent from the client to the server when the document got saved in the client.""" params: DidSaveTextDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["textDocument/didSave"]), default="textDocument/didSave", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentWillSaveNotification: """A document will save notification is sent from the client to the server before the document is actually saved.""" params: WillSaveTextDocumentParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["textDocument/willSave"]), default="textDocument/willSave", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class WorkspaceDidChangeWatchedFilesNotification: """The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client.""" params: DidChangeWatchedFilesParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["workspace/didChangeWatchedFiles"]), default="workspace/didChangeWatchedFiles", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class TextDocumentPublishDiagnosticsNotification: """Diagnostics notification are sent from the server to the client to signal results of validation runs.""" params: PublishDiagnosticsParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["textDocument/publishDiagnostics"]), default="textDocument/publishDiagnostics", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class SetTraceNotification: params: SetTraceParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["$/setTrace"]), default="$/setTrace", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class LogTraceNotification: params: LogTraceParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["$/logTrace"]), default="$/logTrace", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class CancelRequestNotification: params: CancelParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["$/cancelRequest"]), default="$/cancelRequest", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @attrs.define class ProgressNotification: params: ProgressParams = attrs.field() method: str = attrs.field( validator=attrs.validators.in_(["$/progress"]), default="$/progress", ) """The method to be invoked.""" jsonrpc: str = attrs.field(default="2.0") @enum.unique class MessageDirection(enum.Enum): Both = "both" ClientToServer = "clientToServer" ServerToClient = "serverToClient" CALL_HIERARCHY_INCOMING_CALLS = "callHierarchy/incomingCalls" CALL_HIERARCHY_OUTGOING_CALLS = "callHierarchy/outgoingCalls" CANCEL_REQUEST = "$/cancelRequest" CLIENT_REGISTER_CAPABILITY = "client/registerCapability" CLIENT_UNREGISTER_CAPABILITY = "client/unregisterCapability" CODE_ACTION_RESOLVE = "codeAction/resolve" CODE_LENS_RESOLVE = "codeLens/resolve" COMPLETION_ITEM_RESOLVE = "completionItem/resolve" DOCUMENT_LINK_RESOLVE = "documentLink/resolve" EXIT = "exit" INITIALIZE = "initialize" INITIALIZED = "initialized" INLAY_HINT_RESOLVE = "inlayHint/resolve" LOG_TRACE = "$/logTrace" NOTEBOOK_DOCUMENT_DID_CHANGE = "notebookDocument/didChange" NOTEBOOK_DOCUMENT_DID_CLOSE = "notebookDocument/didClose" NOTEBOOK_DOCUMENT_DID_OPEN = "notebookDocument/didOpen" NOTEBOOK_DOCUMENT_DID_SAVE = "notebookDocument/didSave" PROGRESS = "$/progress" SET_TRACE = "$/setTrace" SHUTDOWN = "shutdown" TELEMETRY_EVENT = "telemetry/event" TEXT_DOCUMENT_CODE_ACTION = "textDocument/codeAction" TEXT_DOCUMENT_CODE_LENS = "textDocument/codeLens" TEXT_DOCUMENT_COLOR_PRESENTATION = "textDocument/colorPresentation" TEXT_DOCUMENT_COMPLETION = "textDocument/completion" TEXT_DOCUMENT_DECLARATION = "textDocument/declaration" TEXT_DOCUMENT_DEFINITION = "textDocument/definition" TEXT_DOCUMENT_DIAGNOSTIC = "textDocument/diagnostic" TEXT_DOCUMENT_DID_CHANGE = "textDocument/didChange" TEXT_DOCUMENT_DID_CLOSE = "textDocument/didClose" TEXT_DOCUMENT_DID_OPEN = "textDocument/didOpen" TEXT_DOCUMENT_DID_SAVE = "textDocument/didSave" TEXT_DOCUMENT_DOCUMENT_COLOR = "textDocument/documentColor" TEXT_DOCUMENT_DOCUMENT_HIGHLIGHT = "textDocument/documentHighlight" TEXT_DOCUMENT_DOCUMENT_LINK = "textDocument/documentLink" TEXT_DOCUMENT_DOCUMENT_SYMBOL = "textDocument/documentSymbol" TEXT_DOCUMENT_FOLDING_RANGE = "textDocument/foldingRange" TEXT_DOCUMENT_FORMATTING = "textDocument/formatting" TEXT_DOCUMENT_HOVER = "textDocument/hover" TEXT_DOCUMENT_IMPLEMENTATION = "textDocument/implementation" TEXT_DOCUMENT_INLAY_HINT = "textDocument/inlayHint" TEXT_DOCUMENT_INLINE_COMPLETION = "textDocument/inlineCompletion" TEXT_DOCUMENT_INLINE_VALUE = "textDocument/inlineValue" TEXT_DOCUMENT_LINKED_EDITING_RANGE = "textDocument/linkedEditingRange" TEXT_DOCUMENT_MONIKER = "textDocument/moniker" TEXT_DOCUMENT_ON_TYPE_FORMATTING = "textDocument/onTypeFormatting" TEXT_DOCUMENT_PREPARE_CALL_HIERARCHY = "textDocument/prepareCallHierarchy" TEXT_DOCUMENT_PREPARE_RENAME = "textDocument/prepareRename" TEXT_DOCUMENT_PREPARE_TYPE_HIERARCHY = "textDocument/prepareTypeHierarchy" TEXT_DOCUMENT_PUBLISH_DIAGNOSTICS = "textDocument/publishDiagnostics" TEXT_DOCUMENT_RANGES_FORMATTING = "textDocument/rangesFormatting" TEXT_DOCUMENT_RANGE_FORMATTING = "textDocument/rangeFormatting" TEXT_DOCUMENT_REFERENCES = "textDocument/references" TEXT_DOCUMENT_RENAME = "textDocument/rename" TEXT_DOCUMENT_SELECTION_RANGE = "textDocument/selectionRange" TEXT_DOCUMENT_SEMANTIC_TOKENS_FULL = "textDocument/semanticTokens/full" TEXT_DOCUMENT_SEMANTIC_TOKENS_FULL_DELTA = "textDocument/semanticTokens/full/delta" TEXT_DOCUMENT_SEMANTIC_TOKENS_RANGE = "textDocument/semanticTokens/range" TEXT_DOCUMENT_SIGNATURE_HELP = "textDocument/signatureHelp" TEXT_DOCUMENT_TYPE_DEFINITION = "textDocument/typeDefinition" TEXT_DOCUMENT_WILL_SAVE = "textDocument/willSave" TEXT_DOCUMENT_WILL_SAVE_WAIT_UNTIL = "textDocument/willSaveWaitUntil" TYPE_HIERARCHY_SUBTYPES = "typeHierarchy/subtypes" TYPE_HIERARCHY_SUPERTYPES = "typeHierarchy/supertypes" WINDOW_LOG_MESSAGE = "window/logMessage" WINDOW_SHOW_DOCUMENT = "window/showDocument" WINDOW_SHOW_MESSAGE = "window/showMessage" WINDOW_SHOW_MESSAGE_REQUEST = "window/showMessageRequest" WINDOW_WORK_DONE_PROGRESS_CANCEL = "window/workDoneProgress/cancel" WINDOW_WORK_DONE_PROGRESS_CREATE = "window/workDoneProgress/create" WORKSPACE_APPLY_EDIT = "workspace/applyEdit" WORKSPACE_CODE_LENS_REFRESH = "workspace/codeLens/refresh" WORKSPACE_CONFIGURATION = "workspace/configuration" WORKSPACE_DIAGNOSTIC = "workspace/diagnostic" WORKSPACE_DIAGNOSTIC_REFRESH = "workspace/diagnostic/refresh" WORKSPACE_DID_CHANGE_CONFIGURATION = "workspace/didChangeConfiguration" WORKSPACE_DID_CHANGE_WATCHED_FILES = "workspace/didChangeWatchedFiles" WORKSPACE_DID_CHANGE_WORKSPACE_FOLDERS = "workspace/didChangeWorkspaceFolders" WORKSPACE_DID_CREATE_FILES = "workspace/didCreateFiles" WORKSPACE_DID_DELETE_FILES = "workspace/didDeleteFiles" WORKSPACE_DID_RENAME_FILES = "workspace/didRenameFiles" WORKSPACE_EXECUTE_COMMAND = "workspace/executeCommand" WORKSPACE_INLAY_HINT_REFRESH = "workspace/inlayHint/refresh" WORKSPACE_INLINE_VALUE_REFRESH = "workspace/inlineValue/refresh" WORKSPACE_SEMANTIC_TOKENS_REFRESH = "workspace/semanticTokens/refresh" WORKSPACE_SYMBOL = "workspace/symbol" WORKSPACE_SYMBOL_RESOLVE = "workspaceSymbol/resolve" WORKSPACE_WILL_CREATE_FILES = "workspace/willCreateFiles" WORKSPACE_WILL_DELETE_FILES = "workspace/willDeleteFiles" WORKSPACE_WILL_RENAME_FILES = "workspace/willRenameFiles" WORKSPACE_WORKSPACE_FOLDERS = "workspace/workspaceFolders" METHOD_TO_TYPES = { # Requests CALL_HIERARCHY_INCOMING_CALLS: ( CallHierarchyIncomingCallsRequest, CallHierarchyIncomingCallsResponse, CallHierarchyIncomingCallsParams, None, ), CALL_HIERARCHY_OUTGOING_CALLS: ( CallHierarchyOutgoingCallsRequest, CallHierarchyOutgoingCallsResponse, CallHierarchyOutgoingCallsParams, None, ), CLIENT_REGISTER_CAPABILITY: ( ClientRegisterCapabilityRequest, ClientRegisterCapabilityResponse, RegistrationParams, None, ), CLIENT_UNREGISTER_CAPABILITY: ( ClientUnregisterCapabilityRequest, ClientUnregisterCapabilityResponse, UnregistrationParams, None, ), CODE_ACTION_RESOLVE: ( CodeActionResolveRequest, CodeActionResolveResponse, CodeAction, None, ), CODE_LENS_RESOLVE: ( CodeLensResolveRequest, CodeLensResolveResponse, CodeLens, None, ), COMPLETION_ITEM_RESOLVE: ( CompletionItemResolveRequest, CompletionItemResolveResponse, CompletionItem, None, ), DOCUMENT_LINK_RESOLVE: ( DocumentLinkResolveRequest, DocumentLinkResolveResponse, DocumentLink, None, ), INITIALIZE: (InitializeRequest, InitializeResponse, InitializeParams, None), INLAY_HINT_RESOLVE: ( InlayHintResolveRequest, InlayHintResolveResponse, InlayHint, None, ), SHUTDOWN: (ShutdownRequest, ShutdownResponse, None, None), TEXT_DOCUMENT_CODE_ACTION: ( TextDocumentCodeActionRequest, TextDocumentCodeActionResponse, CodeActionParams, CodeActionRegistrationOptions, ), TEXT_DOCUMENT_CODE_LENS: ( TextDocumentCodeLensRequest, TextDocumentCodeLensResponse, CodeLensParams, CodeLensRegistrationOptions, ), TEXT_DOCUMENT_COLOR_PRESENTATION: ( TextDocumentColorPresentationRequest, TextDocumentColorPresentationResponse, ColorPresentationParams, TextDocumentColorPresentationOptions, ), TEXT_DOCUMENT_COMPLETION: ( TextDocumentCompletionRequest, TextDocumentCompletionResponse, CompletionParams, CompletionRegistrationOptions, ), TEXT_DOCUMENT_DECLARATION: ( TextDocumentDeclarationRequest, TextDocumentDeclarationResponse, DeclarationParams, DeclarationRegistrationOptions, ), TEXT_DOCUMENT_DEFINITION: ( TextDocumentDefinitionRequest, TextDocumentDefinitionResponse, DefinitionParams, DefinitionRegistrationOptions, ), TEXT_DOCUMENT_DIAGNOSTIC: ( TextDocumentDiagnosticRequest, TextDocumentDiagnosticResponse, DocumentDiagnosticParams, DiagnosticRegistrationOptions, ), TEXT_DOCUMENT_DOCUMENT_COLOR: ( TextDocumentDocumentColorRequest, TextDocumentDocumentColorResponse, DocumentColorParams, DocumentColorRegistrationOptions, ), TEXT_DOCUMENT_DOCUMENT_HIGHLIGHT: ( TextDocumentDocumentHighlightRequest, TextDocumentDocumentHighlightResponse, DocumentHighlightParams, DocumentHighlightRegistrationOptions, ), TEXT_DOCUMENT_DOCUMENT_LINK: ( TextDocumentDocumentLinkRequest, TextDocumentDocumentLinkResponse, DocumentLinkParams, DocumentLinkRegistrationOptions, ), TEXT_DOCUMENT_DOCUMENT_SYMBOL: ( TextDocumentDocumentSymbolRequest, TextDocumentDocumentSymbolResponse, DocumentSymbolParams, DocumentSymbolRegistrationOptions, ), TEXT_DOCUMENT_FOLDING_RANGE: ( TextDocumentFoldingRangeRequest, TextDocumentFoldingRangeResponse, FoldingRangeParams, FoldingRangeRegistrationOptions, ), TEXT_DOCUMENT_FORMATTING: ( TextDocumentFormattingRequest, TextDocumentFormattingResponse, DocumentFormattingParams, DocumentFormattingRegistrationOptions, ), TEXT_DOCUMENT_HOVER: ( TextDocumentHoverRequest, TextDocumentHoverResponse, HoverParams, HoverRegistrationOptions, ), TEXT_DOCUMENT_IMPLEMENTATION: ( TextDocumentImplementationRequest, TextDocumentImplementationResponse, ImplementationParams, ImplementationRegistrationOptions, ), TEXT_DOCUMENT_INLAY_HINT: ( TextDocumentInlayHintRequest, TextDocumentInlayHintResponse, InlayHintParams, InlayHintRegistrationOptions, ), TEXT_DOCUMENT_INLINE_COMPLETION: ( TextDocumentInlineCompletionRequest, TextDocumentInlineCompletionResponse, InlineCompletionParams, InlineCompletionRegistrationOptions, ), TEXT_DOCUMENT_INLINE_VALUE: ( TextDocumentInlineValueRequest, TextDocumentInlineValueResponse, InlineValueParams, InlineValueRegistrationOptions, ), TEXT_DOCUMENT_LINKED_EDITING_RANGE: ( TextDocumentLinkedEditingRangeRequest, TextDocumentLinkedEditingRangeResponse, LinkedEditingRangeParams, LinkedEditingRangeRegistrationOptions, ), TEXT_DOCUMENT_MONIKER: ( TextDocumentMonikerRequest, TextDocumentMonikerResponse, MonikerParams, MonikerRegistrationOptions, ), TEXT_DOCUMENT_ON_TYPE_FORMATTING: ( TextDocumentOnTypeFormattingRequest, TextDocumentOnTypeFormattingResponse, DocumentOnTypeFormattingParams, DocumentOnTypeFormattingRegistrationOptions, ), TEXT_DOCUMENT_PREPARE_CALL_HIERARCHY: ( TextDocumentPrepareCallHierarchyRequest, TextDocumentPrepareCallHierarchyResponse, CallHierarchyPrepareParams, CallHierarchyRegistrationOptions, ), TEXT_DOCUMENT_PREPARE_RENAME: ( TextDocumentPrepareRenameRequest, TextDocumentPrepareRenameResponse, PrepareRenameParams, None, ), TEXT_DOCUMENT_PREPARE_TYPE_HIERARCHY: ( TextDocumentPrepareTypeHierarchyRequest, TextDocumentPrepareTypeHierarchyResponse, TypeHierarchyPrepareParams, TypeHierarchyRegistrationOptions, ), TEXT_DOCUMENT_RANGES_FORMATTING: ( TextDocumentRangesFormattingRequest, TextDocumentRangesFormattingResponse, DocumentRangesFormattingParams, DocumentRangeFormattingRegistrationOptions, ), TEXT_DOCUMENT_RANGE_FORMATTING: ( TextDocumentRangeFormattingRequest, TextDocumentRangeFormattingResponse, DocumentRangeFormattingParams, DocumentRangeFormattingRegistrationOptions, ), TEXT_DOCUMENT_REFERENCES: ( TextDocumentReferencesRequest, TextDocumentReferencesResponse, ReferenceParams, ReferenceRegistrationOptions, ), TEXT_DOCUMENT_RENAME: ( TextDocumentRenameRequest, TextDocumentRenameResponse, RenameParams, RenameRegistrationOptions, ), TEXT_DOCUMENT_SELECTION_RANGE: ( TextDocumentSelectionRangeRequest, TextDocumentSelectionRangeResponse, SelectionRangeParams, SelectionRangeRegistrationOptions, ), TEXT_DOCUMENT_SEMANTIC_TOKENS_FULL: ( TextDocumentSemanticTokensFullRequest, TextDocumentSemanticTokensFullResponse, SemanticTokensParams, SemanticTokensRegistrationOptions, ), TEXT_DOCUMENT_SEMANTIC_TOKENS_FULL_DELTA: ( TextDocumentSemanticTokensFullDeltaRequest, TextDocumentSemanticTokensFullDeltaResponse, SemanticTokensDeltaParams, SemanticTokensRegistrationOptions, ), TEXT_DOCUMENT_SEMANTIC_TOKENS_RANGE: ( TextDocumentSemanticTokensRangeRequest, TextDocumentSemanticTokensRangeResponse, SemanticTokensRangeParams, None, ), TEXT_DOCUMENT_SIGNATURE_HELP: ( TextDocumentSignatureHelpRequest, TextDocumentSignatureHelpResponse, SignatureHelpParams, SignatureHelpRegistrationOptions, ), TEXT_DOCUMENT_TYPE_DEFINITION: ( TextDocumentTypeDefinitionRequest, TextDocumentTypeDefinitionResponse, TypeDefinitionParams, TypeDefinitionRegistrationOptions, ), TEXT_DOCUMENT_WILL_SAVE_WAIT_UNTIL: ( TextDocumentWillSaveWaitUntilRequest, TextDocumentWillSaveWaitUntilResponse, WillSaveTextDocumentParams, TextDocumentRegistrationOptions, ), TYPE_HIERARCHY_SUBTYPES: ( TypeHierarchySubtypesRequest, TypeHierarchySubtypesResponse, TypeHierarchySubtypesParams, None, ), TYPE_HIERARCHY_SUPERTYPES: ( TypeHierarchySupertypesRequest, TypeHierarchySupertypesResponse, TypeHierarchySupertypesParams, None, ), WINDOW_SHOW_DOCUMENT: ( WindowShowDocumentRequest, WindowShowDocumentResponse, ShowDocumentParams, None, ), WINDOW_SHOW_MESSAGE_REQUEST: ( WindowShowMessageRequestRequest, WindowShowMessageRequestResponse, ShowMessageRequestParams, None, ), WINDOW_WORK_DONE_PROGRESS_CREATE: ( WindowWorkDoneProgressCreateRequest, WindowWorkDoneProgressCreateResponse, WorkDoneProgressCreateParams, None, ), WORKSPACE_APPLY_EDIT: ( WorkspaceApplyEditRequest, WorkspaceApplyEditResponse, ApplyWorkspaceEditParams, None, ), WORKSPACE_CODE_LENS_REFRESH: ( WorkspaceCodeLensRefreshRequest, WorkspaceCodeLensRefreshResponse, None, None, ), WORKSPACE_CONFIGURATION: ( WorkspaceConfigurationRequest, WorkspaceConfigurationResponse, ConfigurationParams, None, ), WORKSPACE_DIAGNOSTIC: ( WorkspaceDiagnosticRequest, WorkspaceDiagnosticResponse, WorkspaceDiagnosticParams, None, ), WORKSPACE_DIAGNOSTIC_REFRESH: ( WorkspaceDiagnosticRefreshRequest, WorkspaceDiagnosticRefreshResponse, None, None, ), WORKSPACE_EXECUTE_COMMAND: ( WorkspaceExecuteCommandRequest, WorkspaceExecuteCommandResponse, ExecuteCommandParams, ExecuteCommandRegistrationOptions, ), WORKSPACE_INLAY_HINT_REFRESH: ( WorkspaceInlayHintRefreshRequest, WorkspaceInlayHintRefreshResponse, None, None, ), WORKSPACE_INLINE_VALUE_REFRESH: ( WorkspaceInlineValueRefreshRequest, WorkspaceInlineValueRefreshResponse, None, None, ), WORKSPACE_SEMANTIC_TOKENS_REFRESH: ( WorkspaceSemanticTokensRefreshRequest, WorkspaceSemanticTokensRefreshResponse, None, None, ), WORKSPACE_SYMBOL: ( WorkspaceSymbolRequest, WorkspaceSymbolResponse, WorkspaceSymbolParams, WorkspaceSymbolRegistrationOptions, ), WORKSPACE_SYMBOL_RESOLVE: ( WorkspaceSymbolResolveRequest, WorkspaceSymbolResolveResponse, WorkspaceSymbol, None, ), WORKSPACE_WILL_CREATE_FILES: ( WorkspaceWillCreateFilesRequest, WorkspaceWillCreateFilesResponse, CreateFilesParams, FileOperationRegistrationOptions, ), WORKSPACE_WILL_DELETE_FILES: ( WorkspaceWillDeleteFilesRequest, WorkspaceWillDeleteFilesResponse, DeleteFilesParams, FileOperationRegistrationOptions, ), WORKSPACE_WILL_RENAME_FILES: ( WorkspaceWillRenameFilesRequest, WorkspaceWillRenameFilesResponse, RenameFilesParams, FileOperationRegistrationOptions, ), WORKSPACE_WORKSPACE_FOLDERS: ( WorkspaceWorkspaceFoldersRequest, WorkspaceWorkspaceFoldersResponse, None, None, ), # Notifications CANCEL_REQUEST: (CancelRequestNotification, None, CancelParams, None), EXIT: (ExitNotification, None, None, None), INITIALIZED: (InitializedNotification, None, InitializedParams, None), LOG_TRACE: (LogTraceNotification, None, LogTraceParams, None), NOTEBOOK_DOCUMENT_DID_CHANGE: ( NotebookDocumentDidChangeNotification, None, DidChangeNotebookDocumentParams, None, ), NOTEBOOK_DOCUMENT_DID_CLOSE: ( NotebookDocumentDidCloseNotification, None, DidCloseNotebookDocumentParams, None, ), NOTEBOOK_DOCUMENT_DID_OPEN: ( NotebookDocumentDidOpenNotification, None, DidOpenNotebookDocumentParams, None, ), NOTEBOOK_DOCUMENT_DID_SAVE: ( NotebookDocumentDidSaveNotification, None, DidSaveNotebookDocumentParams, None, ), PROGRESS: (ProgressNotification, None, ProgressParams, None), SET_TRACE: (SetTraceNotification, None, SetTraceParams, None), TELEMETRY_EVENT: (TelemetryEventNotification, None, LSPAny, None), TEXT_DOCUMENT_DID_CHANGE: ( TextDocumentDidChangeNotification, None, DidChangeTextDocumentParams, TextDocumentChangeRegistrationOptions, ), TEXT_DOCUMENT_DID_CLOSE: ( TextDocumentDidCloseNotification, None, DidCloseTextDocumentParams, TextDocumentRegistrationOptions, ), TEXT_DOCUMENT_DID_OPEN: ( TextDocumentDidOpenNotification, None, DidOpenTextDocumentParams, TextDocumentRegistrationOptions, ), TEXT_DOCUMENT_DID_SAVE: ( TextDocumentDidSaveNotification, None, DidSaveTextDocumentParams, TextDocumentSaveRegistrationOptions, ), TEXT_DOCUMENT_PUBLISH_DIAGNOSTICS: ( TextDocumentPublishDiagnosticsNotification, None, PublishDiagnosticsParams, None, ), TEXT_DOCUMENT_WILL_SAVE: ( TextDocumentWillSaveNotification, None, WillSaveTextDocumentParams, TextDocumentRegistrationOptions, ), WINDOW_LOG_MESSAGE: (WindowLogMessageNotification, None, LogMessageParams, None), WINDOW_SHOW_MESSAGE: (WindowShowMessageNotification, None, ShowMessageParams, None), WINDOW_WORK_DONE_PROGRESS_CANCEL: ( WindowWorkDoneProgressCancelNotification, None, WorkDoneProgressCancelParams, None, ), WORKSPACE_DID_CHANGE_CONFIGURATION: ( WorkspaceDidChangeConfigurationNotification, None, DidChangeConfigurationParams, DidChangeConfigurationRegistrationOptions, ), WORKSPACE_DID_CHANGE_WATCHED_FILES: ( WorkspaceDidChangeWatchedFilesNotification, None, DidChangeWatchedFilesParams, DidChangeWatchedFilesRegistrationOptions, ), WORKSPACE_DID_CHANGE_WORKSPACE_FOLDERS: ( WorkspaceDidChangeWorkspaceFoldersNotification, None, DidChangeWorkspaceFoldersParams, None, ), WORKSPACE_DID_CREATE_FILES: ( WorkspaceDidCreateFilesNotification, None, CreateFilesParams, FileOperationRegistrationOptions, ), WORKSPACE_DID_DELETE_FILES: ( WorkspaceDidDeleteFilesNotification, None, DeleteFilesParams, FileOperationRegistrationOptions, ), WORKSPACE_DID_RENAME_FILES: ( WorkspaceDidRenameFilesNotification, None, RenameFilesParams, FileOperationRegistrationOptions, ), } REQUESTS = Union[ CallHierarchyIncomingCallsRequest, CallHierarchyOutgoingCallsRequest, ClientRegisterCapabilityRequest, ClientUnregisterCapabilityRequest, CodeActionResolveRequest, CodeLensResolveRequest, CompletionItemResolveRequest, DocumentLinkResolveRequest, InitializeRequest, InlayHintResolveRequest, ShutdownRequest, TextDocumentCodeActionRequest, TextDocumentCodeLensRequest, TextDocumentColorPresentationRequest, TextDocumentCompletionRequest, TextDocumentDeclarationRequest, TextDocumentDefinitionRequest, TextDocumentDiagnosticRequest, TextDocumentDocumentColorRequest, TextDocumentDocumentHighlightRequest, TextDocumentDocumentLinkRequest, TextDocumentDocumentSymbolRequest, TextDocumentFoldingRangeRequest, TextDocumentFormattingRequest, TextDocumentHoverRequest, TextDocumentImplementationRequest, TextDocumentInlayHintRequest, TextDocumentInlineCompletionRequest, TextDocumentInlineValueRequest, TextDocumentLinkedEditingRangeRequest, TextDocumentMonikerRequest, TextDocumentOnTypeFormattingRequest, TextDocumentPrepareCallHierarchyRequest, TextDocumentPrepareRenameRequest, TextDocumentPrepareTypeHierarchyRequest, TextDocumentRangeFormattingRequest, TextDocumentRangesFormattingRequest, TextDocumentReferencesRequest, TextDocumentRenameRequest, TextDocumentSelectionRangeRequest, TextDocumentSemanticTokensFullDeltaRequest, TextDocumentSemanticTokensFullRequest, TextDocumentSemanticTokensRangeRequest, TextDocumentSignatureHelpRequest, TextDocumentTypeDefinitionRequest, TextDocumentWillSaveWaitUntilRequest, TypeHierarchySubtypesRequest, TypeHierarchySupertypesRequest, WindowShowDocumentRequest, WindowShowMessageRequestRequest, WindowWorkDoneProgressCreateRequest, WorkspaceApplyEditRequest, WorkspaceCodeLensRefreshRequest, WorkspaceConfigurationRequest, WorkspaceDiagnosticRefreshRequest, WorkspaceDiagnosticRequest, WorkspaceExecuteCommandRequest, WorkspaceInlayHintRefreshRequest, WorkspaceInlineValueRefreshRequest, WorkspaceSemanticTokensRefreshRequest, WorkspaceSymbolRequest, WorkspaceSymbolResolveRequest, WorkspaceWillCreateFilesRequest, WorkspaceWillDeleteFilesRequest, WorkspaceWillRenameFilesRequest, WorkspaceWorkspaceFoldersRequest, ] RESPONSES = Union[ CallHierarchyIncomingCallsResponse, CallHierarchyOutgoingCallsResponse, ClientRegisterCapabilityResponse, ClientUnregisterCapabilityResponse, CodeActionResolveResponse, CodeLensResolveResponse, CompletionItemResolveResponse, DocumentLinkResolveResponse, InitializeResponse, InlayHintResolveResponse, ShutdownResponse, TextDocumentCodeActionResponse, TextDocumentCodeLensResponse, TextDocumentColorPresentationResponse, TextDocumentCompletionResponse, TextDocumentDeclarationResponse, TextDocumentDefinitionResponse, TextDocumentDiagnosticResponse, TextDocumentDocumentColorResponse, TextDocumentDocumentHighlightResponse, TextDocumentDocumentLinkResponse, TextDocumentDocumentSymbolResponse, TextDocumentFoldingRangeResponse, TextDocumentFormattingResponse, TextDocumentHoverResponse, TextDocumentImplementationResponse, TextDocumentInlayHintResponse, TextDocumentInlineCompletionResponse, TextDocumentInlineValueResponse, TextDocumentLinkedEditingRangeResponse, TextDocumentMonikerResponse, TextDocumentOnTypeFormattingResponse, TextDocumentPrepareCallHierarchyResponse, TextDocumentPrepareRenameResponse, TextDocumentPrepareTypeHierarchyResponse, TextDocumentRangeFormattingResponse, TextDocumentRangesFormattingResponse, TextDocumentReferencesResponse, TextDocumentRenameResponse, TextDocumentSelectionRangeResponse, TextDocumentSemanticTokensFullDeltaResponse, TextDocumentSemanticTokensFullResponse, TextDocumentSemanticTokensRangeResponse, TextDocumentSignatureHelpResponse, TextDocumentTypeDefinitionResponse, TextDocumentWillSaveWaitUntilResponse, TypeHierarchySubtypesResponse, TypeHierarchySupertypesResponse, WindowShowDocumentResponse, WindowShowMessageRequestResponse, WindowWorkDoneProgressCreateResponse, WorkspaceApplyEditResponse, WorkspaceCodeLensRefreshResponse, WorkspaceConfigurationResponse, WorkspaceDiagnosticRefreshResponse, WorkspaceDiagnosticResponse, WorkspaceExecuteCommandResponse, WorkspaceInlayHintRefreshResponse, WorkspaceInlineValueRefreshResponse, WorkspaceSemanticTokensRefreshResponse, WorkspaceSymbolResolveResponse, WorkspaceSymbolResponse, WorkspaceWillCreateFilesResponse, WorkspaceWillDeleteFilesResponse, WorkspaceWillRenameFilesResponse, WorkspaceWorkspaceFoldersResponse, ] NOTIFICATIONS = Union[ CancelRequestNotification, ExitNotification, InitializedNotification, LogTraceNotification, NotebookDocumentDidChangeNotification, NotebookDocumentDidCloseNotification, NotebookDocumentDidOpenNotification, NotebookDocumentDidSaveNotification, ProgressNotification, SetTraceNotification, TelemetryEventNotification, TextDocumentDidChangeNotification, TextDocumentDidCloseNotification, TextDocumentDidOpenNotification, TextDocumentDidSaveNotification, TextDocumentPublishDiagnosticsNotification, TextDocumentWillSaveNotification, WindowLogMessageNotification, WindowShowMessageNotification, WindowWorkDoneProgressCancelNotification, WorkspaceDidChangeConfigurationNotification, WorkspaceDidChangeWatchedFilesNotification, WorkspaceDidChangeWorkspaceFoldersNotification, WorkspaceDidCreateFilesNotification, WorkspaceDidDeleteFilesNotification, WorkspaceDidRenameFilesNotification, ] MESSAGE_TYPES = Union[REQUESTS, RESPONSES, NOTIFICATIONS, ResponseErrorMessage] _KEYWORD_CLASSES = [CallHierarchyIncomingCall] def is_keyword_class(cls: type) -> bool: """Returns true if the class has a property that may be python keyword.""" return any(cls is c for c in _KEYWORD_CLASSES) _SPECIAL_CLASSES = [ CallHierarchyIncomingCallsRequest, CallHierarchyIncomingCallsResponse, CallHierarchyOutgoingCallsRequest, CallHierarchyOutgoingCallsResponse, CallHierarchyRegistrationOptions, CancelRequestNotification, ClientRegisterCapabilityRequest, ClientRegisterCapabilityResponse, ClientUnregisterCapabilityRequest, ClientUnregisterCapabilityResponse, CodeActionRegistrationOptions, CodeActionResolveRequest, CodeActionResolveResponse, CodeLensRegistrationOptions, CodeLensResolveRequest, CodeLensResolveResponse, CompletionItemResolveRequest, CompletionItemResolveResponse, CompletionRegistrationOptions, CreateFile, DeclarationRegistrationOptions, DefinitionRegistrationOptions, DeleteFile, DiagnosticRegistrationOptions, DocumentColorRegistrationOptions, DocumentFormattingRegistrationOptions, DocumentHighlightRegistrationOptions, DocumentLinkRegistrationOptions, DocumentLinkResolveRequest, DocumentLinkResolveResponse, DocumentOnTypeFormattingRegistrationOptions, DocumentRangeFormattingRegistrationOptions, DocumentSymbolRegistrationOptions, ExitNotification, FoldingRangeRegistrationOptions, FullDocumentDiagnosticReport, HoverRegistrationOptions, ImplementationRegistrationOptions, InitializeParams, InitializeRequest, InitializeResponse, InitializedNotification, InlayHintRegistrationOptions, InlayHintResolveRequest, InlayHintResolveResponse, InlineCompletionRegistrationOptions, InlineValueRegistrationOptions, LinkedEditingRangeRegistrationOptions, LogTraceNotification, MonikerRegistrationOptions, NotebookDocumentDidChangeNotification, NotebookDocumentDidCloseNotification, NotebookDocumentDidOpenNotification, NotebookDocumentDidSaveNotification, OptionalVersionedTextDocumentIdentifier, ProgressNotification, ReferenceRegistrationOptions, RelatedFullDocumentDiagnosticReport, RelatedUnchangedDocumentDiagnosticReport, RenameFile, RenameRegistrationOptions, ResponseErrorMessage, SelectionRangeRegistrationOptions, SemanticTokensRegistrationOptions, SetTraceNotification, ShutdownRequest, ShutdownResponse, SignatureHelpRegistrationOptions, StringValue, TelemetryEventNotification, TextDocumentChangeRegistrationOptions, TextDocumentCodeActionRequest, TextDocumentCodeActionResponse, TextDocumentCodeLensRequest, TextDocumentCodeLensResponse, TextDocumentColorPresentationOptions, TextDocumentColorPresentationRequest, TextDocumentColorPresentationResponse, TextDocumentCompletionRequest, TextDocumentCompletionResponse, TextDocumentDeclarationRequest, TextDocumentDeclarationResponse, TextDocumentDefinitionRequest, TextDocumentDefinitionResponse, TextDocumentDiagnosticRequest, TextDocumentDiagnosticResponse, TextDocumentDidChangeNotification, TextDocumentDidCloseNotification, TextDocumentDidOpenNotification, TextDocumentDidSaveNotification, TextDocumentDocumentColorRequest, TextDocumentDocumentColorResponse, TextDocumentDocumentHighlightRequest, TextDocumentDocumentHighlightResponse, TextDocumentDocumentLinkRequest, TextDocumentDocumentLinkResponse, TextDocumentDocumentSymbolRequest, TextDocumentDocumentSymbolResponse, TextDocumentFoldingRangeRequest, TextDocumentFoldingRangeResponse, TextDocumentFormattingRequest, TextDocumentFormattingResponse, TextDocumentHoverRequest, TextDocumentHoverResponse, TextDocumentImplementationRequest, TextDocumentImplementationResponse, TextDocumentInlayHintRequest, TextDocumentInlayHintResponse, TextDocumentInlineCompletionRequest, TextDocumentInlineCompletionResponse, TextDocumentInlineValueRequest, TextDocumentInlineValueResponse, TextDocumentLinkedEditingRangeRequest, TextDocumentLinkedEditingRangeResponse, TextDocumentMonikerRequest, TextDocumentMonikerResponse, TextDocumentOnTypeFormattingRequest, TextDocumentOnTypeFormattingResponse, TextDocumentPrepareCallHierarchyRequest, TextDocumentPrepareCallHierarchyResponse, TextDocumentPrepareRenameRequest, TextDocumentPrepareRenameResponse, TextDocumentPrepareTypeHierarchyRequest, TextDocumentPrepareTypeHierarchyResponse, TextDocumentPublishDiagnosticsNotification, TextDocumentRangeFormattingRequest, TextDocumentRangeFormattingResponse, TextDocumentRangesFormattingRequest, TextDocumentRangesFormattingResponse, TextDocumentReferencesRequest, TextDocumentReferencesResponse, TextDocumentRegistrationOptions, TextDocumentRenameRequest, TextDocumentRenameResponse, TextDocumentSaveRegistrationOptions, TextDocumentSelectionRangeRequest, TextDocumentSelectionRangeResponse, TextDocumentSemanticTokensFullDeltaRequest, TextDocumentSemanticTokensFullDeltaResponse, TextDocumentSemanticTokensFullRequest, TextDocumentSemanticTokensFullResponse, TextDocumentSemanticTokensRangeRequest, TextDocumentSemanticTokensRangeResponse, TextDocumentSignatureHelpRequest, TextDocumentSignatureHelpResponse, TextDocumentTypeDefinitionRequest, TextDocumentTypeDefinitionResponse, TextDocumentWillSaveNotification, TextDocumentWillSaveWaitUntilRequest, TextDocumentWillSaveWaitUntilResponse, TypeDefinitionRegistrationOptions, TypeHierarchyRegistrationOptions, TypeHierarchySubtypesRequest, TypeHierarchySubtypesResponse, TypeHierarchySupertypesRequest, TypeHierarchySupertypesResponse, UnchangedDocumentDiagnosticReport, WindowLogMessageNotification, WindowShowDocumentRequest, WindowShowDocumentResponse, WindowShowMessageNotification, WindowShowMessageRequestRequest, WindowShowMessageRequestResponse, WindowWorkDoneProgressCancelNotification, WindowWorkDoneProgressCreateRequest, WindowWorkDoneProgressCreateResponse, WorkDoneProgressBegin, WorkDoneProgressEnd, WorkDoneProgressReport, WorkspaceApplyEditRequest, WorkspaceApplyEditResponse, WorkspaceCodeLensRefreshRequest, WorkspaceCodeLensRefreshResponse, WorkspaceConfigurationRequest, WorkspaceConfigurationResponse, WorkspaceDiagnosticRefreshRequest, WorkspaceDiagnosticRefreshResponse, WorkspaceDiagnosticRequest, WorkspaceDiagnosticResponse, WorkspaceDidChangeConfigurationNotification, WorkspaceDidChangeWatchedFilesNotification, WorkspaceDidChangeWorkspaceFoldersNotification, WorkspaceDidCreateFilesNotification, WorkspaceDidDeleteFilesNotification, WorkspaceDidRenameFilesNotification, WorkspaceExecuteCommandRequest, WorkspaceExecuteCommandResponse, WorkspaceFoldersInitializeParams, WorkspaceFullDocumentDiagnosticReport, WorkspaceInlayHintRefreshRequest, WorkspaceInlayHintRefreshResponse, WorkspaceInlineValueRefreshRequest, WorkspaceInlineValueRefreshResponse, WorkspaceSemanticTokensRefreshRequest, WorkspaceSemanticTokensRefreshResponse, WorkspaceSymbolRequest, WorkspaceSymbolResolveRequest, WorkspaceSymbolResolveResponse, WorkspaceSymbolResponse, WorkspaceUnchangedDocumentDiagnosticReport, WorkspaceWillCreateFilesRequest, WorkspaceWillCreateFilesResponse, WorkspaceWillDeleteFilesRequest, WorkspaceWillDeleteFilesResponse, WorkspaceWillRenameFilesRequest, WorkspaceWillRenameFilesResponse, WorkspaceWorkspaceFoldersRequest, WorkspaceWorkspaceFoldersResponse, _InitializeParams, ] def is_special_class(cls: type) -> bool: """Returns true if the class or its properties require special handling.""" return any(cls is c for c in _SPECIAL_CLASSES) _SPECIAL_PROPERTIES = [ "CallHierarchyIncomingCallsRequest.jsonrpc", "CallHierarchyIncomingCallsRequest.method", "CallHierarchyIncomingCallsResponse.jsonrpc", "CallHierarchyIncomingCallsResponse.result", "CallHierarchyOutgoingCallsRequest.jsonrpc", "CallHierarchyOutgoingCallsRequest.method", "CallHierarchyOutgoingCallsResponse.jsonrpc", "CallHierarchyOutgoingCallsResponse.result", "CallHierarchyRegistrationOptions.document_selector", "CancelRequestNotification.jsonrpc", "CancelRequestNotification.method", "ClientRegisterCapabilityRequest.jsonrpc", "ClientRegisterCapabilityRequest.method", "ClientRegisterCapabilityResponse.jsonrpc", "ClientRegisterCapabilityResponse.result", "ClientUnregisterCapabilityRequest.jsonrpc", "ClientUnregisterCapabilityRequest.method", "ClientUnregisterCapabilityResponse.jsonrpc", "ClientUnregisterCapabilityResponse.result", "CodeActionRegistrationOptions.document_selector", "CodeActionResolveRequest.jsonrpc", "CodeActionResolveRequest.method", "CodeActionResolveResponse.jsonrpc", "CodeActionResolveResponse.result", "CodeLensRegistrationOptions.document_selector", "CodeLensResolveRequest.jsonrpc", "CodeLensResolveRequest.method", "CodeLensResolveResponse.jsonrpc", "CodeLensResolveResponse.result", "CompletionItemResolveRequest.jsonrpc", "CompletionItemResolveRequest.method", "CompletionItemResolveResponse.jsonrpc", "CompletionItemResolveResponse.result", "CompletionRegistrationOptions.document_selector", "CreateFile.kind", "DeclarationRegistrationOptions.document_selector", "DefinitionRegistrationOptions.document_selector", "DeleteFile.kind", "DiagnosticRegistrationOptions.document_selector", "DocumentColorRegistrationOptions.document_selector", "DocumentFormattingRegistrationOptions.document_selector", "DocumentHighlightRegistrationOptions.document_selector", "DocumentLinkRegistrationOptions.document_selector", "DocumentLinkResolveRequest.jsonrpc", "DocumentLinkResolveRequest.method", "DocumentLinkResolveResponse.jsonrpc", "DocumentLinkResolveResponse.result", "DocumentOnTypeFormattingRegistrationOptions.document_selector", "DocumentRangeFormattingRegistrationOptions.document_selector", "DocumentSymbolRegistrationOptions.document_selector", "ExitNotification.jsonrpc", "ExitNotification.method", "FoldingRangeRegistrationOptions.document_selector", "FullDocumentDiagnosticReport.kind", "HoverRegistrationOptions.document_selector", "ImplementationRegistrationOptions.document_selector", "InitializeParams.process_id", "InitializeParams.root_path", "InitializeParams.root_uri", "InitializeParams.workspace_folders", "InitializeRequest.jsonrpc", "InitializeRequest.method", "InitializeResponse.jsonrpc", "InitializeResponse.result", "InitializedNotification.jsonrpc", "InitializedNotification.method", "InlayHintRegistrationOptions.document_selector", "InlayHintResolveRequest.jsonrpc", "InlayHintResolveRequest.method", "InlayHintResolveResponse.jsonrpc", "InlayHintResolveResponse.result", "InlineCompletionRegistrationOptions.document_selector", "InlineValueRegistrationOptions.document_selector", "LinkedEditingRangeRegistrationOptions.document_selector", "LogTraceNotification.jsonrpc", "LogTraceNotification.method", "MonikerRegistrationOptions.document_selector", "NotebookDocumentDidChangeNotification.jsonrpc", "NotebookDocumentDidChangeNotification.method", "NotebookDocumentDidCloseNotification.jsonrpc", "NotebookDocumentDidCloseNotification.method", "NotebookDocumentDidOpenNotification.jsonrpc", "NotebookDocumentDidOpenNotification.method", "NotebookDocumentDidSaveNotification.jsonrpc", "NotebookDocumentDidSaveNotification.method", "OptionalVersionedTextDocumentIdentifier.version", "ProgressNotification.jsonrpc", "ProgressNotification.method", "ReferenceRegistrationOptions.document_selector", "RelatedFullDocumentDiagnosticReport.kind", "RelatedUnchangedDocumentDiagnosticReport.kind", "RenameFile.kind", "RenameRegistrationOptions.document_selector", "ResponseErrorMessage.error", "ResponseErrorMessage.jsonrpc", "SelectionRangeRegistrationOptions.document_selector", "SemanticTokensRegistrationOptions.document_selector", "SetTraceNotification.jsonrpc", "SetTraceNotification.method", "ShutdownRequest.jsonrpc", "ShutdownRequest.method", "ShutdownResponse.jsonrpc", "ShutdownResponse.result", "SignatureHelpRegistrationOptions.document_selector", "StringValue.kind", "TelemetryEventNotification.jsonrpc", "TelemetryEventNotification.method", "TextDocumentChangeRegistrationOptions.document_selector", "TextDocumentCodeActionRequest.jsonrpc", "TextDocumentCodeActionRequest.method", "TextDocumentCodeActionResponse.jsonrpc", "TextDocumentCodeActionResponse.result", "TextDocumentCodeLensRequest.jsonrpc", "TextDocumentCodeLensRequest.method", "TextDocumentCodeLensResponse.jsonrpc", "TextDocumentCodeLensResponse.result", "TextDocumentColorPresentationOptions.document_selector", "TextDocumentColorPresentationRequest.jsonrpc", "TextDocumentColorPresentationRequest.method", "TextDocumentColorPresentationResponse.jsonrpc", "TextDocumentColorPresentationResponse.result", "TextDocumentCompletionRequest.jsonrpc", "TextDocumentCompletionRequest.method", "TextDocumentCompletionResponse.jsonrpc", "TextDocumentCompletionResponse.result", "TextDocumentDeclarationRequest.jsonrpc", "TextDocumentDeclarationRequest.method", "TextDocumentDeclarationResponse.jsonrpc", "TextDocumentDeclarationResponse.result", "TextDocumentDefinitionRequest.jsonrpc", "TextDocumentDefinitionRequest.method", "TextDocumentDefinitionResponse.jsonrpc", "TextDocumentDefinitionResponse.result", "TextDocumentDiagnosticRequest.jsonrpc", "TextDocumentDiagnosticRequest.method", "TextDocumentDiagnosticResponse.jsonrpc", "TextDocumentDiagnosticResponse.result", "TextDocumentDidChangeNotification.jsonrpc", "TextDocumentDidChangeNotification.method", "TextDocumentDidCloseNotification.jsonrpc", "TextDocumentDidCloseNotification.method", "TextDocumentDidOpenNotification.jsonrpc", "TextDocumentDidOpenNotification.method", "TextDocumentDidSaveNotification.jsonrpc", "TextDocumentDidSaveNotification.method", "TextDocumentDocumentColorRequest.jsonrpc", "TextDocumentDocumentColorRequest.method", "TextDocumentDocumentColorResponse.jsonrpc", "TextDocumentDocumentColorResponse.result", "TextDocumentDocumentHighlightRequest.jsonrpc", "TextDocumentDocumentHighlightRequest.method", "TextDocumentDocumentHighlightResponse.jsonrpc", "TextDocumentDocumentHighlightResponse.result", "TextDocumentDocumentLinkRequest.jsonrpc", "TextDocumentDocumentLinkRequest.method", "TextDocumentDocumentLinkResponse.jsonrpc", "TextDocumentDocumentLinkResponse.result", "TextDocumentDocumentSymbolRequest.jsonrpc", "TextDocumentDocumentSymbolRequest.method", "TextDocumentDocumentSymbolResponse.jsonrpc", "TextDocumentDocumentSymbolResponse.result", "TextDocumentFoldingRangeRequest.jsonrpc", "TextDocumentFoldingRangeRequest.method", "TextDocumentFoldingRangeResponse.jsonrpc", "TextDocumentFoldingRangeResponse.result", "TextDocumentFormattingRequest.jsonrpc", "TextDocumentFormattingRequest.method", "TextDocumentFormattingResponse.jsonrpc", "TextDocumentFormattingResponse.result", "TextDocumentHoverRequest.jsonrpc", "TextDocumentHoverRequest.method", "TextDocumentHoverResponse.jsonrpc", "TextDocumentHoverResponse.result", "TextDocumentImplementationRequest.jsonrpc", "TextDocumentImplementationRequest.method", "TextDocumentImplementationResponse.jsonrpc", "TextDocumentImplementationResponse.result", "TextDocumentInlayHintRequest.jsonrpc", "TextDocumentInlayHintRequest.method", "TextDocumentInlayHintResponse.jsonrpc", "TextDocumentInlayHintResponse.result", "TextDocumentInlineCompletionRequest.jsonrpc", "TextDocumentInlineCompletionRequest.method", "TextDocumentInlineCompletionResponse.jsonrpc", "TextDocumentInlineCompletionResponse.result", "TextDocumentInlineValueRequest.jsonrpc", "TextDocumentInlineValueRequest.method", "TextDocumentInlineValueResponse.jsonrpc", "TextDocumentInlineValueResponse.result", "TextDocumentLinkedEditingRangeRequest.jsonrpc", "TextDocumentLinkedEditingRangeRequest.method", "TextDocumentLinkedEditingRangeResponse.jsonrpc", "TextDocumentLinkedEditingRangeResponse.result", "TextDocumentMonikerRequest.jsonrpc", "TextDocumentMonikerRequest.method", "TextDocumentMonikerResponse.jsonrpc", "TextDocumentMonikerResponse.result", "TextDocumentOnTypeFormattingRequest.jsonrpc", "TextDocumentOnTypeFormattingRequest.method", "TextDocumentOnTypeFormattingResponse.jsonrpc", "TextDocumentOnTypeFormattingResponse.result", "TextDocumentPrepareCallHierarchyRequest.jsonrpc", "TextDocumentPrepareCallHierarchyRequest.method", "TextDocumentPrepareCallHierarchyResponse.jsonrpc", "TextDocumentPrepareCallHierarchyResponse.result", "TextDocumentPrepareRenameRequest.jsonrpc", "TextDocumentPrepareRenameRequest.method", "TextDocumentPrepareRenameResponse.jsonrpc", "TextDocumentPrepareRenameResponse.result", "TextDocumentPrepareTypeHierarchyRequest.jsonrpc", "TextDocumentPrepareTypeHierarchyRequest.method", "TextDocumentPrepareTypeHierarchyResponse.jsonrpc", "TextDocumentPrepareTypeHierarchyResponse.result", "TextDocumentPublishDiagnosticsNotification.jsonrpc", "TextDocumentPublishDiagnosticsNotification.method", "TextDocumentRangeFormattingRequest.jsonrpc", "TextDocumentRangeFormattingRequest.method", "TextDocumentRangeFormattingResponse.jsonrpc", "TextDocumentRangeFormattingResponse.result", "TextDocumentRangesFormattingRequest.jsonrpc", "TextDocumentRangesFormattingRequest.method", "TextDocumentRangesFormattingResponse.jsonrpc", "TextDocumentRangesFormattingResponse.result", "TextDocumentReferencesRequest.jsonrpc", "TextDocumentReferencesRequest.method", "TextDocumentReferencesResponse.jsonrpc", "TextDocumentReferencesResponse.result", "TextDocumentRegistrationOptions.document_selector", "TextDocumentRenameRequest.jsonrpc", "TextDocumentRenameRequest.method", "TextDocumentRenameResponse.jsonrpc", "TextDocumentRenameResponse.result", "TextDocumentSaveRegistrationOptions.document_selector", "TextDocumentSelectionRangeRequest.jsonrpc", "TextDocumentSelectionRangeRequest.method", "TextDocumentSelectionRangeResponse.jsonrpc", "TextDocumentSelectionRangeResponse.result", "TextDocumentSemanticTokensFullDeltaRequest.jsonrpc", "TextDocumentSemanticTokensFullDeltaRequest.method", "TextDocumentSemanticTokensFullDeltaResponse.jsonrpc", "TextDocumentSemanticTokensFullDeltaResponse.result", "TextDocumentSemanticTokensFullRequest.jsonrpc", "TextDocumentSemanticTokensFullRequest.method", "TextDocumentSemanticTokensFullResponse.jsonrpc", "TextDocumentSemanticTokensFullResponse.result", "TextDocumentSemanticTokensRangeRequest.jsonrpc", "TextDocumentSemanticTokensRangeRequest.method", "TextDocumentSemanticTokensRangeResponse.jsonrpc", "TextDocumentSemanticTokensRangeResponse.result", "TextDocumentSignatureHelpRequest.jsonrpc", "TextDocumentSignatureHelpRequest.method", "TextDocumentSignatureHelpResponse.jsonrpc", "TextDocumentSignatureHelpResponse.result", "TextDocumentTypeDefinitionRequest.jsonrpc", "TextDocumentTypeDefinitionRequest.method", "TextDocumentTypeDefinitionResponse.jsonrpc", "TextDocumentTypeDefinitionResponse.result", "TextDocumentWillSaveNotification.jsonrpc", "TextDocumentWillSaveNotification.method", "TextDocumentWillSaveWaitUntilRequest.jsonrpc", "TextDocumentWillSaveWaitUntilRequest.method", "TextDocumentWillSaveWaitUntilResponse.jsonrpc", "TextDocumentWillSaveWaitUntilResponse.result", "TypeDefinitionRegistrationOptions.document_selector", "TypeHierarchyRegistrationOptions.document_selector", "TypeHierarchySubtypesRequest.jsonrpc", "TypeHierarchySubtypesRequest.method", "TypeHierarchySubtypesResponse.jsonrpc", "TypeHierarchySubtypesResponse.result", "TypeHierarchySupertypesRequest.jsonrpc", "TypeHierarchySupertypesRequest.method", "TypeHierarchySupertypesResponse.jsonrpc", "TypeHierarchySupertypesResponse.result", "UnchangedDocumentDiagnosticReport.kind", "WindowLogMessageNotification.jsonrpc", "WindowLogMessageNotification.method", "WindowShowDocumentRequest.jsonrpc", "WindowShowDocumentRequest.method", "WindowShowDocumentResponse.jsonrpc", "WindowShowDocumentResponse.result", "WindowShowMessageNotification.jsonrpc", "WindowShowMessageNotification.method", "WindowShowMessageRequestRequest.jsonrpc", "WindowShowMessageRequestRequest.method", "WindowShowMessageRequestResponse.jsonrpc", "WindowShowMessageRequestResponse.result", "WindowWorkDoneProgressCancelNotification.jsonrpc", "WindowWorkDoneProgressCancelNotification.method", "WindowWorkDoneProgressCreateRequest.jsonrpc", "WindowWorkDoneProgressCreateRequest.method", "WindowWorkDoneProgressCreateResponse.jsonrpc", "WindowWorkDoneProgressCreateResponse.result", "WorkDoneProgressBegin.kind", "WorkDoneProgressEnd.kind", "WorkDoneProgressReport.kind", "WorkspaceApplyEditRequest.jsonrpc", "WorkspaceApplyEditRequest.method", "WorkspaceApplyEditResponse.jsonrpc", "WorkspaceApplyEditResponse.result", "WorkspaceCodeLensRefreshRequest.jsonrpc", "WorkspaceCodeLensRefreshRequest.method", "WorkspaceCodeLensRefreshResponse.jsonrpc", "WorkspaceCodeLensRefreshResponse.result", "WorkspaceConfigurationRequest.jsonrpc", "WorkspaceConfigurationRequest.method", "WorkspaceConfigurationResponse.jsonrpc", "WorkspaceConfigurationResponse.result", "WorkspaceDiagnosticRefreshRequest.jsonrpc", "WorkspaceDiagnosticRefreshRequest.method", "WorkspaceDiagnosticRefreshResponse.jsonrpc", "WorkspaceDiagnosticRefreshResponse.result", "WorkspaceDiagnosticRequest.jsonrpc", "WorkspaceDiagnosticRequest.method", "WorkspaceDiagnosticResponse.jsonrpc", "WorkspaceDiagnosticResponse.result", "WorkspaceDidChangeConfigurationNotification.jsonrpc", "WorkspaceDidChangeConfigurationNotification.method", "WorkspaceDidChangeWatchedFilesNotification.jsonrpc", "WorkspaceDidChangeWatchedFilesNotification.method", "WorkspaceDidChangeWorkspaceFoldersNotification.jsonrpc", "WorkspaceDidChangeWorkspaceFoldersNotification.method", "WorkspaceDidCreateFilesNotification.jsonrpc", "WorkspaceDidCreateFilesNotification.method", "WorkspaceDidDeleteFilesNotification.jsonrpc", "WorkspaceDidDeleteFilesNotification.method", "WorkspaceDidRenameFilesNotification.jsonrpc", "WorkspaceDidRenameFilesNotification.method", "WorkspaceExecuteCommandRequest.jsonrpc", "WorkspaceExecuteCommandRequest.method", "WorkspaceExecuteCommandResponse.jsonrpc", "WorkspaceExecuteCommandResponse.result", "WorkspaceFoldersInitializeParams.workspace_folders", "WorkspaceFullDocumentDiagnosticReport.kind", "WorkspaceFullDocumentDiagnosticReport.version", "WorkspaceInlayHintRefreshRequest.jsonrpc", "WorkspaceInlayHintRefreshRequest.method", "WorkspaceInlayHintRefreshResponse.jsonrpc", "WorkspaceInlayHintRefreshResponse.result", "WorkspaceInlineValueRefreshRequest.jsonrpc", "WorkspaceInlineValueRefreshRequest.method", "WorkspaceInlineValueRefreshResponse.jsonrpc", "WorkspaceInlineValueRefreshResponse.result", "WorkspaceSemanticTokensRefreshRequest.jsonrpc", "WorkspaceSemanticTokensRefreshRequest.method", "WorkspaceSemanticTokensRefreshResponse.jsonrpc", "WorkspaceSemanticTokensRefreshResponse.result", "WorkspaceSymbolRequest.jsonrpc", "WorkspaceSymbolRequest.method", "WorkspaceSymbolResolveRequest.jsonrpc", "WorkspaceSymbolResolveRequest.method", "WorkspaceSymbolResolveResponse.jsonrpc", "WorkspaceSymbolResolveResponse.result", "WorkspaceSymbolResponse.jsonrpc", "WorkspaceSymbolResponse.result", "WorkspaceUnchangedDocumentDiagnosticReport.kind", "WorkspaceUnchangedDocumentDiagnosticReport.version", "WorkspaceWillCreateFilesRequest.jsonrpc", "WorkspaceWillCreateFilesRequest.method", "WorkspaceWillCreateFilesResponse.jsonrpc", "WorkspaceWillCreateFilesResponse.result", "WorkspaceWillDeleteFilesRequest.jsonrpc", "WorkspaceWillDeleteFilesRequest.method", "WorkspaceWillDeleteFilesResponse.jsonrpc", "WorkspaceWillDeleteFilesResponse.result", "WorkspaceWillRenameFilesRequest.jsonrpc", "WorkspaceWillRenameFilesRequest.method", "WorkspaceWillRenameFilesResponse.jsonrpc", "WorkspaceWillRenameFilesResponse.result", "WorkspaceWorkspaceFoldersRequest.jsonrpc", "WorkspaceWorkspaceFoldersRequest.method", "WorkspaceWorkspaceFoldersResponse.jsonrpc", "WorkspaceWorkspaceFoldersResponse.result", "_InitializeParams.process_id", "_InitializeParams.root_path", "_InitializeParams.root_uri", ] def is_special_property(cls: type, property_name: str) -> bool: """Returns true if the class or its properties require special handling. Example: Consider RenameRegistrationOptions * document_selector property: When you set `document_selector` to None in python it has to be preserved when serializing it. Since the serialized JSON value `{"document_selector": null}` means use the Clients document selector. Omitting it might throw error. * prepare_provider property This property does NOT need special handling, since omitting it or using `{"prepare_provider": null}` in JSON has the same meaning. """ qualified_name = f"{cls.__name__}.{property_name}" return qualified_name in _SPECIAL_PROPERTIES ALL_TYPES_MAP: Dict[str, Union[type, object]] = { "AnnotatedTextEdit": AnnotatedTextEdit, "ApplyWorkspaceEditParams": ApplyWorkspaceEditParams, "ApplyWorkspaceEditResult": ApplyWorkspaceEditResult, "BaseSymbolInformation": BaseSymbolInformation, "CallHierarchyClientCapabilities": CallHierarchyClientCapabilities, "CallHierarchyIncomingCall": CallHierarchyIncomingCall, "CallHierarchyIncomingCallsParams": CallHierarchyIncomingCallsParams, "CallHierarchyIncomingCallsRequest": CallHierarchyIncomingCallsRequest, "CallHierarchyIncomingCallsResponse": CallHierarchyIncomingCallsResponse, "CallHierarchyItem": CallHierarchyItem, "CallHierarchyOptions": CallHierarchyOptions, "CallHierarchyOutgoingCall": CallHierarchyOutgoingCall, "CallHierarchyOutgoingCallsParams": CallHierarchyOutgoingCallsParams, "CallHierarchyOutgoingCallsRequest": CallHierarchyOutgoingCallsRequest, "CallHierarchyOutgoingCallsResponse": CallHierarchyOutgoingCallsResponse, "CallHierarchyPrepareParams": CallHierarchyPrepareParams, "CallHierarchyRegistrationOptions": CallHierarchyRegistrationOptions, "CancelParams": CancelParams, "CancelRequestNotification": CancelRequestNotification, "ChangeAnnotation": ChangeAnnotation, "ChangeAnnotationIdentifier": ChangeAnnotationIdentifier, "ClientCapabilities": ClientCapabilities, "ClientRegisterCapabilityRequest": ClientRegisterCapabilityRequest, "ClientRegisterCapabilityResponse": ClientRegisterCapabilityResponse, "ClientUnregisterCapabilityRequest": ClientUnregisterCapabilityRequest, "ClientUnregisterCapabilityResponse": ClientUnregisterCapabilityResponse, "CodeAction": CodeAction, "CodeActionClientCapabilities": CodeActionClientCapabilities, "CodeActionClientCapabilitiesCodeActionLiteralSupportType": CodeActionClientCapabilitiesCodeActionLiteralSupportType, "CodeActionClientCapabilitiesCodeActionLiteralSupportTypeCodeActionKindType": CodeActionClientCapabilitiesCodeActionLiteralSupportTypeCodeActionKindType, "CodeActionClientCapabilitiesResolveSupportType": CodeActionClientCapabilitiesResolveSupportType, "CodeActionContext": CodeActionContext, "CodeActionDisabledType": CodeActionDisabledType, "CodeActionKind": CodeActionKind, "CodeActionOptions": CodeActionOptions, "CodeActionParams": CodeActionParams, "CodeActionRegistrationOptions": CodeActionRegistrationOptions, "CodeActionResolveRequest": CodeActionResolveRequest, "CodeActionResolveResponse": CodeActionResolveResponse, "CodeActionTriggerKind": CodeActionTriggerKind, "CodeDescription": CodeDescription, "CodeLens": CodeLens, "CodeLensClientCapabilities": CodeLensClientCapabilities, "CodeLensOptions": CodeLensOptions, "CodeLensParams": CodeLensParams, "CodeLensRegistrationOptions": CodeLensRegistrationOptions, "CodeLensResolveRequest": CodeLensResolveRequest, "CodeLensResolveResponse": CodeLensResolveResponse, "CodeLensWorkspaceClientCapabilities": CodeLensWorkspaceClientCapabilities, "Color": Color, "ColorInformation": ColorInformation, "ColorPresentation": ColorPresentation, "ColorPresentationParams": ColorPresentationParams, "Command": Command, "CompletionClientCapabilities": CompletionClientCapabilities, "CompletionClientCapabilitiesCompletionItemKindType": CompletionClientCapabilitiesCompletionItemKindType, "CompletionClientCapabilitiesCompletionItemType": CompletionClientCapabilitiesCompletionItemType, "CompletionClientCapabilitiesCompletionItemTypeInsertTextModeSupportType": CompletionClientCapabilitiesCompletionItemTypeInsertTextModeSupportType, "CompletionClientCapabilitiesCompletionItemTypeResolveSupportType": CompletionClientCapabilitiesCompletionItemTypeResolveSupportType, "CompletionClientCapabilitiesCompletionItemTypeTagSupportType": CompletionClientCapabilitiesCompletionItemTypeTagSupportType, "CompletionClientCapabilitiesCompletionListType": CompletionClientCapabilitiesCompletionListType, "CompletionContext": CompletionContext, "CompletionItem": CompletionItem, "CompletionItemKind": CompletionItemKind, "CompletionItemLabelDetails": CompletionItemLabelDetails, "CompletionItemResolveRequest": CompletionItemResolveRequest, "CompletionItemResolveResponse": CompletionItemResolveResponse, "CompletionItemTag": CompletionItemTag, "CompletionList": CompletionList, "CompletionListItemDefaultsType": CompletionListItemDefaultsType, "CompletionListItemDefaultsTypeEditRangeType1": CompletionListItemDefaultsTypeEditRangeType1, "CompletionOptions": CompletionOptions, "CompletionOptionsCompletionItemType": CompletionOptionsCompletionItemType, "CompletionParams": CompletionParams, "CompletionRegistrationOptions": CompletionRegistrationOptions, "CompletionRegistrationOptionsCompletionItemType": CompletionRegistrationOptionsCompletionItemType, "CompletionTriggerKind": CompletionTriggerKind, "ConfigurationItem": ConfigurationItem, "ConfigurationParams": ConfigurationParams, "CreateFile": CreateFile, "CreateFileOptions": CreateFileOptions, "CreateFilesParams": CreateFilesParams, "Declaration": Declaration, "DeclarationClientCapabilities": DeclarationClientCapabilities, "DeclarationLink": DeclarationLink, "DeclarationOptions": DeclarationOptions, "DeclarationParams": DeclarationParams, "DeclarationRegistrationOptions": DeclarationRegistrationOptions, "Definition": Definition, "DefinitionClientCapabilities": DefinitionClientCapabilities, "DefinitionLink": DefinitionLink, "DefinitionOptions": DefinitionOptions, "DefinitionParams": DefinitionParams, "DefinitionRegistrationOptions": DefinitionRegistrationOptions, "DeleteFile": DeleteFile, "DeleteFileOptions": DeleteFileOptions, "DeleteFilesParams": DeleteFilesParams, "Diagnostic": Diagnostic, "DiagnosticClientCapabilities": DiagnosticClientCapabilities, "DiagnosticOptions": DiagnosticOptions, "DiagnosticRegistrationOptions": DiagnosticRegistrationOptions, "DiagnosticRelatedInformation": DiagnosticRelatedInformation, "DiagnosticServerCancellationData": DiagnosticServerCancellationData, "DiagnosticSeverity": DiagnosticSeverity, "DiagnosticTag": DiagnosticTag, "DiagnosticWorkspaceClientCapabilities": DiagnosticWorkspaceClientCapabilities, "DidChangeConfigurationClientCapabilities": DidChangeConfigurationClientCapabilities, "DidChangeConfigurationParams": DidChangeConfigurationParams, "DidChangeConfigurationRegistrationOptions": DidChangeConfigurationRegistrationOptions, "DidChangeNotebookDocumentParams": DidChangeNotebookDocumentParams, "DidChangeTextDocumentParams": DidChangeTextDocumentParams, "DidChangeWatchedFilesClientCapabilities": DidChangeWatchedFilesClientCapabilities, "DidChangeWatchedFilesParams": DidChangeWatchedFilesParams, "DidChangeWatchedFilesRegistrationOptions": DidChangeWatchedFilesRegistrationOptions, "DidChangeWorkspaceFoldersParams": DidChangeWorkspaceFoldersParams, "DidCloseNotebookDocumentParams": DidCloseNotebookDocumentParams, "DidCloseTextDocumentParams": DidCloseTextDocumentParams, "DidOpenNotebookDocumentParams": DidOpenNotebookDocumentParams, "DidOpenTextDocumentParams": DidOpenTextDocumentParams, "DidSaveNotebookDocumentParams": DidSaveNotebookDocumentParams, "DidSaveTextDocumentParams": DidSaveTextDocumentParams, "DocumentColorClientCapabilities": DocumentColorClientCapabilities, "DocumentColorOptions": DocumentColorOptions, "DocumentColorParams": DocumentColorParams, "DocumentColorRegistrationOptions": DocumentColorRegistrationOptions, "DocumentDiagnosticParams": DocumentDiagnosticParams, "DocumentDiagnosticReport": DocumentDiagnosticReport, "DocumentDiagnosticReportKind": DocumentDiagnosticReportKind, "DocumentDiagnosticReportPartialResult": DocumentDiagnosticReportPartialResult, "DocumentFilter": DocumentFilter, "DocumentFormattingClientCapabilities": DocumentFormattingClientCapabilities, "DocumentFormattingOptions": DocumentFormattingOptions, "DocumentFormattingParams": DocumentFormattingParams, "DocumentFormattingRegistrationOptions": DocumentFormattingRegistrationOptions, "DocumentHighlight": DocumentHighlight, "DocumentHighlightClientCapabilities": DocumentHighlightClientCapabilities, "DocumentHighlightKind": DocumentHighlightKind, "DocumentHighlightOptions": DocumentHighlightOptions, "DocumentHighlightParams": DocumentHighlightParams, "DocumentHighlightRegistrationOptions": DocumentHighlightRegistrationOptions, "DocumentLink": DocumentLink, "DocumentLinkClientCapabilities": DocumentLinkClientCapabilities, "DocumentLinkOptions": DocumentLinkOptions, "DocumentLinkParams": DocumentLinkParams, "DocumentLinkRegistrationOptions": DocumentLinkRegistrationOptions, "DocumentLinkResolveRequest": DocumentLinkResolveRequest, "DocumentLinkResolveResponse": DocumentLinkResolveResponse, "DocumentOnTypeFormattingClientCapabilities": DocumentOnTypeFormattingClientCapabilities, "DocumentOnTypeFormattingOptions": DocumentOnTypeFormattingOptions, "DocumentOnTypeFormattingParams": DocumentOnTypeFormattingParams, "DocumentOnTypeFormattingRegistrationOptions": DocumentOnTypeFormattingRegistrationOptions, "DocumentRangeFormattingClientCapabilities": DocumentRangeFormattingClientCapabilities, "DocumentRangeFormattingOptions": DocumentRangeFormattingOptions, "DocumentRangeFormattingParams": DocumentRangeFormattingParams, "DocumentRangeFormattingRegistrationOptions": DocumentRangeFormattingRegistrationOptions, "DocumentRangesFormattingParams": DocumentRangesFormattingParams, "DocumentSelector": DocumentSelector, "DocumentSymbol": DocumentSymbol, "DocumentSymbolClientCapabilities": DocumentSymbolClientCapabilities, "DocumentSymbolClientCapabilitiesSymbolKindType": DocumentSymbolClientCapabilitiesSymbolKindType, "DocumentSymbolClientCapabilitiesTagSupportType": DocumentSymbolClientCapabilitiesTagSupportType, "DocumentSymbolOptions": DocumentSymbolOptions, "DocumentSymbolParams": DocumentSymbolParams, "DocumentSymbolRegistrationOptions": DocumentSymbolRegistrationOptions, "ErrorCodes": ErrorCodes, "ExecuteCommandClientCapabilities": ExecuteCommandClientCapabilities, "ExecuteCommandOptions": ExecuteCommandOptions, "ExecuteCommandParams": ExecuteCommandParams, "ExecuteCommandRegistrationOptions": ExecuteCommandRegistrationOptions, "ExecutionSummary": ExecutionSummary, "ExitNotification": ExitNotification, "FailureHandlingKind": FailureHandlingKind, "FileChangeType": FileChangeType, "FileCreate": FileCreate, "FileDelete": FileDelete, "FileEvent": FileEvent, "FileOperationClientCapabilities": FileOperationClientCapabilities, "FileOperationFilter": FileOperationFilter, "FileOperationOptions": FileOperationOptions, "FileOperationPattern": FileOperationPattern, "FileOperationPatternKind": FileOperationPatternKind, "FileOperationPatternOptions": FileOperationPatternOptions, "FileOperationRegistrationOptions": FileOperationRegistrationOptions, "FileRename": FileRename, "FileSystemWatcher": FileSystemWatcher, "FoldingRange": FoldingRange, "FoldingRangeClientCapabilities": FoldingRangeClientCapabilities, "FoldingRangeClientCapabilitiesFoldingRangeKindType": FoldingRangeClientCapabilitiesFoldingRangeKindType, "FoldingRangeClientCapabilitiesFoldingRangeType": FoldingRangeClientCapabilitiesFoldingRangeType, "FoldingRangeKind": FoldingRangeKind, "FoldingRangeOptions": FoldingRangeOptions, "FoldingRangeParams": FoldingRangeParams, "FoldingRangeRegistrationOptions": FoldingRangeRegistrationOptions, "FormattingOptions": FormattingOptions, "FullDocumentDiagnosticReport": FullDocumentDiagnosticReport, "GeneralClientCapabilities": GeneralClientCapabilities, "GeneralClientCapabilitiesStaleRequestSupportType": GeneralClientCapabilitiesStaleRequestSupportType, "GlobPattern": GlobPattern, "Hover": Hover, "HoverClientCapabilities": HoverClientCapabilities, "HoverOptions": HoverOptions, "HoverParams": HoverParams, "HoverRegistrationOptions": HoverRegistrationOptions, "ImplementationClientCapabilities": ImplementationClientCapabilities, "ImplementationOptions": ImplementationOptions, "ImplementationParams": ImplementationParams, "ImplementationRegistrationOptions": ImplementationRegistrationOptions, "InitializeError": InitializeError, "InitializeParams": InitializeParams, "InitializeParamsClientInfoType": InitializeParamsClientInfoType, "InitializeRequest": InitializeRequest, "InitializeResponse": InitializeResponse, "InitializeResult": InitializeResult, "InitializeResultServerInfoType": InitializeResultServerInfoType, "InitializedNotification": InitializedNotification, "InitializedParams": InitializedParams, "InlayHint": InlayHint, "InlayHintClientCapabilities": InlayHintClientCapabilities, "InlayHintClientCapabilitiesResolveSupportType": InlayHintClientCapabilitiesResolveSupportType, "InlayHintKind": InlayHintKind, "InlayHintLabelPart": InlayHintLabelPart, "InlayHintOptions": InlayHintOptions, "InlayHintParams": InlayHintParams, "InlayHintRegistrationOptions": InlayHintRegistrationOptions, "InlayHintResolveRequest": InlayHintResolveRequest, "InlayHintResolveResponse": InlayHintResolveResponse, "InlayHintWorkspaceClientCapabilities": InlayHintWorkspaceClientCapabilities, "InlineCompletionClientCapabilities": InlineCompletionClientCapabilities, "InlineCompletionContext": InlineCompletionContext, "InlineCompletionItem": InlineCompletionItem, "InlineCompletionList": InlineCompletionList, "InlineCompletionOptions": InlineCompletionOptions, "InlineCompletionParams": InlineCompletionParams, "InlineCompletionRegistrationOptions": InlineCompletionRegistrationOptions, "InlineCompletionTriggerKind": InlineCompletionTriggerKind, "InlineValue": InlineValue, "InlineValueClientCapabilities": InlineValueClientCapabilities, "InlineValueContext": InlineValueContext, "InlineValueEvaluatableExpression": InlineValueEvaluatableExpression, "InlineValueOptions": InlineValueOptions, "InlineValueParams": InlineValueParams, "InlineValueRegistrationOptions": InlineValueRegistrationOptions, "InlineValueText": InlineValueText, "InlineValueVariableLookup": InlineValueVariableLookup, "InlineValueWorkspaceClientCapabilities": InlineValueWorkspaceClientCapabilities, "InsertReplaceEdit": InsertReplaceEdit, "InsertTextFormat": InsertTextFormat, "InsertTextMode": InsertTextMode, "LSPAny": LSPAny, "LSPArray": LSPArray, "LSPErrorCodes": LSPErrorCodes, "LSPObject": LSPObject, "LinkedEditingRangeClientCapabilities": LinkedEditingRangeClientCapabilities, "LinkedEditingRangeOptions": LinkedEditingRangeOptions, "LinkedEditingRangeParams": LinkedEditingRangeParams, "LinkedEditingRangeRegistrationOptions": LinkedEditingRangeRegistrationOptions, "LinkedEditingRanges": LinkedEditingRanges, "Location": Location, "LocationLink": LocationLink, "LogMessageParams": LogMessageParams, "LogTraceNotification": LogTraceNotification, "LogTraceParams": LogTraceParams, "MarkdownClientCapabilities": MarkdownClientCapabilities, "MarkedString": MarkedString, "MarkedString_Type1": MarkedString_Type1, "MarkupContent": MarkupContent, "MarkupKind": MarkupKind, "MessageActionItem": MessageActionItem, "MessageDirection": MessageDirection, "MessageType": MessageType, "Moniker": Moniker, "MonikerClientCapabilities": MonikerClientCapabilities, "MonikerKind": MonikerKind, "MonikerOptions": MonikerOptions, "MonikerParams": MonikerParams, "MonikerRegistrationOptions": MonikerRegistrationOptions, "NotebookCell": NotebookCell, "NotebookCellArrayChange": NotebookCellArrayChange, "NotebookCellKind": NotebookCellKind, "NotebookCellTextDocumentFilter": NotebookCellTextDocumentFilter, "NotebookDocument": NotebookDocument, "NotebookDocumentChangeEvent": NotebookDocumentChangeEvent, "NotebookDocumentChangeEventCellsType": NotebookDocumentChangeEventCellsType, "NotebookDocumentChangeEventCellsTypeStructureType": NotebookDocumentChangeEventCellsTypeStructureType, "NotebookDocumentChangeEventCellsTypeTextContentType": NotebookDocumentChangeEventCellsTypeTextContentType, "NotebookDocumentClientCapabilities": NotebookDocumentClientCapabilities, "NotebookDocumentDidChangeNotification": NotebookDocumentDidChangeNotification, "NotebookDocumentDidCloseNotification": NotebookDocumentDidCloseNotification, "NotebookDocumentDidOpenNotification": NotebookDocumentDidOpenNotification, "NotebookDocumentDidSaveNotification": NotebookDocumentDidSaveNotification, "NotebookDocumentFilter": NotebookDocumentFilter, "NotebookDocumentFilter_Type1": NotebookDocumentFilter_Type1, "NotebookDocumentFilter_Type2": NotebookDocumentFilter_Type2, "NotebookDocumentFilter_Type3": NotebookDocumentFilter_Type3, "NotebookDocumentIdentifier": NotebookDocumentIdentifier, "NotebookDocumentSyncClientCapabilities": NotebookDocumentSyncClientCapabilities, "NotebookDocumentSyncOptions": NotebookDocumentSyncOptions, "NotebookDocumentSyncOptionsNotebookSelectorType1": NotebookDocumentSyncOptionsNotebookSelectorType1, "NotebookDocumentSyncOptionsNotebookSelectorType1CellsType": NotebookDocumentSyncOptionsNotebookSelectorType1CellsType, "NotebookDocumentSyncOptionsNotebookSelectorType2": NotebookDocumentSyncOptionsNotebookSelectorType2, "NotebookDocumentSyncOptionsNotebookSelectorType2CellsType": NotebookDocumentSyncOptionsNotebookSelectorType2CellsType, "NotebookDocumentSyncRegistrationOptions": NotebookDocumentSyncRegistrationOptions, "NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1": NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1, "NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1CellsType": NotebookDocumentSyncRegistrationOptionsNotebookSelectorType1CellsType, "NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2": NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2, "NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2CellsType": NotebookDocumentSyncRegistrationOptionsNotebookSelectorType2CellsType, "OptionalVersionedTextDocumentIdentifier": OptionalVersionedTextDocumentIdentifier, "ParameterInformation": ParameterInformation, "PartialResultParams": PartialResultParams, "Pattern": Pattern, "Position": Position, "PositionEncodingKind": PositionEncodingKind, "PrepareRenameParams": PrepareRenameParams, "PrepareRenameResult": PrepareRenameResult, "PrepareRenameResult_Type1": PrepareRenameResult_Type1, "PrepareRenameResult_Type2": PrepareRenameResult_Type2, "PrepareSupportDefaultBehavior": PrepareSupportDefaultBehavior, "PreviousResultId": PreviousResultId, "ProgressNotification": ProgressNotification, "ProgressParams": ProgressParams, "ProgressToken": ProgressToken, "PublishDiagnosticsClientCapabilities": PublishDiagnosticsClientCapabilities, "PublishDiagnosticsClientCapabilitiesTagSupportType": PublishDiagnosticsClientCapabilitiesTagSupportType, "PublishDiagnosticsParams": PublishDiagnosticsParams, "Range": Range, "ReferenceClientCapabilities": ReferenceClientCapabilities, "ReferenceContext": ReferenceContext, "ReferenceOptions": ReferenceOptions, "ReferenceParams": ReferenceParams, "ReferenceRegistrationOptions": ReferenceRegistrationOptions, "Registration": Registration, "RegistrationParams": RegistrationParams, "RegularExpressionsClientCapabilities": RegularExpressionsClientCapabilities, "RelatedFullDocumentDiagnosticReport": RelatedFullDocumentDiagnosticReport, "RelatedUnchangedDocumentDiagnosticReport": RelatedUnchangedDocumentDiagnosticReport, "RelativePattern": RelativePattern, "RenameClientCapabilities": RenameClientCapabilities, "RenameFile": RenameFile, "RenameFileOptions": RenameFileOptions, "RenameFilesParams": RenameFilesParams, "RenameOptions": RenameOptions, "RenameParams": RenameParams, "RenameRegistrationOptions": RenameRegistrationOptions, "ResourceOperation": ResourceOperation, "ResourceOperationKind": ResourceOperationKind, "ResponseError": ResponseError, "ResponseErrorMessage": ResponseErrorMessage, "SaveOptions": SaveOptions, "SelectedCompletionInfo": SelectedCompletionInfo, "SelectionRange": SelectionRange, "SelectionRangeClientCapabilities": SelectionRangeClientCapabilities, "SelectionRangeOptions": SelectionRangeOptions, "SelectionRangeParams": SelectionRangeParams, "SelectionRangeRegistrationOptions": SelectionRangeRegistrationOptions, "SemanticTokenModifiers": SemanticTokenModifiers, "SemanticTokenTypes": SemanticTokenTypes, "SemanticTokens": SemanticTokens, "SemanticTokensClientCapabilities": SemanticTokensClientCapabilities, "SemanticTokensClientCapabilitiesRequestsType": SemanticTokensClientCapabilitiesRequestsType, "SemanticTokensClientCapabilitiesRequestsTypeFullType1": SemanticTokensClientCapabilitiesRequestsTypeFullType1, "SemanticTokensDelta": SemanticTokensDelta, "SemanticTokensDeltaParams": SemanticTokensDeltaParams, "SemanticTokensDeltaPartialResult": SemanticTokensDeltaPartialResult, "SemanticTokensEdit": SemanticTokensEdit, "SemanticTokensLegend": SemanticTokensLegend, "SemanticTokensOptions": SemanticTokensOptions, "SemanticTokensOptionsFullType1": SemanticTokensOptionsFullType1, "SemanticTokensParams": SemanticTokensParams, "SemanticTokensPartialResult": SemanticTokensPartialResult, "SemanticTokensRangeParams": SemanticTokensRangeParams, "SemanticTokensRegistrationOptions": SemanticTokensRegistrationOptions, "SemanticTokensRegistrationOptionsFullType1": SemanticTokensRegistrationOptionsFullType1, "SemanticTokensWorkspaceClientCapabilities": SemanticTokensWorkspaceClientCapabilities, "ServerCapabilities": ServerCapabilities, "ServerCapabilitiesWorkspaceType": ServerCapabilitiesWorkspaceType, "SetTraceNotification": SetTraceNotification, "SetTraceParams": SetTraceParams, "ShowDocumentClientCapabilities": ShowDocumentClientCapabilities, "ShowDocumentParams": ShowDocumentParams, "ShowDocumentResult": ShowDocumentResult, "ShowMessageParams": ShowMessageParams, "ShowMessageRequestClientCapabilities": ShowMessageRequestClientCapabilities, "ShowMessageRequestClientCapabilitiesMessageActionItemType": ShowMessageRequestClientCapabilitiesMessageActionItemType, "ShowMessageRequestParams": ShowMessageRequestParams, "ShutdownRequest": ShutdownRequest, "ShutdownResponse": ShutdownResponse, "SignatureHelp": SignatureHelp, "SignatureHelpClientCapabilities": SignatureHelpClientCapabilities, "SignatureHelpClientCapabilitiesSignatureInformationType": SignatureHelpClientCapabilitiesSignatureInformationType, "SignatureHelpClientCapabilitiesSignatureInformationTypeParameterInformationType": SignatureHelpClientCapabilitiesSignatureInformationTypeParameterInformationType, "SignatureHelpContext": SignatureHelpContext, "SignatureHelpOptions": SignatureHelpOptions, "SignatureHelpParams": SignatureHelpParams, "SignatureHelpRegistrationOptions": SignatureHelpRegistrationOptions, "SignatureHelpTriggerKind": SignatureHelpTriggerKind, "SignatureInformation": SignatureInformation, "StaticRegistrationOptions": StaticRegistrationOptions, "StringValue": StringValue, "SymbolInformation": SymbolInformation, "SymbolKind": SymbolKind, "SymbolTag": SymbolTag, "TelemetryEventNotification": TelemetryEventNotification, "TextDocumentChangeRegistrationOptions": TextDocumentChangeRegistrationOptions, "TextDocumentClientCapabilities": TextDocumentClientCapabilities, "TextDocumentCodeActionRequest": TextDocumentCodeActionRequest, "TextDocumentCodeActionResponse": TextDocumentCodeActionResponse, "TextDocumentCodeLensRequest": TextDocumentCodeLensRequest, "TextDocumentCodeLensResponse": TextDocumentCodeLensResponse, "TextDocumentColorPresentationOptions": TextDocumentColorPresentationOptions, "TextDocumentColorPresentationRequest": TextDocumentColorPresentationRequest, "TextDocumentColorPresentationResponse": TextDocumentColorPresentationResponse, "TextDocumentCompletionRequest": TextDocumentCompletionRequest, "TextDocumentCompletionResponse": TextDocumentCompletionResponse, "TextDocumentContentChangeEvent": TextDocumentContentChangeEvent, "TextDocumentContentChangeEvent_Type1": TextDocumentContentChangeEvent_Type1, "TextDocumentContentChangeEvent_Type2": TextDocumentContentChangeEvent_Type2, "TextDocumentDeclarationRequest": TextDocumentDeclarationRequest, "TextDocumentDeclarationResponse": TextDocumentDeclarationResponse, "TextDocumentDefinitionRequest": TextDocumentDefinitionRequest, "TextDocumentDefinitionResponse": TextDocumentDefinitionResponse, "TextDocumentDiagnosticRequest": TextDocumentDiagnosticRequest, "TextDocumentDiagnosticResponse": TextDocumentDiagnosticResponse, "TextDocumentDidChangeNotification": TextDocumentDidChangeNotification, "TextDocumentDidCloseNotification": TextDocumentDidCloseNotification, "TextDocumentDidOpenNotification": TextDocumentDidOpenNotification, "TextDocumentDidSaveNotification": TextDocumentDidSaveNotification, "TextDocumentDocumentColorRequest": TextDocumentDocumentColorRequest, "TextDocumentDocumentColorResponse": TextDocumentDocumentColorResponse, "TextDocumentDocumentHighlightRequest": TextDocumentDocumentHighlightRequest, "TextDocumentDocumentHighlightResponse": TextDocumentDocumentHighlightResponse, "TextDocumentDocumentLinkRequest": TextDocumentDocumentLinkRequest, "TextDocumentDocumentLinkResponse": TextDocumentDocumentLinkResponse, "TextDocumentDocumentSymbolRequest": TextDocumentDocumentSymbolRequest, "TextDocumentDocumentSymbolResponse": TextDocumentDocumentSymbolResponse, "TextDocumentEdit": TextDocumentEdit, "TextDocumentFilter": TextDocumentFilter, "TextDocumentFilter_Type1": TextDocumentFilter_Type1, "TextDocumentFilter_Type2": TextDocumentFilter_Type2, "TextDocumentFilter_Type3": TextDocumentFilter_Type3, "TextDocumentFoldingRangeRequest": TextDocumentFoldingRangeRequest, "TextDocumentFoldingRangeResponse": TextDocumentFoldingRangeResponse, "TextDocumentFormattingRequest": TextDocumentFormattingRequest, "TextDocumentFormattingResponse": TextDocumentFormattingResponse, "TextDocumentHoverRequest": TextDocumentHoverRequest, "TextDocumentHoverResponse": TextDocumentHoverResponse, "TextDocumentIdentifier": TextDocumentIdentifier, "TextDocumentImplementationRequest": TextDocumentImplementationRequest, "TextDocumentImplementationResponse": TextDocumentImplementationResponse, "TextDocumentInlayHintRequest": TextDocumentInlayHintRequest, "TextDocumentInlayHintResponse": TextDocumentInlayHintResponse, "TextDocumentInlineCompletionRequest": TextDocumentInlineCompletionRequest, "TextDocumentInlineCompletionResponse": TextDocumentInlineCompletionResponse, "TextDocumentInlineValueRequest": TextDocumentInlineValueRequest, "TextDocumentInlineValueResponse": TextDocumentInlineValueResponse, "TextDocumentItem": TextDocumentItem, "TextDocumentLinkedEditingRangeRequest": TextDocumentLinkedEditingRangeRequest, "TextDocumentLinkedEditingRangeResponse": TextDocumentLinkedEditingRangeResponse, "TextDocumentMonikerRequest": TextDocumentMonikerRequest, "TextDocumentMonikerResponse": TextDocumentMonikerResponse, "TextDocumentOnTypeFormattingRequest": TextDocumentOnTypeFormattingRequest, "TextDocumentOnTypeFormattingResponse": TextDocumentOnTypeFormattingResponse, "TextDocumentPositionParams": TextDocumentPositionParams, "TextDocumentPrepareCallHierarchyRequest": TextDocumentPrepareCallHierarchyRequest, "TextDocumentPrepareCallHierarchyResponse": TextDocumentPrepareCallHierarchyResponse, "TextDocumentPrepareRenameRequest": TextDocumentPrepareRenameRequest, "TextDocumentPrepareRenameResponse": TextDocumentPrepareRenameResponse, "TextDocumentPrepareTypeHierarchyRequest": TextDocumentPrepareTypeHierarchyRequest, "TextDocumentPrepareTypeHierarchyResponse": TextDocumentPrepareTypeHierarchyResponse, "TextDocumentPublishDiagnosticsNotification": TextDocumentPublishDiagnosticsNotification, "TextDocumentRangeFormattingRequest": TextDocumentRangeFormattingRequest, "TextDocumentRangeFormattingResponse": TextDocumentRangeFormattingResponse, "TextDocumentRangesFormattingRequest": TextDocumentRangesFormattingRequest, "TextDocumentRangesFormattingResponse": TextDocumentRangesFormattingResponse, "TextDocumentReferencesRequest": TextDocumentReferencesRequest, "TextDocumentReferencesResponse": TextDocumentReferencesResponse, "TextDocumentRegistrationOptions": TextDocumentRegistrationOptions, "TextDocumentRenameRequest": TextDocumentRenameRequest, "TextDocumentRenameResponse": TextDocumentRenameResponse, "TextDocumentSaveReason": TextDocumentSaveReason, "TextDocumentSaveRegistrationOptions": TextDocumentSaveRegistrationOptions, "TextDocumentSelectionRangeRequest": TextDocumentSelectionRangeRequest, "TextDocumentSelectionRangeResponse": TextDocumentSelectionRangeResponse, "TextDocumentSemanticTokensFullDeltaRequest": TextDocumentSemanticTokensFullDeltaRequest, "TextDocumentSemanticTokensFullDeltaResponse": TextDocumentSemanticTokensFullDeltaResponse, "TextDocumentSemanticTokensFullRequest": TextDocumentSemanticTokensFullRequest, "TextDocumentSemanticTokensFullResponse": TextDocumentSemanticTokensFullResponse, "TextDocumentSemanticTokensRangeRequest": TextDocumentSemanticTokensRangeRequest, "TextDocumentSemanticTokensRangeResponse": TextDocumentSemanticTokensRangeResponse, "TextDocumentSignatureHelpRequest": TextDocumentSignatureHelpRequest, "TextDocumentSignatureHelpResponse": TextDocumentSignatureHelpResponse, "TextDocumentSyncClientCapabilities": TextDocumentSyncClientCapabilities, "TextDocumentSyncKind": TextDocumentSyncKind, "TextDocumentSyncOptions": TextDocumentSyncOptions, "TextDocumentTypeDefinitionRequest": TextDocumentTypeDefinitionRequest, "TextDocumentTypeDefinitionResponse": TextDocumentTypeDefinitionResponse, "TextDocumentWillSaveNotification": TextDocumentWillSaveNotification, "TextDocumentWillSaveWaitUntilRequest": TextDocumentWillSaveWaitUntilRequest, "TextDocumentWillSaveWaitUntilResponse": TextDocumentWillSaveWaitUntilResponse, "TextEdit": TextEdit, "TokenFormat": TokenFormat, "TraceValues": TraceValues, "TypeDefinitionClientCapabilities": TypeDefinitionClientCapabilities, "TypeDefinitionOptions": TypeDefinitionOptions, "TypeDefinitionParams": TypeDefinitionParams, "TypeDefinitionRegistrationOptions": TypeDefinitionRegistrationOptions, "TypeHierarchyClientCapabilities": TypeHierarchyClientCapabilities, "TypeHierarchyItem": TypeHierarchyItem, "TypeHierarchyOptions": TypeHierarchyOptions, "TypeHierarchyPrepareParams": TypeHierarchyPrepareParams, "TypeHierarchyRegistrationOptions": TypeHierarchyRegistrationOptions, "TypeHierarchySubtypesParams": TypeHierarchySubtypesParams, "TypeHierarchySubtypesRequest": TypeHierarchySubtypesRequest, "TypeHierarchySubtypesResponse": TypeHierarchySubtypesResponse, "TypeHierarchySupertypesParams": TypeHierarchySupertypesParams, "TypeHierarchySupertypesRequest": TypeHierarchySupertypesRequest, "TypeHierarchySupertypesResponse": TypeHierarchySupertypesResponse, "UnchangedDocumentDiagnosticReport": UnchangedDocumentDiagnosticReport, "UniquenessLevel": UniquenessLevel, "Unregistration": Unregistration, "UnregistrationParams": UnregistrationParams, "VersionedNotebookDocumentIdentifier": VersionedNotebookDocumentIdentifier, "VersionedTextDocumentIdentifier": VersionedTextDocumentIdentifier, "WatchKind": WatchKind, "WillSaveTextDocumentParams": WillSaveTextDocumentParams, "WindowClientCapabilities": WindowClientCapabilities, "WindowLogMessageNotification": WindowLogMessageNotification, "WindowShowDocumentRequest": WindowShowDocumentRequest, "WindowShowDocumentResponse": WindowShowDocumentResponse, "WindowShowMessageNotification": WindowShowMessageNotification, "WindowShowMessageRequestRequest": WindowShowMessageRequestRequest, "WindowShowMessageRequestResponse": WindowShowMessageRequestResponse, "WindowWorkDoneProgressCancelNotification": WindowWorkDoneProgressCancelNotification, "WindowWorkDoneProgressCreateRequest": WindowWorkDoneProgressCreateRequest, "WindowWorkDoneProgressCreateResponse": WindowWorkDoneProgressCreateResponse, "WorkDoneProgressBegin": WorkDoneProgressBegin, "WorkDoneProgressCancelParams": WorkDoneProgressCancelParams, "WorkDoneProgressCreateParams": WorkDoneProgressCreateParams, "WorkDoneProgressEnd": WorkDoneProgressEnd, "WorkDoneProgressOptions": WorkDoneProgressOptions, "WorkDoneProgressParams": WorkDoneProgressParams, "WorkDoneProgressReport": WorkDoneProgressReport, "WorkspaceApplyEditRequest": WorkspaceApplyEditRequest, "WorkspaceApplyEditResponse": WorkspaceApplyEditResponse, "WorkspaceClientCapabilities": WorkspaceClientCapabilities, "WorkspaceCodeLensRefreshRequest": WorkspaceCodeLensRefreshRequest, "WorkspaceCodeLensRefreshResponse": WorkspaceCodeLensRefreshResponse, "WorkspaceConfigurationParams": WorkspaceConfigurationParams, "WorkspaceConfigurationRequest": WorkspaceConfigurationRequest, "WorkspaceConfigurationResponse": WorkspaceConfigurationResponse, "WorkspaceDiagnosticParams": WorkspaceDiagnosticParams, "WorkspaceDiagnosticRefreshRequest": WorkspaceDiagnosticRefreshRequest, "WorkspaceDiagnosticRefreshResponse": WorkspaceDiagnosticRefreshResponse, "WorkspaceDiagnosticReport": WorkspaceDiagnosticReport, "WorkspaceDiagnosticReportPartialResult": WorkspaceDiagnosticReportPartialResult, "WorkspaceDiagnosticRequest": WorkspaceDiagnosticRequest, "WorkspaceDiagnosticResponse": WorkspaceDiagnosticResponse, "WorkspaceDidChangeConfigurationNotification": WorkspaceDidChangeConfigurationNotification, "WorkspaceDidChangeWatchedFilesNotification": WorkspaceDidChangeWatchedFilesNotification, "WorkspaceDidChangeWorkspaceFoldersNotification": WorkspaceDidChangeWorkspaceFoldersNotification, "WorkspaceDidCreateFilesNotification": WorkspaceDidCreateFilesNotification, "WorkspaceDidDeleteFilesNotification": WorkspaceDidDeleteFilesNotification, "WorkspaceDidRenameFilesNotification": WorkspaceDidRenameFilesNotification, "WorkspaceDocumentDiagnosticReport": WorkspaceDocumentDiagnosticReport, "WorkspaceEdit": WorkspaceEdit, "WorkspaceEditClientCapabilities": WorkspaceEditClientCapabilities, "WorkspaceEditClientCapabilitiesChangeAnnotationSupportType": WorkspaceEditClientCapabilitiesChangeAnnotationSupportType, "WorkspaceExecuteCommandRequest": WorkspaceExecuteCommandRequest, "WorkspaceExecuteCommandResponse": WorkspaceExecuteCommandResponse, "WorkspaceFolder": WorkspaceFolder, "WorkspaceFoldersChangeEvent": WorkspaceFoldersChangeEvent, "WorkspaceFoldersInitializeParams": WorkspaceFoldersInitializeParams, "WorkspaceFoldersServerCapabilities": WorkspaceFoldersServerCapabilities, "WorkspaceFullDocumentDiagnosticReport": WorkspaceFullDocumentDiagnosticReport, "WorkspaceInlayHintRefreshRequest": WorkspaceInlayHintRefreshRequest, "WorkspaceInlayHintRefreshResponse": WorkspaceInlayHintRefreshResponse, "WorkspaceInlineValueRefreshRequest": WorkspaceInlineValueRefreshRequest, "WorkspaceInlineValueRefreshResponse": WorkspaceInlineValueRefreshResponse, "WorkspaceSemanticTokensRefreshRequest": WorkspaceSemanticTokensRefreshRequest, "WorkspaceSemanticTokensRefreshResponse": WorkspaceSemanticTokensRefreshResponse, "WorkspaceSymbol": WorkspaceSymbol, "WorkspaceSymbolClientCapabilities": WorkspaceSymbolClientCapabilities, "WorkspaceSymbolClientCapabilitiesResolveSupportType": WorkspaceSymbolClientCapabilitiesResolveSupportType, "WorkspaceSymbolClientCapabilitiesSymbolKindType": WorkspaceSymbolClientCapabilitiesSymbolKindType, "WorkspaceSymbolClientCapabilitiesTagSupportType": WorkspaceSymbolClientCapabilitiesTagSupportType, "WorkspaceSymbolLocationType1": WorkspaceSymbolLocationType1, "WorkspaceSymbolOptions": WorkspaceSymbolOptions, "WorkspaceSymbolParams": WorkspaceSymbolParams, "WorkspaceSymbolRegistrationOptions": WorkspaceSymbolRegistrationOptions, "WorkspaceSymbolRequest": WorkspaceSymbolRequest, "WorkspaceSymbolResolveRequest": WorkspaceSymbolResolveRequest, "WorkspaceSymbolResolveResponse": WorkspaceSymbolResolveResponse, "WorkspaceSymbolResponse": WorkspaceSymbolResponse, "WorkspaceUnchangedDocumentDiagnosticReport": WorkspaceUnchangedDocumentDiagnosticReport, "WorkspaceWillCreateFilesRequest": WorkspaceWillCreateFilesRequest, "WorkspaceWillCreateFilesResponse": WorkspaceWillCreateFilesResponse, "WorkspaceWillDeleteFilesRequest": WorkspaceWillDeleteFilesRequest, "WorkspaceWillDeleteFilesResponse": WorkspaceWillDeleteFilesResponse, "WorkspaceWillRenameFilesRequest": WorkspaceWillRenameFilesRequest, "WorkspaceWillRenameFilesResponse": WorkspaceWillRenameFilesResponse, "WorkspaceWorkspaceFoldersRequest": WorkspaceWorkspaceFoldersRequest, "WorkspaceWorkspaceFoldersResponse": WorkspaceWorkspaceFoldersResponse, "_InitializeParams": _InitializeParams, } _MESSAGE_DIRECTION: Dict[str, str] = { # Request methods CALL_HIERARCHY_INCOMING_CALLS: "clientToServer", CALL_HIERARCHY_OUTGOING_CALLS: "clientToServer", CLIENT_REGISTER_CAPABILITY: "serverToClient", CLIENT_UNREGISTER_CAPABILITY: "serverToClient", CODE_ACTION_RESOLVE: "clientToServer", CODE_LENS_RESOLVE: "clientToServer", COMPLETION_ITEM_RESOLVE: "clientToServer", DOCUMENT_LINK_RESOLVE: "clientToServer", INITIALIZE: "clientToServer", INLAY_HINT_RESOLVE: "clientToServer", SHUTDOWN: "clientToServer", TEXT_DOCUMENT_CODE_ACTION: "clientToServer", TEXT_DOCUMENT_CODE_LENS: "clientToServer", TEXT_DOCUMENT_COLOR_PRESENTATION: "clientToServer", TEXT_DOCUMENT_COMPLETION: "clientToServer", TEXT_DOCUMENT_DECLARATION: "clientToServer", TEXT_DOCUMENT_DEFINITION: "clientToServer", TEXT_DOCUMENT_DIAGNOSTIC: "clientToServer", TEXT_DOCUMENT_DOCUMENT_COLOR: "clientToServer", TEXT_DOCUMENT_DOCUMENT_HIGHLIGHT: "clientToServer", TEXT_DOCUMENT_DOCUMENT_LINK: "clientToServer", TEXT_DOCUMENT_DOCUMENT_SYMBOL: "clientToServer", TEXT_DOCUMENT_FOLDING_RANGE: "clientToServer", TEXT_DOCUMENT_FORMATTING: "clientToServer", TEXT_DOCUMENT_HOVER: "clientToServer", TEXT_DOCUMENT_IMPLEMENTATION: "clientToServer", TEXT_DOCUMENT_INLAY_HINT: "clientToServer", TEXT_DOCUMENT_INLINE_COMPLETION: "clientToServer", TEXT_DOCUMENT_INLINE_VALUE: "clientToServer", TEXT_DOCUMENT_LINKED_EDITING_RANGE: "clientToServer", TEXT_DOCUMENT_MONIKER: "clientToServer", TEXT_DOCUMENT_ON_TYPE_FORMATTING: "clientToServer", TEXT_DOCUMENT_PREPARE_CALL_HIERARCHY: "clientToServer", TEXT_DOCUMENT_PREPARE_RENAME: "clientToServer", TEXT_DOCUMENT_PREPARE_TYPE_HIERARCHY: "clientToServer", TEXT_DOCUMENT_RANGES_FORMATTING: "clientToServer", TEXT_DOCUMENT_RANGE_FORMATTING: "clientToServer", TEXT_DOCUMENT_REFERENCES: "clientToServer", TEXT_DOCUMENT_RENAME: "clientToServer", TEXT_DOCUMENT_SELECTION_RANGE: "clientToServer", TEXT_DOCUMENT_SEMANTIC_TOKENS_FULL: "clientToServer", TEXT_DOCUMENT_SEMANTIC_TOKENS_FULL_DELTA: "clientToServer", TEXT_DOCUMENT_SEMANTIC_TOKENS_RANGE: "clientToServer", TEXT_DOCUMENT_SIGNATURE_HELP: "clientToServer", TEXT_DOCUMENT_TYPE_DEFINITION: "clientToServer", TEXT_DOCUMENT_WILL_SAVE_WAIT_UNTIL: "clientToServer", TYPE_HIERARCHY_SUBTYPES: "clientToServer", TYPE_HIERARCHY_SUPERTYPES: "clientToServer", WINDOW_SHOW_DOCUMENT: "serverToClient", WINDOW_SHOW_MESSAGE_REQUEST: "serverToClient", WINDOW_WORK_DONE_PROGRESS_CREATE: "serverToClient", WORKSPACE_APPLY_EDIT: "serverToClient", WORKSPACE_CODE_LENS_REFRESH: "serverToClient", WORKSPACE_CONFIGURATION: "serverToClient", WORKSPACE_DIAGNOSTIC: "clientToServer", WORKSPACE_DIAGNOSTIC_REFRESH: "serverToClient", WORKSPACE_EXECUTE_COMMAND: "clientToServer", WORKSPACE_INLAY_HINT_REFRESH: "serverToClient", WORKSPACE_INLINE_VALUE_REFRESH: "serverToClient", WORKSPACE_SEMANTIC_TOKENS_REFRESH: "serverToClient", WORKSPACE_SYMBOL: "clientToServer", WORKSPACE_SYMBOL_RESOLVE: "clientToServer", WORKSPACE_WILL_CREATE_FILES: "clientToServer", WORKSPACE_WILL_DELETE_FILES: "clientToServer", WORKSPACE_WILL_RENAME_FILES: "clientToServer", WORKSPACE_WORKSPACE_FOLDERS: "serverToClient", # Notification methods CANCEL_REQUEST: "both", EXIT: "clientToServer", INITIALIZED: "clientToServer", LOG_TRACE: "serverToClient", NOTEBOOK_DOCUMENT_DID_CHANGE: "clientToServer", NOTEBOOK_DOCUMENT_DID_CLOSE: "clientToServer", NOTEBOOK_DOCUMENT_DID_OPEN: "clientToServer", NOTEBOOK_DOCUMENT_DID_SAVE: "clientToServer", PROGRESS: "both", SET_TRACE: "clientToServer", TELEMETRY_EVENT: "serverToClient", TEXT_DOCUMENT_DID_CHANGE: "clientToServer", TEXT_DOCUMENT_DID_CLOSE: "clientToServer", TEXT_DOCUMENT_DID_OPEN: "clientToServer", TEXT_DOCUMENT_DID_SAVE: "clientToServer", TEXT_DOCUMENT_PUBLISH_DIAGNOSTICS: "serverToClient", TEXT_DOCUMENT_WILL_SAVE: "clientToServer", WINDOW_LOG_MESSAGE: "serverToClient", WINDOW_SHOW_MESSAGE: "serverToClient", WINDOW_WORK_DONE_PROGRESS_CANCEL: "clientToServer", WORKSPACE_DID_CHANGE_CONFIGURATION: "clientToServer", WORKSPACE_DID_CHANGE_WATCHED_FILES: "clientToServer", WORKSPACE_DID_CHANGE_WORKSPACE_FOLDERS: "clientToServer", WORKSPACE_DID_CREATE_FILES: "clientToServer", WORKSPACE_DID_DELETE_FILES: "clientToServer", WORKSPACE_DID_RENAME_FILES: "clientToServer", } def message_direction(method: str) -> str: """Returns message direction clientToServer, serverToClient or both.""" return _MESSAGE_DIRECTION[method]