Replace all Video structuring with Video.cattr()

roomrys commented 1 month ago

Description

In a downstream branch that updates the version of cattrs (to 23.x.x from the current 1.1.1) we were seeing the following error in out CI tests:

FAILED tests/gui/test_suggestions.py::test_video_selection - ValueError: <class 'sleap.io.video.SingleImageVideo'> has no usable non-default attributes.

. Although we had already merged a PR to handle this (Use Video.from_filename when structuring videos (#1905)), it seems that there were leftover cattr.structure calls on serialized Video dictionaries that did not use the Video.cattr() created for this purpose.

This PR replaces all remaining instances of cattr.structure on Video dictionaries with Video.cattr().structure.

Types of changes

[x] Bugfix (downstream)
[ ] New feature
[ ] Refactor / Code style update (no logical changes)
[ ] Build / CI changes
[ ] Documentation Update
[ ] Other (explain)

Does this address any currently open issues?

1841
1905

Outside contributors checklist

[ ] Review the guidelines for contributing to this repository
[ ] Read and sign the CLA and add yourself to the authors list
[ ] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
[ ] Add tests that prove your fix is effective or that your feature works
[ ] Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

New Features
- Enhanced video object handling with improved structure management and context awareness.
- Increased encapsulation of the Video class for better attribute management.
Bug Fixes
- Improved data validation and processing for video attributes.

coderabbitai[bot] commented 1 month ago

Walkthrough

Recent modifications enhance the handling and instantiation of Video objects within the ParallelFeaturePipeline and AsyncVideo classes. Both changes shift the structure transformation process to utilize a class method from the Video class, improving encapsulation and context awareness. These updates may enhance data validation and processing, ensuring a more robust management of video data.

Changes

File	Change Summary
`sleap/info/feature_suggestions.py`, `sleap/io/asyncvideo.py`	Updated the instantiation method of `Video` objects to use `Video.cattr().structure(...)`, enhancing encapsulation and context-aware data handling.

Poem

🐇 In the code, innovations sprout,
With Video’s charm, there's no doubt!
Structure's refined, like a dance,
Encapsulation gives it a chance.
Now we hop through data with glee,
Thanks to changes, just wait and see!
✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.50%. Comparing base (7ed1229) to head (5bb8d37). Report is 36 commits behind head on develop.

Files	Patch %	Lines
sleap/info/feature_suggestions.py	0.00%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #1911 +/- ## =========================================== + Coverage 73.30% 74.50% +1.19% =========================================== Files 134 135 +1 Lines 24087 24787 +700 =========================================== + Hits 17658 18467 +809 + Misses 6429 6320 -109 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

roomrys commented 1 month ago

A side question is whether we even use the sleap/io/asyncvideo.py file? I only found search results for it in tests, but those tests hung up for me when running locally....

Also, codecov is reporting that feature_suggestions.py has the untested line, but that is actually the line that causes the error in the downstream tests (L362 in these actions)

____________________________ test_video_selection _____________________________
multiprocessing.pool.RemoteTraceback: 
"""
Traceback (most recent call last):
  File "C:\Users\runneradmin\miniconda3\envs\sleap_ci\lib\multiprocessing\pool.py", line 125, in worker
    result = (True, func(*args, **kwds))
  File "C:\Users\runneradmin\miniconda3\envs\sleap_ci\lib\multiprocessing\pool.py", line 48, in mapstar
    return list(map(*args))
  File "D:\a\sleap\sleap\sleap\info\feature_suggestions.py", line 647, in get
    video = cattr.structure(video_dict, Video)

so it must be tested - unless I am missing something.

talmolab / sleap