review: unconditional opendal in vortex-python, pub(crate) supports_scheme

Address review on #9199:

* `hf::supports_scheme` is only asked by the registry, so it does not need to be
  `pub`. Its doc no longer intra-doc-links the OpenDAL counterpart either, since
  that path does not exist in an hf-only build.
* "spelled" -> "passed" in the `TokenArg` doc.
* The Python bindings should not carry Rust feature gates: the `opendal` feature
  of `vortex-python` is gone and the OpenDAL-backed stores (COS, and GooseFS from
  the rebase) are always compiled in, like `HfStore`. The ImportError
  placeholders, the feature language in the stubs and docs, and the cfg gates in
  `lib.rs`/`io.rs` all go with it. Other consumers (JNI) keep the opt-in Cargo
  feature. The `vortex._lib.CosStore`/`GoosefsStore` nitpick entries mirror the
  `HfStore` one, since the simplified re-exports resolve annotations to the
  native module path.

Signed-off-by: Robert Kruszewski <robert@spiraldb.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Lc5zw7Le2T3pakDEUdKTYd

Author: robert3005

docs/api/python/store/opendal.rst

@@ -6,8 +6,8 @@ Vortex can read from and write to Tencent Cloud COS, Alibaba Cloud OSS, and Tenc
 GooseFS through `OpenDAL <https://opendal.apache.org/>`_, which provides native service
 support.
 
-These stores are available only when Vortex is built with the ``opendal`` feature
-(e.g. ``maturin develop --features opendal`` or ``cargo build -p vortex-jni --features opendal``).
+The Python bindings always include these stores. Other consumers opt in with the ``opendal``
+Cargo feature (e.g. ``cargo build -p vortex-jni --features opendal``).
 
 .. list-table::
    :header-rows: 1
@@ -39,9 +39,6 @@ These stores are available only when Vortex is built with the ``opendal`` featur
    :func:`vortex.io.read_url` / :func:`vortex.io.write` via the ``store=`` argument,
    exactly like the built-in S3/Azure/GCS stores.
 
-   The class is only available when Vortex is built with the ``opendal`` feature; on
-   a default build, instantiating it raises :class:`ImportError`.
-
    :param bucket: COS bucket name (e.g. ``"my-bucket"``).
    :param endpoint: COS endpoint (e.g. ``"https://cos.ap-guangzhou.myqcloud.com"``).
    :param secret_id: Optional Tencent Cloud secret id. Maps to the ``TENCENTCLOUD_SECRET_ID``
@@ -62,9 +59,6 @@ These stores are available only when Vortex is built with the ``opendal`` featur
    :func:`vortex.io.read_url` / :func:`vortex.io.write` via the ``store=`` argument,
    exactly like the built-in S3/Azure/GCS stores.
 
-   The class is only available when Vortex is built with the ``opendal`` feature; on
-   a default build, instantiating it raises :class:`ImportError`.
-
    :param master_addr: GooseFS master address(es). Single master:
        ``"10.0.0.1:9200"``. HA (comma-separated):
        ``"10.0.0.1:9200,10.0.0.2:9200,10.0.0.3:9200"``.

docs/conf.py

@@ -57,9 +57,12 @@
     # classes are fully documented in `opendal.rst`; the private paths are intentionally not.
     ("py:class", "vortex.store._cos.CosStore"),
     ("py:class", "vortex.store._goosefs.GoosefsStore"),
-    # `vortex.store.HfStore` is the native class re-exported through `vortex.store._hf`, so
-    # annotations resolve to its `vortex._lib` module path. The public class is fully documented
-    # in `huggingface.rst`; the native path is intentionally not.
+    # `vortex.store.CosStore` / `GoosefsStore` / `HfStore` are the native classes re-exported
+    # through private modules, so annotations resolve to their `vortex._lib` module paths. The
+    # public classes are fully documented in `opendal.rst` / `huggingface.rst`; the native paths
+    # are intentionally not.
+    ("py:class", "vortex._lib.CosStore"),
+    ("py:class", "vortex._lib.GoosefsStore"),
     ("py:class", "vortex._lib.HfStore"),
 ]
 

