refactor: fix most ruff issues in generated types (#29)

* refactor: fix most ruff issues in generated types

* run tox

* unused

* remove mypy

* update readme

Author: rchl

.github/workflows/main.yml

@@ -16,7 +16,6 @@ jobs:
       - uses: actions/setup-python@v6
         with:
           python-version: '3.14'
-      - run: pip3 install pyright==1.1.271  flake8==5.0.4 --user
+      - run: pip3 install tox --user
       - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
-      - run: pyright .
-      - run: flake8 .
+      - run: tox

README.md

@@ -18,6 +18,4 @@ python ./generate.py
 ```
 Copy the `lsp_types.py` file to your project.
 
-The `lsp_types_sublime_text_33.py` file is made specifically for use in Sublime's LSP package using Python 3.3 host that doesn't support class-based `TypedDict` syntax. For all other cases stick with `lsp_types.py`.
-
 NOTE: Do not import types that begin with `__`. These types are internal types and are not meant to be used.

download_schemas.py

@@ -1,7 +1,11 @@
+from pathlib import Path
 from urllib.request import urlopen
 
-lsp_json_schema = urlopen("https://raw.githubusercontent.com/microsoft/vscode-languageserver-node/main/protocol/metaModel.schema.json").read().decode('utf-8')
-open("./lsprotocol/lsp.schema.json", "w").write(lsp_json_schema)
 
-lsp_meta_model = urlopen("https://raw.githubusercontent.com/microsoft/vscode-languageserver-node/main/protocol/metaModel.json").read().decode('utf-8')
-open("./lsprotocol/lsp.json", "w").write(lsp_meta_model)
+REPO_URL = 'https://raw.githubusercontent.com/microsoft/vscode-languageserver-node'
+
+with urlopen(f'{REPO_URL}/main/protocol/metaModel.schema.json') as url:
+    Path('./lsprotocol/lsp.schema.json', 'w').write_text(url.read().decode('utf-8'))
+
+with urlopen(f'{REPO_URL}/main/protocol/metaModel.json'):
+    Path('./lsprotocol/lsp.json', 'w').write_text(url.read().decode('utf-8'))

generate.py

@@ -1,15 +1,19 @@
 #!/usr/bin/env python3
-import json
 
-from lsp_schema import MetaModel
-from typing import Dict, Literal
+from __future__ import annotations
+from pathlib import Path
+from typing import Literal, cast, TYPE_CHECKING
 from utils.generate_enumerations import generate_enumerations
 from utils.generate_structures import generate_structures
 from utils.generate_type_aliases import generate_type_aliases
-from utils.helpers import get_new_literal_structures, reset_new_literal_structures, StructureKind
+from utils.helpers import get_new_literal_structures, reset_new_literal_structures
+import json
+
+if TYPE_CHECKING:
+    from lsp_schema import MetaModel
 
 
-ENUM_OVERRIDES = {
+ENUM_OVERRIDES: dict[str, Literal['StrEnum', 'IntFlag']] = {
     'CodeActionKind': 'StrEnum',
     'DocumentDiagnosticReportKind': 'StrEnum',
     'FailureHandlingKind': 'StrEnum',
@@ -26,46 +30,48 @@
     'TraceValue': 'StrEnum',
     'UniquenessLevel': 'StrEnum',
     'WatchKind': 'IntFlag',
-    'ApplyKind': 'IntFlag'
-}  # type: Dict[str, Literal['StrEnum', 'IntFlag']]
+    'ApplyKind': 'IntFlag',
+}
 
 
-def generate(preferred_structure_kind: StructureKind, output: str) -> None:
+def generate(output: str) -> None:
     reset_new_literal_structures()
 
-    with open('./lsprotocol/lsp.json') as file:
-        lsp_json: MetaModel = json.load(file)
-        specification_version = lsp_json.get('metaData')['version']
+    schema = Path('./lsprotocol/lsp.json').read_text(encoding='utf-8')
+    lsp_json = cast('MetaModel', json.loads(schema))
+    specification_version = lsp_json.get('metaData')['version']
 
-        content = "\n".join([
-            "# Code generated. DO NOT EDIT.",
-            f"# LSP v{specification_version}\n",
-            "from typing_extensions import NotRequired",
-            "from typing import Dict, List, Literal, TypedDict, Union",
-            "from enum import IntEnum, IntFlag, StrEnum\n\n",
-            "URI = str",
-            "DocumentUri = str",
-            "Uint = int",
-            "RegExp = str",
-        ])
+    content = '\n'.join(
+        [
+            '# ruff: noqa: E501, UP006, UP007',
+            '# Code generated. DO NOT EDIT.',
+            f'# LSP v{specification_version}\n',
+            'from __future__ import annotations',
+            'from enum import IntEnum, IntFlag, StrEnum',
+            'from typing import Dict, List, Literal, TypedDict, Union',
+            'from typing_extensions import NotRequired\n\n',
+            'URI = str',
+            'DocumentUri = str',
+            'Uint = int',
+            'RegExp = str',
+        ]
+    )
 
-        content += '\n\n\n'
-        content += '\n\n\n'.join(generate_enumerations(lsp_json['enumerations'], ENUM_OVERRIDES))
-        content += '\n\n'
-        content += '\n'.join(generate_type_aliases(lsp_json['typeAliases'], preferred_structure_kind))
-        content += '\n\n\n'
-        content += '\n\n\n'.join(generate_structures(lsp_json['structures'], preferred_structure_kind))
-        content += '\n\n'
-        content += '\n'.join(get_new_literal_structures())
+    content += '\n\n\n'
+    content += '\n\n\n'.join(generate_enumerations(lsp_json['enumerations'], ENUM_OVERRIDES))
+    content += '\n\n'
+    content += '\n'.join(generate_type_aliases(lsp_json['typeAliases']))
+    content += '\n\n\n'
+    content += '\n\n\n'.join(generate_structures(lsp_json['structures']))
+    content += '\n\n'
+    content += '\n'.join(get_new_literal_structures())
 
-        # Remove trailing spaces.
-        lines = content.split('\n')
-        lines = [line.rstrip() for line in lines]
-        content = '\n'.join(lines)
+    # Remove trailing spaces.
+    lines = content.split('\n')
+    lines = [line.rstrip() for line in lines]
+    content = '\n'.join(lines)
 
-        with open(output, "w") as new_file:
-            new_file.write(content)
+    Path(output).write_text(content)
 
 
-generate(preferred_structure_kind=StructureKind.Class, output="./lsp_types.py")
-generate(preferred_structure_kind=StructureKind.Function, output="./lsp_types_sublime_text_33.py")
+generate(output='./generated/lsp_types.py')