Add color by instance group preference saving #1999

justinvshen · 2024-10-18T07:55:45Z

Description

Added color by instance group preference saving

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-18T08:17:24Z

Codecov Report

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

Project coverage is 74.18%. Comparing base (b55d4ef) to head (08afb9f).
Report is 1 commits behind head on liezl/add-gui-elements-for-sessions.

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

Additional details and impacted files

@@                           Coverage Diff                           @@
##           liezl/add-gui-elements-for-sessions    #1999      +/-   ##
=======================================================================
- Coverage                                74.18%   74.18%   -0.01%     
=======================================================================
  Files                                      135      135              
  Lines                                    25438    25440       +2     
=======================================================================
+ Hits                                     18872    18873       +1     
- Misses                                    6566     6567       +1

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

roomrys

Almost. Let's rename "color_by_instance_group" to "distinctly_color" which already exists as a GuiState key and is connected to the existing View > Apply Distinct Colors to submenu. Also, we don't want to save the preferences file each time we change the checkbox selection.

roomrys · 2024-10-22T22:16:58Z

sleap/gui/app.py

+
+    def _save_color_by_instance_group(self, value):
+        """Update the color_by_instance_group preference and save it."""
+        prefs["color_by_instance_group"] = value
+        prefs.save()


We do not want to save preferences each time we click a checkbox, and we already have logic above to save on close.

sleap/sleap/gui/app.py

Lines 215 to 229 in b55d4ef

def closeEvent(self, event):

"""Close application window, prompting for saving as needed."""

# Save window state.

prefs["window state"] = self.saveState()

prefs["marker size"] = self.state["marker size"]

prefs["show non-visible nodes"] = self.state["show non-visible nodes"]

prefs["node label size"] = self.state["node label size"]

prefs["edge style"] = self.state["edge style"]

prefs["propagate track labels"] = self.state["propagate track labels"]

prefs["color predicted"] = self.state["color predicted"]

prefs["trail shade"] = self.state["trail_shade"]

prefs["share usage data"] = self.state["share usage data"]

# Save preferences.

prefs.save()

Suggested change

def _save_color_by_instance_group(self, value):

"""Update the color_by_instance_group preference and save it."""

prefs["color_by_instance_group"] = value

prefs.save()

roomrys · 2024-10-22T22:20:40Z

sleap/gui/app.py

+        add_menu_check_item(viewMenu, "color_by_instance_group", "Color by Instance Group")
+        self.state.connect("color_by_instance_group", lambda value: self._save_color_by_instance_group(value))
+


We already have a GUI element for this. It's under View > Apply DIstinct COlors to > instance_groups and connected to state["distinctly_color"]:

sleap/sleap/gui/app.py

Lines 658 to 668 in b55d4ef

distinctly_color_options = ("instance_groups", "instances", "nodes", "edges")

add_submenu_choices(

menu=viewMenu,

title="Apply Distinct Colors To",

options=distinctly_color_options,

key="distinctly_color",

)

self.state["palette"] = prefs["palette"]

self.state["distinctly_color"] = "instances"

Suggested change

add_menu_check_item(viewMenu, "color_by_instance_group", "Color by Instance Group")

self.state.connect("color_by_instance_group", lambda value: self._save_color_by_instance_group(value))

roomrys · 2024-10-22T22:21:36Z

sleap/gui/app.py

@@ -298,6 +304,8 @@ def labels(self, value):
    def _initialize_gui(self):
        """Creates menus, dock windows, starts timers to update gui state."""

+        self.state["color_by_instance_group"] = prefs["color_by_instance_group"]


The GUI element View > Apply DIstinct COlors to is connected to the state["distinctly_color"]:

sleap/sleap/gui/app.py

Lines 658 to 668 in b55d4ef

distinctly_color_options = ("instance_groups", "instances", "nodes", "edges")

add_submenu_choices(

menu=viewMenu,

title="Apply Distinct Colors To",

options=distinctly_color_options,

key="distinctly_color",

)

self.state["palette"] = prefs["palette"]

self.state["distinctly_color"] = "instances"

Suggested change

self.state["color_by_instance_group"] = prefs["color_by_instance_group"]

roomrys · 2024-10-22T23:16:15Z

sleap/prefs.py

@@ -15,6 +15,7 @@ class Preferences(object):
        "medium step size": 10,
        "large step size": 100,
        "color predicted": False,
+        "color_by_instance_group": False,


We do not want a boolean here. We want one of the four str options for which to distinctly color instances by:

sleap/sleap/gui/app.py

Line 658 in b55d4ef

