Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented May 19, 2025

Description

Expose a reconnection method

Issue linked

NA

Checklist

Summary by Sourcery

Extract connection logic from init and provide a dedicated reconnect_to_mapdl() API to allow re-establishing a stopped or crashed MAPDL gRPC session without relaunching the instance.

New Features:

  • Expose a public reconnect_to_mapdl() method to manually re-establish a gRPC connection

Enhancements:

  • Refactor connection logic into a new internal _connect_to_mapdl() helper

@germa89 germa89 requested a review from a team as a code owner May 19, 2025 15:44
@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 19, 2025

Reviewer's Guide

Refactored the gRPC connection setup by extracting the multi_connect logic into a private helper and exposing a new public reconnect_to_mapdl API that can re-establish dropped connections with an optional timeout, replacing the inline connection code in the constructor.

File-Level Changes

Change Details Files
Extracted connection logic into a private helper
  • Moved the try/except block of _multi_connect from init into a new _connect_to_mapdl method
  • Retained post-mortem error checks and debug logging in the extracted helper
src/ansys/mapdl/core/mapdl_grpc.py
Added and wired up the public reconnect_to_mapdl method
  • Introduced reconnect_to_mapdl with optional timeout and default fallback to self._timeout
  • Replaced inline connection calls in init with a call to reconnect_to_mapdl
src/ansys/mapdl/core/mapdl_grpc.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 @germa89 - I've reviewed your changes - here's some feedback:

  • Replace if not timeout: with an explicit if timeout is None: check so that a zero timeout can be handled correctly.
  • Add explicit -> None return type annotations to both _connect_to_mapdl and reconnect_to_mapdl for consistency with the existing type hints.
  • Consider returning a status flag or raising a custom exception in reconnect_to_mapdl to clearly signal success or failure to callers instead of implicit None.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@germa89 germa89 self-assigned this May 27, 2025
@codecov
Copy link

codecov bot commented May 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.26%. Comparing base (cce7ad1) to head (49a4ff3).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3933      +/-   ##
==========================================
+ Coverage   88.25%   88.26%   +0.01%     
==========================================
  Files         187      187              
  Lines       14935    14941       +6     
==========================================
+ Hits        13181    13188       +7     
+ Misses       1754     1753       -1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

germa89 and others added 2 commits May 30, 2025 14:23
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@germa89 germa89 changed the title exposing a reconnection method feat: exposing a reconnection method May 30, 2025
@github-actions github-actions bot added the new feature Request or proposal for a new feature label May 30, 2025
@germa89
Copy link
Collaborator Author

germa89 commented May 30, 2025

@pyansys-ci-bot LGTM.

Copy link
Contributor

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

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 enabled auto-merge (squash) May 30, 2025 12:27
@germa89 germa89 merged commit 628dde1 into main May 30, 2025
48 checks passed
@germa89 germa89 deleted the feat/exposing-connection branch May 30, 2025 13:04
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.

3 participants