add nitypes to all_types, and update comments

Author: Mike Prosser

examples/all_types/README.md

@@ -1,6 +1,6 @@
 ## All Types Example
 
-This is a nipanel example that demonstrates all supported data types
+This is an example for `nipanel` that demonstrates all supported data types
 
 ### Feature
 

examples/all_types/all_types.py

@@ -1,4 +1,4 @@
-"""example script for nipanel package demonstrating various data types."""
+"""An example that demonstrates the supported data types for nipanel scripts."""
 
 from pathlib import Path
 

examples/all_types/all_types_panel.py

@@ -1,4 +1,4 @@
-"""A Streamlit panel to demonstrate various types and their values."""
+"""A Streamlit visualization panel for the all_types.py example script."""
 
 import streamlit as st
 from define_types import all_types_with_values

examples/all_types/define_types.py

@@ -2,6 +2,10 @@
 
 import enum
 
+import numpy as np
+from nitypes.scalar import Scalar
+from nitypes.waveform import AnalogWaveform
+
 
 class MyIntFlags(enum.IntFlag):
     """Example of an IntFlag enum."""
@@ -29,21 +33,21 @@ class MyStrEnum(str, enum.Enum):
 
 all_types_with_values = {
     # supported scalar types
-    "bool_scalar": True,
-    "bytes_scalar": b"robotext",
-    "float_scalar": 13.12,
-    "int_scalar": 42,
-    "str_scalar": "sample string",
+    "bool": True,
+    "bytes": b"robotext",
+    "float": 13.12,
+    "int": 42,
+    "str": "sample string",
     # supported collection types
     "bool_collection": [True, False, True],
     "bytes_collection": [b"one", b"two", b"three"],
     "float_collection": [1.1, 2.2, 3.3],
     "int_collection": [1, 2, 3],
     "str_collection": ["one", "two", "three"],
     # supported enum and flag types
-    "intflags_scalar": MyIntFlags.VALUE1 | MyIntFlags.VALUE4,
-    "intenum_scalar": MyIntEnum.VALUE20,
-    "strenum_scalar": MyStrEnum.VALUE3,
+    "intflags": MyIntFlags.VALUE1 | MyIntFlags.VALUE4,
+    "intenum": MyIntEnum.VALUE20,
+    "strenum": MyStrEnum.VALUE3,
     "intflags_collection": [MyIntFlags.VALUE1, MyIntFlags.VALUE2, MyIntFlags.VALUE4],
     "intenum_collection": [MyIntEnum.VALUE10, MyIntEnum.VALUE20, MyIntEnum.VALUE30],
     "strenum_collection": [MyStrEnum.VALUE1, MyStrEnum.VALUE2, MyStrEnum.VALUE3],
@@ -52,4 +56,7 @@ class MyStrEnum(str, enum.Enum):
     "tuple": (4, 5, 6),
     "set": {7, 8, 9},
     "frozenset": frozenset([10, 11, 12]),
+    # NI types
+    "nitypes_Scalar": Scalar(42, "m"),
+    "nitypes_AnalogWaveform": AnalogWaveform.from_array_1d(np.array([1.0, 2.0, 3.0])),
 }

src/nipanel/_streamlit_panel_initializer.py

@@ -13,9 +13,13 @@
 def create_panel(streamlit_script_path: Path) -> StreamlitPanel:
     """Create a Streamlit panel with the specified script path.
 
-    This function initializes a Streamlit panel using the provided script path.
-    The panel ID will be derived from the script path, which is expected to be a valid Streamlit script.
-    It is typically used to create a new panel instance for use in a Streamlit application.
+    This function initializes a Streamlit panel using the provided script path. It derives the panel
+    ID from the script's path, which it expects to be a valid Streamlit script. For example, if the
+    value for streamlit_script_path is "c:/example/some_example.py", then the panel's ID becomes
+    "some_example".
+
+    Use this function when you want to create a new panel instance to use in a Streamlit
+    application.
 
     Args:
         streamlit_script_path: The file path of the Streamlit script to be used for the panel.
@@ -29,7 +33,7 @@ def create_panel(streamlit_script_path: Path) -> StreamlitPanel:
             "The provided script path must be a valid Streamlit script ending with '.py'."
         )
 
-    panel_id = path_str.replace("\\", "/").split("/")[-1].replace(".py", "")
+    panel_id = streamlit_script_path.stem
     return StreamlitPanel(panel_id, path_str)