vortex-cloud/src/hf/mod.rs

@@ -86,9 +86,9 @@ const REVISION_ESCAPES: &AsciiSet = &CONTROLS.add(b'/').add(b'%').add(b'?').add(
 
 /// Whether `scheme` is served by this module.
 ///
-/// Callers dispatching on a URL scheme should ask this rather than comparing against [`HF_SCHEME`]
-/// themselves, matching how [`crate::opendal::supports_scheme`] is used.
-pub fn supports_scheme(scheme: &str) -> bool {
+/// The registry dispatches on this rather than comparing against [`HF_SCHEME`] itself, matching
+/// how the OpenDAL module's `supports_scheme` is used.
+pub(crate) fn supports_scheme(scheme: &str) -> bool {
     scheme == HF_SCHEME
 }
 

vortex-python/Cargo.toml

@@ -28,9 +28,6 @@ default = ["extension-module", "tui"]
 # duplicate PyInit__lib symbols.
 extension-module = []
 tui = ["dep:tokio", "dep:vortex-tui"]
-# OpenDAL-backed object stores (Tencent COS, Alibaba OSS) for `cos://` and `oss://` URLs. Pulls in
-# `opendal`, so it is opt-in.
-opendal = ["vortex-cloud/opendal", "vortex/opendal"]
 
 [dependencies]
 arrow-array = { workspace = true }
@@ -58,9 +55,10 @@ vortex = { workspace = true, features = [
     "hf",
     "object_store",
     "object_store_registry",
+    "opendal",
 ] }
 vortex-arrow = { workspace = true }
-vortex-cloud = { workspace = true, optional = true }
+vortex-cloud = { workspace = true, features = ["opendal"] }
 vortex-python-abi = { path = "../vortex-python-abi" }
 vortex-tui = { workspace = true, optional = true }
 

vortex-python/python/vortex/_lib/__init__.pyi

@@ -7,8 +7,6 @@ class CosStore:
     Construct it with explicit configuration and pass it to
     ``vortex.io.read_url(url, store=cos_store)`` /
     ``vortex.io.write(arrays, path, store=cos_store)``.
-
-    This class is only available when Vortex is built with the ``opendal`` feature.
     """
 
     def __init__(
@@ -28,8 +26,6 @@ class GoosefsStore:
     Construct it with explicit configuration and pass it to
     ``vortex.io.read_url(url, store=goosefs_store)`` /
     ``vortex.io.write(arrays, path, store=goosefs_store)``.
-
-    This class is only available when Vortex is built with the ``opendal`` feature.
     """
 
     def __init__(

vortex-python/python/vortex/_lib/store/__init__.pyi

@@ -89,8 +89,8 @@ def from_url(  # type: ignore[misc] # docstring in pyi file
     - `gs://bucket/path` -> [`GCSStore`][vortex.store.GCSStore]
     - `az://account/container/path` -> [`AzureStore`][vortex.store.AzureStore] (also
       supports `adl`, `azure`, `abfs`, `abfss`)
-    - `cos://bucket/path` -> OpenDAL-backed Tencent Cloud COS store (requires the
-      `opendal` feature; configure via environment variables such as
+    - `cos://bucket/path` -> OpenDAL-backed Tencent Cloud COS store (configure
+      via environment variables such as
       `TENCENTCLOUD_SECRET_ID` / `TENCENTCLOUD_SECRET_KEY` and `COS_ENDPOINT`)
     - `http://mydomain/path` -> [`HTTPStore`][vortex.store.HTTPStore]
     - `https://mydomain/path` -> [`HTTPStore`][vortex.store.HTTPStore]

vortex-python/python/vortex/store/__init__.py

@@ -94,12 +94,12 @@ def from_url(  # type: ignore[misc] # docstring in pyi file
     - ``gs://bucket/path`` -> :class:`~vortex.store.GCSStore`
     - ``az://account/container/path`` -> :class:`~vortex.store.AzureStore` (also
       supports ``adl``, ``azure``, ``abfs``, ``abfss``)
-    - ``cos://bucket/path`` -> OpenDAL-backed Tencent Cloud COS store (requires the
-      ``opendal`` feature; configure via environment variables such as
+    - ``cos://bucket/path`` -> OpenDAL-backed Tencent Cloud COS store (configure
+      via environment variables such as
       ``TENCENTCLOUD_SECRET_ID`` / ``TENCENTCLOUD_SECRET_KEY`` and ``COS_ENDPOINT``)
     - ``goosefs://master-addr:port/path`` -> OpenDAL-backed Tencent Cloud GooseFS store
-      (requires the ``opendal`` feature; configure via environment variable
-      ``GOOSEFS_MASTER_ADDR`` or pass ``master_addr`` in properties)
+      (configure via environment variable ``GOOSEFS_MASTER_ADDR`` or pass
+      ``master_addr`` in properties)
     - ``http://mydomain/path`` -> :class:`~vortex.store.HTTPStore`
     - ``https://mydomain/path`` -> :class:`~vortex.store.HTTPStore`
 

vortex-python/python/vortex/store/_cos.py

@@ -3,35 +3,11 @@
 
 """Tencent Cloud COS object store, backed by OpenDAL.
 
-This store is only available when Vortex is built with the ``opendal`` feature.
-The class is re-exported from the native extension module; if the feature is
-not enabled, instantiating :class:`CosStore` raises :class:`ImportError`.
+The class is re-exported from the native extension module.
 """
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
-
-if TYPE_CHECKING:
-    # `vortex._lib.__init__.pyi` declares `CosStore` so type checkers see a real
-    # signature; the runtime branch below provides the same symbol when the
-    # `opendal` feature is enabled, and a placeholder that raises on
-    # instantiation when it is not.
-    from vortex._lib import CosStore
-else:
-    try:
-        from vortex._lib import CosStore as CosStore
-    except ImportError:
-
-        class CosStore:
-            """Placeholder; the real implementation requires the ``opendal`` feature."""
-
-            def __init__(self, *args: Any, **kwargs: Any) -> None:
-                raise ImportError(
-                    "CosStore requires Vortex to be built with the 'opendal' feature; "
-                    + "build with `maturin build --features opendal` "
-                    + "or `maturin develop --features opendal`."
-                )
-
+from vortex._lib import CosStore as CosStore
 
 __all__ = ["CosStore"]

vortex-python/python/vortex/store/_goosefs.py

@@ -3,35 +3,11 @@
 
 """Tencent Cloud GooseFS object store, backed by OpenDAL.
 
-This store is only available when Vortex is built with the ``opendal`` feature.
-The class is re-exported from the native extension module; if the feature is
-not enabled, instantiating :class:`GoosefsStore` raises :class:`ImportError`.
+The class is re-exported from the native extension module.
 """
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
-
-if TYPE_CHECKING:
-    # `vortex._lib.__init__.pyi` declares `GoosefsStore` so type checkers see a real
-    # signature; the runtime branch below provides the same symbol when the
-    # `opendal` feature is enabled, and a placeholder that raises on
-    # instantiation when it is not.
-    from vortex._lib import GoosefsStore
-else:
-    try:
-        from vortex._lib import GoosefsStore as GoosefsStore
-    except ImportError:
-
-        class GoosefsStore:
-            """Placeholder; the real implementation requires the ``opendal`` feature."""
-
-            def __init__(self, *args: Any, **kwargs: Any) -> None:
-                raise ImportError(
-                    "GoosefsStore requires Vortex to be built with the 'opendal' feature; "
-                    + "build with `maturin build --features opendal` "
-                    + "or `maturin develop --features opendal`."
-                )
-
+from vortex._lib import GoosefsStore as GoosefsStore
 
 __all__ = ["GoosefsStore"]

vortex-python/src/hf_store.rs

@@ -17,7 +17,7 @@ use vortex::cloud::hf::HfConfig;
 use vortex::cloud::hf::HfRepoType;
 use vortex::cloud::hf::make_hf_store;
 
-/// How the `token` argument was spelled.
+/// How the `token` argument was passed.
 ///
 /// Mirrors `huggingface_hub`'s own convention so that a caller can pass the same value through.
 #[derive(Debug, Clone, FromPyObject)]