feat: First tentative for Plugin Mapdl Mechanism python API #3627

FredAns · 2024-12-19T15:41:18Z

Description

**There's now a new command in MAPDL, called *PLUG, to allow the loading of external dynamic libraries, to dynamically add custom commands and features in MAPDL ( for the time of the session). There are a few plugins already shipped with MAPDL ( The gRPC server lib and the DPF Plugin) we can load and use this way.

I've copy/paste what was done for the XPL API implementation **

Issue linked

There's a TFS User Story for this action. But not already a Github ID.

Checklist

ansys-reviewer-bot · 2024-12-19T15:41:23Z

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

@ansys-reviewer-bot review

germa89 · 2024-12-19T16:21:08Z

I will check it out next year. #HappyVacations

MaxJPRey · 2024-12-24T15:25:04Z

Can't wait to discuss about it early next year when I visit you @FredAns 😃 .

germa89

I think this is good. I would also add a string dunder method __str__, so we can do:

>>> print(mapdl.plugins)
MAPDL Plugins
----------------
DPF                          : feature
ABC                          : feature

germa89 · 2025-01-10T11:18:20Z

src/ansys/mapdl/core/mapdl_grpc.py

@@ -2767,6 +2768,26 @@ def xpl(self) -> "ansXpl":
            self._xpl = ansXpl(self)
        return self._xpl

+    @property
+    def plugin(self) -> "ansPlugin":


Suggested change

def plugin(self) -> "ansPlugin":

def plugin(self) -> ansPlugin:

germa89 · 2025-01-10T11:20:03Z

src/ansys/mapdl/core/mapdl_grpc.py

+        >>> plugin.load('PluginDPF')
+        """
+        if self._plugin is None:
+            from ansys.mapdl.core.plugin import ansPlugin


Suggested change

from ansys.mapdl.core.plugin import ansPlugin

It seems to me there is no reason to delay the import. You can delete this line and then apply my previous comment (remove quotes).

Or delete the import at the beginning and leave these lines as it is.

src/ansys/mapdl/core/plugin.py

germa89 · 2025-01-10T11:24:50Z

src/ansys/mapdl/core/plugin.py

+        command = f"*PLUG,LOAD,{plugin_name},{feature}"
+        response = self._mapdl.run(command)
+        if "error" in response.lower():
+            raise PluginLoadError(


You should create this type of exception in ansys.mapdl.core.errors, ideally inheritate from MapdlException or MapdlRuntimeError.

germa89 · 2025-01-10T11:26:03Z

src/ansys/mapdl/core/plugin.py

+            raise PluginLoadError(
+                f"Failed to load plugin '{plugin_name}' with feature '{feature}'."
+            )
+        return f"Plugin '{plugin_name}' with feature '{feature}' loaded successfully."


Why are you not returned the original MAPDL response response?

src/ansys/mapdl/core/plugin.py

for more information, see https://pre-commit.ci

codecov · 2025-01-10T15:03:42Z

Codecov Report

Attention: Patch coverage is 7.14286% with 39 lines in your changes missing coverage. Please review.

Project coverage is 88.06%. Comparing base (f59d94a) to head (1d2d4d5).
Report is 4 commits behind head on main.

❌ Your patch check has failed because the patch coverage (7.14%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3627      +/-   ##
==========================================
- Coverage   88.29%   88.06%   -0.23%     
==========================================
  Files         187      188       +1     
  Lines       14819    14861      +42     
==========================================
+ Hits        13084    13087       +3     
- Misses       1735     1774      +39

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

germa89 · 2025-04-23T12:27:46Z

@FredAns

I'm having a look at this PR.

It seems that the 202504160030P01 build does not return anything when I issue *PLUG,LIST:

Additionally, can I have a dummy plugin so I can test loading and unloading?

…loading methods

FredAns requested review from germa89 and clatapie December 19, 2024 15:41

github-actions bot added the new feature Request or proposal for a new feature label Dec 19, 2024

germa89 approved these changes Jan 10, 2025

View reviewed changes

FredAns and others added 5 commits January 10, 2025 15:42

First tentative for plugin mapdl mechanism

7a8a716

ci: auto fixes from pre-commit.com hooks.

538936d

for more information, see https://pre-commit.ci

chore: adding changelog file 3627.miscellaneous.md [dependabot-skip]

35bcf88

ci: auto fixes from pre-commit.com hooks.

2dea3bc

for more information, see https://pre-commit.ci

ci: auto fixes from pre-commit.com hooks.

a1d7ee2

for more information, see https://pre-commit.ci

germa89 force-pushed the feat/plugins branch from 19240d7 to a1d7ee2 Compare January 10, 2025 14:42

germa89 added 3 commits February 17, 2025 18:56

Merge branch 'main' into feat/plugins

57e2de6

Merge branch 'main' into feat/plugins

cd63cc8

chore: merge remote-tracking branch 'origin/main' into feat/plugins

1d2d4d5

germa89 added 2 commits April 23, 2025 14:43

feat: add plugin error handling classes and improve plugin loading/un…

4afa907

…loading methods

test: adding plugin tests

16c744d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: First tentative for Plugin Mapdl Mechanism python API #3627

feat: First tentative for Plugin Mapdl Mechanism python API #3627

FredAns commented Dec 19, 2024

ansys-reviewer-bot bot commented Dec 19, 2024

germa89 commented Dec 19, 2024

MaxJPRey commented Dec 24, 2024

germa89 left a comment

germa89 Jan 10, 2025

germa89 Jan 10, 2025

germa89 Jan 10, 2025

germa89 Jan 10, 2025

codecov bot commented Jan 10, 2025 •

edited

Loading

germa89 commented Apr 23, 2025 •

edited

Loading

	def plugin(self) -> "ansPlugin":
	def plugin(self) -> ansPlugin:

feat: First tentative for Plugin Mapdl Mechanism python API #3627

Are you sure you want to change the base?

feat: First tentative for Plugin Mapdl Mechanism python API #3627

Conversation

FredAns commented Dec 19, 2024

Description

Issue linked

Checklist

ansys-reviewer-bot bot commented Dec 19, 2024

germa89 commented Dec 19, 2024

MaxJPRey commented Dec 24, 2024

germa89 left a comment

Choose a reason for hiding this comment

germa89 Jan 10, 2025

Choose a reason for hiding this comment

germa89 Jan 10, 2025

Choose a reason for hiding this comment

germa89 Jan 10, 2025

Choose a reason for hiding this comment

germa89 Jan 10, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 10, 2025 • edited Loading

Codecov Report

germa89 commented Apr 23, 2025 • edited Loading

codecov bot commented Jan 10, 2025 •

edited

Loading

germa89 commented Apr 23, 2025 •

edited

Loading