Refactor Task Internal Modules: Triggers (#546)

* minor codegen fix

* update return type docs

* update functions metadata

* update metadata

* Refactor triggers

* add type hints

* modify docs

docs/task.rst

@@ -9,4 +9,4 @@ nidaqmx.task
 
    task_channels
    task_collections
-   triggers
+   task_triggering

docs/task_triggering.rst

@@ -0,0 +1,7 @@
+nidaqmx.task.triggering
+=======================
+
+.. automodule:: nidaqmx.task.triggering
+    :members:
+    :show-inheritance:
+    :member-order: bysource

generated/nidaqmx/task/_task.py

@@ -9,7 +9,7 @@
 from nidaqmx.task._export_signals import ExportSignals
 from nidaqmx.task._in_stream import InStream
 from nidaqmx.task._timing import Timing
-from nidaqmx._task_modules.triggers import Triggers
+from nidaqmx.task.triggering._triggers import Triggers
 from nidaqmx.task._out_stream import OutStream
 from nidaqmx.task.collections._ai_channel_collection import (
     AIChannelCollection)
@@ -255,10 +255,9 @@ def timing(self) -> Timing:
         return self._timing
 
     @property
-    def triggers(self):
+    def triggers(self) -> Triggers:
         """
-        :class:`nidaqmx._task_modules.triggers.Triggers`: Gets the trigger
-            configurations for the task.
+        Gets the trigger configurations for the task.
         """
         return self._triggers
 

generated/nidaqmx/task/triggering/__init__.py

@@ -0,0 +1,9 @@
+
+from nidaqmx.task.triggering._triggers import Triggers
+from nidaqmx.task.triggering._arm_start_trigger import ArmStartTrigger
+from nidaqmx.task.triggering._handshake_trigger import HandshakeTrigger
+from nidaqmx.task.triggering._pause_trigger import PauseTrigger
+from nidaqmx.task.triggering._reference_trigger import ReferenceTrigger
+from nidaqmx.task.triggering._start_trigger import StartTrigger
+
+__all__ = ['Triggers', 'ArmStartTrigger', 'HandshakeTrigger', 'PauseTrigger', 'ReferenceTrigger', 'StartTrigger']

generated/nidaqmx/_task_modules/triggers.py → generated/nidaqmx/task/triggering/_triggers.py

@@ -1,10 +1,10 @@
 # Do not edit this file; it was automatically generated.
 
-from nidaqmx._task_modules.triggering.arm_start_trigger import ArmStartTrigger
-from nidaqmx._task_modules.triggering.handshake_trigger import HandshakeTrigger
-from nidaqmx._task_modules.triggering.pause_trigger import PauseTrigger
-from nidaqmx._task_modules.triggering.reference_trigger import ReferenceTrigger
-from nidaqmx._task_modules.triggering.start_trigger import StartTrigger
+from nidaqmx.task.triggering._arm_start_trigger import ArmStartTrigger
+from nidaqmx.task.triggering._handshake_trigger import HandshakeTrigger
+from nidaqmx.task.triggering._pause_trigger import PauseTrigger
+from nidaqmx.task.triggering._reference_trigger import ReferenceTrigger
+from nidaqmx.task.triggering._start_trigger import StartTrigger
 from nidaqmx.constants import (
     SyncType)
 
@@ -23,42 +23,37 @@ def __init__(self, task_handle, interpreter):
         self._start_trigger = StartTrigger(self._handle, self._interpreter)
 
     @property
-    def arm_start_trigger(self):
+    def arm_start_trigger(self) -> ArmStartTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.arm_start_trigger.ArmStartTrigger`:
-            Gets the arm start trigger configurations for the task.
+        Gets the arm start trigger configurations for the task.
         """
         return self._arm_start_trigger
 
     @property
-    def handshake_trigger(self):
+    def handshake_trigger(self) -> HandshakeTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.handshake_trigger.HandshakeTrigger`:
-            Gets the handshake trigger configurations for the task.
+        Gets the handshake trigger configurations for the task.
         """
         return self._handshake_trigger
 
     @property
-    def pause_trigger(self):
+    def pause_trigger(self) -> PauseTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.pause_trigger.PauseTrigger`:
-            Gets the pause trigger configurations for the task.
+        Gets the pause trigger configurations for the task.
         """
         return self._pause_trigger
 
     @property
-    def reference_trigger(self):
+    def reference_trigger(self) -> ReferenceTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.reference_trigger.ReferenceTrigger`:
-            Gets the reference trigger configurations for the task.
+        Gets the reference trigger configurations for the task.
         """
         return self._reference_trigger
 
     @property
-    def start_trigger(self):
+    def start_trigger(self) -> StartTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.start_trigger.StartTrigger`:
-            Gets the start trigger configurations for the task.
+        Gets the start trigger configurations for the task.
         """
         return self._start_trigger
 

src/codegen/metadata/script_info.py

@@ -93,24 +93,24 @@
             "templateFile": "task\\_export_signals.py.mako",
         },
         {
-            "relativeOutputPath": "_task_modules\\triggering\\arm_start_trigger.py",
-            "templateFile": "_task_modules\\triggering\\arm_start_trigger.py.mako",
+            "relativeOutputPath": "task\\triggering\\_arm_start_trigger.py",
+            "templateFile": "task\\triggering\\_arm_start_trigger.py.mako",
         },
         {
-            "relativeOutputPath": "_task_modules\\triggering\\handshake_trigger.py",
-            "templateFile": "_task_modules\\triggering\\handshake_trigger.py.mako",
+            "relativeOutputPath": "task\\triggering\\_handshake_trigger.py",
+            "templateFile": "task\\triggering\\_handshake_trigger.py.mako",
         },
         {
-            "relativeOutputPath": "_task_modules\\triggering\\pause_trigger.py",
-            "templateFile": "_task_modules\\triggering\\pause_trigger.py.mako",
+            "relativeOutputPath": "task\\triggering\\_pause_trigger.py",
+            "templateFile": "task\\triggering\\_pause_trigger.py.mako",
         },
         {
-            "relativeOutputPath": "_task_modules\\triggering\\reference_trigger.py",
-            "templateFile": "_task_modules\\triggering\\reference_trigger.py.mako",
+            "relativeOutputPath": "task\\triggering\\_reference_trigger.py",
+            "templateFile": "task\\triggering\\_reference_trigger.py.mako",
         },
         {
-            "relativeOutputPath": "_task_modules\\triggering\\start_trigger.py",
-            "templateFile": "_task_modules\\triggering\\start_trigger.py.mako",
+            "relativeOutputPath": "task\\triggering\\_start_trigger.py",
+            "templateFile": "task\\triggering\\_start_trigger.py.mako",
         },
         {
             "relativeOutputPath": "system\\system.py",
@@ -125,8 +125,8 @@
             "templateFile": "system\\physical_channel.py.mako",
         },
         {
-            "relativeOutputPath": "_task_modules\\triggers.py",
-            "templateFile": "_task_modules\\triggers.py.mako",
+            "relativeOutputPath": "task\\triggering\\_triggers.py",
+            "templateFile": "task\\triggering\\_triggers.py.mako",
         },
     ]
 }

src/codegen/templates/_task_modules/triggers.py.mako → src/codegen/templates/task/triggering/_triggers.py.mako

@@ -13,11 +13,11 @@
 %>\
 # Do not edit this file; it was automatically generated.
 
-from nidaqmx._task_modules.triggering.arm_start_trigger import ArmStartTrigger
-from nidaqmx._task_modules.triggering.handshake_trigger import HandshakeTrigger
-from nidaqmx._task_modules.triggering.pause_trigger import PauseTrigger
-from nidaqmx._task_modules.triggering.reference_trigger import ReferenceTrigger
-from nidaqmx._task_modules.triggering.start_trigger import StartTrigger
+from nidaqmx.task.triggering._arm_start_trigger import ArmStartTrigger
+from nidaqmx.task.triggering._handshake_trigger import HandshakeTrigger
+from nidaqmx.task.triggering._pause_trigger import PauseTrigger
+from nidaqmx.task.triggering._reference_trigger import ReferenceTrigger
+from nidaqmx.task.triggering._start_trigger import StartTrigger
 %if enums_used:
 from nidaqmx.constants import (
     ${', '.join([c for c in enums_used]) | wrap(4, 4)})
@@ -38,42 +38,37 @@ class Triggers:
         self._start_trigger = StartTrigger(self._handle, self._interpreter)
 
     @property
-    def arm_start_trigger(self):
+    def arm_start_trigger(self) -> ArmStartTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.arm_start_trigger.ArmStartTrigger`:
-            Gets the arm start trigger configurations for the task.
+        Gets the arm start trigger configurations for the task.
         """
         return self._arm_start_trigger
 
     @property
-    def handshake_trigger(self):
+    def handshake_trigger(self) -> HandshakeTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.handshake_trigger.HandshakeTrigger`:
-            Gets the handshake trigger configurations for the task.
+        Gets the handshake trigger configurations for the task.
         """
         return self._handshake_trigger
 
     @property
-    def pause_trigger(self):
+    def pause_trigger(self) -> PauseTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.pause_trigger.PauseTrigger`:
-            Gets the pause trigger configurations for the task.
+        Gets the pause trigger configurations for the task.
         """
         return self._pause_trigger
 
     @property
-    def reference_trigger(self):
+    def reference_trigger(self) -> ReferenceTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.reference_trigger.ReferenceTrigger`:
-            Gets the reference trigger configurations for the task.
+        Gets the reference trigger configurations for the task.
         """
         return self._reference_trigger
 
     @property
-    def start_trigger(self):
+    def start_trigger(self) -> StartTrigger:
         """
-        :class:`nidaqmx._task_modules.triggering.start_trigger.StartTrigger`:
-            Gets the start trigger configurations for the task.
+        Gets the start trigger configurations for the task.
         """
         return self._start_trigger
 

src/handwritten/task/_task.py

@@ -9,7 +9,7 @@
 from nidaqmx.task._export_signals import ExportSignals
 from nidaqmx.task._in_stream import InStream
 from nidaqmx.task._timing import Timing
-from nidaqmx._task_modules.triggers import Triggers
+from nidaqmx.task.triggering._triggers import Triggers
 from nidaqmx.task._out_stream import OutStream
 from nidaqmx.task.collections._ai_channel_collection import (
     AIChannelCollection)
@@ -255,10 +255,9 @@ def timing(self) -> Timing:
         return self._timing
 
     @property
-    def triggers(self):
+    def triggers(self) -> Triggers:
         """
-        :class:`nidaqmx._task_modules.triggers.Triggers`: Gets the trigger
-            configurations for the task.
+        Gets the trigger configurations for the task.
         """
         return self._triggers
 

src/handwritten/task/triggering/__init__.py

@@ -0,0 +1,9 @@
+
+from nidaqmx.task.triggering._triggers import Triggers
+from nidaqmx.task.triggering._arm_start_trigger import ArmStartTrigger
+from nidaqmx.task.triggering._handshake_trigger import HandshakeTrigger
+from nidaqmx.task.triggering._pause_trigger import PauseTrigger
+from nidaqmx.task.triggering._reference_trigger import ReferenceTrigger
+from nidaqmx.task.triggering._start_trigger import StartTrigger
+
+__all__ = ['Triggers', 'ArmStartTrigger', 'HandshakeTrigger', 'PauseTrigger', 'ReferenceTrigger', 'StartTrigger']