Skip to content

Improve error message formatting for environment JSON loading#1066

Open
Vidhushaaa30 wants to merge 3 commits intofossasia:masterfrom
Vidhushaaa30:improve-error-message-format
Open

Improve error message formatting for environment JSON loading#1066
Vidhushaaa30 wants to merge 3 commits intofossasia:masterfrom
Vidhushaaa30:improve-error-message-format

Conversation

@Vidhushaaa30
Copy link

@Vidhushaaa30 Vidhushaaa30 commented Mar 19, 2026

Description

Improved the error message when loading environment JSON files by using a clearer and more descriptive format. Updated string formatting to use f-strings for better readability.

Motivation and Context

The previous error message was less readable and used older string formatting. This change makes debugging easier by providing clearer information about the file and error.

How Has This Been Tested?

Tested by triggering a JSON load failure and verifying that the updated error message is displayed correctly.

Types of changes

  • Bug fix
  • New feature
  • Breaking change
  • Code refactor or cleanup

Checklist:

  • I adapted the version number
  • My code follows the code style
  • My change requires a documentation update
  • I have updated the documentation accordingly

Summary by Sourcery

Enhancements:

  • Improve the ValueError message for environment JSON loading failures to provide clearer file and error context.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 19, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refactors the environment JSON loading error handling in server_utils to use a clearer f-string based ValueError message that surfaces the file path and underlying exception more readably.

File-Level Changes

Change Details Files
Improve the ValueError message raised when environment JSON loading fails.
  • Replace old str.format-based error message with an f-string for readability and consistency with modern style.
  • Clarify the wording of the error message to explicitly mention the environment JSON file path and underlying error.
py/visdom/utils/server_utils.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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.

Hey - I've left some high level feedback:

  • The new f-string in the ValueError is mis-indented relative to the opening parenthesis and will cause a syntax/indentation issue; align it with the previous string literal inside the raise call.
  • The previous implementation used repr(e) which preserves the exception type and quotes; consider using {e!r} in the f-string to retain that level of detail while still improving readability.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new f-string in the ValueError is mis-indented relative to the opening parenthesis and will cause a syntax/indentation issue; align it with the previous string literal inside the raise call.
- The previous implementation used repr(e) which preserves the exception type and quotes; consider using {e!r} in the f-string to retain that level of detail while still improving readability.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Vidhushaaa30
Copy link
Author

Thanks for the feedback! I've fixed the indentation and updated the error message to use {e!r} to preserve exception details.

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