Custom Higher Level Exceptions

src/ansys/fluent/core/__init__.py

@@ -12,14 +12,46 @@
 logging.configure_env_var()
 
 from ansys.fluent.core._version import __version__  # noqa: F401
+from ansys.fluent.core.file_session import (  # noqa: F401
+    InvalidFieldName,
+    InvalidFieldNamePrefix,
+    SurfaceNamesIDsNotProvided,
+)
+from ansys.fluent.core.filereader.data_file import InvalidFilePath  # noqa: F401
+from ansys.fluent.core.fluent_connection import (  # noqa: F401
+    PortNotProvided,
+    RemoteNotSupported,
+    WaitTypeError,
+)
+from ansys.fluent.core.launcher.fluent_container import (  # noqa: F401
+    FluentImageNameTagNotSpecified,
+    LicenseServerNotSpecified,
+    ServerInfoFileError,
+)
 from ansys.fluent.core.launcher.launcher import (  # noqa: F401
+    AnsysVersionNotFound,
+    DockerContainerLaunchNotSupported,
     FluentMode,
     FluentVersion,
+    InvalidPassword,
+    IpPortNotProvided,
+    UnexpectedKeywordArgument,
     connect_to_fluent,
     launch_fluent,
 )
+from ansys.fluent.core.launcher.watchdog import WatchdogLaunchFailed  # noqa: F401
+from ansys.fluent.core.post_objects.post_helper import (  # noqa: F401
+    IncompleteISOSurfaceDefinition,
+    SurfaceCreationError,
+)
 from ansys.fluent.core.services.batch_ops import BatchOps  # noqa: F401
+from ansys.fluent.core.services.datamodel_se import (  # noqa: F401
+    InvalidNamedObject,
+    SubscribeEventError,
+    UnsubscribeEventError,
+)
 from ansys.fluent.core.session import BaseSession as Fluent  # noqa: F401
+from ansys.fluent.core.solver.flobject import InactiveObjectError  # noqa: F401
 from ansys.fluent.core.utils import fldoc
 from ansys.fluent.core.utils.search import search  # noqa: F401
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401

src/ansys/fluent/core/exceptions.py

@@ -0,0 +1,11 @@
+"""Custom common higher level exceptions."""
+
+
+class DisallowedValuesError(ValueError):
+    def __init__(self, error):
+        super().__init__(error)
+
+
+class InvalidArgument(ValueError):
+    def __init__(self, error):
+        super().__init__(error)

src/ansys/fluent/core/file_session.py

