Skip to content

exposing a reconnection method #3933

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Copy link

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

@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.

Comment on lines +474 to +475
if not timeout:
timeout = self._timeout
Copy link

Choose a reason for hiding this comment

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

suggestion (bug_risk): Use timeout is None instead of falsy check

This prevents valid falsy values (e.g., 0) from being overridden by self._timeout.

Suggested change
if not timeout:
timeout = self._timeout
if timeout is None:
timeout = self._timeout

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