Removing scooby dependency (#1092)

* fixing forgotten pyvista import

* Added base class for reporting. So scooby is not enforced.

* Removing self

* Fixing code coverage

* Fixing unit tests.

* Improving coverage

* Update src/ansys/mapdl/core/misc.py

Co-authored-by: Alex Kaszynski <[email protected]>
(cherry picked from commit cc11149)

Author: germa89

src/ansys/mapdl/core/misc.py

@@ -11,7 +11,16 @@
 from threading import Thread
 
 import numpy as np
-import scooby
+
+from ansys.mapdl.core import _HAS_PYVISTA, LOG
+
+try:
+    import scooby
+
+    _HAS_SCOOBY = True
+except ModuleNotFoundError:  # pragma: no cover
+    LOG.debug("The module 'scooby' is not installed.")
+    _HAS_SCOOBY = False
 
 # path of this module
 MODULE_PATH = os.path.dirname(inspect.getfile(inspect.currentframe()))
@@ -33,7 +42,87 @@ def get_ansys_bin(rver):
     return mapdlbin
 
 
-class Report(scooby.Report):
+class Plain_Report:
+    def __init__(self, core, optional=None, additional=None, **kwargs):
+        """
+        Base class for a plain report.
+
+
+        Based on `scooby <https://github.com/banesullivan/scooby>`_ package.
+
+        Parameters
+        ----------
+        additional : iter[str]
+            List of packages or package names to add to output information.
+        core : iter[str]
+            The core packages to list first.
+        optional : iter[str]
+            A list of packages to list if they are available. If not available,
+            no warnings or error will be thrown.
+        """
+
+        self.additional = additional
+        self.core = core
+        self.optional = optional
+        self.kwargs = kwargs
+
+    def get_version(self, package):
+        from importlib.metadata import PackageNotFoundError
+        from importlib.metadata import version as get_lib_version
+
+        package = package.replace(".", "-")
+
+        try:
+            return get_lib_version(package)
+        except PackageNotFoundError:
+            return "Package not found"
+
+    def __repr__(self):
+        header = ["\n", "Packages Requirements", "*********************"]
+
+        core = ["\nCore packages", "-------------"]
+        core.extend(
+            [
+                f"{each.ljust(20)}: {self.get_version(each)}"
+                for each in self.core
+                if self.get_version(each)
+            ]
+        )
+
+        if self.optional:
+            optional = ["\nOptional packages", "-----------------"]
+            optional.extend(
+                [
+                    f"{each.ljust(20)}: {self.get_version(each)}"
+                    for each in self.optional
+                    if self.get_version(each)
+                ]
+            )
+        else:
+            optional = [""]
+
+        if self.additional:
+            additional = ["\nAdditional packages", "-----------------"]
+            additional.extend(
+                [
+                    f"{each.ljust(20)}: {self.get_version(each)}"
+                    for each in self.additional
+                    if self.get_version(each)
+                ]
+            )
+        else:
+            additional = [""]
+
+        return "\n".join(header + core + optional + additional)
+
+
+if _HAS_SCOOBY:
+    base_report_class = scooby.Report
+else:  # pragma: no cover
+    base_report_class = Plain_Report
+
+
+class Report(base_report_class):
     """A class for custom scooby.Report."""
 
     def __init__(self, additional=None, ncol=3, text_width=80, sort=False, gpu=True):
@@ -56,7 +145,7 @@ def __init__(self, additional=None, ncol=3, text_width=80, sort=False, gpu=True)
 
         gpu : bool
             Gather information about the GPU. Defaults to ``True`` but if
-            experiencing renderinng issues, pass ``False`` to safely generate
+            experiencing rendering issues, pass ``False`` to safely generate
             a report.
 
         """
@@ -83,18 +172,17 @@ def __init__(self, additional=None, ncol=3, text_width=80, sort=False, gpu=True)
 
         # Information about the GPU - bare except in case there is a rendering
         # bug that the user is trying to report.
-        if gpu:
+        if gpu and _HAS_PYVISTA:
             from pyvista.utilities.errors import GPUInfo
 
             try:
                 extra_meta = [(t[1], t[0]) for t in GPUInfo().get_info()]
-            except:
-                extra_meta = ("GPU Details", "error")
+            except Exception as e:  # pragma: no cover
+                extra_meta = ("GPU Details", f"Error: {e.message}")
         else:
             extra_meta = ("GPU Details", "None")
 
-        scooby.Report.__init__(
-            self,
+        super().__init__(
             additional=additional,
             core=core,
             optional=optional,

tests/test_misc.py

@@ -62,3 +62,95 @@ def test_check_valid_port(port):
 )
 def test_check_valid_start_instance(start_instance):
     check_valid_start_instance(start_instance)
+
+
+def test_get_ansys_bin(mapdl):
+    rver = mapdl.__str__().splitlines()[1].split(":")[1].strip().replace(".", "")
+    assert isinstance(get_ansys_bin(rver), str)
+
+
+def test_mapdl_info(mapdl, capfd):
+    info = mapdl.info
+    for attr, value in inspect.getmembers(info):
+        if not attr.startswith("_") and attr not in ["title", "stitles"]:
+            assert isinstance(value, str)
+
+            with pytest.raises(AttributeError):
+                setattr(info, attr, "any_value")
+
+    assert "PyMAPDL" in mapdl.info.__repr__()
+    out = info.__str__()
+
+    assert "ansys" in out.lower()
+    assert "Product" in out
+    assert "MAPDL Version" in out
+    assert "UPDATE" in out
+
+
+def test_info_title(mapdl):
+    title = "this is my title"
+    mapdl.info.title = title
+    assert title == mapdl.info.title
+
+
+def test_info_stitle(mapdl):
+    info = mapdl.info
+
+    assert not info.stitles
+    stitles = ["asfd", "qwer", "zxcv", "jkl"]
+    info.stitles = "\n".join(stitles)
+
+    assert stitles == info.stitles
+
+    stitles = stitles[::-1]
+
+    info.stitles = stitles
+    assert stitles == info.stitles
+
+    info.stitles = None
+    assert not info.stitles
+
+
+def test_plain_report():
+    from ansys.mapdl.core.misc import Plain_Report
+
+    core = ["numpy", "ansys.mapdl.reader"]
+    optional = ["pyvista", "tqdm"]
+    additional = ["scipy", "ger"]
+
+    report = Plain_Report(core=core, optional=optional, additional=additional)
+    rep_str = report.__repr__()
+
+    for each in core + optional + additional:
+        assert each in rep_str
+
+    # There should be only one package not found ("ger")
+    assert "Package not found" in rep_str
+    _rep_str = rep_str.replace("Package not found", "", 1)
+    assert "Package not found" not in _rep_str
+
+    assert "\n" in rep_str
+    assert len(rep_str.splitlines()) > 3
+
+    assert "Core packages" in rep_str
+    assert "Optional packages" in rep_str
+    assert "Additional packages" in rep_str
+
+
+def test_plain_report_no_options():
+    from ansys.mapdl.core.misc import Plain_Report
+
+    core = ["numpy", "ansys.mapdl.reader"]
+
+    report = Plain_Report(core=core)
+    rep_str = report.__repr__()
+
+    for each in core:
+        assert each in rep_str
+
+    assert "\n" in rep_str
+    assert len(rep_str.splitlines()) > 3
+
+    assert "Core packages" in rep_str
+    assert "Optional packages" not in rep_str
+    assert "Additional packages" not in rep_str