Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Jun 25, 2025

Description

As the title.

Issue linked

Extracted from #1300

Checklist

Summary by Sourcery

Extract the IP parsing utility from the launcher module into the misc module, streamline the launcher to use the shared function, and update tests accordingly

Enhancements:

  • Move parse_ip_route out of the launcher module into misc for shared use
  • Remove the private _parse_ip_route function and update launcher to call the new misc.parse_ip_route

Tests:

  • Update unit tests to reference parse_ip_route instead of the removed _parse_ip_route

@germa89 germa89 requested a review from a team as a code owner June 25, 2025 11:40
@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 Jun 25, 2025

Reviewer's Guide

This PR refactors the IP route parsing helper by relocating the function from the launcher module into misc, updating its usage in host IP resolution, and adjusting tests to reference the new implementation.

Class diagram for refactored parse_ip_route function location

classDiagram
    class launcher {
        +_get_windows_host_ip() str | None
        +_run_ip_route() str | None
    }
    class misc {
        +parse_ip_route(output: str) str | None
    }
    launcher ..> misc : uses parse_ip_route
Loading

File-Level Changes

Change Details Files
Relocate IP route parsing logic
  • Removed the private _parse_ip_route function from launcher
  • Added a public parse_ip_route function in misc
src/ansys/mapdl/core/launcher.py
src/ansys/mapdl/core/misc.py
Redirect function calls in launcher
  • Replaced _parse_ip_route with parse_ip_route in _get_windows_host_ip
  • Ensured parse_ip_route is imported into launcher
src/ansys/mapdl/core/launcher.py
Update unit tests for new function
  • Removed imports of _parse_ip_route in tests
  • Changed assertions to call parse_ip_route instead
tests/test_launcher.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

@germa89 germa89 self-assigned this Jun 25, 2025
@germa89
Copy link
Collaborator Author

germa89 commented Jun 25, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 enabled auto-merge (squash) June 25, 2025 11:41
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

@github-actions github-actions bot added the enhancement Improve any current implemented feature label Jun 25, 2025
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:

  • Ensure launcher.py includes the appropriate import for parse_ip_route from misc.py so the reference resolves correctly.
  • Add the missing import re in misc.py (if not already present) so parse_ip_route can use regex functions without errors.
  • Include a unit test for parse_ip_route when the output contains no IP match to confirm it returns None as expected.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Ensure `launcher.py` includes the appropriate import for `parse_ip_route` from `misc.py` so the reference resolves correctly.
- Add the missing `import re` in `misc.py` (if not already present) so `parse_ip_route` can use regex functions without errors.
- Include a unit test for `parse_ip_route` when the output contains no IP match to confirm it returns None as expected.

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.

@codecov
Copy link

codecov bot commented Jun 25, 2025

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 89.12%. Comparing base (53ad87c) to head (cdc874b).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4039      +/-   ##
==========================================
+ Coverage   89.05%   89.12%   +0.07%     
==========================================
  Files         187      187              
  Lines       14970    14970              
==========================================
+ Hits        13331    13342      +11     
+ Misses       1639     1628      -11     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 merged commit ae37909 into main Jun 25, 2025
84 of 86 checks passed
@germa89 germa89 deleted the refactor/moving-parse_ip_route-to-misc branch June 25, 2025 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Improve any current implemented feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants