Add `RecordingSession`s table to `SessionsDock`

talmolab / sleap

A deep learning framework for multi-animal pose tracking.

Other

427 stars 97 forks source link

Description

The overall goal here is to add a new table to the SessionsDock that displays all RecordingSessions in the SessionsDock.main_window.label.sessions: List[RecordingSession] list. The widget should be a table that displays the RecordingSessions hash (eventually name), number of RecordingSession.cameras: List[Camcorder], and number of RecordingSession.videos: List[Video] (see Figure 1). This SessionsTable will be used to dynamically populate our CamerasTable later on.

[x] Subclass GenericTableModel to create a new model called SessionsTableModel with the class attribute properties = ("id", "videos", "cameras") (similar to VideosTableModel)
[x] Implement the method SessionsTableModel.item_to_data(self, obj: List[RecordingSession], item: RecordingSession) which returns the following dictionary: {id: item.__hash__(), videos: len(item.videos), cameras: len(item.cameras)} (similar to VideosTableModel.item_to_data)
[x] Add a sessions_model_type = SessionsTableModel attribute to SessionsDock (similar to SkeletonDock.nodes_model_type) and pass into the model_type list for super().__init__
[x] Add a SessionsDock.create_models method (or append to it if it already exists) that sets a SessionsDock.sessions_model = SessionsDock.sessions_model_type(items=main_window.state["labels"].sessions, context=main_window.commands) and returns a list of all models created (see SkeletonDock.create_models)
[x] Add a SessionsDock.create_tables method (or append to it if it already exists) that sets a SessionsDock.sessions_table = GenericTableView(state=..., row_name="session", ...) and returns a list of all tables created (see SkeletonDock.create_tables)
[x] Add button to "Add Session" and link it to CommandContext.add_session(self)
[x] Create a command class called RemoveSession (similar to AddSession with only a do_action method) that uses Labels.remove_recording_session(session: RecordingSession) (does not exist yet, but it will be named this) to remove the RecordingSession from the labels
[x] Add a method to the command context CommandContext.remove_session(self, session: RecordingSession) which takes in a RecordingSession to remove and CommandContext.executes the RemoveSession class (similar to CommandContext.add_session but with an additional argument)

Note: CommandContext.execute(command: AppCommand, **kwargs) passes all keyword arguments into the command: AppCommand class as key-value pairs in the params: dict https://github.com/talmolab/sleap/blob/7f74a8ba75aa2bd9d7cc53a156fcc2efa188607a/sleap/gui/commands.py#L242-L244
[x] Add button to "Remove Session" and link it to CommandContext.remove_session (similar to you add sessions button).
[x] Disable "Remove Session" button when no selected RecordingSession (see comment on CamerasTable PR)
[x] In the SessionsDock.lay_everything_out method, add the SessionsDock.sessions_table to the SessionsDock.wgt_layout: QVBoxLayout (see the InstancesDock.lay_everything_out).
[x] Add a sessions option to UpdateTopic: Enum
[x] In MainWindow.on_data_update add (or append to) the if _has_topic(UpdateTopic.sessions) that updates the items to display in the SessionsTable (see video_dock.table update)

Test the `SessionsTable`

Tests for the SessionsTable will be added to tests/gui/test_dataviews.py.

[ ] Test that the expected RecordingSession is returned when we select a specific row of the table (see existing test for inspiration)
[ ] Test that when we update a RecordingSession in labels.sessions, the RecordingSession in the table is updated as well

Test the `SessionsTable` as part of the `SessionsDock`

Tests for the SessionsDock will be added to tests/gui/widgets/test_docks.py.

[ ] Test interactions with table and GuiState (see existing test)

