chore: pyright (#4289)

Closes #2668

---------

Signed-off-by: Daniel King <[email protected]>

Author: danking

.github/workflows/ci.yml

@@ -57,6 +57,8 @@ jobs:
         run: uv run ruff format --check .
       - name: Python Lint - Ruff
         run: uv run ruff check .
+      - name: Python Lint - PyRight
+        run: uv run basedpyright vortex-python
 
   python-test:
     name: "Python (test)"
@@ -73,25 +75,19 @@ jobs:
           sync: false
           prune-cache: false
 
-      # Ensure the stub files are up-to-date with the public API of the native module.
-      - name: Stubtest - Vortex
-        run: |
-          uv run --isolated --all-packages stubtest vortex._lib --allowlist python/vortex/_lib/mypy.allowlist
-        working-directory: vortex-python/
-
       - name: Pytest - Vortex
         run: |
-          uv run --isolated --all-packages pytest --benchmark-disable test/
+          uv run --all-packages pytest --benchmark-disable test/
         working-directory: vortex-python/
 
       - name: Doctest - PyVortex
         run: |
-          uv run --isolated --all-packages make doctest
+          uv run --all-packages make doctest
         working-directory: docs/
 
       - name: Ensure docs build - PyVortex
         run: |
-          uv run --isolated --all-packages make html
+          uv run --all-packages make html
         working-directory: docs/
 
       - uses: mlugg/setup-zig@v2

docs/api/python/arrays.rst

@@ -60,22 +60,18 @@ of the array, and are also zero-copy to Apache Arrow.
 Utility Encodings
 -----------------
 
-.. autoclass:: vortex.ChunkedArray
+.. autoclass:: vortex.ConstantArray
     :members:
 
 
-.. autoclass:: vortex.ConstantArray
+.. autoclass:: vortex.ChunkedArray
     :members:
 
 
 .. autoclass:: vortex.ByteBoolArray
      :members:
 
 
-.. autoclass:: vortex.SparseArray
-    :members:
-
-
 Compressed Encodings
 --------------------
 
@@ -103,10 +99,19 @@ Compressed Encodings
     :members:
 
 
+.. autoclass:: vortex.SequenceArray
+    :members:
+
+
+.. autoclass:: vortex.SparseArray
+    :members:
+
+
 .. autoclass:: vortex.ZigZagArray
     :members:
 
 
+
 .. autoclass:: vortex.FastLanesBitPackedArray
     :members:
 
@@ -148,4 +153,4 @@ Streams and Iterators
 ---------------------
 
 .. autoclass:: vortex.ArrayIterator
-    :members:
+    :members:

docs/api/python/index.rst

@@ -11,3 +11,4 @@ Python API
    compress
    io
    dataset
+   type_aliases

docs/api/python/type_aliases.rst

@@ -0,0 +1,16 @@
+Type Aliases
+============
+
+.. data:: vortex.type_aliases.IntoArrayIterator
+
+          Anything that can produce a sequence of Vortex Arrays.
+
+
+.. data:: vortex.type_aliases.IntoProjection
+
+          An expression, a list of column names, or None.
+
+          Only the data necessary to evaluate the expression or produce the explicit column list are read.
+
+          If None, all columns from the file are read.
+

docs/conf.py

@@ -43,7 +43,7 @@
     "pyarrow": ("https://arrow.apache.org/docs", None),
     "pandas": ("https://pandas.pydata.org/docs", None),
     "numpy": ("https://numpy.org/doc/stable", None),
-    "polars": ("https://docs.pola.rs/api/python/stable", None),
+    "polars": ("https://docs.pola.rs/api/python/stable", "polars.objects.inv"),
 }
 
 git_root = Path(__file__).parent.parent

docs/generate_missing_polars_objects_inv.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env -S uv run --script
+# /// script
+# requires-python = ">=3.12"
+# dependencies = [
+# "sphobjinv",
+# ]
+# ///
+#
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright the Vortex contributors
+#
+# https://github.com/pola-rs/polars/issues/7027#issuecomment-2661198001
+
+import sphobjinv as soi
+
+inv = soi.Inventory()
+inv.project = "Polars"
+inv.version = ""
+
+data_obj_strs = [
+    soi.DataObjStr(
+        name="polars.DataFrame",
+        domain="py",
+        role="class",
+        priority="1",
+        uri="reference/dataframe/index.html",
+        dispname="DataFrame",
+    ),
+    soi.DataObjStr(
+        name="polars.LazyFrame",
+        domain="py",
+        role="class",
+        priority="1",
+        uri="reference/lazyframe/index.html",
+        dispname="LazyFrame",
+    ),
+    soi.DataObjStr(
+        name="Expr",
+        domain="py",
+        role="class",
+        priority="1",
+        uri="expressions/index.html",
+        dispname="Expr",
+    ),
+    soi.DataObjStr(
+        name="Series",
+        domain="py",
+        role="class",
+        priority="1",
+        uri="series/index.html",
+        dispname="Series",
+    ),
+]
+
+for data_obj_str in data_obj_strs:
+    inv.objects.append(data_obj_str)
+
+text = inv.data_file()
+ztext = soi.compress(text)
+
+soi.writebytes("polars.objects.inv", ztext)

docs/polars.objects.inv

@@ -0,0 +1,6 @@
+# Sphinx inventory version 2
+# Project: Polars
+# Version: 
+# The remainder of this file is compressed using zlib.
+x�}�;
+�0��"'Pl����,��@~�Z��7*H@��}3�%����:&�z�$�+͘��#�)��5��O؊euV���O��c���4"���-r."�1�K.\����rr�a�	�ERe

pyproject.toml

@@ -19,13 +19,16 @@ required-version = ">=0.6.0"
 # Currently, all dev dependencies live in the root since uv doesn't have transitive dev dependencies.
 #  See: https://github.com/astral-sh/uv/issues/7541
 dev-dependencies = [
+    "basedpyright>=1.31",
     "duckdb>=1.1.2",
     "ipython>=8.26.0",
     "maturin>=1.7.2",
+    "pandas-stubs>=2.2.3.241126",
     "pandas[output-formatting]>=2.2.3",
+    "pcodec>=0.3.3",
     "pip>=23.3.2",
     "polars>=1.9.0",
-    "pyright>=1.1.385",
+    "pyarrow-stubs>=17.16",
     "pytest-benchmark>=4.0.0",
     "pytest>=7.4.0",
     "ruff>=0.7.1",