Add TimeDeltaArray to bintime by jfriedri-ni · Pull Request #160 · ni/nitypes-python

jfriedri-ni · 2025-07-24T21:06:01Z

This contribution adheres to CONTRIBUTING.md.

What does this Pull Request accomplish?

Adds new class TimeDeltaArray to nitypes.bintime
Adds unit tests and a benchmark test for the constructor

Why should this Pull Request be merged?

AB#3137071
Support irregular timing with NI-BTF timestamps

What testing has been done?

See tests/unit/bintime/test_timedelta_array.py
See tests/benchmark/bintime/test_timedelta_array.py

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

github-actions · 2025-07-24T21:11:56Z

Test Results

44 files ± 0 44 suites ±0 25m 6s ⏱️ + 5m 46s
2 004 tests + 264 2 004 ✅ + 264 0 💤 ±0 0 ❌ ±0
45 460 runs +6 064 45 460 ✅ +6 064 0 💤 ±0 0 ❌ ±0

Results for commit 157d3e4. ± Comparison against base commit 36eee3c.

♻️ This comment has been updated with latest results.

jfriedri-ni

This sketch is a basic TimeDeltaArray class with tests for its constructor.

src/nitypes/bintime/_timedelta_array.py

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

src/nitypes/bintime/_timedelta_array.py

tests/unit/bintime/test_timedelta_array.py

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

src/nitypes/bintime/_timedelta_array.py

tests/benchmark/bintime/test_timedelta_array.py

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

jfriedri-ni

One behavior decision to make below.

src/nitypes/bintime/_timedelta_array.py

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

…ices Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Raise when trying to grow the array Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

- replace and remove when assigning fewer values than the slice - replace and insert when assigning more values than the slice - replace directly when assigning same number of values as the slice Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

bkeryan

Approved with suggestions

src/nitypes/bintime/_timedelta_array.py

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add sketch of basic TimeDelta array

9487985

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

jfriedri-ni requested a review from bkeryan July 24, 2025 21:14

jfriedri-ni commented Jul 24, 2025

View reviewed changes

src/nitypes/bintime/_timedelta_array.py Outdated Show resolved Hide resolved

src/nitypes/bintime/_timedelta_array.py Outdated Show resolved Hide resolved

Do not incorrectly swap the struct packing order

b263c5f

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

bkeryan reviewed Jul 24, 2025

View reviewed changes

jfriedri-ni added 14 commits July 25, 2025 10:11

Specialize the numpy storage as much as supported

3772dc4

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Stop using Union

d73ae19

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Use len() for a 1D numpy array

9a15209

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Test with negative and fractional values as well

5dda9f0

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add CVI representation helpers to TimeValueTuple

25dd201

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Fix docstring typo

6626785

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Use the CVI helper when getting an item

3645d6a

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Try using a generator when constructing the TimeDeltaArray

d25b88f

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Address formatter to get to the type checker

0bdac3d

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Iterate over the input sequence when constructing the np array

7af2a9a

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add a test for indexing by integer

f35b7ff

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Use np.fromiter() to initialize the backing ndarray

268351f

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add test for len()

6a6861e

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add TimeDeltaArray constructor benchmark tests

363740a

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

bkeryan mentioned this pull request Jul 25, 2025

Create a Vector python type with unit tests. #161

Merged

1 task

bkeryan reviewed Jul 25, 2025

View reviewed changes

src/nitypes/bintime/_timedelta_array.py Outdated Show resolved Hide resolved

bkeryan reviewed Jul 25, 2025

View reviewed changes

tests/benchmark/bintime/test_timedelta_array.py Outdated Show resolved Hide resolved

tests/benchmark/bintime/test_timedelta_array.py Outdated Show resolved Hide resolved

jfriedri-ni added 7 commits July 28, 2025 09:25

Promote to MutableSequence

56f0d7c

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add signatures for remaining MutableSequence methods

27a0c91

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add impl and test for slicing

37470da

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add test for indexing with invalid indices

30dda3a

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add test cases for negative index and out of bounds index

27faef7

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Implement and test __setitem__()

c1a2265

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Implement and test __delitem__()

f116a78

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

jfriedri-ni added 10 commits August 5, 2025 11:35

Make test section comments match other files' style

c5b6fde

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Remove __imul__ and tests

b3169c2

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Use error factories for user input validation

e504a6f

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Fix test name typo

21f3b09

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Validate that an unpickled TimeDeltaArray has its own backing array

7a9f9a2

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Remove test for sorted

01a2aa4

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add test for deepcopy()

03ffd4e

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Use pytest parameters for validating equals

17c090f

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

TDD: use full truth-table coverage for setting with a slice

7b91f69

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Make TimeDeltaArray behave like list when setting by slice

4891ab4

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

jfriedri-ni commented Aug 6, 2025

View reviewed changes

src/nitypes/bintime/_timedelta_array.py Outdated Show resolved Hide resolved

jfriedri-ni requested a review from bkeryan August 6, 2025 22:42

bkeryan requested changes Aug 7, 2025

View reviewed changes

jfriedri-ni added 12 commits August 7, 2025 10:09

Unpack the slice into named variables

fdb40bb

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Prefer builtin functions over magic methods

9e3c67a

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Group the slice assignment tests together

8543def

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Add test cases for settings mismatched-length values on contiguous sl…

3b198e0

…ices Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Raise when trying to shrink the array using a stride

89b857a

Raise when trying to grow the array Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Do not hokey-pokey when setting a single value with a slice

896abc8

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Group selected==incoming test cases

8c87415

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Remove 'expected to raise' test cases that should pass for plain lists

83e6bcf

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Group and add mismatched slice vs incoming test cases

f9ff477

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Address the analyzers

c891490

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

Contiguous slices accept any number of incoming entries

26a18ba

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

jfriedri-ni requested a review from bkeryan August 7, 2025 22:27

bkeryan approved these changes Aug 7, 2025

View reviewed changes

src/nitypes/bintime/_timedelta_array.py Outdated Show resolved Hide resolved

Use np.insert to grow the array once

157d3e4

Signed-off-by: Joe Friedrichsen <114173023+jfriedri-ni@users.noreply.github.com>

jfriedri-ni merged commit f0a8889 into main Aug 8, 2025
28 checks passed

jfriedri-ni deleted the users/jfriedri/ab3137071-add-bintime-array-wrappers branch August 8, 2025 15:40

Conversation

jfriedri-ni commented Jul 24, 2025 • edited by ni-github-admins Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this Pull Request accomplish?

Why should this Pull Request be merged?

What testing has been done?

Uh oh!

github-actions bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

jfriedri-ni left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jfriedri-ni left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bkeryan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jfriedri-ni commented Jul 24, 2025 •

edited by ni-github-admins

Loading

github-actions bot commented Jul 24, 2025 •

edited

Loading