feat: session submodule

[clatapie]

Description

This PR follows the PyConverter-XML2Py integration plan to automate the PyMAPDL_commands documentation.
The changes have been generated using pyconverter-xml2py and more specifically mapdl-cmd-conv.

This PR focus on the session submodule.

You can check the mapdl-cmd-conv documentation to have a look at the output of each submodules.

Pinging @ansys/pymapdl-developers for visibility. Feel free to provide any feedback on the way the docstrings and the source code generation are handled.

Issue linked

This PR is meant to be merged within the feat/main_commands branch. The latter will gather all the submodule changes, one by one, prior to be merged to the main branch.

Checklist

• I have visited and read Develop PyMAPDL.
• I have tested my changes locally
• I have added necessary documentation or updated existing documentation.
• I have followed the PyMAPDL coding style guidelines.
• I have added appropriate unit tests that also ensure the minimal coverage criteria.
• I have reviewed my changes before submitting this pull request.
• I have linked the issue or issues that are solved to the PR if any.
• I have assigned this PR to myself.
• I have marked this PR as draft if it is not ready to be reviewed yet.
• I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

Summary by Sourcery

Implement the post26 submodule for PyMAPDL, following the PyConverter-XML2Py integration plan to automate documentation generation

New Features:

• Add post26 submodule with comprehensive command implementations
• Implement classes for different aspects of POST26 postprocessing such as SetUp, Controls, Display, Listing, Operations, Special Purpose, and Status

Chores:

• Reorganize project structure to accommodate the new submodule
• Remove old post26_ directory

Summary by Sourcery

Implement the session submodule for PyMAPDL, following the PyConverter-XML2Py integration plan to automate documentation generation

New Features:

• Add comprehensive documentation and implementation for session-related MAPDL commands

Enhancements:

• Refactor and update session-related command implementations
• Improve type hinting and docstring documentation

Documentation:

• Add documentation for session submodule commands
• Create index and documentation files for session commands

[ansys-reviewer-bot]

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

[sourcery-ai]

Reviewer's Guide

This pull request implements the session submodule commands by leveraging the pyconverter-xml2py tool for automated code generation. The core of the changes involves replacing manually written Python methods in run_controls.py, files.py, processor_entry.py, and list_controls.py with their auto-generated counterparts. This process standardizes method signatures to match APDL commands, incorporates comprehensive docstrings directly sourced from APDL documentation (complete with hyperlinks), and ensures consistent APDL command string construction. Accompanying these code changes, the documentation structure for the session submodule has been updated, including the removal of old RST files and the addition of a new index file and a changelog entry.

Updated Class Diagram for RunControls

classDiagram
    class RunControls {
        +keyw(**kwargs)
        +slashexit(slab: str, fname: str, ext: str, **kwargs)
        +pause(**kwargs)
        +uis(label: str, value: int | str, **kwargs)
        +ui(func: str, type_: str, format_: str, screen: str, color: str, krev: str, orient: str, compress: str, quality: str, **kwargs)
        +unpause(**kwargs)
        +mstart(label: str, key: str, **kwargs)
        +memm(lab: str, kywrd: str, **kwargs)
        +menu(key: str, **kwargs)
        +nerr(nmerr: str, nmabt: str, ifkey: str, num: int | str, **kwargs)
        +output(fname: str, ext: str, loc: str, **kwargs)
        +input(fname: str, ext: str, dir_: str, line: str, log: int | str, **kwargs)
        +cwd(dirpath: str, **kwargs)
        +config(lab: str, val: str, **kwargs)
        +sys(string: str, **kwargs)
        +syp(string: str, arg1: str, arg2: str, arg3: str, arg4: str, arg5: str, arg6: str, arg7: str, arg8: str, **kwargs)
        +slashstatus(lab: str, **kwargs)
        +filname(fname: str, key: str, **kwargs)
    }
    note for RunControls "Methods updated with auto-generated code from pyconverter-xml2py. Docstrings and signatures standardized."

Loading

Updated Class Diagram for ProcessorEntry

classDiagram
    class ProcessorEntry {
        +post26(**kwargs)
        +post1(**kwargs)
        +prep7(**kwargs)
        +quit(**kwargs)
        +slashsolu(**kwargs)
        +finish(**kwargs)
    }
    note for ProcessorEntry "Methods updated with auto-generated code. Methods aux2, aux3, aux12, aux15 are no longer part of this class."

Loading

Updated Class Diagram for ListControls

classDiagram
    class ListControls {
        +golist(**kwargs)
        +gopr(**kwargs)
        +slashgo(**kwargs)
        +nopr(**kwargs)
        +nolist(**kwargs)
        +com(comment: str, **kwargs)
    }
    note for ListControls "Methods updated with auto-generated code from pyconverter-xml2py. Method slashgo added. Docstrings and signatures standardized."

Loading

File-Level Changes

Change	Details	Files
Replaced manual implementations of APDL commands in the session submodule with auto-generated code from pyconverter-xml2py.	Updated Python method signatures and parameters to match APDL command syntax. Embedded extensive docstrings generated from official APDL documentation, including direct links. Standardized internal APDL command string assembly and removed previous module-level docstrings.	src/ansys/mapdl/core/_commands/session/run_controls.py src/ansys/mapdl/core/_commands/session/files.py src/ansys/mapdl/core/_commands/session/processor_entry.py src/ansys/mapdl/core/_commands/session/list_controls.py
Updated the documentation build process and file structure for the session submodule to reflect auto-generated content.	Deleted obsolete RST files previously used for session command documentation. Added a new index.rst for the session submodule documentation. Included a changelog entry for the new feature.	doc/source/mapdl_commands/session/files.rst doc/source/mapdl_commands/session/list_controls.rst doc/source/mapdl_commands/session/processor_entry.rst doc/source/mapdl_commands/session/run_controls.rst doc/changelog.d/3894.documentation.md doc/source/mapdl_commands/session/index.rst

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[germa89]

LGTM. Minor changes.

[germa89]

Can we add here also a warning mentioning that PyMAPDL requirest these printouts?

[clatapie]

Sure, I can add a warning (or a note depending of what you prefer) at the top of this function description. Could you specify what you expect in it please?

[clatapie]

Latest attempts are intended to fix the pytest errors.

[germa89]

Latest attempts are intended to fix the pytest errors.

@clatapie I just fixed the CICD pipeline.

The mypy precommit hook can by bypassed using SKIP env var

SKIP=mypy git commit -m "feat: my commit message"

[clatapie]

Thank you very much @germa89!

[clatapie]

All the comments have been addressed.

[clatapie]

I need @germa89's feedback on #3895 (comment) before merging this PR. Once I will add the adequate warning, the PR will be ready to merge on my side.