Python generator: use Mapping instead of Dict for type annotations

Fixes #414

Author: lheckemann

generator/plugins/python/utils.py

@@ -208,7 +208,7 @@ def _reset(self):
         self._imports: List[str] = [
             "import enum",
             "import functools",
-            "from typing import Any, Dict, Literal, Optional, Sequence, Tuple, Union",
+            "from typing import Any, Mapping, Literal, Optional, Sequence, Tuple, Union",
             "import attrs",
             "from . import validators",
         ]
@@ -356,7 +356,7 @@ def _generate_type_name(
 
         if type_def.kind == "map":
             # This kind defines a dictionary like object.
-            return f"Dict[{self._generate_type_name(type_def.key, class_name, prefix)}, {self._generate_type_name(type_def.value, class_name, prefix)}]"
+            return f"Mapping[{self._generate_type_name(type_def.key, class_name, prefix)}, {self._generate_type_name(type_def.value, class_name, prefix)}]"
 
         if type_def.kind == "tuple":
             # This kind defined a tuple like object.
@@ -1154,11 +1154,11 @@ def _get_utility_code(self, lsp_model: model.LSPModel) -> List[str]:
             "",
         ]
 
-        code_lines += ["", "ALL_TYPES_MAP: Dict[str, Union[type, object]] = {"]
+        code_lines += ["", "ALL_TYPES_MAP: Mapping[str, Union[type, object]] = {"]
         code_lines += sorted([f"'{name}': {name}," for name in set(self._types.keys())])
         code_lines += ["}", ""]
 
-        code_lines += ["_MESSAGE_DIRECTION: Dict[str, str] = {"]
+        code_lines += ["_MESSAGE_DIRECTION: Mapping[str, str] = {"]
 
         code_lines += ["# Request methods"]
         code_lines += sorted(

packages/python/lsprotocol/types.py

@@ -9,7 +9,7 @@
 
 import enum
 import functools
-from typing import Any, Dict, Literal, Optional, Sequence, Tuple, Union
+from typing import Any, Mapping, Literal, Optional, Sequence, Tuple, Union
 import attrs
 from . import validators
 
@@ -1957,7 +1957,7 @@ class WorkspaceEdit:
     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, Sequence["TextEdit"]]] = attrs.field(default=None)
+    changes: Optional[Mapping[str, Sequence["TextEdit"]]] = attrs.field(default=None)
     """Holds changes to existing resources."""
 
     document_changes: Optional[
@@ -1975,7 +1975,7 @@ class WorkspaceEdit:
     only plain `TextEdit`s using the `changes` property are supported."""
 
     change_annotations: Optional[
-        Dict[ChangeAnnotationIdentifier, "ChangeAnnotation"]
+        Mapping[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.
@@ -2454,7 +2454,7 @@ class DocumentDiagnosticReportPartialResult:
 
     # Since: 3.17.0
 
-    related_documents: Dict[
+    related_documents: Mapping[
         str, Union["FullDocumentDiagnosticReport", "UnchangedDocumentDiagnosticReport"]
     ] = attrs.field()
 
@@ -5644,7 +5644,7 @@ class RelatedFullDocumentDiagnosticReport:
     """The actual items."""
 
     related_documents: Optional[
-        Dict[
+        Mapping[
             str,
             Union[FullDocumentDiagnosticReport, "UnchangedDocumentDiagnosticReport"],
         ]
@@ -5705,7 +5705,7 @@ class RelatedUnchangedDocumentDiagnosticReport:
     diagnostic request for the same document."""
 
     related_documents: Optional[
-        Dict[
+        Mapping[
             str, Union[FullDocumentDiagnosticReport, UnchangedDocumentDiagnosticReport]
         ]
     ] = attrs.field(default=None)
@@ -13236,7 +13236,7 @@ def is_special_property(cls: type, property_name: str) -> bool:
     return qualified_name in _SPECIAL_PROPERTIES
 
 
-ALL_TYPES_MAP: Dict[str, Union[type, object]] = {
+ALL_TYPES_MAP: Mapping[str, Union[type, object]] = {
     "AnnotatedTextEdit": AnnotatedTextEdit,
     "ApplyKind": ApplyKind,
     "ApplyWorkspaceEditParams": ApplyWorkspaceEditParams,
@@ -13901,7 +13901,7 @@ def is_special_property(cls: type, property_name: str) -> bool:
     "_InitializeParams": _InitializeParams,
 }
 
-_MESSAGE_DIRECTION: Dict[str, str] = {
+_MESSAGE_DIRECTION: Mapping[str, str] = {
     # Request methods
     CALL_HIERARCHY_INCOMING_CALLS: "clientToServer",
     CALL_HIERARCHY_OUTGOING_CALLS: "clientToServer",