**Figure 1**: Depiction of `SessionsTable` layout. ### Types of changes - [ ] Bugfix - [x] New feature - [ ] Refactor / Code style update (no logical changes) - [ ] Build / CI changes - [ ] Documentation Update - [ ] Other (explain) ### Does this address any currently open issues? [list open issues here] ### Outside contributors checklist - [ ] Review the [guidelines for contributing](https://github.com/talmolab/sleap/blob/develop/docs/CONTRIBUTING.md) to this repository - [ ] Read and sign the [CLA](https://github.com/talmolab/sleap/blob/develop/sleap-cla.pdf) and add yourself to the [authors list](https://github.com/talmolab/sleap/blob/develop/AUTHORS) - [ ] 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 ## Summary by CodeRabbit - **New Features** - Added a check for the presence of a selected session in the GUI state. - Enabled a button based on the presence of a selected session. - Introduced a new `UpdateTopic` enum value for sessions. - Added a `removeSelectedSession` method to `AppCommand` for session removal. - Updated the `AddSession` class to handle adding sessions and resetting the selected session state. - Updated the `SessionsTableModel` class with properties for `id`, `videos`, and `cameras`. - Added functionality to `SessionsDock` class for creating models and tables. - **Bug Fixes** - Updated logic in the `find_path_using_paths` function for improved file existence checks. - **Tests** - Added tests for session-related functionality within GUI widgets.

Walkthrough

The recent code changes focused on enhancing the GUI functionality and data handling in the Sleap application. These updates include improvements such as session management, data presentation refinements, and adjustments to the camera handling logic, all aimed at enhancing the user experience and overall system robustness.

Changes

File	Summary
`sleap/gui/app.py`, `sleap/gui/commands.py`	Added session management features like session selection check, removal methods, and enum value updates.
`sleap/gui/dataviews.py`	Introduced `SessionsTableModel` class for data representation and formatting changes in `SuggestionsTableModel`.
`sleap/gui/widgets/docks.py`	Enhanced `SessionsDock` functionality with model and table creation methods.
`sleap/io/cameras.py`	Updated camera handling logic for `add_video` method and added new methods.
`sleap/io/dataset.py`	Added session removal method and updated logic for path searching.
`tests/gui/test_dataviews.py`, `tests/gui/widgets/test_docks.py`	Tests and enhancements related to GUI functionality testing.

File

Summary

sleap/gui/app.py, sleap/gui/commands.py

Added session management features like session selection check, removal methods, and enum value updates.

sleap/gui/dataviews.py

Introduced SessionsTableModel class for data representation and formatting changes in SuggestionsTableModel.

sleap/gui/widgets/docks.py

Enhanced SessionsDock functionality with model and table creation methods.

sleap/io/cameras.py

Updated camera handling logic for add_video method and added new methods.

sleap/io/dataset.py

Added session removal method and updated logic for path searching.

tests/gui/test_dataviews.py, tests/gui/widgets/test_docks.py

Tests and enhancements related to GUI functionality testing.

Poem

🐇
Code changes dance like leaves in spring,
GUI enhancements make the heart sing.
Cameras iterate, datasets refine,
Testing the limits, line by line.
🌿

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?

- [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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests 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 tests 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 tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

Codecov Report

Attention: Patch coverage is 78.57143% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 73.70%. Comparing base (cc78c91) to head (f4c68ac).

:exclamation: Current head f4c68ac differs from pull request most recent head c9b5780. Consider uploading reports for the commit c9b5780 to get more accurate results

Files	Patch %	Lines
sleap/gui/dataviews.py	37.50%	5 Missing :warning:
sleap/gui/widgets/docks.py	92.30%	2 Missing :warning:
sleap/gui/commands.py	75.00%	1 Missing :warning:
sleap/io/dataset.py	50.00%	1 Missing :warning:

Files

Patch %

Lines

sleap/gui/dataviews.py

37.50%

5 Missing :warning:

sleap/gui/widgets/docks.py

92.30%

2 Missing :warning:

sleap/gui/commands.py

75.00%

1 Missing :warning:

sleap/io/dataset.py

50.00%

1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## liezl/add-gui-elements-for-sessions #1654 +/- ## ======================================================================= - Coverage 73.70% 73.70% -0.01% ======================================================================= Files 135 135 Lines 24540 24578 +38 ======================================================================= + Hits 18086 18114 +28 - Misses 6454 6464 +10 ```

talmolab / sleap