distinctly_color_options = ("instance_groups", "instances", "nodes", "edges")

Suggested change

"color_by_instance_group": False,

"distinctly_color": "instances",

roomrys · 2024-10-22T23:22:24Z

sleap/gui/app.py

@@ -224,6 +224,7 @@ def closeEvent(self, event):
        prefs["color predicted"] = self.state["color predicted"]
        prefs["trail shade"] = self.state["trail_shade"]
        prefs["share usage data"] = self.state["share usage data"]
+        prefs["color_by_instance_group"] = self.state["color_by_instance_group"]


Suggested change

prefs["color_by_instance_group"] = self.state["color_by_instance_group"]

prefs["distinctly_color"] = self.state["distinctly_color"]

…the existing View > Apply Distinct Colors To submenu

coderabbitai · 2024-10-25T08:06:22Z

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-01T12:39:51Z

sleap/gui/app.py

@@ -665,7 +668,7 @@ def prev_vid():
        )

        self.state["palette"] = prefs["palette"]
-        self.state["distinctly_color"] = "instances"
+        self.state["distinctly_color"] = prefs["distinctly_color"]


Needed this line to use the saved preference.

Add Color by Instance Group preference saving

2088716

roomrys requested changes Oct 22, 2024

View reviewed changes

Replaced color_by_instance_group with distinctly_color to align with …

aa8771e

…the existing View > Apply Distinct Colors To submenu

roomrys added 2 commits November 1, 2024 05:36

Use updated preference for GUI state

4b7d3a7

Rename GUI facing "instance_groups" to "instance groups"

08afb9f

roomrys approved these changes Nov 1, 2024

View reviewed changes

roomrys marked this pull request as ready for review November 1, 2024 12:40

roomrys merged commit c7185c7 into liezl/add-gui-elements-for-sessions Nov 1, 2024
9 of 10 checks passed

roomrys deleted the justin/add-saving-for-color-as-preference branch November 1, 2024 13:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add color by instance group preference saving #1999

Add color by instance group preference saving #1999

justinvshen commented Oct 18, 2024

codecov bot commented Oct 18, 2024 •

edited

Loading

roomrys left a comment

roomrys Oct 22, 2024

roomrys Oct 22, 2024

roomrys Oct 22, 2024

roomrys Oct 22, 2024

roomrys Oct 22, 2024

coderabbitai bot commented Oct 25, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

roomrys Nov 1, 2024

	def closeEvent(self, event):
	"""Close application window, prompting for saving as needed."""
	# Save window state.
	prefs["window state"] = self.saveState()
	prefs["marker size"] = self.state["marker size"]
	prefs["show non-visible nodes"] = self.state["show non-visible nodes"]
	prefs["node label size"] = self.state["node label size"]
	prefs["edge style"] = self.state["edge style"]
	prefs["propagate track labels"] = self.state["propagate track labels"]
	prefs["color predicted"] = self.state["color predicted"]
	prefs["trail shade"] = self.state["trail_shade"]
	prefs["share usage data"] = self.state["share usage data"]

	# Save preferences.
	prefs.save()

		add_menu_check_item(viewMenu, "color_by_instance_group", "Color by Instance Group")
		self.state.connect("color_by_instance_group", lambda value: self._save_color_by_instance_group(value))

	distinctly_color_options = ("instance_groups", "instances", "nodes", "edges")

	add_submenu_choices(
	menu=viewMenu,
	title="Apply Distinct Colors To",
	options=distinctly_color_options,
	key="distinctly_color",
	)

	self.state["palette"] = prefs["palette"]
	self.state["distinctly_color"] = "instances"

	"color_by_instance_group": False,
	"distinctly_color": "instances",

	prefs["color_by_instance_group"] = self.state["color_by_instance_group"]
	prefs["distinctly_color"] = self.state["distinctly_color"]

Add color by instance group preference saving #1999

Add color by instance group preference saving #1999

Conversation

justinvshen commented Oct 18, 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 18, 2024 • edited Loading

Codecov Report

roomrys left a comment

Choose a reason for hiding this comment

roomrys Oct 22, 2024

Choose a reason for hiding this comment

roomrys Oct 22, 2024

Choose a reason for hiding this comment

roomrys Oct 22, 2024

Choose a reason for hiding this comment

roomrys Oct 22, 2024

Choose a reason for hiding this comment

roomrys Oct 22, 2024

Choose a reason for hiding this comment

coderabbitai bot commented Oct 25, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

roomrys Nov 1, 2024

Choose a reason for hiding this comment

codecov bot commented Oct 18, 2024 •

edited

Loading

coderabbitai bot commented Oct 25, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)