Adding transaction for embedding (#542)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kerry McAdams <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -9,7 +9,9 @@ This document follows the conventions laid out in [Keep a CHANGELOG](https://kee
 
 ### Added
 
-- Add release note configuration ([#512](https://github.com/ansys/pymechanical/pull/512))- Add 242 to scheduled nightly run ([#519](https://github.com/ansys/pymechanical/pull/519))
+- Add release note configuration ([#512](https://github.com/ansys/pymechanical/pull/512))
+- Add 242 to scheduled nightly run ([#519](https://github.com/ansys/pymechanical/pull/519))
+- Add transaction for embedding ([#542](https://github.com/ansys/pymechanical/pull/542))
 
 ### Fixed
 

doc/source/user_guide_embedding/globals.rst

@@ -8,7 +8,7 @@ When using Mechanical scripting APIs (in either Mechanical's graphical user inte
 sending scripts to a remote session of Mechanical), there are many global variables that are
 by default usable from Python. Some of these are API entry points, like those discussed in
 :ref:`ref_user_guide_scripting`, while others are types and namespaces that are used by the
-scripting APIs. Examples of those are the ``Quantity`` class or the ``DataModel`` entry point.
+scripting APIs. Examples of those are the ``Quantity``, ``Transaction`` class or the ``DataModel`` entry point.
 
 Embedding Mechanical into Python is as simple as constructing an application object. This can
 not automatically change the global variables available to the Python scope that constructed
@@ -25,10 +25,10 @@ following code:
    globals().update(global_variables(app))
 
 
-Some enum types are available when scripting inside of mechanical, such as `SelectionTypeEnum`
-or `LoadDefineBy`. Because these number in the thousands, by default, these enums are not
+Some enum types are available when scripting inside of mechanical, such as ``SelectionTypeEnum``
+or ``LoadDefineBy``. Because these number in the thousands, by default, these enums are not
 included in these global variables. To include enums, set the second argument of
-`global_variables`` to True.
+``global_variables`` to True.
 
 .. code:: python
 

doc/source/user_guide_scripting/index.rst

@@ -67,9 +67,9 @@ tasks until after a block of commands are run. Here is an example:
 
 .. code:: python
 
-    with Transaction():
-        for obj in Tree:
-            obj.Name = obj.Name + " suffix"
+   with Transaction():
+       for obj in Tree:
+           obj.Name = obj.Name + " suffix"
 
 API entry points
 ^^^^^^^^^^^^^^^^

src/ansys/mechanical/core/embedding/imports.py

@@ -42,7 +42,8 @@ def global_variables(app: "ansys.mechanical.core.App", enums: bool = False) -> t
 
     clr.AddReference("System.Collections")
     clr.AddReference("Ansys.ACT.WB1")
-    from Ansys.ACT.Mechanical import Transaction
+    # from Ansys.ACT.Mechanical import Transaction
+    # When ansys-pythonnet issue #14 is fixed, uncomment above
     from Ansys.Core.Units import Quantity
 
     import System  # isort: skip
@@ -71,3 +72,32 @@ def get_all_enums() -> typing.Dict[str, typing.Any]:
         if type(the_enum).__name__ == "CLRMetatype":
             enums[attr] = the_enum
     return enums
+
+
+class Transaction:  # When ansys-pythonnet issue #14 is fixed, this class will be removed
+    """
+    A class to speed up bulk user interactions using Ansys ACT Mechanical Transaction.
+
+    Example
+    -------
+    >>> with Transaction() as transaction:
+    ...     pass   # Perform bulk user interactions here
+    ...
+    """
+
+    def __init__(self):
+        """Initialize the Transaction class."""
+        import clr
+
+        clr.AddReference("Ansys.ACT.WB1")
+        import Ansys
+
+        self._transaction = Ansys.ACT.Mechanical.Transaction()
+
+    def __enter__(self):
+        """Enter the context of the transaction."""
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Exit the context of the transaction and disposes of resources."""
+        self._transaction.Dispose()

tests/embedding/test_globals.py

@@ -0,0 +1,40 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Embedding tests for global variables associated with Mechanical"""
+import pytest
+
+from ansys.mechanical.core import global_variables
+
+
+@pytest.mark.embedding
+def test_global_variables(embedded_app):
+    """Test the global variables"""
+    globals_dict = global_variables(embedded_app, True)
+    assert "ExtAPI" in globals_dict
+    assert "DataModel" in globals_dict
+    assert "Model" in globals_dict
+    assert "Tree" in globals_dict
+    assert "Quantity" in globals_dict
+    assert "System" in globals_dict
+    assert "Ansys" in globals_dict
+    assert "Transaction" in globals_dict