Skip to content

Commit f25c1e3

Browse files
committed
Cleanup stub
1 parent 4829c5b commit f25c1e3

File tree

2 files changed

+30
-7
lines changed

2 files changed

+30
-7
lines changed

rerun_py/rerun_bindings/rerun_bindings.pyi

+22-4
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,24 @@ class Schema:
180180
181181
"""
182182

183+
def column_for_selector(self, selector: str | ComponentColumnSelector | ComponentColumnDescriptor) -> ComponentColumnDescriptor:
184+
"""
185+
Look up the column descriptor for a specific selector.
186+
187+
Parameters
188+
----------
189+
selector: str | ComponentColumnDescriptor | ComponentColumnSelector
190+
The selector to look up.
191+
192+
String arguments are expected to follow the following format:
193+
`"<entity_path>:<component_name>"`
194+
195+
Returns
196+
-------
197+
ComponentColumnDescriptor
198+
The column descriptor, if it exists. Raise an exception otherwise.
199+
"""
200+
183201
class RecordingView:
184202
"""
185203
A view of a recording restricted to a given index, containing a specific set of entities and components.
@@ -1037,7 +1055,7 @@ class Dataset(Entry):
10371055
def create_fts_index(
10381056
self,
10391057
*,
1040-
column: ComponentColumnSelector,
1058+
column: str | ComponentColumnSelector | ComponentColumnDescriptor,
10411059
time_index: IndexColumnSelector,
10421060
store_position: bool = False,
10431061
base_tokenizer: str = "simple",
@@ -1047,7 +1065,7 @@ class Dataset(Entry):
10471065
def create_vector_index(
10481066
self,
10491067
*,
1050-
column: ComponentColumnSelector,
1068+
column: str | ComponentColumnSelector | ComponentColumnDescriptor,
10511069
time_index: IndexColumnSelector,
10521070
num_partitions: int = 5,
10531071
num_sub_vectors: int = 16,
@@ -1058,14 +1076,14 @@ class Dataset(Entry):
10581076
def search_fts(
10591077
self,
10601078
query: str,
1061-
column: ComponentColumnSelector,
1079+
column: str | ComponentColumnSelector | ComponentColumnDescriptor,
10621080
) -> DataFusionTable:
10631081
"""Search the dataset using a full-text search query."""
10641082

10651083
def search_vector(
10661084
self,
10671085
query: Any, # VectorLike
1068-
column: ComponentColumnSelector,
1086+
column: str | ComponentColumnSelector | ComponentColumnDescriptor,
10691087
top_k: int,
10701088
) -> DataFusionTable:
10711089
"""Search the dataset using a vector search query."""

rerun_py/src/dataframe.rs

+8-3
Original file line numberDiff line numberDiff line change
@@ -567,16 +567,21 @@ impl PySchema {
567567
///
568568
/// Parameters
569569
/// ----------
570-
/// component_column_selector: str | ComponentColumnDescriptor | ComponentColumnSelector
570+
/// selector: str | ComponentColumnDescriptor | ComponentColumnSelector
571571
/// The selector to look up.
572572
///
573573
/// String arguments are expected to follow the following format:
574574
/// `"<entity_path>:<component_name>"`
575+
///
576+
/// Returns
577+
/// -------
578+
/// ComponentColumnDescriptor
579+
/// The column descriptor, if it exists. Raise an exception otherwise.
575580
pub fn column_for_selector(
576581
&self,
577-
component_column_selector: AnyComponentColumn,
582+
selector: AnyComponentColumn,
578583
) -> PyResult<PyComponentColumnDescriptor> {
579-
match component_column_selector {
584+
match selector {
580585
AnyComponentColumn::Name(name) => self.resolve_component_column_selector(
581586
&ComponentColumnSelector::from_str(&name).map_err(to_py_err)?,
582587
),

0 commit comments

Comments
 (0)