fix physical channel/device collection slice/string behavior (#536)

generated/nidaqmx/system/_collections/physical_channel_collection.py

@@ -59,9 +59,21 @@ def __getitem__(self, index):
         if isinstance(index, int):
             return _PhysicalChannelAlternateConstructor(self.channel_names[index], self._interpreter)
         elif isinstance(index, slice):
-            return _PhysicalChannelAlternateConstructor(self.channel_names[index], self._interpreter)
+            return [_PhysicalChannelAlternateConstructor(channel, self._interpreter) for channel in self.channel_names[index]]
         elif isinstance(index, str):
-            return _PhysicalChannelAlternateConstructor(f'{self._name}/{index}', self._interpreter)
+            requested_channels = unflatten_channel_string(index)
+            # Ensure the channel names are fully qualified. If the channel is invalid, the user will get errors from the
+            # channel objects on use.
+            channels_to_use = []
+            for channel in requested_channels:
+                if channel.startswith(f"{self._name}/"):
+                    channels_to_use.append(channel)
+                else:
+                    channels_to_use.append(f'{self._name}/{channel}')
+
+            if len(channels_to_use) == 1:
+                return _PhysicalChannelAlternateConstructor(channels_to_use[0], self._interpreter)
+            return [_PhysicalChannelAlternateConstructor(channel, self._interpreter) for channel in channels_to_use]
         else:
             raise DaqError(
                 'Invalid index type "{}" used to access collection.'
@@ -96,7 +108,7 @@ def all(self):
     @property
     def channel_names(self):
         """
-        List[str]: Specifies the entire list of physical channels on this
+        List[str]: Specifies the entire list of physical channels in this
             collection.
         """
         raise NotImplementedError()

src/handwritten/system/_collections/physical_channel_collection.py

@@ -59,9 +59,21 @@ def __getitem__(self, index):
         if isinstance(index, int):
             return _PhysicalChannelAlternateConstructor(self.channel_names[index], self._interpreter)
         elif isinstance(index, slice):
-            return _PhysicalChannelAlternateConstructor(self.channel_names[index], self._interpreter)
+            return [_PhysicalChannelAlternateConstructor(channel, self._interpreter) for channel in self.channel_names[index]]
         elif isinstance(index, str):
-            return _PhysicalChannelAlternateConstructor(f'{self._name}/{index}', self._interpreter)
+            requested_channels = unflatten_channel_string(index)
+            # Ensure the channel names are fully qualified. If the channel is invalid, the user will get errors from the
+            # channel objects on use.
+            channels_to_use = []
+            for channel in requested_channels:
+                if channel.startswith(f"{self._name}/"):
+                    channels_to_use.append(channel)
+                else:
+                    channels_to_use.append(f'{self._name}/{channel}')
+
+            if len(channels_to_use) == 1:
+                return _PhysicalChannelAlternateConstructor(channels_to_use[0], self._interpreter)
+            return [_PhysicalChannelAlternateConstructor(channel, self._interpreter) for channel in channels_to_use]
         else:
             raise DaqError(
                 'Invalid index type "{}" used to access collection.'
@@ -96,7 +108,7 @@ def all(self):
     @property
     def channel_names(self):
         """
-        List[str]: Specifies the entire list of physical channels on this
+        List[str]: Specifies the entire list of physical channels in this
             collection.
         """
         raise NotImplementedError()

tests/component/system/_collections/test_physical_channel_collection.py

@@ -37,7 +37,6 @@ def test___physical_channels___getitem_int___shared_interpreter(
     assert all(chan._interpreter is sim_6363_device._interpreter for chan in channels)
 
 
-@pytest.mark.xfail(reason="https://github.com/ni/nidaqmx-python/issues/392")
 @pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
 def test___physical_channels___getitem_slice___forward_order(
     collection_name: str, sim_6363_device: Device
@@ -49,7 +48,6 @@ def test___physical_channels___getitem_slice___forward_order(
     assert [chan.name for chan in channels] == physical_channels.channel_names
 
 
-@pytest.mark.xfail(reason="https://github.com/ni/nidaqmx-python/issues/392")
 @pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
 def test___physical_channels___getitem_slice___shared_interpreter(
     collection_name: str, sim_6363_device: Device
@@ -62,7 +60,7 @@ def test___physical_channels___getitem_slice___shared_interpreter(
 
 
 @pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
-def test___physical_channels___getitem_str___shared_interpreter(
+def test___physical_channels___getitem_unqualified_str___shared_interpreter(
     collection_name: str, sim_6363_device: Device
 ):
     physical_channels = getattr(sim_6363_device, collection_name)
@@ -77,7 +75,7 @@ def test___physical_channels___getitem_str___shared_interpreter(
 
 
 @pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
-def test___physical_channels___getitem_str_list___shared_interpreter(
+def test___physical_channels___getitem_unqualified_str_list___shared_interpreter(
     collection_name: str, sim_6363_device: Device
 ):
     physical_channels = getattr(sim_6363_device, collection_name)
@@ -86,9 +84,150 @@ def test___physical_channels___getitem_str_list___shared_interpreter(
         name.replace(device_name + "/", "") for name in physical_channels.channel_names
     ]
 
-    channel = physical_channels[",".join(unqualified_channel_names)]
+    channels = physical_channels[",".join(unqualified_channel_names)]
 
-    assert channel._interpreter == sim_6363_device._interpreter
+    assert all(chan._interpreter is sim_6363_device._interpreter for chan in channels)
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_unqualified_str___name(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+    device_name = sim_6363_device.name
+    unqualified_channel_names = [
+        name.replace(device_name + "/", "") for name in physical_channels.channel_names
+    ]
+
+    channels = [physical_channels[name] for name in unqualified_channel_names]
+
+    assert all(chan.name == name for chan, name in zip(channels, physical_channels.channel_names))
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_unqualified_str_list___name(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+    device_name = sim_6363_device.name
+    unqualified_channel_names = [
+        name.replace(device_name + "/", "") for name in physical_channels.channel_names
+    ]
+
+    channels = physical_channels[",".join(unqualified_channel_names)]
+
+    assert all(chan.name == name for chan, name in zip(channels, physical_channels.channel_names))
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_qualified_str___shared_interpreter(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+
+    channels = [physical_channels[name] for name in physical_channels.channel_names]
+
+    assert all(chan._interpreter is sim_6363_device._interpreter for chan in channels)
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_qualified_str_list___shared_interpreter(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+
+    channels = physical_channels[",".join(physical_channels.channel_names)]
+
+    assert all(chan._interpreter is sim_6363_device._interpreter for chan in channels)
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_qualified_str___name(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+
+    channels = [physical_channels[name] for name in physical_channels.channel_names]
+
+    assert all(chan.name == name for chan, name in zip(channels, physical_channels.channel_names))
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_qualified_str_list___name(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+
+    channels = physical_channels[",".join(physical_channels.channel_names)]
+
+    assert all(chan.name == name for chan, name in zip(channels, physical_channels.channel_names))
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_mixed_str_list___shared_interpreter(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+    device_name = sim_6363_device.name
+    qualified_channel_names = physical_channels.channel_names
+    unqualified_channel_names = [
+        name.replace(device_name + "/", "") for name in qualified_channel_names
+    ]
+    middle_idx = len(qualified_channel_names) // 2
+    mixed_channel_names = (
+        physical_channels.channel_names[:middle_idx] + unqualified_channel_names[middle_idx:]
+    )
+
+    channels = physical_channels[",".join(mixed_channel_names)]
+
+    assert all(chan._interpreter is sim_6363_device._interpreter for chan in channels)
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_mixed_str_list___name(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+    device_name = sim_6363_device.name
+    qualified_channel_names = physical_channels.channel_names
+    unqualified_channel_names = [
+        name.replace(device_name + "/", "") for name in qualified_channel_names
+    ]
+    middle_idx = len(qualified_channel_names) // 2
+    mixed_channel_names = (
+        physical_channels.channel_names[:middle_idx] + unqualified_channel_names[middle_idx:]
+    )
+
+    channels = physical_channels[",".join(mixed_channel_names)]
+
+    assert all(chan.name == name for chan, name in zip(channels, physical_channels.channel_names))
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_qualified_internal_channel_list___name(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+    internal_channel_names = [f"{sim_6363_device.name}/_ao{x}_vs_aognd" for x in range(4)]
+
+    channels = physical_channels[",".join(internal_channel_names)]
+
+    assert all(chan.name == name for chan, name in zip(channels, internal_channel_names))
+
+
+@pytest.mark.parametrize("collection_name", COLLECTION_NAMES)
+def test___physical_channels___getitem_unqualified_internal_channel_list___name(
+    collection_name: str, sim_6363_device: Device
+):
+    physical_channels = getattr(sim_6363_device, collection_name)
+    internal_channel_names = ["_ao{x}_vs_aognd" for x in range(4)]
+
+    channels = physical_channels[",".join(internal_channel_names)]
+
+    assert all(
+        chan.name == f"{sim_6363_device.name}/{name}"
+        for chan, name in zip(channels, internal_channel_names)
+    )
 
 
 @pytest.mark.parametrize("collection_name", COLLECTION_NAMES)

tests/component/task/channels/test_di_channel.py

@@ -17,7 +17,7 @@ def test___task___add_di_chan_chan_for_all_lines___sets_channel_attributes(
     num_lines: int,
 ) -> None:
     chan: DIChannel = task.di_channels.add_di_chan(
-        flatten_channel_string(sim_6363_device.di_lines[:num_lines].name),
+        flatten_channel_string(sim_6363_device.di_lines.channel_names[:num_lines]),
         line_grouping=LineGrouping.CHAN_FOR_ALL_LINES,
     )
 
@@ -36,7 +36,7 @@ def test___task___add_di_chan_chan_per_line___sets_channel_attributes(
     num_lines: int,
 ) -> None:
     chans: DIChannel = task.di_channels.add_di_chan(
-        flatten_channel_string(sim_6363_device.di_lines[:num_lines].name),
+        flatten_channel_string(sim_6363_device.di_lines.channel_names[:num_lines]),
         line_grouping=LineGrouping.CHAN_PER_LINE,
     )
 

tests/component/task/channels/test_do_channel.py

@@ -17,7 +17,7 @@ def test___task___add_do_chan_chan_for_all_lines___sets_channel_attributes(
     num_lines: int,
 ) -> None:
     chan: DOChannel = task.do_channels.add_do_chan(
-        flatten_channel_string(sim_6363_device.do_lines[:num_lines].name),
+        flatten_channel_string(sim_6363_device.do_lines.channel_names[:num_lines]),
         line_grouping=LineGrouping.CHAN_FOR_ALL_LINES,
     )
 
@@ -36,7 +36,7 @@ def test___task___add_do_chan_chan_per_line___sets_channel_attributes(
     num_lines: int,
 ) -> None:
     chans: DOChannel = task.do_channels.add_do_chan(
-        flatten_channel_string(sim_6363_device.do_lines[:num_lines].name),
+        flatten_channel_string(sim_6363_device.do_lines.channel_names[:num_lines]),
         line_grouping=LineGrouping.CHAN_PER_LINE,
     )