@@ -108,15 +108,17 @@ def add_scalar_fields_request(
 
         Raises
         ------
-        RuntimeError
+        SurfaceNamesIDsNotProvided
             If surface names or surface ids are not provided.
-        RuntimeError
+        InvalidFieldNamePrefix
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
         if surface_ids is None:
             surface_ids = []
         if surface_ids and surface_names:
-            raise RuntimeError("Please provide either surface names or surface ids.")
+            raise SurfaceNamesIDsNotProvided(
+                "Please provide either surface names or surface ids."
+            )
 
         if surface_names:
             for surface_name in surface_names:
@@ -126,7 +128,7 @@ def add_scalar_fields_request(
 
         if len(self._file_session._data_file.get_phases()) > 1:
             if not field_name.startswith("phase-"):
-                raise RuntimeError(
+                raise InvalidFieldNamePrefix(
                     "For multi-phase cases field name should have a prefix of phase name."
                 )
             self._scalar_field_transactions.append(
@@ -162,15 +164,17 @@ def add_vector_fields_request(
 
         Raises
         ------
-        RuntimeError
+        SurfaceNamesIDsNotProvided
             If surface names or surface ids are not provided.
-        RuntimeError
+        InvalidFieldNamePrefix
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
         if surface_ids is None:
             surface_ids = []
         if surface_ids and surface_names:
-            raise RuntimeError("Please provide either surface names or surface ids.")
+            raise SurfaceNamesIDsNotProvided(
+                "Please provide either surface names or surface ids."
+            )
 
         if surface_names:
             for surface_name in surface_names:
@@ -180,7 +184,7 @@ def add_vector_fields_request(
 
         if len(self._file_session._data_file.get_phases()) > 1:
             if not field_name.startswith("phase-"):
-                raise RuntimeError(
+                raise InvalidFieldNamePrefix(
                     "For multi-phase cases field name should have a prefix of phase name."
                 )
             self._vector_field_transactions.append(
@@ -227,7 +231,7 @@ def get_fields(self):
 
         Raises
         ------
-        RuntimeError
+        InvalidFieldName
             If any field other than ``"velocity"`` is provided.
         """
         mesh = self._file_session._case_file.get_mesh()
@@ -258,7 +262,7 @@ def get_fields(self):
 
         for transaction in self._vector_field_transactions:
             if "velocity" not in transaction.field_name:
-                raise RuntimeError("Only 'velocity' is allowed field.")
+                raise InvalidFieldName("Only 'velocity' is allowed field.")
             if vector_field_tag not in field_data:
                 field_data[vector_field_tag] = {}
             field_data_surface = field_data[vector_field_tag]
@@ -323,11 +327,13 @@ def get_surface_data(
 
         Raises
         ------
-        RuntimeError
+        SurfaceNamesIDsNotProvided
             If surface names or surface ids are not provided.
         """
         if surface_ids and surface_name:
-            raise RuntimeError("Please provide either surface name or surface ids.")
+            raise SurfaceNamesIDsNotProvided(
+                "Please provide either surface name or surface ids."
+            )
 
         if data_type == SurfaceDataType.Vertices:
             if surface_name:
@@ -407,23 +413,23 @@ def get_scalar_field_data(
 
         Raises
         ------
-        RuntimeError
+        SurfaceNamesIDsNotProvided
             If surface names or surface ids are not provided.
-        RuntimeError
-            If field name does not have prefix ``phase-`` for multi-phase cases.
-        RuntimeError
+        InvalidFieldNamePrefix
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
         if surface_ids and surface_name:
-            raise RuntimeError("Please provide either surface name or surface ids.")
+            raise SurfaceNamesIDsNotProvided(
+                "Please provide either surface name or surface ids."
+            )
 
         if surface_name:
             surface_ids = self._field_info.get_surfaces_info()[surface_name][
                 "surface_id"
             ]
             if len(self._file_session._data_file.get_phases()) > 1:
                 if not field_name.startswith("phase-"):
-                    raise RuntimeError(
+                    raise InvalidFieldNamePrefix(
                         "For multi-phase cases field name should have a prefix of phase name."
                     )
                 return ScalarFieldData(
@@ -444,7 +450,7 @@ def get_scalar_field_data(
         else:
             if len(self._file_session._data_file.get_phases()) > 1:
                 if not field_name.startswith("phase-"):
-                    raise RuntimeError(
+                    raise InvalidFieldNamePrefix(
                         "For multi-phase cases field name should have a prefix of phase name."
                     )
                 return {
@@ -495,31 +501,31 @@ def get_vector_field_data(
 
         Raises
         ------
-        RuntimeError
+        SurfaceNamesIDsNotProvided
             If surface names or surface ids are not provided.
-        RuntimeError
+        InvalidFieldName
             If any field other than ``"velocity"`` is provided.
-        RuntimeError
-            If field name does not have prefix ``phase-`` for multi-phase cases.
-        RuntimeError
+        InvalidFieldNamePrefix
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
         if surface_ids and surface_name:
-            raise RuntimeError("Please provide either surface name or surface ids.")
+            raise SurfaceNamesIDsNotProvided(
+                "Please provide either surface name or surface ids."
+            )
 
         if (
             field_name.lower() != "velocity"
             and field_name.split(":")[1].lower() != "velocity"
         ):
-            raise RuntimeError("Only 'velocity' is allowed field.")
+            raise InvalidFieldName("Only 'velocity' is allowed field.")
 
         if surface_name:
             surface_ids = self._field_info.get_surfaces_info()[surface_name][
                 "surface_id"
             ]
             if len(self._file_session._data_file.get_phases()) > 1:
                 if not field_name.startswith("phase-"):
-                    raise RuntimeError(
+                    raise InvalidFieldNamePrefix(
                         "For multi-phase cases field name should have a prefix of phase name."
                     )
                 vector_data = self._file_session._data_file.get_face_vector_field_data(
@@ -534,7 +540,7 @@ def get_vector_field_data(
         else:
             if len(self._file_session._data_file.get_phases()) > 1:
                 if not field_name.startswith("phase-"):
-                    raise RuntimeError(
+                    raise InvalidFieldNamePrefix(
                         "For multi-phase cases field name should have a prefix of phase name."
                     )
                 return {
@@ -724,3 +730,18 @@ def read_case(self, case_file_name):
     def read_data(self, data_file_name):
         """Read Data file."""
         self._data_file = DataFile(data_file_name, case_file_handle=self._case_file)
+
+
+class SurfaceNamesIDsNotProvided(ValueError):
+    def __init__(self, error):
+        super().__init__(error)
+
+
+class InvalidFieldNamePrefix(ValueError):
+    def __init__(self, error):
+        super().__init__(error)
+
+
+class InvalidFieldName(ValueError):
+    def __init__(self, error):
+        super().__init__(error)

src/ansys/fluent/core/fluent_connection.py

@@ -236,6 +236,11 @@ def __init__(
         inside_container: bool, optional
             Whether the Fluent session that is being connected to
             is running inside a docker container.
+
+        Raises
+        ------
+        PortNotProvided
+            If port is not provided.
         """
         self.error_state = ErrorState()
         self._data_valid = False
@@ -250,7 +255,7 @@ def __init__(
                 port = os.getenv("PYFLUENT_FLUENT_PORT")
             self._channel_str = f"{ip}:{port}"
             if not port:
-                raise ValueError(
+                raise PortNotProvided(
                     "The port to connect to Fluent session is not provided."
                 )
             # Same maximum message length is used in the server
@@ -495,13 +500,13 @@ def wait_process_finished(self, wait: Union[float, int, bool] = 60):
 
         Raises
         ------
-        ValueError
+        RemoteNotSupported
             If current Fluent instance is running remotely.
-        TypeError
+        WaitTypeError
             If ``wait`` is specified improperly.
         """
         if self._remote_instance:
-            raise ValueError(
+            raise RemoteNotSupported(
                 "Fluent remote instance not supported by FluentConnection.wait_process_finished()."
             )
         if isinstance(wait, bool):
@@ -513,7 +518,7 @@ def wait_process_finished(self, wait: Union[float, int, bool] = 60):
         if isinstance(wait, (float, int)):
             logger.info(f"Waiting {wait} seconds for Fluent processes to finish...")
         else:
-            raise TypeError("Invalid 'limit' type.")
+            raise WaitTypeError("Invalid 'limit' type.")
         if self.connection_properties.inside_container:
             _response = timeout_loop(
                 get_container,
@@ -659,3 +664,18 @@ def _exit(
             remote_instance.delete()
 
         exit_event.set()
+
+
+class PortNotProvided(ValueError):
+    def __init__(self, error):
+        super().__init__(error)
+
+
+class RemoteNotSupported(ValueError):
+    def __init__(self, error):
+        super().__init__(error)
+
+
+class WaitTypeError(TypeError):
+    def __init__(self, error):
+        super().__init__(error)