Refactor `LossViewer` to use underscores for internal method names

roomrys commented 2 months ago

Description

In a previous PR #1899, we had touched on the LossViewer code to replace the QtCharts dependency with matplotlib. While I was itching to refactor/organize the LossViewer class in that PR - I refrained to maintain scope.

This PR refactors the LossViewer class by renaming internal methods to use underscores and organizing methods with internal methods listed last. Note that we call the now-named _update_runtime externally in one of our tests, but otherwise it is an internal method.

Types of changes

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

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
- Introduced properties log_scale and ignore_outliers for enhanced control over settings.
Bug Fixes
- Updated method calls in tests to reflect changes in method visibility, ensuring proper functionality.
Refactor
- Improved encapsulation of the Monitor class by renaming several public methods to private, enhancing internal structure and maintainability.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve significant modifications to the Monitor class in the sleap/gui/widgets/monitor.py file. Key alterations include the renaming of several public methods to private ones, enhancing encapsulation. New properties and private methods have been introduced, improving the organization of the class. These adjustments extend to the tests/gui/test_monitor.py file, where method calls have been updated to reflect the new private method names, maintaining the overall control flow.

Changes

Files	Change Summary
`sleap/gui/widgets/monitor.py`	Renamed public methods to private (e.g., `close` to `_close`, `setup_zmq` to `_setup_zmq`); introduced new properties and private methods for better encapsulation and organization.
`tests/gui/test_monitor.py`	Updated method calls to reflect changes from public to private methods (e.g., `update_runtime()` to `_update_runtime()`).

Poem

In the burrow deep, where code does play,
A rabbit hops in joy today.
With methods tucked away so neat,
Our Monitor's now a tidy treat!
Encapsulated, clean, and bright,
Hooray for changes, what a delight! 🐰✨

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

Codecov Report

Attention: Patch coverage is 49.54128% with 55 lines in your changes missing coverage. Please review.

Project coverage is 75.33%. Comparing base (7ed1229) to head (237da2b). Report is 39 commits behind head on develop.

Files	Patch %	Lines
sleap/gui/widgets/monitor.py	49.54%	55 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #1919 +/- ## =========================================== + Coverage 73.30% 75.33% +2.02% =========================================== Files 134 133 -1 Lines 24087 24471 +384 =========================================== + Hits 17658 18436 +778 + Misses 6429 6035 -394 ```

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

talmolab / sleap