better group slice support for operators

app/packages/operators/src/CustomPanel.tsx

@@ -34,7 +34,7 @@
  setPanelCloseEffect(() => {
  clearUseKeyStores(panelId);
  });
  }, []);
 
  useEffect(() => {
  setLoading(count > 0);
@@ -98,7 +98,7 @@
 
  useEffect(() => {
  dimensions?.refresh();
  }, []);
 
  return children;
 }
@@ -114,6 +114,7 @@
  on_change_selected,
  on_change_selected_labels,
  on_change_extended_selection,
+ on_change_group_slice,
  panel_name,
  panel_label,
 }) {
@@ -130,6 +131,7 @@
  onChangeSelected={on_change_selected}
  onChangeSelectedLabels={on_change_selected_labels}
  onChangeExtendedSelection={on_change_extended_selection}
+ onChangeGroupSlice={on_change_group_slice}
  dimensions={dimensions}
  panelName={panel_name}
  panelLabel={panel_label}

app/packages/operators/src/hooks.ts

@@ -25,6 +25,7 @@ function useOperatorThrottledContextSetter() {
  const filters = useRecoilValue(fos.filters);
  const selectedSamples = useRecoilValue(fos.selectedSamples);
  const selectedLabels = useRecoilValue(fos.selectedLabels);
+ const groupSlice = useRecoilValue(fos.groupSlice);
  const currentSample = useCurrentSample();
  const setContext = useSetRecoilState(operatorThrottledContext);
  const setThrottledContext = useMemo(() => {
@@ -47,6 +48,7 @@ function useOperatorThrottledContextSetter() {
  selectedLabels,
  currentSample,
  viewName,
+ groupSlice,
  });
  }, [
  setThrottledContext,
@@ -58,6 +60,7 @@ function useOperatorThrottledContextSetter() {
  selectedLabels,
  currentSample,
  viewName,
+ groupSlice,
  ]);
 }
 

app/packages/operators/src/operators.ts

@@ -90,6 +90,7 @@ export type RawContext = {
  selection: string[] | null;
  scope: string;
  };
+ groupSlice: string;
 };
 
 export class ExecutionContext {
@@ -132,6 +133,9 @@ export class ExecutionContext {
  public get extendedSelection(): any {
  return this._currentContext.extendedSelection;
  }
+ public get groupSlice(): any {
+ return this._currentContext.groupSlice;
+ }
  getCurrentPanelId(): string | null {
  return this.params.panel_id || this.currentPanel?.id || null;
  }
@@ -538,6 +542,7 @@ async function executeOperatorAsGenerator(
  selected_labels: formatSelectedLabels(currentContext.selectedLabels),
  view: currentContext.view,
  view_name: currentContext.viewName,
+ group_slice: currentContext.groupSlice,
  },
  "json-stream"
  );
@@ -700,6 +705,7 @@ export async function executeOperatorWithContext(
  selected_labels: formatSelectedLabels(currentContext.selectedLabels),
  view: currentContext.view,
  view_name: currentContext.viewName,
+ group_slice: currentContext.groupSlice,
  }
  );
  result = serverResult.result;
@@ -802,6 +808,7 @@ export async function resolveRemoteType(
  selected_labels: formatSelectedLabels(currentContext.selectedLabels),
  view: currentContext.view,
  view_name: currentContext.viewName,
+ group_slice: currentContext.groupSlice,
  }
  );
 
@@ -875,6 +882,7 @@ export async function resolveExecutionOptions(
  selected_labels: formatSelectedLabels(currentContext.selectedLabels),
  view: currentContext.view,
  view_name: currentContext.viewName,
+ group_slice: currentContext.groupSlice,
  }
  );
 
