Skip to content

refactor: enhance sys method type hints and clean up return value #4099

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

Merged
merged 6 commits into from
Jul 14, 2025

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Jul 14, 2025

Description

As the title.

Issue linked

NA but extracted from #1300.

Checklist

Summary by Sourcery

Refine the sys method by adding type hints and ensuring the returned output has no trailing newline

Enhancements:

  • Add cmd: str parameter and -> str return type hints to sys
  • Trim a single trailing newline from the sys method’s return value if present

@Copilot Copilot AI review requested due to automatic review settings July 14, 2025 10:12
@germa89 germa89 requested a review from a team as a code owner July 14, 2025 10:12
@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
Contributor

sourcery-ai bot commented Jul 14, 2025

Reviewer's Guide

Refactors sys method by adding explicit type hints for cmd and return type and ensures trailing newline is removed from returned output.

File-Level Changes

Change Details Files
Enhanced sys method type hints
  • Added parameter type hint cmd: str
  • Added return type annotation -> str
src/ansys/mapdl/core/mapdl_grpc.py
Cleaned up return value
  • Strips trailing newline character from returned obj
  • Added explanatory comment for newline removal
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

@germa89 germa89 self-assigned this Jul 14, 2025
@germa89
Copy link
Collaborator Author

germa89 commented Jul 14, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 enabled auto-merge (squash) July 14, 2025 10:12
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 and they look great!


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.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Refactors the sys method by adding type hints and ensuring the returned output doesn’t end with a newline.

  • Added cmd: str and -> str type annotations to sys
  • Updated return logic to strip a single trailing newline from the command output
Comments suppressed due to low confidence (2)

src/ansys/mapdl/core/mapdl_grpc.py:1475

  • [nitpick] The docstring should mention that the returned string has a trailing newline removed. Document the newline-stripping behavior to keep consumers informed.
    def sys(self, cmd: str, **kwargs) -> str:

src/ansys/mapdl/core/mapdl_grpc.py:1475

  • [nitpick] The method name sys shadows Python's built-in sys module. Consider renaming to reduce confusion or explicitly document its purpose.
    def sys(self, cmd: str, **kwargs) -> str:

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 Jul 14, 2025
Copy link

codecov bot commented Jul 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.85%. Comparing base (a9d37dc) to head (6d270fc).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4099      +/-   ##
==========================================
+ Coverage   91.82%   91.85%   +0.02%     
==========================================
  Files         187      187              
  Lines       15033    15033              
==========================================
+ Hits        13804    13808       +4     
+ Misses       1229     1225       -4     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 merged commit 4dbdb62 into main Jul 14, 2025
44 checks passed
@germa89 germa89 deleted the fix/removing-new-line-from-sys branch July 14, 2025 12:11
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.

2 participants