Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix call of logger to properly pass arguments to messages #1179

Merged
merged 1 commit into from
Aug 13, 2024

Conversation

Czaki
Copy link
Collaborator

@Czaki Czaki commented Aug 13, 2024

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced logging clarity by updating the log message formatting across various components, including error handling and module reloading.
  • Chores

    • Updated logging statements for consistency and improved context without impacting functionality in multiple files.

@Czaki Czaki added this to the 0.15.4 milestone Aug 13, 2024
Copy link
Contributor

coderabbitai bot commented Aug 13, 2024

Walkthrough

These changes primarily involve improvements to the logging mechanisms across several Python files in the PartSeg package. The adjustments include modifying string formatting methods for logging statements, enhancing log clarity, and adding context to error messages, all while maintaining existing functionality. This effort aims to standardize and improve the readability of log outputs, facilitating easier debugging and monitoring.

Changes

Files Change Summary
package/PartSeg/_roi_analysis/export_batch.py
package/PartSeg/common_gui/advanced_tabs.py
package/PartSegCore/analysis/load_functions.py
Updated logging string formatting from f-strings or curly braces to the older % style, enhancing consistency without affecting functionality.
package/PartSeg/common_backend/segmentation_thread.py Modified error logging to include stack_info=True, providing additional context in logs for improved error tracking in the run method.

Poem

In code we hop and change,
With logs that now rearrange.
From f-strings to percent,
Our messages are well-meant.
Burrows deep, we fix and play,
In brighter logs we find our way! 🐇✨


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

sourcery-ai bot commented Aug 13, 2024

🧙 Sourcery has finished reviewing your pull request!


Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Copy link

sonarcloud bot commented Aug 13, 2024

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 30574f5 and 21169e5.

Files selected for processing (4)
  • package/PartSeg/_roi_analysis/export_batch.py (1 hunks)
  • package/PartSeg/common_backend/segmentation_thread.py (1 hunks)
  • package/PartSeg/common_gui/advanced_tabs.py (1 hunks)
  • package/PartSegCore/analysis/load_functions.py (1 hunks)
Files skipped from review due to trivial changes (3)
  • package/PartSeg/_roi_analysis/export_batch.py
  • package/PartSeg/common_gui/advanced_tabs.py
  • package/PartSegCore/analysis/load_functions.py
Additional comments not posted (1)
package/PartSeg/common_backend/segmentation_thread.py (1)

51-53: Enhanced logging with stack trace.

The addition of stack_info=True in the logging statement provides valuable stack trace information, which aids in debugging by giving more context when an error occurs.

Copy link

codecov bot commented Aug 13, 2024

Codecov Report

Attention: Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 93.08%. Comparing base (30574f5) to head (21169e5).

Files Patch % Lines
package/PartSeg/common_gui/advanced_tabs.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1179   +/-   ##
========================================
  Coverage    93.08%   93.08%           
========================================
  Files          209      209           
  Lines        32887    32887           
========================================
  Hits         30614    30614           
  Misses        2273     2273           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Czaki Czaki merged commit 30540fe into develop Aug 13, 2024
54 of 55 checks passed
@Czaki Czaki deleted the fix_logger_call branch August 13, 2024 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant