Skip to content

Add set data test cases #61

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
merged 15 commits into from
Aug 13, 2024
Merged

Add set data test cases #61

Changes from 2 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
95fc07e
add test cases to test files and make edition to make sure the behavi…
stevenhua0320 Aug 12, 2024
28c6ea7
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Aug 12, 2024
ce1d97f
change case in test__eq__ to be compatible with the behavior of setdata
stevenhua0320 Aug 12, 2024
0faa2ca
delete text and redundant tests
stevenhua0320 Aug 13, 2024
6a011a2
tweaking error message in DataClusters
sbillinge Aug 13, 2024
83eac4c
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Aug 13, 2024
9f17d25
update test for checking implicit attributes for setdata function
stevenhua0320 Aug 13, 2024
9d84a9f
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Aug 13, 2024
321f47d
update test for setdata function
stevenhua0320 Aug 13, 2024
3369069
update test for setdata function
stevenhua0320 Aug 13, 2024
3ef8a5b
update setdata test to right format.
stevenhua0320 Aug 13, 2024
cbe85f1
update to constructor test & make setdata clear function private
stevenhua0320 Aug 13, 2024
759a7e8
final tweaks to tests by Simon
sbillinge Aug 13, 2024
6f29c60
fix actual_attribute typo
sbillinge Aug 13, 2024
d102f5f
final refactor of actual_attr
sbillinge Aug 13, 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
27 changes: 22 additions & 5 deletions src/diffpy/srmise/tests/test_dataclusters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,32 @@ def test___eq__():
"y": np.array([3, 2, 1]),
"res": 4,
},
DataClusters(x=np.array([1, 2, 3]), y=np.array([3, 2, 1]), res=4),
{
"x": np.array([1, 2, 3]),
"y": np.array([3, 2, 1]),
"res": 4,
"data_order": [2, 1, 0],
"clusters": np.array([[0, 0]]),
"current_idx": 2,
"lastpoint_idx": 0,
"INIT": 0,
"READY": 1,
"CLUSTERING": 2,
"DONE": 3,
"lastcluster_idx": None,
"status": 1,
},
),
],
)
def test_set_data(inputs, expected):
actual = DataClusters(x=np.array([]), y=np.array([]), res=0)
actual.setdata(x=inputs["x"], y=inputs["y"], res=inputs["res"])
assert expected == actual

actual = DataClusters(x=inputs["x"], y=inputs["y"], res=inputs["res"])
Copy link
Contributor

Choose a reason for hiding this comment

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

this is better. Strinctly this still doesn't test set_data alone. It tests the object constructor. I think this is ok, but we may want to make clear and set_data as private functions. Then we don't need tests (or docstrings in prinicple) for them and we just test the constructor (the __init__).

Whether or not to do this depends where else these functions rae used. Do we want to make them available to users to use, or are they just being used in init alone or in init and a few other places.

These are small things, but once we touch the code we want to leave it better than when we arrived, and it is also a good learning experience.....

Could you look how these two functions are used and we can decide. If we make them private functions we can leave this test as it is but just change its name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is better. Strinctly this still doesn't test set_data alone. It tests the object constructor. I think this is ok, but we may want to make clear and set_data as private functions. Then we don't need tests (or docstrings in prinicple) for them and we just test the constructor (the __init__).

Whether or not to do this depends where else these functions rae used. Do we want to make them available to users to use, or are they just being used in init alone or in init and a few other places.

These are small things, but once we touch the code we want to leave it better than when we arrived, and it is also a good learning experience.....

Could you look how these two functions are used and we can decide. If we make them private functions we can leave this test as it is but just change its name.

I'm certain that these two functions are only used in the constructor. It should be OK to change them into private functions.

Copy link
Contributor

Choose a reason for hiding this comment

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

super, let's do this. Just

  • change the name of this test to something like test_DataClusters_constructor since this is what it does anyway.
  • add an underscore to the beginning of the clear and set_data functions. You can leave the docstring since we already wrote it.
  • revisit the test_clear tests. We want to remove this test, but let's make sure that this behavior is being tested in the constructor test, so move over anything we need from there.

attributes = vars(actual)
for attr_key, attr_val in attributes.items():
if isinstance(attr_val, np.ndarray):
assert np.array_equal(attr_val, expected[attr_key])
else:
assert attr_val == expected[attr_key]


@pytest.mark.parametrize(
Expand Down