Address additional feedback on the refactoring of stream_readers and stream_writers (#825)

mikeprosserni · Mike Prosser · web-flow · commit faf34c90c840 · 2025-09-08T15:36:13.000-05:00
* made submodules in stream_readers and stream_writters private

* rename component\readers to component\stream_readers

* fix AUTO_START_UNSET compatibility breakage

* change relative imports to absolute imports

* export UnsetAutoStartSentinel also

---------

Co-authored-by: Mike Prosser &lt;Mike.Prosser@emerson.com&gt;
diff --git a/generated/nidaqmx/stream_readers.py b/generated/nidaqmx/stream_readers.py
@@ -3,7 +3,13 @@
 """
 
 # Import all classes from the subpackage to maintain backward compatibility
-from .stream_readers import *  # noqa: F403, F401
-
-# Re-export the __all__ list from the subpackage
-from .stream_readers import __all__
+from nidaqmx.stream_readers import (
+    AnalogSingleChannelReader,
+    AnalogMultiChannelReader, 
+    AnalogUnscaledReader,
+    CounterReader,
+    DigitalSingleChannelReader,
+    DigitalMultiChannelReader,
+    AUTO_START_UNSET,
+    __all__
+)
diff --git a/generated/nidaqmx/stream_readers/__init__.py b/generated/nidaqmx/stream_readers/__init__.py
@@ -8,13 +8,13 @@
 
 from nidaqmx import DaqError
 
-from .analog_single_channel_reader import AnalogSingleChannelReader
-from .analog_multi_channel_reader import AnalogMultiChannelReader
-from .analog_unscaled_reader import AnalogUnscaledReader
-from .counter_reader import CounterReader
-from .digital_single_channel_reader import DigitalSingleChannelReader
-from .digital_multi_channel_reader import DigitalMultiChannelReader
-from .power_readers import (
+from nidaqmx.stream_readers._analog_single_channel_reader import AnalogSingleChannelReader
+from nidaqmx.stream_readers._analog_multi_channel_reader import AnalogMultiChannelReader
+from nidaqmx.stream_readers._analog_unscaled_reader import AnalogUnscaledReader
+from nidaqmx.stream_readers._counter_reader import CounterReader
+from nidaqmx.stream_readers._digital_single_channel_reader import DigitalSingleChannelReader
+from nidaqmx.stream_readers._digital_multi_channel_reader import DigitalMultiChannelReader
+from nidaqmx.stream_readers._power_readers import (
     PowerSingleChannelReader,
     PowerMultiChannelReader,
     PowerBinaryReader,
diff --git a/generated/nidaqmx/stream_readers/_analog_multi_channel_reader.py b/generated/nidaqmx/stream_readers/_analog_multi_channel_reader.py
@@ -8,7 +8,7 @@
 from nidaqmx.error_codes import DAQmxErrors
 from nitypes.waveform import AnalogWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class AnalogMultiChannelReader(ChannelReaderBase):
diff --git a/generated/nidaqmx/stream_readers/_analog_single_channel_reader.py b/generated/nidaqmx/stream_readers/_analog_single_channel_reader.py
@@ -8,7 +8,7 @@
 from nidaqmx.error_codes import DAQmxErrors
 from nitypes.waveform import AnalogWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class AnalogSingleChannelReader(ChannelReaderBase):
diff --git a/generated/nidaqmx/stream_readers/_analog_unscaled_reader.py b/generated/nidaqmx/stream_readers/_analog_unscaled_reader.py
@@ -2,7 +2,7 @@
 
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class AnalogUnscaledReader(ChannelReaderBase):
diff --git a/generated/nidaqmx/stream_readers/_counter_reader.py b/generated/nidaqmx/stream_readers/_counter_reader.py
@@ -3,7 +3,7 @@
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 from nidaqmx.types import CtrFreq, CtrTick, CtrTime
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class CounterReader(ChannelReaderBase):
diff --git a/generated/nidaqmx/stream_readers/_digital_multi_channel_reader.py b/generated/nidaqmx/stream_readers/_digital_multi_channel_reader.py
@@ -8,7 +8,7 @@
 from nidaqmx.error_codes import DAQmxErrors
 from nitypes.waveform import DigitalWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class DigitalMultiChannelReader(ChannelReaderBase):
diff --git a/generated/nidaqmx/stream_readers/_digital_single_channel_reader.py b/generated/nidaqmx/stream_readers/_digital_single_channel_reader.py
@@ -6,7 +6,7 @@
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 from nitypes.waveform import DigitalWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class DigitalSingleChannelReader(ChannelReaderBase):
diff --git a/generated/nidaqmx/stream_readers/_power_readers.py b/generated/nidaqmx/stream_readers/_power_readers.py
@@ -3,7 +3,7 @@
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 from nidaqmx.types import PowerMeasurement
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class PowerSingleChannelReader(ChannelReaderBase):
diff --git a/generated/nidaqmx/stream_writers.py b/generated/nidaqmx/stream_writers.py
@@ -3,7 +3,13 @@
 """
 
 # Import all classes from the subpackage to maintain backward compatibility
-from .stream_writers import *  # noqa: F403, F401
-
-# Re-export the __all__ list from the subpackage
-from .stream_writers import __all__
+from nidaqmx.stream_writers import (
+    AnalogSingleChannelWriter,
+    AnalogMultiChannelWriter,
+    AnalogUnscaledWriter,
+    CounterWriter,
+    DigitalSingleChannelWriter,
+    DigitalMultiChannelWriter,
+    AUTO_START_UNSET,
+    __all__
+)
diff --git a/generated/nidaqmx/stream_writers/__init__.py b/generated/nidaqmx/stream_writers/__init__.py
@@ -6,17 +6,20 @@
 
 from __future__ import annotations
 
-from .analog_single_channel_writer import AnalogSingleChannelWriter
-from .analog_multi_channel_writer import AnalogMultiChannelWriter
-from .analog_unscaled_writer import AnalogUnscaledWriter
-from .counter_writer import CounterWriter
-from .digital_single_channel_writer import DigitalSingleChannelWriter
-from .digital_multi_channel_writer import DigitalMultiChannelWriter
+from nidaqmx.stream_writers._analog_single_channel_writer import AnalogSingleChannelWriter
+from nidaqmx.stream_writers._analog_multi_channel_writer import AnalogMultiChannelWriter
+from nidaqmx.stream_writers._analog_unscaled_writer import AnalogUnscaledWriter
+from nidaqmx.stream_writers._counter_writer import CounterWriter
+from nidaqmx.stream_writers._digital_single_channel_writer import DigitalSingleChannelWriter
+from nidaqmx.stream_writers._digital_multi_channel_writer import DigitalMultiChannelWriter
+from nidaqmx.stream_writers._channel_writer_base import UnsetAutoStartSentinel, AUTO_START_UNSET
 
 __all__ = [
     'AnalogSingleChannelWriter', 
     'AnalogMultiChannelWriter',
     'AnalogUnscaledWriter', 
     'CounterWriter',
     'DigitalSingleChannelWriter', 
-    'DigitalMultiChannelWriter']
+    'DigitalMultiChannelWriter',
+    'UnsetAutoStartSentinel',
+    'AUTO_START_UNSET']
diff --git a/generated/nidaqmx/stream_writers/_analog_multi_channel_writer.py b/generated/nidaqmx/stream_writers/_analog_multi_channel_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class AnalogMultiChannelWriter(ChannelWriterBase):
diff --git a/generated/nidaqmx/stream_writers/_analog_single_channel_writer.py b/generated/nidaqmx/stream_writers/_analog_single_channel_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class AnalogSingleChannelWriter(ChannelWriterBase):
diff --git a/generated/nidaqmx/stream_writers/_analog_unscaled_writer.py b/generated/nidaqmx/stream_writers/_analog_unscaled_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class AnalogUnscaledWriter(ChannelWriterBase):
diff --git a/generated/nidaqmx/stream_writers/_channel_writer_base.py b/generated/nidaqmx/stream_writers/_channel_writer_base.py
@@ -3,12 +3,13 @@
 
 
 class UnsetAutoStartSentinel:
