Allow passing in Labels to app.main

[roomrys]

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

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

and it also
3. 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
• 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!

❤️

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]

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.

[coderabbitai]

Review Status

Actionable comments generated: 0

Commits

Files that changed from the base of the PR and between ed77b49 and a8e587a.

Files selected for processing (1)

• sleap/gui/app.py (5 hunks)

Additional comments (Suppressed): 6

sleap/gui/app.py (6)

• 101-107: The __init__ method of the MainWindow class now accepts an additional optional parameter labels. Ensure that all calls to this constructor throughout the codebase have been updated to match the new signature if necessary.

• 122-122: The labels attribute of the MainWindow instance is now initialized with the labels parameter if provided, otherwise a new instance of the Labels class is created. This change allows developers to pass in Labels directly for visual inspection.

- self.labels = Labels()
+ self.labels = labels or Labels()

• 1595-1601: > Note: This review was outside of the patch, so it was mapped to the patch with the greatest overlap. Original lines [1598-1638]

The creation of the argument parser has been isolated into a separate function create_parser, improving modularity and readability of the code. This is a good practice as it separates concerns and makes the code easier to understand and maintain.

• 1641-1647: The entry point function main has been updated to accept an optional labels parameter, allowing developers to pass in Labels directly for visual inspection without having to save and use file paths. This change facilitates quick visual checks after code modifications.

• 1660-1665: The call to the MainWindow constructor in the main function now includes the labels parameter. Ensure that the labels passed here are correctly initialized and valid.

• 1669-1672: The call to sleap.use_cpu_only() is now wrapped in a try-except block to handle potential RuntimeError exceptions. This enhances error handling in the application by preventing crashes due to unhandled exceptions.

- sleap.use_cpu_only()
+ try:
+     sleap.use_cpu_only()
+ except RuntimeError:  # Visible devices cannot be modified after being initialized
+     pass

[codecov]

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%)	⬇️

... and 1 file with indirect coverage changes

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

[coderabbitai]

Review Status

Actionable comments generated: 0

Commits

Files that changed from the base of the PR and between a8e587a and 816869b.

Files selected for processing (2)

• sleap/gui/app.py (6 hunks)
• sleap/gui/commands.py (5 hunks)

Additional comments (Suppressed): 12

sleap/gui/commands.py (5)

• 36-42: No significant changes detected in this hunk. The import statements remain the same.

• 260-274: The function signature of loadProjectFile has been updated to accept either a str or Labels object. Ensure all calls to this function throughout the codebase have been updated to match the new signature.

• 646-653: The filename parameter is now optional and defaults to None if not provided. This change seems to be in line with the new functionality of accepting a Labels object directly.

• 667-675: The has_changes state now also considers whether filename is None. This seems to be a logical change given the new functionality of accepting a Labels object directly.

• 683-698: The loadProjectFile function now checks if filename is an instance of Labels before assigning it to labels and setting has_loaded to True. This is a good use of Python's isinstance function for type checking, and it improves upon the previous implementation which used the type function.

sleap/gui/app.py (7)

• 101-107: The function signature of __init__ has been modified to include an optional labels parameter of type Labels. Ensure that all calls to this function throughout the codebase have been updated to match the new signature. Also, verify that the labels object is correctly handled within the function.

• 122-122: The labels attribute of the MainWindow class is now initialized with the labels argument if it is not None. Otherwise, a new Labels object is created. This change provides more flexibility but also requires careful handling of the labels object.

• 179-184: The logic for loading project files has been updated to handle cases where a Labels object is provided instead of a file path. This change provides more flexibility for developers, but it also requires careful error handling and testing to ensure that the Labels object is correctly loaded.

• 1597-1603: > Note: This review was outside of the patch, so it was mapped to the patch with the greatest overlap. Original lines [1600-1640]

A new function, create_parser, has been introduced to create an argument parser. This change improves the modularity of the code and makes it easier to test and maintain the argument parsing logic.

• 1643-1643: The function signature of main has been modified to include an optional labels parameter of type Labels. Ensure that all calls to this function throughout the codebase have been updated to match the new signature. Also, verify that the labels object is correctly handled within the function.

• 1662-1667: The MainWindow constructor is now called with the labels argument. Ensure that the labels object is correctly handled within the MainWindow class.

• 1671-1674: The call to sleap.use_cpu_only() is now wrapped in a try-except block to handle potential RuntimeError exceptions. This change improves the robustness of the code, but it also requires careful testing to ensure that exceptions are correctly handled.

[coderabbitai]

Review Status

Actionable comments generated: 0

Commits

Files that changed from the base of the PR and between 816869b and 9b5b1c7.

Files selected for processing (1)

• sleap/gui/app.py (8 hunks)

Additional comments (Suppressed): 9

sleap/gui/app.py (9)

• 52-53: New imports for traceback and getLogger have been added. Ensure these are used appropriately in the code.

• 90-90: A logger has been initialized for this module. This is a good practice for handling and tracking errors and events.

• 108-109: The __init__ method of MainWindow class now accepts an additional optional parameter labels. This change should be propagated to all instances where MainWindow is initialized.

• 127-127: The labels attribute of MainWindow instance is now initialized with the labels parameter if it is not None, otherwise a new Labels object is created. This is a good practice as it provides flexibility to initialize MainWindow with a pre-existing Labels object.

• 185-189: The logic for loading project file or labels object has been updated. If labels_path is not None, the project file is loaded. If labels_path is None but labels is not None, the labels object is loaded. If both are None, the project is not loaded. This change provides more flexibility in loading projects.

• 1602-1608: > Note: This review was outside of the patch, so it was mapped to the patch with the greatest overlap. Original lines [1605-1645]

A new function create_parser has been introduced to create an argument parser. This is a good practice as it separates the concern of creating a parser from the main function, improving modularity and readability.

• 1648-1648: The main function now accepts an additional optional parameter labels. This change should be propagated to all instances where main is called.

• 1668-1671: The MainWindow is now initialized with the labels parameter. Ensure that this change is propagated to all instances where MainWindow is initialized.

• 1676-1685: Error handling has been added for the sleap.use_cpu_only() call to handle a RuntimeError exception. This is a good practice as it prevents the application from crashing due to this exception.