Skip to content

Refactor Task Internal Modules #538

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

Closed
wants to merge 13 commits into from
Closed

Refactor Task Internal Modules #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
614ec8e
Refactor task internal modules
charitylxy Mar 14, 2024
1f900ac
Add type hints
charitylxy Mar 14, 2024
19c164b
Refactor collections
charitylxy Mar 14, 2024
e9436bb
fix mypy
charitylxy Mar 14, 2024
6883a25
delete channel collection in generated _task_modules
charitylxy Mar 14, 2024
1374a30
Fix error and documentation
charitylxy Mar 14, 2024
4e6531f
Add type hints for channel collection
charitylxy Mar 14, 2024
112b9bb
Refactor channels
charitylxy Mar 14, 2024
a9f5a8a
update channels doc
charitylxy Mar 14, 2024
ef87791
update affected tests
charitylxy Mar 14, 2024
3ddcb81
minor codegen fix
charitylxy Mar 14, 2024
914b3ba
fix lint error
charitylxy Mar 14, 2024
e4c9cc0
Refactor triggers
charitylxy Mar 14, 2024
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
6 changes: 3 additions & 3 deletions docs/ai_channel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.ai_channel
=======================
nidaqmx.task.channels.AIChannel
===============================

.. automodule:: nidaqmx._task_modules.channels.ai_channel
.. autoclass:: nidaqmx.task.channels.AIChannel
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/ai_channel_collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.ai_channel_collection
==================================
nidaqmx.task.collections.AIChannelCollection
===============================================

.. automodule:: nidaqmx._task_modules.ai_channel_collection
.. autoclass:: nidaqmx.task.collections.AIChannelCollection
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/ao_channel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.ao_channel
=======================
nidaqmx.task.channels.AOChannel
===============================

.. automodule:: nidaqmx._task_modules.channels.ao_channel
.. autoclass:: nidaqmx.task.channels.AOChannel
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/ao_channel_collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.ao_channel_collection
==================================
nidaqmx.task.collections.AOChannelCollection
===============================================

.. automodule:: nidaqmx._task_modules.ao_channel_collection
.. autoclass:: nidaqmx.task.collections.AOChannelCollection
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/arm_start_trigger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nidaqmx.task.arm_start_trigger
==============================
nidaqmx.task.triggering.ArmStartTrigger
=======================================

.. automodule:: nidaqmx._task_modules.triggering.arm_start_trigger
.. autoclass:: nidaqmx.task.triggering.ArmStartTrigger
:members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/channel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.channel
====================
nidaqmx.task.channels
=====================

.. automodule:: nidaqmx._task_modules.channels.channel
.. autoclass:: nidaqmx.task.channels.Channel
:members:
:show-inheritance:

Expand Down
4 changes: 2 additions & 2 deletions docs/channel_collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.channel_collection
nidaqmx.task.collections
===============================

.. automodule:: nidaqmx._task_modules.channel_collection
.. autoclass:: nidaqmx.task.collections.ChannelCollection
:members:
:show-inheritance:

Expand Down
6 changes: 3 additions & 3 deletions docs/ci_channel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.ci_channel
=======================
nidaqmx.task.channels.CIChannel
===============================

.. automodule:: nidaqmx._task_modules.channels.ci_channel
.. autoclass:: nidaqmx.task.channels.CIChannel
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/ci_channel_collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.ci_channel_collection
==================================
nidaqmx.task.collections.CIChannelCollection
===============================================

.. automodule:: nidaqmx._task_modules.ci_channel_collection
.. autoclass:: nidaqmx.task.collections.CIChannelCollection
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/co_channel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.co_channel
=======================
nidaqmx.task.channels.COChannel
===============================

.. automodule:: nidaqmx._task_modules.channels.co_channel
.. autoclass:: nidaqmx.task.channels.COChannel
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/co_channel_collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.co_channel_collection
==================================
nidaqmx.task.collections.COChannelCollection
===============================================

.. automodule:: nidaqmx._task_modules.co_channel_collection
.. autoclass:: nidaqmx.task.collections.COChannelCollection
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/di_channel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.di_channel
=======================
nidaqmx.task.channels.DIChannel
===============================

