Set selected instance to None when switching videos/frames #1988

justinvshen · 2024-10-09T03:56:38Z

Description

Sets selected instance to None when switching videos/frames

Types of changes

Does this address any currently open issues?

[list open issues here]

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!

❤️

codecov · 2024-10-09T04:43:56Z

Codecov Report

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

Project coverage is 74.17%. Comparing base (b55d4ef) to head (cb75f33).
Report is 2 commits behind head on liezl/add-gui-elements-for-sessions.

Files with missing lines	Patch %	Lines
sleap/gui/commands.py	0.00%	2 Missing ⚠️

Additional details and impacted files

@@                           Coverage Diff                           @@
##           liezl/add-gui-elements-for-sessions    #1988      +/-   ##
=======================================================================
- Coverage                                74.18%   74.17%   -0.01%     
=======================================================================
  Files                                      135      135              
  Lines                                    25438    25440       +2     
=======================================================================
- Hits                                     18872    18871       -1     
- Misses                                    6566     6569       +3

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

roomrys

Move self.state["instance"] logic into the classes that are being executed.

roomrys · 2024-10-09T16:11:20Z

sleap/gui/commands.py

@@ -363,10 +363,12 @@ def exportFullPackage(self):
    def previousLabeledFrame(self):
        """Goes to labeled frame prior to current frame."""
        self.execute(GoPreviousLabeledFrame)
+        self.state["instance"] = None


We want this logic to go inside the class that is being executed (i.e. GoPreviousLabeledFrame).

Suggested change

self.state["instance"] = None

roomrys

Better, but I think we can simplify this further. Notice how all classes-of-interest subclass either NavCommand or GoIteratorCommand. Therefore, we should be able to move the context.state["instance"] logic inside those classes to cover all cases.

coderabbitai · 2024-11-01T14:05:51Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

🪧 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 <commit_id>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

roomrys · 2024-11-01T15:20:49Z

After some manual testing, we realize that there are a few places in the GUI where we switch frames not through the CommandContext. Ideally, the CommandContext should handle all commands made by the user to the GUI. But, since we are on a divergent branch... we want to implement the smallest amount of code to fix the current problem (not properly resetting state["instance"] when switching frames). The minimal amount of code needed is a callback updating state["instance"] when we update state["frame_idx"].

This PR is superseded by:

[MV] Update instance state as frame idx callback #2012

Set selected instance to None when switching frames or videos

5b1440a

justinvshen marked this pull request as draft October 9, 2024 03:57

roomrys requested changes Oct 9, 2024

View reviewed changes

Add logic inside class it's being executed in

8a54592

roomrys requested changes Oct 9, 2024

View reviewed changes

Jvshen added 2 commits October 9, 2024 12:59

Add logic to higher level classes

db0482d

Apply black

cb75f33

roomrys marked this pull request as ready for review November 1, 2024 14:05

roomrys mentioned this pull request Nov 1, 2024

[MV] Update instance state as frame idx callback #2012

Merged

11 tasks

roomrys closed this Nov 1, 2024

roomrys deleted the justin/reset-instance-on-frame-video-switch branch November 1, 2024 15:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set selected instance to None when switching videos/frames #1988

Set selected instance to None when switching videos/frames #1988

justinvshen commented Oct 9, 2024

codecov bot commented Oct 9, 2024 •

edited

Loading

roomrys left a comment

roomrys Oct 9, 2024

roomrys left a comment •

edited

Loading

coderabbitai bot commented Nov 1, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

roomrys commented Nov 1, 2024

Set selected instance to None when switching videos/frames #1988

Set selected instance to None when switching videos/frames #1988

Conversation

justinvshen commented Oct 9, 2024

Description

Types of changes

Does this address any currently open issues?

Outside contributors checklist

Thank you for contributing to SLEAP!

codecov bot commented Oct 9, 2024 • edited Loading

Codecov Report

roomrys left a comment

Choose a reason for hiding this comment

roomrys Oct 9, 2024

Choose a reason for hiding this comment

roomrys left a comment • edited Loading

Choose a reason for hiding this comment

coderabbitai bot commented Nov 1, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

roomrys commented Nov 1, 2024

codecov bot commented Oct 9, 2024 •

edited

Loading

roomrys left a comment •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)