Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikeprosserni merged 5 commits into from
Sep 8, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ca1da4
made submodules in stream_readers and stream_writters private
Sep 8, 2025
542c530
rename component\readers to component\stream_readers
Sep 8, 2025
c482db9
fix AUTO_START_UNSET compatibility breakage
Sep 8, 2025
91160a8
change relative imports to absolute imports
Sep 8, 2025
51d9f1a
export UnsetAutoStartSentinel also
Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions generated/nidaqmx/stream_readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__
)
14 changes: 7 additions & 7 deletions generated/nidaqmx/stream_readers/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion ...am_readers/analog_multi_channel_reader.py → ...m_readers/_analog_multi_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...m_readers/analog_single_channel_reader.py → ..._readers/_analog_single_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion .../stream_readers/analog_unscaled_reader.py → ...stream_readers/_analog_unscaled_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...dwritten/stream_readers/counter_reader.py → ...nidaqmx/stream_readers/_counter_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...m_readers/digital_multi_channel_reader.py → ..._readers/_digital_multi_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ..._readers/digital_single_channel_reader.py → ...readers/_digital_single_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...ndwritten/stream_readers/power_readers.py → .../nidaqmx/stream_readers/_power_readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
14 changes: 10 additions & 4 deletions generated/nidaqmx/stream_writers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__
)
17 changes: 10 additions & 7 deletions generated/nidaqmx/stream_writers/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']
2 changes: 1 addition & 1 deletion ...am_writers/analog_multi_channel_writer.py → ...m_writers/_analog_multi_channel_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...m_writers/analog_single_channel_writer.py → ..._writers/_analog_single_channel_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion .../stream_writers/analog_unscaled_writer.py → ...stream_writers/_analog_unscaled_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
9 changes: 5 additions & 4 deletions generated/nidaqmx/stream_writers/_channel_writer_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .../nidaqmx/stream_writers/counter_writer.py → ...nidaqmx/stream_writers/_counter_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...m_writers/digital_multi_channel_writer.py → ..._writers/_digital_multi_channel_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ..._writers/digital_single_channel_writer.py → ...writers/_digital_single_channel_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
14 changes: 10 additions & 4 deletions src/handwritten/stream_readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__
)
14 changes: 7 additions & 7 deletions src/handwritten/stream_readers/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion ...am_readers/analog_multi_channel_reader.py → ...m_readers/_analog_multi_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...m_readers/analog_single_channel_reader.py → ..._readers/_analog_single_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion .../stream_readers/analog_unscaled_reader.py → ...stream_readers/_analog_unscaled_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion .../nidaqmx/stream_readers/counter_reader.py → ...written/stream_readers/_counter_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...m_readers/digital_multi_channel_reader.py → ..._readers/_digital_multi_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ..._readers/digital_single_channel_reader.py → ...readers/_digital_single_channel_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...d/nidaqmx/stream_readers/power_readers.py → ...dwritten/stream_readers/_power_readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
14 changes: 10 additions & 4 deletions src/handwritten/stream_writers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__
)
17 changes: 10 additions & 7 deletions src/handwritten/stream_writers/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']
2 changes: 1 addition & 1 deletion ...am_writers/analog_multi_channel_writer.py → ...m_writers/_analog_multi_channel_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion ...m_writers/analog_single_channel_writer.py → ..._writers/_analog_single_channel_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion .../stream_writers/analog_unscaled_writer.py → ...stream_writers/_analog_unscaled_writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
Loading
Loading