.. automodule:: nidaqmx._task_modules.channels.di_channel
.. autoclass:: nidaqmx.task.channels.DIChannel
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/di_channel_collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.di_channel_collection
==================================
nidaqmx.task.collections.DIChannelCollection
===============================================

.. automodule:: nidaqmx._task_modules.di_channel_collection
.. autoclass:: nidaqmx.task.collections.DIChannelCollection
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/do_channel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.do_channel
=======================
nidaqmx.task.channels.DOChannel
===============================

.. automodule:: nidaqmx._task_modules.channels.do_channel
.. autoclass:: nidaqmx.task.channels.DOChannel
:members:
:inherited-members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/do_channel_collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.do_channel_collection
==================================
nidaqmx.task.collections.DOChannelCollection
===============================================

.. automodule:: nidaqmx._task_modules.do_channel_collection
.. autoclass:: nidaqmx.task.collections.DOChannelCollection
:members:
:inherited-members:
:show-inheritance:
6 changes: 0 additions & 6 deletions docs/export_signals.rst
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions docs/handshake_trigger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nidaqmx.task.handshake_trigger
==============================
nidaqmx.task.triggering.HandshakeTrigger
========================================

.. automodule:: nidaqmx._task_modules.triggering.handshake_trigger
.. autoclass:: nidaqmx.task.triggering.HandshakeTrigger
:members:
:show-inheritance:
6 changes: 0 additions & 6 deletions docs/out_stream.rst
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions docs/pause_trigger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nidaqmx.task.pause_trigger
==========================
nidaqmx.task.triggering.PauseTrigger
====================================

.. automodule:: nidaqmx._task_modules.triggering.pause_trigger
.. autoclass:: nidaqmx.task.triggering.PauseTrigger
:members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/reference_trigger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nidaqmx.task.reference_trigger
==============================
nidaqmx.task.triggering.ReferenceTrigger
========================================

.. automodule:: nidaqmx._task_modules.triggering.reference_trigger
.. autoclass:: nidaqmx.task.triggering.ReferenceTrigger
:members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/start_trigger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nidaqmx.task.start_trigger
==========================
nidaqmx.task.triggering.StartTrigger
====================================

.. automodule:: nidaqmx._task_modules.triggering.start_trigger
.. autoclass:: nidaqmx.task.triggering.StartTrigger
:members:
:show-inheritance:
3 changes: 0 additions & 3 deletions docs/task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,4 @@ nidaqmx.task

channel
channel_collection
export_signals
out_stream
timing
triggers
6 changes: 0 additions & 6 deletions docs/timing.rst
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions docs/triggers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nidaqmx.task.triggers
=====================
nidaqmx.task.triggering
=======================

.. automodule:: nidaqmx._task_modules.triggers
.. autoclass:: nidaqmx.task.triggering.Triggers
:members:
:show-inheritance:

Expand Down
Empty file removed generated/nidaqmx/_task_modules/__init__.py
View file
Open in desktop
Empty file.
11 changes: 0 additions & 11 deletions generated/nidaqmx/_task_modules/channels/__init__.py
View file
Open in desktop

This file was deleted.

Empty file removed generated/nidaqmx/_task_modules/triggering/__init__.py
View file
Open in desktop
Empty file.
5 changes: 4 additions & 1 deletion generated/nidaqmx/task/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,8 @@
Task, _TaskEventType, _TaskAlternateConstructor
)
from nidaqmx.task._in_stream import InStream
from nidaqmx.task._out_stream import OutStream
from nidaqmx.task._export_signals import ExportSignals
from nidaqmx.task._timing import Timing

__all__ = ['Task', 'InStream']
__all__ = ['Task', 'InStream', 'OutStream', 'ExportSignals', 'Timing',]
0 ...d/nidaqmx/_task_modules/export_signals.py → generated/nidaqmx/task/_export_signals.py
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion generated/nidaqmx/task/_in_stream.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import numpy.typing
import deprecation

from nidaqmx._task_modules.channels.channel import Channel
from nidaqmx.task.channels import Channel
from nidaqmx.utils import unflatten_channel_string
from nidaqmx.constants import (
AcquisitionType, LoggingMode, LoggingOperation, OverwriteMode,
Expand Down
0 ...rated/nidaqmx/_task_modules/out_stream.py → generated/nidaqmx/task/_out_stream.py
View file
Open in desktop
File renamed without changes.
Loading