Skip to content
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.

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

Refactor Task Internal Modules (ExportSignal, OutStream, Timing) #539

Merged

Conversation

charitylxy
Copy link
Collaborator

@charitylxy charitylxy commented Mar 14, 2024

What does this Pull Request accomplish?

This PR aims to address issue brought up in #461:

  • Currently, task subobject types are defined in internal modules contained in private nidaqmx._task_modules package.
  • We want to turn task.py into a package and merge it with the internal modules contained in nidaqmx._task_modules

Refactoring work will be split into 5 PRs:

  • Refactor _task.py and _in_stream.py - Refactor task.py and internal module (in_stream.py)  #534
  • Refactor _export_signal.py, _out_stream.py, _timing.py - Implemented in this PR
  • Refactor collections: _channel_collection.py, _ai_channel_collection.py, _ao_channel_collection.py, _ci_channel_collection.py, _co_channel_collection.py, _di_channel_collection.py, _do_channel_collection.py
  • Refactor channels: _channel.py, _ai_channel.py, _ao_channel.py, _ci_channel.py, _co_channel.py, _di_channel.py, _do_channel.py
  • Refactor triggering: _triggers.py, _arm_start_trigger.py, _handshake_trigger.py, _pause_trigger.py, _reference_trigger.py, _start_trigger.py

Why should this Pull Request be merged?

In this PR to address #461, following changes have been made:

  • Made export_signal.py, out_stream.py and timing.py into private submodule and moved them to task package.
  • Added type hints for export_signal, out_stream. and timing..
  • Documentation updated.

What testing has been done?

Ran poetry run pytest and all tests passed.

@charitylxy charitylxy marked this pull request as ready for review March 14, 2024 16:10
Copy link
Collaborator

@bkeryan bkeryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with suggestions

src/handwritten/task/_task.py Outdated Show resolved Hide resolved
@charitylxy charitylxy merged commit 5fd2123 into ni:master Mar 18, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants