Skip to content

chore(python-sdk): improve error message when using wrong op type #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2025
Merged

chore(python-sdk): improve error message when using wrong op type #453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion python/cocoindex/flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@ def transform(self, fn_spec: op.FunctionSpec, *args, **kwargs) -> DataSlice:
"""
Apply a function to the data slice.
"""
if not isinstance(fn_spec, op.FunctionSpec):
raise ValueError("transform() can only be called on a CocoIndex function")

transform_args: list[tuple[Any, str | None]]
transform_args = [(self._state.engine_data_slice, None)]
transform_args += [(self._state.flow_builder_state.get_data_slice(v), None) for v in args]
Expand Down Expand Up @@ -280,6 +283,9 @@ def export(self, name: str, target_spec: op.StorageSpec, /, *,

`vector_index` is for backward compatibility only. Please use `vector_indexes` instead.
"""
if not isinstance(target_spec, op.StorageSpec):
raise ValueError("export() can only be called on a CocoIndex target storage")

# For backward compatibility only.
if len(vector_indexes) == 0 and len(vector_index) > 0:
vector_indexes = [index.VectorIndexDef(field_name=field_name, metric=metric)
Expand Down Expand Up @@ -343,8 +349,10 @@ def add_source(self, spec: op.SourceSpec, /, *,
refresh_interval: datetime.timedelta | None = None,
) -> DataSlice:
"""
Add a source to the flow.
Import a source to the flow.
"""
if not isinstance(spec, op.SourceSpec):
raise ValueError("add_source() can only be called on a CocoIndex source")
return _create_data_slice(
self._state,
lambda target_scope, name: self._state.engine_flow_builder.add_source(
Expand Down