Merge pull request #4612 from voxel51/panel-config

rename PanelOperatorConfig to PanelConfig
voxel51 · Aug 5, 2024 · 00337b6 · 00337b6
2 parents 4b3c94a + 0212781
commit 00337b6
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 5 deletions.
diff --git a/e2e-pw/src/shared/assets/plugins/e2e/__init__.py b/e2e-pw/src/shared/assets/plugins/e2e/__init__.py
@@ -97,7 +97,7 @@ async def execute(self, ctx):
 class E2ECounterPythonPanel(foo.Panel):
     @property
     def config(self):
-        return foo.PanelOperatorConfig(
+        return foo.PanelConfig(
             name="e2e_counter_python_panel",
             label="E2E: Counter Python Panel",
             allow_multiple=True,

diff --git a/fiftyone/operators/__init__.py b/fiftyone/operators/__init__.py
@@ -17,7 +17,7 @@
     ExecutionOptions,
 )
 from .utils import ProgressHandler
-from .panel import PanelOperatorConfig, Panel
+from .panel import Panel, PanelConfig, PanelOperatorConfig
 
 # This enables Sphinx refs to directly use paths imported here
 __all__ = [k for k, v in globals().items() if not k.startswith("_")]
diff --git a/fiftyone/operators/panel.py b/fiftyone/operators/panel.py
@@ -12,7 +12,7 @@
 import pydash
 
 
-class PanelOperatorConfig(OperatorConfig):
+class PanelConfig(OperatorConfig):
     """A configuration for a panel operator."""
 
     def __init__(
@@ -49,6 +49,10 @@ def to_json(self):
         }
 
 
+# Alias for backwards compatibility
+PanelOperatorConfig = PanelConfig
+
+
 class Panel(Operator):
     """A panel operator."""
 

diff --git a/tests/unittests/panels/panel_tests.py b/tests/unittests/panels/panel_tests.py
@@ -2,7 +2,7 @@
 from unittest.mock import MagicMock
 from fiftyone.operators.panel import (
     Panel,
-    PanelOperatorConfig,
+    PanelConfig,
     PanelRef,
     PanelRefState,
     PanelRefData,
@@ -19,7 +19,7 @@ def simulate_event(panel, mock_ctx, event_name):
 class TestPanel(Panel):
     @property
     def config(self):
-        return PanelOperatorConfig(name="test_panel", label="Test Panel")
+        return PanelConfig(name="test_panel", label="Test Panel")
 
     def render(self, ctx):
         panel = Object()