-    pass
+    """Sentinel class for unset auto_start parameter."""
+    
+    def __init__(self):
+        raise RuntimeError("Cannot instantiate UnsetAutoStartSentinel. Use AUTO_START_UNSET instead.")
 
 
-AUTO_START_UNSET = UnsetAutoStartSentinel()
-
-del UnsetAutoStartSentinel
+AUTO_START_UNSET = object.__new__(UnsetAutoStartSentinel)
 
 
 class ChannelWriterBase:
diff --git a/generated/nidaqmx/stream_writers/_counter_writer.py b/generated/nidaqmx/stream_writers/_counter_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class CounterWriter(ChannelWriterBase):
diff --git a/generated/nidaqmx/stream_writers/_digital_multi_channel_writer.py b/generated/nidaqmx/stream_writers/_digital_multi_channel_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class DigitalMultiChannelWriter(ChannelWriterBase):
diff --git a/generated/nidaqmx/stream_writers/_digital_single_channel_writer.py b/generated/nidaqmx/stream_writers/_digital_single_channel_writer.py
@@ -2,7 +2,7 @@
 
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class DigitalSingleChannelWriter(ChannelWriterBase):
diff --git a/src/handwritten/stream_readers.py b/src/handwritten/stream_readers.py
@@ -3,7 +3,13 @@
 """
 
 # Import all classes from the subpackage to maintain backward compatibility
-from .stream_readers import *  # noqa: F403, F401
-
-# Re-export the __all__ list from the subpackage
-from .stream_readers import __all__
+from nidaqmx.stream_readers import (
+    AnalogSingleChannelReader,
+    AnalogMultiChannelReader, 
+    AnalogUnscaledReader,
+    CounterReader,
+    DigitalSingleChannelReader,
+    DigitalMultiChannelReader,
+    AUTO_START_UNSET,
+    __all__
+)
diff --git a/src/handwritten/stream_readers/__init__.py b/src/handwritten/stream_readers/__init__.py
@@ -8,13 +8,13 @@
 
 from nidaqmx import DaqError
 
-from .analog_single_channel_reader import AnalogSingleChannelReader
-from .analog_multi_channel_reader import AnalogMultiChannelReader
-from .analog_unscaled_reader import AnalogUnscaledReader
-from .counter_reader import CounterReader
-from .digital_single_channel_reader import DigitalSingleChannelReader
-from .digital_multi_channel_reader import DigitalMultiChannelReader
-from .power_readers import (
+from nidaqmx.stream_readers._analog_single_channel_reader import AnalogSingleChannelReader
+from nidaqmx.stream_readers._analog_multi_channel_reader import AnalogMultiChannelReader
+from nidaqmx.stream_readers._analog_unscaled_reader import AnalogUnscaledReader
+from nidaqmx.stream_readers._counter_reader import CounterReader
+from nidaqmx.stream_readers._digital_single_channel_reader import DigitalSingleChannelReader
+from nidaqmx.stream_readers._digital_multi_channel_reader import DigitalMultiChannelReader
+from nidaqmx.stream_readers._power_readers import (
     PowerSingleChannelReader,
     PowerMultiChannelReader,
     PowerBinaryReader,
diff --git a/src/handwritten/stream_readers/_analog_multi_channel_reader.py b/src/handwritten/stream_readers/_analog_multi_channel_reader.py
@@ -8,7 +8,7 @@
 from nidaqmx.error_codes import DAQmxErrors
 from nitypes.waveform import AnalogWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class AnalogMultiChannelReader(ChannelReaderBase):
diff --git a/src/handwritten/stream_readers/_analog_single_channel_reader.py b/src/handwritten/stream_readers/_analog_single_channel_reader.py
@@ -8,7 +8,7 @@
 from nidaqmx.error_codes import DAQmxErrors
 from nitypes.waveform import AnalogWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class AnalogSingleChannelReader(ChannelReaderBase):
diff --git a/src/handwritten/stream_readers/_analog_unscaled_reader.py b/src/handwritten/stream_readers/_analog_unscaled_reader.py
@@ -2,7 +2,7 @@
 
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class AnalogUnscaledReader(ChannelReaderBase):
diff --git a/src/handwritten/stream_readers/_counter_reader.py b/src/handwritten/stream_readers/_counter_reader.py
@@ -3,7 +3,7 @@
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 from nidaqmx.types import CtrFreq, CtrTick, CtrTime
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class CounterReader(ChannelReaderBase):
diff --git a/src/handwritten/stream_readers/_digital_multi_channel_reader.py b/src/handwritten/stream_readers/_digital_multi_channel_reader.py
@@ -8,7 +8,7 @@
 from nidaqmx.error_codes import DAQmxErrors
 from nitypes.waveform import DigitalWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class DigitalMultiChannelReader(ChannelReaderBase):
diff --git a/src/handwritten/stream_readers/_digital_single_channel_reader.py b/src/handwritten/stream_readers/_digital_single_channel_reader.py
@@ -6,7 +6,7 @@
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 from nitypes.waveform import DigitalWaveform
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class DigitalSingleChannelReader(ChannelReaderBase):
diff --git a/src/handwritten/stream_readers/_power_readers.py b/src/handwritten/stream_readers/_power_readers.py
@@ -3,7 +3,7 @@
 from nidaqmx.constants import FillMode, READ_ALL_AVAILABLE
 from nidaqmx.types import PowerMeasurement
 
-from ._channel_reader_base import ChannelReaderBase
+from nidaqmx.stream_readers._channel_reader_base import ChannelReaderBase
 
 
 class PowerSingleChannelReader(ChannelReaderBase):
diff --git a/src/handwritten/stream_writers.py b/src/handwritten/stream_writers.py
@@ -3,7 +3,13 @@
 """
 
 # Import all classes from the subpackage to maintain backward compatibility
