feat: raise helpful error message for existing event properties

[xiaotiansu]

Hi, my first commit of code, hope I'm doing it correctly :)

Fixes #

Implemented changes

Insert a description of the changes implemented in the pull request.

• raise ValueError if the computed property already exists in the event dataframe

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change is or requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.
Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration

• passed 579 tests for dataset: tox -e py39 -- tests/unit/events

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules
• I have checked my code and corrected any misspellings

[codecov]

Codecov Report

Attention: Patch coverage is 94.44444% with 2 lines in your changes missing coverage. Please review.

Project coverage is 99.94%. Comparing base (6245bbf) to head (3d410dd).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
src/pymovements/dataset/dataset.py	50.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##              main    #1046      +/-   ##
===========================================
- Coverage   100.00%   99.94%   -0.06%     
===========================================
  Files           84       86       +2     
  Lines         3654     3722      +68     
  Branches       646      652       +6     
===========================================
+ Hits          3654     3720      +66     
- Misses           0        1       +1     
- Partials         0        1       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[dkrako]

Great! Thank you so much for your initiative!

Some of the tests don't pass because event_properties can also be a dict.
I posted a short proposal on how to change your code accordingly.

You will also need to add at least two test cases here:

pymovements/tests/unit/dataset/dataset_test.py

Lines 1603 to 1614 in 87487d0

	@pytest.mark.parametrize(
	('property_kwargs', 'exception', 'msg_substrings'),
	[
	pytest.param(
	{'event_properties': 'foo'},
	pm.exceptions.InvalidProperty,
	('foo', 'invalid', 'valid', 'peak_velocity'),
	id='invalid_property',
	),
	],
	)
	def test_event_dataframe_add_property_raises_exceptions(

One for the ValueError and one for the TypeError.

[dkrako]

Great, this looks quite good already, but please make sure that all tests pass.

There are a few syntax errors left in your code, that's why the tests fail. The error messages in the test runs point you to the error: https://github.com/aeye-lab/pymovements/actions/runs/14032843428?pr=1046

[SiQube]

this PR gets screwed over by autopep8, see hhatto/autopep8#765 for the issue. maybe we should deactivate autopep8?

[dkrako]

Great, finally linting and all tests pass! Was a bit complicated with all the type unions. There seemed to be a confusion between EventProcessor and EventGazeProcessor, so I helped out a bit to not burden you with these details.

The last thing what's missing now is covering all the new exceptions with tests.

[dkrako]

This is not covered by any tests anymore. Please add a test here:

pymovements/tests/unit/dataset/dataset_test.py

Lines 1603 to 1619 in 6245bbf

	@pytest.mark.parametrize(
	('property_kwargs', 'exception', 'msg_substrings'),
	[
	pytest.param(
	{'event_properties': 'foo'},
	pm.exceptions.InvalidProperty,
	('foo', 'invalid', 'valid', 'peak_velocity'),
	id='invalid_property',
	),
	],
	)
	def test_event_dataframe_add_property_raises_exceptions(
	gaze_dataset_configuration,
	property_kwargs,
	exception,
	msg_substrings,
	):

[dkrako]

Hi @xiaotiansu maybe you overlooked this, there's one final test needed to get full coverage.

After adding the test we'll be ready to merge. Thanks for all the work so far!