Skip to content

Conversation

@koubaa
Copy link
Contributor

@koubaa koubaa commented May 9, 2025

Fixes #3916

mapdl_inprocess should use None for graphics backend. This will have to be revisited with some automated tests when 2025R2 is released.

@koubaa koubaa requested a review from a team as a code owner May 9, 2025 13:24
@koubaa koubaa requested review from germa89 and pyansys-ci-bot May 9, 2025 13:24
@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 9, 2025

Reviewer's Guide

This pull request updates the MapdlCore class constructor to prevent a ModuleNotFoundError when GraphicsBackend.MAPDL is used without the optional graphics dependencies installed. The modification ensures that the exception is only raised if a graphics backend other than MAPDL is specified and the necessary libraries are missing.

Class Diagram: Update to MapdlCore for Graphics Backend Handling

classDiagram
    class MapdlCore {
        +__init__(self, ..., graphics_backend: Optional[GraphicsBackend] = None, **kwargs)
        - _graphics_backend: GraphicsBackend
        # Other methods and attributes...
    }
    class GraphicsBackend {
      <<enumeration>>
      PYVISTA
      MAPDL
      NONE
      # Potentially other enum values
    }
    MapdlCore ..> GraphicsBackend : uses
    note for MapdlCore "__init__ method updated:\nPrevents ModuleNotFoundError if 'graphics_backend' is GraphicsBackend.MAPDL,\neven when optional graphics dependencies are not installed."
Loading

File-Level Changes

Change Details Files
Refined graphics backend initialization to avoid unnecessary exceptions.
  • Modified the conditional statement in the MapdlCore constructor to not raise a ModuleNotFoundError if graphics_backend is GraphicsBackend.MAPDL and the optional graphics libraries are not installed.
src/ansys/mapdl/core/mapdl_core.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 @koubaa - I've reviewed your changes - here's some feedback:

  • When graphics_backend is GraphicsBackend.MAPDL and PyVista is unavailable, ensure self._graphics_backend is explicitly assigned to GraphicsBackend.MAPDL to fully enable its functionality, not just bypass the error.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@koubaa koubaa changed the title Do not throw when using the in-process backend fix: Do not throw when using the in-process backend May 9, 2025
@github-actions github-actions bot added the bug Issue, problem or error in PyMAPDL label May 9, 2025
`mapdl_inprocess` should use `None`for graphics
backend. This will have to be revisited with some
automated tests when 2025R2 is released.
@koubaa koubaa force-pushed the fix-mapdl-graphics-backend branch from 2efb018 to d506984 Compare May 9, 2025 16:26
@koubaa koubaa changed the title fix: Do not throw when using the in-process backend fix: Change the mapdl_inprocess graphics backend May 9, 2025
@codecov
Copy link

codecov bot commented May 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.27%. Comparing base (a1a20bc) to head (30a7f6c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3915      +/-   ##
==========================================
- Coverage   88.28%   88.27%   -0.01%     
==========================================
  Files         187      187              
  Lines       14830    14830              
==========================================
- Hits        13092    13091       -1     
- Misses       1738     1739       +1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

LGTM

@germa89 germa89 enabled auto-merge (squash) May 12, 2025 08:32
@germa89 germa89 merged commit 1779e65 into main May 12, 2025
82 of 83 checks passed
@germa89 germa89 deleted the fix-mapdl-graphics-backend branch May 12, 2025 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Issue, problem or error in PyMAPDL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

mapdl_inprocess should use a custom graphics backend

4 participants