-from .stream_writers import *  # noqa: F403, F401
-
-# Re-export the __all__ list from the subpackage
-from .stream_writers import __all__
+from nidaqmx.stream_writers import (
+    AnalogSingleChannelWriter,
+    AnalogMultiChannelWriter,
+    AnalogUnscaledWriter,
+    CounterWriter,
+    DigitalSingleChannelWriter,
+    DigitalMultiChannelWriter,
+    AUTO_START_UNSET,
+    __all__
+)
diff --git a/src/handwritten/stream_writers/__init__.py b/src/handwritten/stream_writers/__init__.py
@@ -6,17 +6,20 @@
 
 from __future__ import annotations
 
-from .analog_single_channel_writer import AnalogSingleChannelWriter
-from .analog_multi_channel_writer import AnalogMultiChannelWriter
-from .analog_unscaled_writer import AnalogUnscaledWriter
-from .counter_writer import CounterWriter
-from .digital_single_channel_writer import DigitalSingleChannelWriter
-from .digital_multi_channel_writer import DigitalMultiChannelWriter
+from nidaqmx.stream_writers._analog_single_channel_writer import AnalogSingleChannelWriter
+from nidaqmx.stream_writers._analog_multi_channel_writer import AnalogMultiChannelWriter
+from nidaqmx.stream_writers._analog_unscaled_writer import AnalogUnscaledWriter
+from nidaqmx.stream_writers._counter_writer import CounterWriter
+from nidaqmx.stream_writers._digital_single_channel_writer import DigitalSingleChannelWriter
+from nidaqmx.stream_writers._digital_multi_channel_writer import DigitalMultiChannelWriter
+from nidaqmx.stream_writers._channel_writer_base import UnsetAutoStartSentinel, AUTO_START_UNSET
 
 __all__ = [
     'AnalogSingleChannelWriter', 
     'AnalogMultiChannelWriter',
     'AnalogUnscaledWriter', 
     'CounterWriter',
     'DigitalSingleChannelWriter', 
-    'DigitalMultiChannelWriter']
+    'DigitalMultiChannelWriter',
+    'UnsetAutoStartSentinel',
+    'AUTO_START_UNSET']
diff --git a/src/handwritten/stream_writers/_analog_multi_channel_writer.py b/src/handwritten/stream_writers/_analog_multi_channel_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class AnalogMultiChannelWriter(ChannelWriterBase):
diff --git a/src/handwritten/stream_writers/_analog_single_channel_writer.py b/src/handwritten/stream_writers/_analog_single_channel_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class AnalogSingleChannelWriter(ChannelWriterBase):
diff --git a/src/handwritten/stream_writers/_analog_unscaled_writer.py b/src/handwritten/stream_writers/_analog_unscaled_writer.py
@@ -1,6 +1,6 @@
 from nidaqmx.constants import FillMode
 
