Allow passing in `Labels` to `app.main`

roomrys commented 1 year ago

Description

This is more a debugging feature than anything else. A lot of the times when I want to visually inspect a project after making changes to the code, I will end up calling sleap-label through it's entry point function sleap.gui.app.main. This forces me to save the file and use the path to that file to then open the project in the GUI.

This PR allows developers to

just pass in the Labels to visually inspect via sleap.gui.app.main
create an instance of the GUI after using the GPU

and it also

creates the argparser in it's own function

Types of changes

[ ] Bugfix
[ ] New feature
[ ] Refactor / Code style update (no logical changes)
[ ] Build / CI changes
[ ] Documentation Update
[x] Other (flexibility)

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!

:heart:

Summary by CodeRabbit

New Features:

Added the ability to pass a pre-loaded Labels object to the MainWindow constructor, providing more flexibility in initializing the main application window.
Introduced a new function create_parser for creating an argument parser, improving code modularity and readability.

Improvements:

Enhanced the loadProjectFile method to accept a Union[str, Labels] parameter, allowing for more versatile project file loading.
Improved error handling when switching to CPU-only mode, increasing application robustness.

Bug Fixes:

Fixed an issue in the do_action function where it did not handle the case where filename is None.
Corrected the ask function to check if the filename parameter is an instance of Labels before loading the file, preventing potential errors.

coderabbitai[bot] commented 1 year ago

Walkthrough

The changes primarily revolve around enhancing the MainWindow class and main function in sleap/gui/app.py to accept an optional labels parameter, improving flexibility. Additionally, error handling has been introduced for CPU-only mode switch, and a new function create_parser has been added for argument parsing.

Changes

File	Summary
`sleap/gui/app.py`	Introduced `labels` parameter to `MainWindow` and `main` function, added `create_parser` function, and implemented error handling for CPU-only mode switch.
`sleap/gui/commands.py`	Enhanced `loadProjectFile` method to accept `Union[str, Labels]` parameter and improved `do_action` and `ask` functions to handle `None` filename and `Labels` instance respectively.

🐇

In the land of code, changes were made,

With logic and precision, a foundation was laid.

The rabbit hopped, the keys did clatter,

Crafting solutions to make SLEAP better.

With labels in hand, and errors caught,

A more robust system, the rabbit has wrought. 🎉

Tips

### Chat with CodeRabbit Bot (`@coderabbitai`) - Mention `@coderabbitai` in any *review comment* for bot assistance. - Note: Review comments are made on code diffs or files, not on the PR overview. ### Pause Incremental Reviews - Insert `@coderabbitai: ignore` in the PR description to halt the bot's ongoing reviews. Remove the line to resume. - Additionally, enter `@coderabbitai pause` to halt the bot's ongoing reviews as any issue or review comment. To resume reviews, enter `@coderabbitai resume` as any issue or review comment.

codecov[bot] commented 1 year ago

Codecov Report

Merging #1524 (9b5b1c7) into develop (ed77b49) will decrease coverage by 0.02%. The diff coverage is 63.63%.

@@             Coverage Diff             @@
##           develop    #1524      +/-   ##
===========================================
- Coverage    73.39%   73.38%   -0.02%     
===========================================
  Files          134      134              
  Lines        23961    23973      +12     
===========================================
+ Hits         17586    17592       +6     
- Misses        6375     6381       +6

Files	Coverage Δ
sleap/gui/commands.py	`61.35% <100.00%> (ø)`
sleap/gui/app.py	`74.73% <50.00%> (-0.62%)`	:arrow_down:

... and 1 file with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

talmolab / sleap