Skip to content

feat: enhance error handling with color support and additional notes in exceptions. - #3964

Merged
germa89 merged 4 commits into
mainfrom
feat/custom-exception-errors
May 29, 2025
Merged

germa89 merged 4 commits into
mainfrom
feat/custom-exception-errors

Conversation

@germa89

@germa89 germa89 commented May 28, 2025 •

Copy link
Copy Markdown
Collaborator

Description

As the title and adding stdout and stderr attributes in MapdlDidntstart exception.
Also refactor by removing unnecesary code.

image

Issue linked

NA

Checklist

Summary by Sourcery

Enhance exception handling with ANSI color support, additional notes and output details, and streamline exception class definitions

New Features:

  • Add ANSI color support for error, warning, info, and notes in exception messages
  • Allow an optional notes field in MapdlException and its subclasses
  • Include process stdout and stderr in MapdlDidNotStart exceptions

Enhancements:

  • Remove redundant init methods in exception subclasses
  • Use functools.cache for terminal color support detection
  • Enforce argument types and raise a TypeError in retrieve_mapdl_from_args
  • Refactor imports and type hints with TYPE_CHECKING for gRPC mapping

…in exceptions. Adding stdout and stderr in MapdlDidntstart exception.

Also refactor by removing unnecesary code.
@germa89
germa89 requested a review from a team as a code owner May 28, 2025 12:57
@ansys-reviewer-bot

Copy link
Copy Markdown
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@sourcery-ai

sourcery-ai Bot commented May 28, 2025 •

Copy link
Copy Markdown
Contributor

🧙 Sourcery has finished reviewing your pull request!


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

@germa89 germa89 self-assigned this May 28, 2025
@github-actions github-actions Bot added the new feature Request or proposal for a new feature label May 28, 2025

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey @germa89 - I've reviewed your changes - here's some feedback:

  • Refactor color_text to accept a bcolors enum (or validate string keys) instead of raw strings to prevent KeyError at runtime.
  • DRY up the duplicated str logic by having MapdlDidNotStart call super().str and then append its additional stdout/stderr/notes instead of reimplementing the entire method.
  • In retrieve_mapdl_from_args, prefer using isinstance checks or a shared protocol rather than matching on class.name for more reliable type detection.
Here's what I looked at during the review
  • 🟡 General issues: 3 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

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.

Comment thread src/ansys/mapdl/core/errors.py
Comment thread src/ansys/mapdl/core/errors.py Outdated
Comment thread src/ansys/mapdl/core/errors.py
germa89 and others added 2 commits May 28, 2025 15:06
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@codecov

codecov Bot commented May 28, 2025 •

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 92.30769% with 7 lines in your changes missing coverage. Please review.

Project coverage is 88.30%. Comparing base (5606ec3) to head (6c49771).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3964      +/-   ##
==========================================
+ Coverage   88.28%   88.30%   +0.02%     
==========================================
  Files         187      187              
  Lines       14906    14935      +29     
==========================================
+ Hits        13160    13189      +29     
  Misses       1746     1746              
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89

germa89 commented May 29, 2025

Copy link
Copy Markdown
Collaborator Author

@pyansys-ci-bot LGTM.

@germa89
germa89 enabled auto-merge (squash) May 29, 2025 09:21

@pyansys-ci-bot pyansys-ci-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@germa89
germa89 merged commit e18a6ea into main May 29, 2025
@germa89
germa89 deleted the feat/custom-exception-errors branch May 29, 2025 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new feature Request or proposal for a new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants