Deprecating CORBA and Python 3.8 (#2517)

* Adding warning about CORBA deprecation. * Updating docs * Deprecating corba from launcher.py * Deprecating CORBA in the rest of the package * Deprecating Python 3.8 * Removing more corba stuff * fixing stuff * removed repeated import * missing argument * fixing scipy version * fixing test * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix: typo in `pyproject.toml` + reverting pre-commit changes --------- Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
ansys · Nov 30, 2023 · 0a4287e · 0a4287e
1 parent a1e045e
commit 0a4287e
Show file tree

Hide file tree

Showing 18 changed files with 38 additions and 1,214 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -80,7 +80,6 @@ body:
       description: Run `python --version` to verify your Python version
       multiple: false
       options:
-       - '3.8'
        - '3.9'
        - '3.10'
        - '3.11'

diff --git a/.github/ISSUE_TEMPLATE/examples.yml b/.github/ISSUE_TEMPLATE/examples.yml
@@ -56,7 +56,6 @@ body:
       description: Run `python --version` to verify your Python version
       multiple: false
       options:
-       - '3.8'
        - '3.9'
        - '3.10'
        - '3.11'

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -77,7 +77,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
         # Only perform wheelhouse builds for macOS when releasing
         should-release: 
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}

diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml
@@ -15,7 +15,7 @@ jobs:
     steps:
       - uses: marcoroth/dependabot-bump-together-action@main
         with:
-          dependencies: ansys-api-mapdl, ansys-corba, ansys-dpf-core, ansys-mapdl-reader, ansys-math-core, ansys-platform-instancemanagement, ansys-sphinx-theme, ansys-tools-path, autopep8, click, grpcio, imageio, imageio-ffmpeg, importlib-metadata, jupyter_sphinx, jupyterlab, matplotlib, numpy, numpydoc, pandas, pexpect, platformdirs, plotly, protobuf, psutil, pyansys-tools-report, pyansys-tools-versioning, pyiges, pyiges[full], pypandoc, pytest, pytest-cov, pytest-pyvista, pytest-rerunfailures, pytest-sphinx, pythreejs, pyvista, scipy, sphinx, sphinx-autobuild, sphinx-autodoc-typehints, sphinx-copybutton, sphinx-gallery, sphinx-reredirects, sphinxcontrib-websupport, sphinxemoji, tqdm, vtk
+          dependencies: ansys-api-mapdl, ansys-dpf-core, ansys-mapdl-reader, ansys-math-core, ansys-platform-instancemanagement, ansys-sphinx-theme, ansys-tools-path, autopep8, click, grpcio, imageio, imageio-ffmpeg, importlib-metadata, jupyter_sphinx, jupyterlab, matplotlib, numpy, numpydoc, pandas, pexpect, platformdirs, plotly, protobuf, psutil, pyansys-tools-report, pyansys-tools-versioning, pyiges, pyiges[full], pypandoc, pytest, pytest-cov, pytest-pyvista, pytest-rerunfailures, pytest-sphinx, pythreejs, pyvista, scipy, sphinx, sphinx-autobuild, sphinx-autodoc-typehints, sphinx-copybutton, sphinx-gallery, sphinx-reredirects, sphinxcontrib-websupport, sphinxemoji, tqdm, vtk
           package_managers: pip
           directory: /
           branch: main

diff --git a/codecov.yml b/codecov.yml
@@ -2,7 +2,6 @@ ignore:
   - "src/ansys/mapdl/core/_commands"
   - "src/ansys/mapdl/core/jupyter.py"
   - "src/ansys/mapdl/core/mapdl_console.py"
-  - "src/ansys/mapdl/core/mapdl_corba.py"
 
 comment:
   layout: "diff"

diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,7 @@ name = "ansys-mapdl-core"
 version = "0.68.dev0"
 description = "A Python wrapper for Ansys MAPDL."
 readme = "README.rst"
