feat!: Custom patterns for parsing logged metadata in ASC files

[saeub]

Description

Fixes #758

Implemented changes

• BREAKING: Return metadata dictionary from from_asc()
• Add argument matadata_patterns to from_asc() and parse_eyelink()
• Default value of None for metadata keys specified in metadata_patterns that are not present in the ASC file

TODO

• Make pylint happy
• Fix test coverage

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?

• Metadata returned
• Test default None values

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

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (84f1416) to head (b2ce27f).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #767   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           71        71           
  Lines         3230      3225    -5     
  Branches       925       925           
=========================================
- Hits          3230      3225    -5     

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

[saeub]

NOTE: #510 says:

Don't care about integrating this into the 'gaze.from_asc()` function yet.

So not sure if this breaking interface change in from_asc() is acceptable, but I think it would be useful...

[SiQube]

I think this is a great addition and the benefits outweigh the breaking change.

[SiQube]

looks very good -- some minor comments

[SiQube]

@prassepaul @dkrako I'd liked to have a second pair of eyes on this breaking change

[SiQube]