Add pyright type checking to ci (developmentseed#388)

* Add pyright to ci

* progress fixing ci

* skip fsspec typing

* type checks

* fix from_url typing

Author: kylebarron

.github/workflows/test-python.yml

@@ -74,3 +74,9 @@ jobs:
       - name: Check docs
         if: "${{ matrix.python-version == 3.11 }}"
         run: uv run mkdocs build --strict
+
+      - name: Add venv to PATH (for pyright action)
+        run: echo "$PWD/.venv/bin" >> $GITHUB_PATH
+
+      - name: Run pyright
+        uses: jakebailey/pyright-action@v2

obstore/python/obstore/_store/__init__.pyi

@@ -65,7 +65,7 @@ def from_url(
     **kwargs: Unpack[AzureConfig],
 ) -> ObjectStore: ...
 @overload
-def from_url(
+def from_url(  # type: ignore reportOverlappingOverload
     url: str,
     *,
     config: None = None,

obstore/python/obstore/fsspec.py

@@ -161,6 +161,21 @@ def __init__(
         batch_size: int | None = None,
         **kwargs: Unpack[AzureConfig],
     ) -> None: ...
+    @overload
+    def __init__(
+        self,
+        protocol: Literal["file"],
+        *args: Any,
+        config: None = None,
+        client_options: None = None,
+        retry_config: None = None,
+        asynchronous: bool = False,
+        max_cache_size: int = 10,
+        loop: Any = None,
+        batch_size: int | None = None,
+        automatic_cleanup: bool = False,
+        mkdir: bool = False,
+    ) -> None: ...
     def __init__(  # noqa: PLR0913
         self,
         protocol: SUPPORTED_PROTOCOLS_T | str | None = None,
@@ -355,7 +370,7 @@ async def _cat_file(
         range_bytes = await obs.get_range_async(store, path, start=start, end=end)
         return range_bytes.to_bytes()
 
-    async def _cat(
+    async def _cat(  # type: ignore (fsspec has bad typing)
         self,
         path: str,
         recursive: bool = False,
@@ -373,15 +388,15 @@ async def _cat(
             raise FileNotFoundError(err_msg)
 
         # Call the original _cat only on files
-        return await super()._cat(
+        return await super()._cat(  # type: ignore (fsspec has bad typing)
             files,
             recursive=False,
             on_error=on_error,
             batch_size=batch_size,
             **_kwargs,
         )
 
-    async def _cat_ranges(  # noqa: PLR0913
+    async def _cat_ranges(  # noqa: PLR0913 # type: ignore (fsspec has bad typing)
         self,
         paths: list[str],
         starts: list[int] | int,

pyproject.toml

@@ -13,6 +13,7 @@ dev-dependencies = [
     "arro3-core>=0.4.2",
     "azure-identity>=1.21.0",
     "boto3>=1.35.38",
+    "fastapi>=0.115.12",                  # used in example but added here for pyright CI
     "fsspec>=2024.10.0",
     "google-auth>=2.38.0",
     "griffe-inherited-docstrings>=1.0.1",
@@ -34,7 +35,9 @@ dev-dependencies = [
     "pystac>=1.10.1",
     "pytest-asyncio>=0.24.0",
     "pytest>=8.3.3",
+    "python-dotenv>=1.0.1",
     "ruff>=0.11.0",
+    "tqdm>=4.67.1",                       # used in example but added here for pyright CI
     "types-boto3[sts]>=1.36.23",
 ]
 constraint-dependencies = [

tests/conftest.py

@@ -4,7 +4,7 @@
 
 import boto3
 import pytest
-import urllib3
+import requests
 from botocore import UNSIGNED
 from botocore.client import Config
 from moto.moto_server.threaded_moto_server import ThreadedMotoServer
@@ -27,7 +27,9 @@ def moto_server_uri():
     if hasattr(server, "get_host_and_port"):
         host, port = server.get_host_and_port()
     else:
-        host, port = server._server.server_address
+        s = server._server
+        assert s is not None
+        host, port = s.server_address
     uri = f"http://{host}:{port}"
     yield uri
     server.stop()
@@ -44,7 +46,7 @@ def s3(moto_server_uri: str):
     client.create_bucket(Bucket=TEST_BUCKET_NAME, ACL="public-read")
     client.put_object(Bucket=TEST_BUCKET_NAME, Key="afile", Body=b"hello world")
     yield moto_server_uri
-    urllib3.request(method="post", url=f"{moto_server_uri}/moto-api/reset")
+    requests.post(f"{moto_server_uri}/moto-api/reset", timeout=30)
 
 
 @pytest.fixture

tests/store/test_azure.py

@@ -6,11 +6,11 @@
 
 def test_overlapping_config_keys():
     with pytest.raises(BaseError, match="Duplicate key"):
-        AzureStore(azure_container_name="test", AZURE_CONTAINER_NAME="test")
+        AzureStore(container_name="test", AZURE_CONTAINER_NAME="test")  # type: ignore intentional test
 
     with pytest.raises(BaseError, match="Duplicate key"):
         AzureStore(
-            config={"azure_container_name": "test", "AZURE_CONTAINER_NAME": "test"},
+            config={"azure_container_name": "test", "AZURE_CONTAINER_NAME": "test"},  # type: ignore (intentional test)
         )
 
 

tests/store/test_from_url.py

@@ -17,7 +17,7 @@ def test_memory():
     _store = from_url(url)
 
     with pytest.raises(BaseError):
-        from_url(url, aws_access_key_id="test")
+        from_url(url, access_key_id="test")
 
 
 def test_s3_params():
@@ -28,7 +28,7 @@ def test_s3_params():
     )
 
     with pytest.raises(UnknownConfigurationKeyError):
-        from_url("s3://bucket/path", azure_authority_id="")
+        from_url("s3://bucket/path", tenant_id="")
 
 
 def test_gcs_params():
@@ -38,20 +38,20 @@ def test_gcs_params():
     from_url("gs://test.example.com/path")
 
     with pytest.raises(UnknownConfigurationKeyError):
-        from_url("gs://test.example.com/path", azure_authority_id="")
+        from_url("gs://test.example.com/path", tenant_id="")
 
 
 def test_azure_params():
     url = "abfs://[email protected]/path"
-    from_url(url, azure_skip_signature=True)
+    from_url(url, skip_signature=True)
 
     with pytest.raises(UnknownConfigurationKeyError):
-        from_url(url, aws_bucket="test")
+        from_url(url, bucket="test")
 
 
 def test_http():
     url = "https://mydomain/path"
     from_url(url)
 
     with pytest.raises(BaseError):
-        from_url(url, aws_bucket="test")
+        from_url(url, bucket="test")

tests/store/test_gcs.py

@@ -6,10 +6,10 @@
 
 def test_overlapping_config_keys():
     with pytest.raises(BaseError, match="Duplicate key"):
-        GCSStore(google_bucket="bucket", GOOGLE_BUCKET="bucket")
+        GCSStore(google_bucket="bucket", GOOGLE_BUCKET="bucket")  # type: ignore intentional test
 
     with pytest.raises(BaseError, match="Duplicate key"):
-        GCSStore(config={"google_bucket": "test", "GOOGLE_BUCKET": "test"})
+        GCSStore(config={"google_bucket": "test", "GOOGLE_BUCKET": "test"})  # type: ignore intentional test
 
 
 def test_eq():

tests/test_fsspec.py

@@ -59,7 +59,7 @@ def test_register():
     )
 
     # Ensure a new instance of the registered store can be created
-    fs_instance = fs_class()
+    fs_instance = fs_class("s3")
     assert isinstance(
         fs_instance,
         FsspecStore,
@@ -300,7 +300,7 @@ def test_put_files(fs: FsspecStore, tmp_path: Path):
 
     # Verify file upload
     assert remote_file_path in fs.ls(f"{TEST_BUCKET_NAME}", detail=False)
-    assert fs.cat(remote_file_path)[remote_file_path] == test_data.encode()
+    assert fs.cat(remote_file_path)[remote_file_path] == test_data.encode()  # type: ignore (fsspec)
 
     # Cleanup remote file
     fs.rm(remote_file_path)