depr: Deprecate utils.parsing in favor of gaze.from_asc()

[dkrako]

⚠️ Deprecation

utils.parsing is deprecated. please use gaze.from_asc() instead.
utils.parsing will be removed in pymovements v0.26.0

Description

Deprecate utils.parsing in favor of gaze.from_asc()

The following warning is printed:

DeprecationWarning: Call to deprecated function (or staticmethod) parse_eyelink. (Please use gaze.from_asc() instead of utils.parsing. This module will be removed in v0.26.0.) -- Deprecated since version v0.21.0.

Fixes #973

Should be merged before #945

Implemented changes

• added deprecated as a dependency for @deprecated decorator
• moved utils/parsing.py to gaze/_utils/parsing.py and adjusted to new location
• use gaze._utils.parsing in gaze.io
• created depracted function in utils/parsing.py
• moved tests/unit/utils/parsing_test.py to tests/unit/gaze/_utils/parsing_test.py
• add test that function is correctly deprecated
• add test that function is removed in planned version

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (38c78f8) to head (05428a2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #976   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           78        79    +1     
  Lines         3557      3567   +10     
  Branches       622       622           
=========================================
+ Hits          3557      3567   +10     

☔ 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]

finally

[dkrako]

let's merge this after releasing v0.20.0

[dkrako]

this is now ready for being merged

[dkrako]

Why was #989 merged before this?

[SiQube]

whoops -- #954 was the pain point 🙈

[dkrako]

#954 could wait

[SiQube]

very true -- I just forgot about this PR. I think the "easiest" way would be to revert #989, merge #976, and then adjust #989 in a new PR.... sorry

[dkrako]

I try to resolve the conflicts in this PR

[SiQube]

see #993

[SiQube]

okay -- if you decide to revert and remerge, lmk and I'll fix #989

[dkrako]

shit happens, we're all doing errors here and now. luckily there weren't many changes in #989.

please review the merge commit against the changes in #989

[SiQube]

just a couple of feedback questions:

1. comment below
2. why gaze/_utils instead of gaze/utils?

[dkrako]

just a couple of feedback questions:

1. comment below

2. why `gaze/_utils` instead of `gaze/utils`?

I wanted to make sure that users understand that this is a private utils module that is not intended for the end-user.

[SiQube]

okay reasonable, I have to preference and let make pytest happy :-)