Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Jun 2, 2025

Description

Avoid EQSLV conversion in the converter module.

Issue linked

Close #3977

Checklist

Summary by Sourcery

Avoid automatic conversion of the EQSLV command in the converter module and clean up the eqslv command’s documentation formatting.

Bug Fixes:

  • Add an explicit "EQSL" entry to the converter mapping to prevent unintended conversion of the EQSLV command.

Enhancements:

  • Reformat the eqslv command’s docstring in analysis_options for consistent indentation and readability.

@germa89 germa89 requested a review from a team as a code owner June 2, 2025 10:50
@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 2, 2025

Reviewer's Guide

This PR ensures the EQSLV command is now recognized by the conversion layer and tidies up its docstring for consistent formatting in the analysis options module.

Sequence Diagram: EQSLV Command Conversion Before and After Fix

sequenceDiagram
    actor UserScript
    participant PyMapdlCore
    participant ConverterModule
    participant AnsysMAPDL

    UserScript->>PyMapdlCore: mapdl.eqslv(...)
    PyMapdlCore->>ConverterModule: convert_command("EQSLV")
    alt Before PR (EQSLV not properly converted)
        ConverterModule-->>PyMapdlCore: Error or Unhandled Command
        PyMapdlCore-->>UserScript: Failure (e.g., CommandException)
    else After PR (EQSLV is now recognized)
        ConverterModule->>ConverterModule: Lookup "EQSL" (SUCCESS)
        ConverterModule-->>PyMapdlCore: Converted/Validated Command
        PyMapdlCore->>AnsysMAPDL: Execute on MAPDL instance
        AnsysMAPDL-->>PyMapdlCore: Execution Result
        PyMapdlCore-->>UserScript: Success
    end
Loading

File-Level Changes

Change Details Files
Add missing EQSLV mapping in the conversion registry
  • Insert “EQSL”: () entry into the command-to-converter map
  • Reorder nearby entries for consistent alphabetical grouping
src/ansys/mapdl/core/convert.py
Refactor eqslv docstring formatting
  • Remove leading hyphened bullet prefixes
  • Normalize indentation and line wrapping
  • Condense lengthy descriptions into standard block comment style
src/ansys/mapdl/core/_commands/solution/analysis_options.py

Assessment against linked issues

Issue Objective Addressed Explanation
#3977 The translate_script function should correctly convert the MAPDL command eqsl,sparse,,,,,1 into its PyMAPDL equivalent without causing a TypeError during the solve step.

Possibly linked issues


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 2, 2025
@germa89 germa89 requested a review from vnamdeo June 2, 2025 10:50
@germa89 germa89 enabled auto-merge (squash) June 2, 2025 10:51
@github-actions github-actions bot added the bug Issue, problem or error in PyMAPDL label Jun 2, 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 and they look great!

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.

@codecov
Copy link

codecov bot commented Jun 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.26%. Comparing base (628dde1) to head (a37edc4).
Report is 3 commits behind head on main.

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

@germa89
Copy link
Collaborator Author

germa89 commented Jun 2, 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 merged commit a50c8c7 into main Jun 2, 2025
50 checks passed
@germa89 germa89 deleted the fix/eqslv-conversion branch June 2, 2025 15:02
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.

Issue with the "translate_script" function

3 participants