Migrate from pyright to ty (#24)

* Introduce ty

* Fix ty issues

* Update vscode config

* remove mise file

Author: lukasbindreiter

.github/workflows/main.yml

@@ -29,8 +29,8 @@ jobs:
         run: uv sync --all-packages --frozen
       - name: Ruff
         run: uv run ruff format --check . && uv run ruff check .
-      - name: Pyright
-        run: uv run pyright .
+      - name: Ty
+        run: uv run ty check
 
   tests:
     name: Run tests

.pre-commit-config.yaml

@@ -1,11 +1,11 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
   - repo: https://github.com/tsvikas/sync-with-uv
-    rev: v0.4.0
+    rev: v0.5.0
     hooks:
       - id: sync-with-uv
   - repo: https://github.com/charliermarsh/ruff-pre-commit
@@ -14,7 +14,12 @@ repos:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
-  - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.400
+  - repo: local
     hooks:
-      - id: pyright
+      - id: ty-check
+        name: ty-check
+        language: python
+        entry: ty check
+        pass_filenames: false
+        args: [--python=.venv/]
+        additional_dependencies: [ty]

.vscode/extensions.json

@@ -1,5 +1,6 @@
 {
   "recommendations": [
+    "astral-sh.ty",
     "ms-python.python",
     "ms-python.vscode-pylance",
     "charliermarsh.ruff",

.vscode/settings.json

@@ -12,6 +12,7 @@
     }
   },
   "files.insertFinalNewline": true,
+  "python.languageServer": "None",
   "python.testing.unittestEnabled": false,
   "python.testing.pytestEnabled": true,
   "python.analysis.autoImportCompletions": true,

CONTRIBUTING.md

@@ -42,7 +42,7 @@ uv run --package tilebox-datasets pytest tilebox-datasets
 uv run ruff format . && uv run ruff check --fix .
 
 # type checking:
-uv run pyright .
+uv run ty check
 ```
 
 ### Adding dependencies to one of the packages
@@ -54,8 +54,8 @@ uv add --package tilebox-datasets "numpy>=2"
 ### Used code quality tools
 
 - [ruff](https://github.com/astral-sh/ruff) for linting and formatting
-- [pyright](https://github.com/microsoft/pyright) for type checking
-- [pre-commit](https://pre-commit.com/) for running all of the above automatically on each git commit
+- [ty](github.com/astral-sh/ty) for type checking
+- [prek](https://prek.j178.dev/) for running all of the above automatically on each git commit
 
 ## Protobuf usage
 

pyproject.toml

@@ -24,11 +24,10 @@ dev = [
     "pyarrow>=17.0.0",
     # some dev tooling
     "ruff>=0.11.10",
-    # pyright 1.1.401 reports many wrong false positives, let's wait until that is fixed before upgrading
-    "pyright>=1.1.379,<1.1.401",
-    "pre-commit>=3.8.0",
     "types-protobuf>=6.30",
     "junitparser>=3.2.0",
+    "ty>=0.0.11",
+    "prek>=0.2.27",
 ]
 
 [project.scripts]
@@ -112,33 +111,10 @@ known-first-party = ["tilebox", "_tilebox"]
 [tool.ruff.lint.per-file-ignores]
 "*/tests/*" = ["INP001", "SLF001"]
 
-[tool.pyright]
+[tool.ty.src]
 exclude = [
-    "**/.ipynb_checkpoints",
-    "**/__pycache__",
-    ".venv",
-    "tilebox-datasets/tests/example_dataset/*", # auto-generated code
-    "tilebox-workflows/tests/proto/*",          # auto-generated code
+    # auto-generated code
+    "**/*_pb2.py",
+    "**/*_pb2.pyi",
+    "**/*pb2_grpc.py"
 ]
-
-# ignore warnings in those files, but still type check them when used as a dependency in other files
-ignore = [
-    # it's auto generated
-    "**/datasets/v1",
-    "**/workflows/v1",
-    "**/tilebox/v1",
-    "**/buf/validate",
-]
-
-# pyright needs to have all the dependencies installed to be able to type check
-# we can make sure of this by telling it to use the uv venv
-venvPath = "."
-venv = ".venv"
-extraPaths = [
-    "tilebox-datasets",
-    "tilebox-grpc",
-    "tilebox-storage",
-    "tilebox-workflows",
-]
-
-reportPrivateImportUsage = false

tilebox-datasets/tests/data/datapoint.py

@@ -62,7 +62,7 @@ def example_datapoints(draw: DrawFn, generated_fields: bool = False, missing_fie
         some_time=draw(datetime_messages() | maybe_none),
         some_duration=draw(duration_messages() | maybe_none),
         some_bytes=draw(binary(min_size=1, max_size=10) | maybe_none),
-        some_bool=draw(booleans() | maybe_none),  # type: ignore[arg-type]
+        some_bool=draw(booleans() | maybe_none),
         # well-known types
         some_identifier=draw(uuid_messages() | maybe_none),
         some_vec3=draw(vec3_messages() | maybe_none),

tilebox-datasets/tilebox/datasets/message_pool.py

@@ -1,5 +1,6 @@
 from google.protobuf import descriptor_pb2, duration_pb2, timestamp_pb2
 from google.protobuf.descriptor_pool import Default
+from google.protobuf.message import Message
 from google.protobuf.message_factory import GetMessageClass, GetMessages
 
 from tilebox.datasets.data.datasets import AnnotatedType
@@ -25,5 +26,5 @@ def register_message_types(descriptor_set: descriptor_pb2.FileDescriptorSet) ->
     GetMessages(descriptor_set.file, pool=Default())
 
 
-def get_message_type(type_url: str) -> type:
+def get_message_type(type_url: str) -> type[Message]:
     return GetMessageClass(Default().FindMessageTypeByName(type_url))

tilebox-datasets/tilebox/datasets/progress.py

@@ -62,7 +62,8 @@ def _calc_progress_seconds(self, time: datetime) -> int:
 
     def set_progress(self, time: datetime) -> None:
         """Set the progress of the progress bar to the given time"""
-        done = min(self._calc_progress_seconds(time), self._progress_bar.total)
+        total = self._calc_progress_seconds(self._interval.end)
+        done = min(self._calc_progress_seconds(time), total)
         self._progress_bar.update(done - self._progress_bar.n)
 
     def set_download_info(self, datapoints: int, byte_size: int, download_time: float) -> None:
@@ -79,7 +80,8 @@ def __exit__(
     ) -> None:
         try:
             if traceback is None:
-                self._progress_bar.update(self._progress_bar.total - self._progress_bar.n)  # set to 100%
+                total = self._calc_progress_seconds(self._interval.end)
+                self._progress_bar.update(total - self._progress_bar.n)  # set to 100%
 
             self._progress_bar.close()  # mark as completed or failed
         except AttributeError:

tilebox-datasets/tilebox/datasets/protobuf_conversion/field_types.py

@@ -1,4 +1,4 @@
-from collections.abc import Sized
+from collections.abc import Sequence
 from datetime import timedelta
 from typing import Any
 from uuid import UUID
@@ -16,9 +16,10 @@
 from tilebox.datasets.datasets.v1.well_known_types_pb2 import UUID as UUIDMessage  # noqa: N811
 from tilebox.datasets.datasets.v1.well_known_types_pb2 import Geometry, LatLon, LatLonAlt, Quaternion, Vec3
 
-ProtoFieldValue = Message | float | str | bool | bytes | Sized | None
+ScalarProtoFieldValue = Message | float | str | bool | bytes
+ProtoFieldValue = ScalarProtoFieldValue | Sequence[ScalarProtoFieldValue] | None
 
-_FILL_VALUES_BY_DTYPE = {
+_FILL_VALUES_BY_DTYPE: dict[type[np.dtype[Any]], Any] = {
     npdtypes.Int8DType: np.int8(0),
     npdtypes.Int16DType: np.int16(0),
     npdtypes.Int32DType: np.int32(0),