-from ._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
+from nidaqmx.stream_writers._channel_writer_base import ChannelWriterBase, AUTO_START_UNSET
 
 
 class AnalogUnscaledWriter(ChannelWriterBase):
diff --git a/src/handwritten/stream_writers/_channel_writer_base.py b/src/handwritten/stream_writers/_channel_writer_base.py
diff --git a/src/handwritten/stream_writers/_counter_writer.py b/src/handwritten/stream_writers/_counter_writer.py
diff --git a/src/handwritten/stream_writers/_digital_multi_channel_writer.py b/src/handwritten/stream_writers/_digital_multi_channel_writer.py
diff --git a/src/handwritten/stream_writers/_digital_single_channel_writer.py b/src/handwritten/stream_writers/_digital_single_channel_writer.py
diff --git a/tests/component/conftest.py b/tests/component/conftest.py
diff --git a/tests/component/stream_readers/__init__.py b/tests/component/stream_readers/__init__.py
diff --git a/tests/component/stream_readers/test_analog_multi_channel_reader.py b/tests/component/stream_readers/test_analog_multi_channel_reader.py
diff --git a/tests/component/stream_readers/test_analog_single_channel_reader.py b/tests/component/stream_readers/test_analog_single_channel_reader.py
diff --git a/tests/component/stream_readers/test_analog_unscaled_reader.py b/tests/component/stream_readers/test_analog_unscaled_reader.py
diff --git a/tests/component/stream_readers/test_digital_multi_channel_reader.py b/tests/component/stream_readers/test_digital_multi_channel_reader.py
diff --git a/tests/component/stream_readers/test_digital_single_channel_reader.py b/tests/component/stream_readers/test_digital_single_channel_reader.py
diff --git a/tests/component/stream_readers/test_power_readers_ai.py b/tests/component/stream_readers/test_power_readers_ai.py
diff --git a/tests/component/task/test_task_read_ai.py b/tests/component/task/test_task_read_ai.py
diff --git a/tests/component/task/test_task_read_waveform_ai.py b/tests/component/task/test_task_read_waveform_ai.py
diff --git a/tests/component/task/test_task_read_waveform_di.py b/tests/component/task/test_task_read_waveform_di.py
