cleanup

Author: Mike Prosser

examples/all_types/define_types.py

@@ -18,9 +18,9 @@ class MyIntFlags(enum.IntFlag):
 class MyIntableFlags(enum.Flag):
     """Example of an Flag enum with int values."""
 
-    VALUE1 = 1
-    VALUE2 = 2
-    VALUE4 = 4
+    VALUE8 = 8
+    VALUE16 = 16
+    VALUE32 = 32
 
 
 class MyIntEnum(enum.IntEnum):
@@ -75,7 +75,7 @@ class MyMixedEnum(enum.Enum):
     "intenum": MyIntEnum.VALUE20,
     "strenum": MyStrEnum.VALUE3,
     "intableenum": MyIntableEnum.VALUE200,
-    "intableflags": MyIntableFlags.VALUE1 | MyIntableFlags.VALUE2,
+    "intableflags": MyIntableFlags.VALUE8 | MyIntableFlags.VALUE32,
     "stringableenum": MyStringableEnum.VALUE2,
     "mixedenum": MyMixedEnum.VALUE2,
     # NI types
@@ -98,6 +98,6 @@ class MyMixedEnum(enum.Enum):
     # supported 2D collections
     "list_list_float": [[1.0, 2.0], [3.0, 4.0]],
     "tuple_tuple_float": ((1.0, 2.0), (3.0, 4.0)),
-    "set_tuple_float": set([(1.0, 2.0), (3.0, 4.0)]),
+    "set_list_float": set([(1.0, 2.0), (3.0, 4.0)]),
     "frozenset_frozenset_float": frozenset([frozenset([1.0, 2.0]), frozenset([3.0, 4.0])]),
 }

src/nipanel/controls/_flag_checkboxes.py

@@ -1,7 +1,7 @@
 """A set of checkboxes for selecting Flag enum values."""
 
 from enum import Flag
-from typing import TypeVar
+from typing import TypeVar, Callable
 
 import streamlit as st
 
@@ -16,6 +16,7 @@ def flag_checkboxes(
     value: T,
     key: str,
     disabled: bool = False,
+    label_formatter: Callable[[Flag], str] = lambda x: str(x.name),
 ) -> T:
     """Create a set of checkboxes for a Flag enum.
 
@@ -29,6 +30,8 @@ def flag_checkboxes(
         value: The default Flag enum value (also determines the specific Flag enum type)
         key: Key to use for storing the Flag value in the panel
         disabled: Whether the checkboxes should be disabled
+        label_formatter: Function that formats the flag to a string for display. Default
+                         uses flag.name.
 
     Returns:
         The selected Flag enum value with all selected flags combined
@@ -56,7 +59,7 @@ def flag_checkboxes(
     for flag in flag_values:
         is_selected = bool(selected_flags & flag)
         if flag_container.checkbox(
-            label=str(flag.name),
+            label=label_formatter(flag),
             value=is_selected,
             key=f"{key}_{flag.name}",
             disabled=disabled,

tests/unit/test_streamlit_panel.py

@@ -403,7 +403,7 @@ def test___set_int_enum_value___get_value___returns_int_enum(
     assert retrieved_value.name == enum_value.name
 
 
-def test___set_intable_enum_value___get_value___returns_enum(
+def test___set_intable_enum_value___get_value___returns_intable_enum(
     fake_panel_channel: grpc.Channel,
 ) -> None:
     panel = StreamlitPanel("my_panel", "path/to/script", grpc_channel=fake_panel_channel)
@@ -435,7 +435,7 @@ def test___set_string_enum_value___get_value___returns_string_enum(
     assert retrieved_value.name == enum_value.name
 
 
-def test___set_stringable_enum_value___get_value___returns_enum(
+def test___set_stringable_enum_value___get_value___returns_stringable_enum(
     fake_panel_channel: grpc.Channel,
 ) -> None:
     panel = StreamlitPanel("my_panel", "path/to/script", grpc_channel=fake_panel_channel)
@@ -451,7 +451,7 @@ def test___set_stringable_enum_value___get_value___returns_enum(
     assert retrieved_value.name == enum_value.name
 
 
-def test___set_mixed_enum_value___get_value___returns_enum(
+def test___set_mixed_enum_value___get_value___returns_mixed_enum(
     fake_panel_channel: grpc.Channel,
 ) -> None:
     panel = StreamlitPanel("my_panel", "path/to/script", grpc_channel=fake_panel_channel)
@@ -482,7 +482,7 @@ def test___set_int_flags_value___get_value___returns_int_flags(
     assert retrieved_value.value == flags_value.value
 
 
-def test___set_intable_flags_value___get_value___returns_flags(
+def test___set_intable_flags_value___get_value___returns_intable_flags(
     fake_panel_channel: grpc.Channel,
 ) -> None:
     panel = StreamlitPanel("my_panel", "path/to/script", grpc_channel=fake_panel_channel)