Use | instead of + in key commands

roomrys commented 1 month ago

Description

In our attempts to migrate to PySide6 in a downstream branch, we are getting the following error:

    key_command = Qt.CTRL + Qt.Key_0 + self.labels.tracks.index(track) + 1
TypeError: unsupported operand type(s) for +: 'PySide6.QtCore.QKeyCombination' and 'int'

and the following warning:

UserWarning: 
The "+" operator is deprecated in Qt For Python 6.0 .
Please use "|" instead.

.

This PR refactors for PySide6 by using the | operator instead of the depreciated + operator when combining keys (which is also supported by PySide2).

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

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
- Improved keyboard shortcut definitions for actions like copying and pasting instances and managing track actions.
- Introduced a new, structured key mapping for track indices to enhance shortcut assignment clarity.
Bug Fixes
- Enhanced clarity and correctness in keyboard shortcut logic.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes enhance the handling of keyboard shortcuts within the application by transitioning from addition to bitwise operations for defining key combinations. A new dictionary for mapping track indices to Qt.Key values improves the clarity and maintainability of the shortcut logic, ensuring a more consistent user experience.

Changes

Files	Change Summary
sleap/gui/app.py	Updated keyboard shortcut definitions to use bitwise OR instead of addition; introduced `key_mapping` dictionary for clearer track index to key value mapping.

Poem

In a world of keys and tracks,
A rabbit hops, with joyful cracks!
Shortcuts neat and clear as day,
We frolic in our coding play.
With every byte, we leap and bound,
In this sweet app, joy is found! 🐇✨

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

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 74.49%. Comparing base (7ed1229) to head (4f20bfd). Report is 32 commits behind head on develop.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #1907 +/- ## =========================================== + Coverage 73.30% 74.49% +1.19% =========================================== Files 134 135 +1 Lines 24087 24792 +705 =========================================== + Hits 17658 18470 +812 + Misses 6429 6322 -107 ```

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

talmolab / sleap