@@ -905,6 +913,7 @@ export async function fetchRemotePlacements(ctx: ExecutionContext) {
  selected_labels: formatSelectedLabels(currentContext.selectedLabels),
  current_sample: currentContext.currentSample,
  view_name: currentContext.viewName,
+ group_slice: currentContext.groupSlice,
  }
  );
  if (result && result.error) {

app/packages/operators/src/state.ts

@@ -93,6 +93,7 @@ const globalContextSelector = selector({
  const selectedLabels = get(fos.selectedLabels);
  const viewName = get(fos.viewName);
  const extendedSelection = get(fos.extendedSelection);
+ const groupSlice = get(fos.groupSlice);
 
  return {
  datasetName,
@@ -103,6 +104,7 @@ const globalContextSelector = selector({
  selectedLabels,
  viewName,
  extendedSelection,
+ groupSlice,
  };
  },
 });
@@ -142,6 +144,7 @@ const useExecutionContext = (operatorName, hooks = {}) => {
  selectedLabels,
  viewName,
  extendedSelection,
+ groupSlice,
  } = curCtx;
  const [analyticsInfo] = useAnalyticsInfo();
  const ctx = useMemo(() => {
@@ -158,6 +161,7 @@ const useExecutionContext = (operatorName, hooks = {}) => {
  viewName,
  extendedSelection,
  analyticsInfo,
+ groupSlice,
  },
  hooks
  );
@@ -172,6 +176,7 @@ const useExecutionContext = (operatorName, hooks = {}) => {
  hooks,
  viewName,
  currentSample,
+ groupSlice,
  ]);
 
  return ctx;

app/packages/operators/src/useCustomPanelHooks.ts

@@ -25,6 +25,7 @@ export interface CustomPanelProps {
  onChangeSelected?: string;
  onChangeSelectedLabels?: string;
  onChangeExtendedSelection?: string;
+ onChangeGroupSlice?: string;
  dimensions: DimensionsType | null;
  panelName?: string;
  panelLabel?: string;
@@ -129,6 +130,12 @@ export function useCustomPanelHooks(props: CustomPanelProps): CustomPanelHooks {
  ctx.selectedLabels,
  props.onChangeSelectedLabels
  );
+ useCtxChangePanelEvent(
+ isLoaded,
+ panelId,
+ ctx.groupSlice,
+ props.onChangeGroupSlice
+ );
 
  useEffect(() => {
  onLoad();

docs/source/plugins/developing_plugins.rst

@@ -979,6 +979,7 @@ contains the following properties:
 - `ctx.selected_labels` - the list of currently selected labels in the App,
  if any
 - `ctx.extended_selection` - the extended selection of the view, if any
+- `ctx.group_slice` - the active group slice in the App, if any
 - `ctx.user_id` - the ID of the user that invoked the operator, if known
 - `ctx.panel_id` - the ID of the panel that invoked the operator, if any
 - `ctx.panel` - a :class:`PanelRef <fiftyone.operators.panel.PanelRef>`
@@ -2047,6 +2048,19 @@ subsequent sections.
  }
  ctx.panel.set_state("event", "on_change_extended_selection")
  ctx.panel.set_data("event_data", event)
+
+ def on_change_group_slice(self, ctx):
+ """Implement this method to set panel state/data when the current
+ group slice changes.
+
+ The current group slice will be available via ``ctx.group_slice``.
+ """
+ event = {
+ "data": ctx.group_slice,
+ "description": "the current group slice",
+ }
+ ctx.panel.set_state("event", "on_change_group_slice")
+ ctx.panel.set_data("event_data", event)
 
  #######################################################################
  # Custom events

fiftyone/operators/builtin.py

@@ -1487,7 +1487,7 @@ def resolve_input(self, ctx):
  inputs.enum(
  "name",
  slice_selector.values(),
- default=None,
+ default=ctx.group_slice,
  required=True,
  label="Group slice",
  description="The group slice to rename",
@@ -1518,10 +1518,8 @@ def execute(self, ctx):
  new_name = ctx.params["new_name"]
 
  ctx.dataset.rename_group_slice(name, new_name)
-
- # @todo ideally we would only set this if the group slice we renamed is
- # currently loaded in the App
- ctx.ops.set_group_slice(ctx.dataset.default_group_slice)
+ if ctx.group_slice == name:
+ ctx.ops.set_group_slice(new_name)
 
  ctx.ops.reload_dataset()
 
@@ -1554,7 +1552,7 @@ def resolve_input(self, ctx):
  inputs.enum(
  "name",
  slice_selector.values(),
- default=None,
+ default=ctx.group_slice,
  required=True,
  label="Group slice",
  description="The group slice to delete",
@@ -1569,10 +1567,8 @@ def execute(self, ctx):
  name = ctx.params["name"]
 
  ctx.dataset.delete_group_slice(name)
-
- # @todo ideally we would only set this if the group slice we deleted is
- # currently loaded in the App
- ctx.ops.set_group_slice(ctx.dataset.default_group_slice)
+ if ctx.group_slice == name:
+ ctx.ops.set_group_slice(ctx.dataset.default_group_slice)
 
  ctx.ops.reload_dataset()
 

fiftyone/operators/executor.py

@@ -17,6 +17,7 @@
 
 import fiftyone as fo
 import fiftyone.core.dataset as fod
+import fiftyone.core.media as fom
 import fiftyone.core.odm.utils as focu
 import fiftyone.core.utils as fou
 import fiftyone.core.view as fov
@@ -507,22 +508,32 @@ def dataset(self):
  """The :class:`fiftyone.core.dataset.Dataset` being operated on."""
  if self._dataset is not None:
  return self._dataset
+
  # Since dataset may have been renamed, always resolve the dataset by
  # id if it is available
  uid = self.request_params.get("dataset_id", None)
  if uid:
  self._dataset = focu.load_dataset(id=uid)
+
  # Set the dataset_name using the dataset object in case the dataset
  # has been renamed or changed since the context was created
  self.request_params["dataset_name"] = self._dataset.name
  else:
  uid = self.request_params.get("dataset_name", None)
  if uid:
  self._dataset = focu.load_dataset(name=uid)
+
  # TODO: refactor so that this additional reload post-load is not
  # required
  if self._dataset is not None:
  self._dataset.reload()
+
+ if (
+ self.group_slice is not None
+ and self._dataset.media_type == fom.GROUP
+ ):
+ self._dataset.group_slice = self.group_slice
+
  return self._dataset
 
  @property
@@ -697,6 +708,11 @@ def ops(self):
  """
  return self._ops
 
+ @property
+ def group_slice(self):
+ """The current group slice of the view (if any)."""
+ return self.request_params.get("group_slice", None)
+
  def prompt(
  self,
  operator_uri,

fiftyone/operators/operations.py

@@ -316,6 +316,7 @@ def register_panel(
  on_change_selected=None,
  on_change_selected_labels=None,
  on_change_extended_selection=None,
+ on_change_group_slice=None,
  allow_duplicates=False,
  ):
  """Registers a panel with the given name and lifecycle callbacks.
@@ -353,6 +354,8 @@ def register_panel(
  current selected labels changes
  on_change_extended_selection (None): an operator to invoke when the
  current extended selection changes
+ on_change_group_slice (None): an operator to invoke when the group
+ slice changes
  allow_duplicates (False): whether to allow multiple instances of
  the panel to the opened
  """
@@ -375,6 +378,7 @@ def register_panel(
  "on_change_selected": on_change_selected,
  "on_change_selected_labels": on_change_selected_labels,
  "on_change_extended_selection": on_change_extended_selection,
+ "on_change_group_slice": on_change_group_slice,
  "allow_duplicates": allow_duplicates,
  }
  return self._ctx.trigger("register_panel", params=params)

fiftyone/operators/panel.py

@@ -125,6 +125,7 @@ def on_startup(self, ctx):
  "on_change_selected",
  "on_change_selected_labels",
  "on_change_extended_selection",
+ "on_change_group_slice",
  ]
  for method in methods + ctx_change_events:
  if hasattr(self, method) and callable(getattr(self, method)):