search

talmolab / sleap

A deep learning framework for multi-animal pose tracking.
https://sleap.ai
Other
436 stars 97 forks source link

Use positional argument for exception type #1912

Closed roomrys closed 3 months ago

roomrys commented 3 months ago

Description

In a downstream branch, we upgrade our EOL Python 3.7 to a safer Python 3.10. But, traceback.format_exception has changed it's first positional argument's name from etype to exc in python 3.7 vs 3.10, relatively.

This PR instead uses just the positional nature of the exception type argument and does not try to pass it in as a keyword argument (to keep compatibility between both Python 3.7 and 3.10).

By the way, the open skeleton function gave the same warning on both the develop and downstream branch during L533 of test_OpenSkeleton: https://github.com/talmolab/sleap/blob/8a8ed575cf597f3319e679ab6b43776fef6b3eba/tests/gui/test_commands.py#L527-L534

WARNING  sleap.gui.commands:commands.py:2072 Recieved the following error while replacing skeleton:
Traceback (most recent call last):
  File "/Users/liezlmaree/Projects/sleap/sleap/gui/commands.py", line 2067, in try_and_skip_if_error
    func(*args, **kwargs)
  File "/Users/liezlmaree/Projects/sleap/sleap/skeleton.py", line 845, in relabel_node
    self.relabel_nodes({old_name: new_name})
  File "/Users/liezlmaree/Projects/sleap/sleap/skeleton.py", line 863, in relabel_nodes
    raise ValueError("Cannot relabel a node to an existing name.")
ValueError: Cannot relabel a node to an existing name.

which seems fine/redundant, but could be something that is avoided with some prepended logic (for another PR).

Types of changes

Does this address any currently open issues?

Outside contributors checklist

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

A minor adjustment was made in the sleap/gui/commands.py file, specifically within the try_and_skip_if_error function. The change involved removing the etype= keyword argument from the traceback.format_exception call, simplifying the function's parameters. This modification streamlines the error handling process without impacting the functionality or logging behavior, ensuring that exceptions are still managed effectively.

Changes

Files Change Summary
sleap/gui/commands.py Removed the etype= keyword argument from traceback.format_exception in the try_and_skip_if_error function.

Poem

In the code where errors creep,
A little change, a tiny leap.
The trace is clear, the log's a breeze,
Simplified paths, oh what a tease!
Hopping high with joy and glee,
Code's now light, as it should be! 🐰✨

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 3 months ago

Codecov Report

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

Project coverage is 74.50%. Comparing base (7ed1229) to head (71d60d7). Report is 35 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1912 +/- ## =========================================== + 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.