-requires-python = ">=3.8,<3.13"
+requires-python = ">=3.9,<3.13"
 license = {file = "LICENSE"}
 authors = [
     {name = "Ansys, Inc.", email = "pyansys.maintainers@ansys.com"},
@@ -18,7 +18,6 @@ maintainers = [
 ]
 dependencies = [
     "ansys-api-mapdl==0.5.1",  # supports at least 2020R2 - 2022R1
-    "ansys-corba; python_version < '3.9'",
     "ansys-mapdl-reader>=0.51.7",
     "ansys-math-core>=0.1.2",
     "ansys-platform-instancemanagement~=1.0",
@@ -48,7 +47,6 @@ classifiers = [
     "Operating System :: Microsoft :: Windows",
     "Operating System :: POSIX",
     "Operating System :: MacOS",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -66,8 +64,7 @@ tests = [
     "ansys-dpf-core==0.10.0",
     "autopep8==2.0.4",
     "matplotlib==3.8.2",
-    "scipy==1.10.1; python_version < '3.9'", # to support python 3.8
-    "scipy==1.11.3; python_version > '3.8'",
+    "scipy==1.11.3",
     "pandas==2.1.3",
     "pyiges[full]==0.3.1",
     "pytest==7.4.3",
@@ -131,7 +128,6 @@ filterwarnings = [
 ]
 markers = [
     "skip_grpc: skip tests using grpc",
-    "corba: skip tests using the CORBA interface",
     "gui: skip tests that launch the GUI interface",
 ]
 testpaths = "tests"
@@ -150,10 +146,8 @@ source = ["ansys/pymapdl"]
 omit = [
     # omit commands
     "ansys/mapdl/core/_commands/*",
-
     # ignore legacy interfaces
     "ansys/mapdl/core/mapdl_console.py",
-    "ansys/mapdl/core/mapdl_corba.py",
     "ansys/mapdl/core/jupyter.py",
 ]
 

diff --git a/src/ansys/mapdl/core/errors.py b/src/ansys/mapdl/core/errors.py
@@ -119,6 +119,13 @@ def __init__(self, msg=""):
         RuntimeError.__init__(self, msg)
 
 
+class DeprecationError(RuntimeError):
+    """Provides the error for deprecated commands, classes, interfaces, etc"""
+
+    def __init__(self, msg=""):
+        RuntimeError.__init__(self, msg)
+
+
 # handler for protect_grpc
 def handler(sig, frame):  # pragma: no cover
     """Pass signal to custom interrupt handler."""

diff --git a/src/ansys/mapdl/core/launcher.py b/src/ansys/mapdl/core/launcher.py
@@ -31,6 +31,7 @@
 from ansys.mapdl.core import LOG
 from ansys.mapdl.core._version import SUPPORTED_ANSYS_VERSIONS
 from ansys.mapdl.core.errors import (
+    DeprecationError,
     LockFileException,
     MapdlDidNotStart,
     MapdlRuntimeError,
@@ -64,7 +65,7 @@
         )
 
 CONFIG_FILE = os.path.join(SETTINGS_DIR, "config.txt")
-ALLOWABLE_MODES = ["corba", "console", "grpc"]
+ALLOWABLE_MODES = ["console", "grpc"]
 
 ON_WSL = os.name == "posix" and (
     bool(os.environ.get("WSL_DISTRO_NAME", None))
@@ -1015,17 +1016,12 @@ def launch_mapdl(
         Mode to launch MAPDL.  Must be one of the following:
 
         - ``'grpc'``
-        - ``'corba'``
         - ``'console'``
 
         The ``'grpc'`` mode is available on ANSYS 2021R1 or newer and
-        provides the best performance and stability.  The ``'corba'``
-        mode is available from v17.0 and newer and is given legacy
-        support. However only Python up to 3.8 is supported.
-        This mode requires the additional ``ansys_corba`` module.
-        Finally, the ``'console'`` mode
-        is for legacy use only Linux only prior to v17.0.  This console
-        mode is pending depreciation.
+        provides the best performance and stability.
+        The ``'console'`` mode is for legacy use only Linux only prior to 2020R2.
+        This console mode is pending depreciation.
         Visit :ref:`versions_and_interfaces` for more information.
 
     override : bool, optional
@@ -1186,14 +1182,9 @@ def launch_mapdl(
           by default. See :ref:`vpn_issues_troubleshooting` for more information.
           Defaults to ``False``.
 
-        log_broadcast : :class:`bool`
-          *(Only for CORBA mode)*
-          Enables a logger to record broadcasted commands.
-          Defaults to ``False``.
-
     Returns
     -------
-    Union[MapdlGrpc, MapdlConsole, MapdlCorba]
+    Union[MapdlGrpc, MapdlConsole]
         An instance of Mapdl.  Type depends on the selected ``mode``.
 
     Notes
@@ -1328,10 +1319,6 @@ def launch_mapdl(
     >>> mapdl = launch_mapdl(start_instance=False, ip='192.168.1.30',
     ...                      port=50001)
 
-    Force the usage of the CORBA protocol (not recommended).
-
-    >>> mapdl = launch_mapdl(mode='corba')
-
     Run MAPDL using the console mode (not recommended, and available only on Linux).
 
     >>> mapdl = launch_mapdl('/ansys_inc/v194/ansys/bin/ansys194',
@@ -1374,6 +1361,11 @@ def launch_mapdl(
     # Extract arguments:
     force_intel = kwargs.pop("force_intel", False)
     broadcast = kwargs.pop("log_broadcast", False)
+    if broadcast:
+        raise ValueError(
+            "The CORBA interface has been deprecated from 0.67."
+            "Hence this argument is not valid."
+        )
     use_vtk = kwargs.pop("use_vtk", None)
 
     # Transferring MAPDL arguments to start_parameters:
@@ -1610,8 +1602,9 @@ def launch_mapdl(
         }
     )
 
-    if mode in ["console", "corba"]:
+    if mode == "console":
         start_parm["start_timeout"] = start_timeout
+
     else:
         start_parm["ram"] = ram
         start_parm["override"] = override
@@ -1633,24 +1626,7 @@ def launch_mapdl(
             mapdl = MapdlConsole(
                 loglevel=loglevel, log_apdl=log_apdl, use_vtk=use_vtk, **start_parm
             )
-        elif mode == "corba":
-            try:
-                # pending deprecation to ansys-mapdl-corba
-                from ansys.mapdl.core.mapdl_corba import MapdlCorba
-            except ModuleNotFoundError:  # pragma: no cover
-                raise ModuleNotFoundError(
-                    "To use this feature, install the MAPDL CORBA package"
-                    " with:\n\npip install ansys_corba"
-                ) from None
-
-            mapdl = MapdlCorba(
-                loglevel=loglevel,
-                log_apdl=log_apdl,
-                log_broadcast=broadcast,
-                verbose=verbose_mapdl,
-                use_vtk=use_vtk,
-                **start_parm,
-            )
+
         elif mode == "grpc":
             port, actual_run_location, process = launch_grpc(
                 port=port,
@@ -1713,19 +1689,13 @@ def check_mode(mode, version):
                 elif os.name == "posix":
                     raise VersionError("gRPC mode requires MAPDL 2021R1 or newer.")
         elif mode == "corba":
-            warnings.warn(
-                "The CORBA interface is going to be deprecated with the version"
+            raise DeprecationError(
+                "The CORBA interface has been deprecated with the"
                 " v0.67 release. Please use the gRPC interface instead.\n"
                 "For more information visit: "
                 "https://mapdl.docs.pyansys.com/version/0.66/getting_started/versioning.html#corba-interface"
             )
-            if version < 170:
-                raise VersionError("CORBA AAS mode requires MAPDL v17.0 or newer.")
-            if version >= 211:
-                warnings.warn(
-                    "CORBA AAS mode not recommended in MAPDL 2021R1 or newer.\n"
-                    "Recommend using gRPC mode instead."
-                )
+
         elif mode == "console":
             if os.name == "nt":
                 raise ValueError("Console mode requires Linux.")
@@ -1746,18 +1716,17 @@ def check_mode(mode, version):
         elif version == 202 and os.name == "nt":
             # Windows supports it as of 2020R2
             mode = "grpc"
-        elif version >= 170:
-            mode = "corba"
         else:
             if os.name == "nt":
                 raise VersionError(
                     "Running MAPDL as a service requires "
-                    "v17.0 or greater on Windows."
+                    "MAPDL 2020R2 or greater on Windows."
                 )
             mode = "console"
 
     if version < 130:
         warnings.warn("MAPDL as a service has not been tested on MAPDL < v13")
+        mode = "console"
 
     return mode
 

diff --git a/src/ansys/mapdl/core/mapdl.py b/src/ansys/mapdl/core/mapdl.py
@@ -328,7 +328,7 @@ def print_com(self, value):
 
     @property
     def connection(self):
-        """Return the type of connection to the instance, namely: grpc, corba or console."""
+        """Return the type of connection to the instance, namely: grpc, or console."""
         return self._mode
 
     @property
-Original file line number
+Diff line change
@@ Expand Up / @@ -80,7 +80,6 @@ body: @@
           description: Run `python --version` to verify your Python version
           multiple: false
           options:
-           - '3.8'
            - '3.9'
            - '3.10'
            - '3.11'
@@ Expand Down @@