doc: modified final set of files.

Author: moe-ad

src/ansys/dpf/core/operator_specification.py

@@ -320,7 +320,7 @@ def __str__(self):
     @property
     def properties(self) -> dict:
         """Additional properties of the Operator.
-        
+
         Some additional properties of the Operator, like the category, the exposure,
         the scripting and user names, and the plugin
 
@@ -592,7 +592,7 @@ def __setitem__(self, key, value):
         """
         Set the value of a specified attribute.
 
-        If a specification is defined, the value is also updated in the 
+        If a specification is defined, the value is also updated in the
         operator specification.
 
         Parameters
@@ -621,7 +621,7 @@ def __getitem__(self, item: str):
         -------
         any
             The value of the specified attribute.
-        """       
+        """
         return getattr(self, item)
 
     def __eq__(self, other):
@@ -836,7 +836,7 @@ def config_specification(self, val: list):
     @version_requires("4.0")
     def properties(self) -> SpecificationProperties:
         """Return additional properties of the Operator.
-        
+
         Returns some additional properties of the Operator, like the category, the exposure,
         the scripting and user names and the plugin
         """

src/ansys/dpf/core/result_info.py

@@ -589,7 +589,7 @@ def __len__(self):
         """
         Return the number of results available.
 
-        If an exception occurs while attempting to retrieve the number of results, 
+        If an exception occurs while attempting to retrieve the number of results,
         the method returns 0.
 
         Returns
@@ -633,7 +633,7 @@ def __del__(self):
         """
         Clean up resources associated with the instance.
 
-        This method calls the deleter function to release resources. If an exception 
+        This method calls the deleter function to release resources. If an exception
         occurs during deletion, a warning is issued.
 
         Raises

src/ansys/dpf/core/results.py

@@ -137,7 +137,7 @@ def __result__(self, result_type, *args):
         -------
         Result
             An instance of the `Result` class, providing access to the specified result.
-        """        
+        """
         return Result(self._connector, self._mesh_by_default, result_type, self._server)
 
     def _connect_operators(self, result_info):

src/ansys/dpf/core/runtime_config.py

@@ -39,7 +39,7 @@ def __init__(self, data_tree, server=None):
 
 class RuntimeClientConfig(_RuntimeConfig):
     """Enable accessing and setting runtime configuration options to gRPC client.
-    
+
     Mostly used to configure gRPC streaming and calls options.
 
     Parameters
@@ -123,7 +123,7 @@ def stream_floats_instead_of_doubles(self, value):
     @property
     def return_arrays(self):
         """All methods will return :class:`ansys.dpf.core.DPFArray` (instead of lists) when possible.
-        
+
         Default is ``True``.
         See for example, :func:`ansys.dpf.core.Scoping.ids`.
 

src/ansys/dpf/core/scoping.py

@@ -335,22 +335,22 @@ def __del__(self):
         """
         Clean up resources associated with the instance.
 
-        This method calls the deleter function to release resources. If an exception 
+        This method calls the deleter function to release resources. If an exception
         occurs during deletion, a warning is issued.
 
         Raises
         ------
         Warning
             If an exception occurs while attempting to delete resources.
-        """       
+        """
         try:
             self._deleter_func[0](self._deleter_func[1](self))
         except Exception as e:
             print(str(e.args), str(self._deleter_func[0]))
             warnings.warn(traceback.format_exc())
 
     def __iter__(self):
-        """Return an iterator over the scoping ids."""       
+        """Return an iterator over the scoping ids."""
         return self.ids.__iter__()
 
     def __getitem__(self, key):

src/ansys/dpf/core/server.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 """
-Server
+Server.
 
 Contains the directives necessary to start the DPF server.
 """
@@ -53,6 +53,7 @@
 
 
 def shutdown_global_server():
+    """Shut down the global DPF server."""
     try:
         if dpf.core.SERVER is not None:
             dpf.core.SERVER = None
@@ -103,7 +104,7 @@ def _global_server() -> BaseServer:
 
 
 def set_server_configuration(server_config: ServerConfig) -> None:
-    """Sets, for the current python session, the default type of DPF server to use.
+    """Set the default type of DPF server to use for the current python session, .
 
     Parameters
     ----------
@@ -399,7 +400,7 @@ def connect():
 
 
 def get_or_create_server(server: BaseServer) -> Union[BaseServer, None]:
-    """Returns the given server or if None, creates a new one.
+    """Return the given server or if None, creates a new one.
 
     Parameters
     ----------
@@ -415,7 +416,7 @@ def get_or_create_server(server: BaseServer) -> Union[BaseServer, None]:
 
 
 def available_servers():
-    """Searches all available installed DPF servers on the current machine.
+    """Search all available installed DPF servers on the current machine.
 
     This method binds new functions to the server module, which helps to choose the appropriate version.
 

src/ansys/dpf/core/server_context.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 """
-ServerContext
+ServerContext.
 
 Gives the ability to choose the context with which the server should be started.
 The context allows you to choose the licensing logic for operators.
@@ -43,6 +43,8 @@
 
 
 class LicensingContextType(Enum):
+    """Enum representing different types of licensing contexts."""
+
     none = 5
     premium = 1
     """Checks if at least one license increment exists
@@ -52,10 +54,33 @@ class LicensingContextType(Enum):
     and does not allow operators to block an increment."""
 
     def __int__(self):
+        """
+        Return the integer values of the licensing context.
+
+        Returns
+        -------
+        int
+            Integer values corresponding to the licensing context.
+        """
         return self.value
 
     @staticmethod
     def same_licensing_context(first, second):
+        """
+        Determine if two licensing contexts are compatible.
+
+        Parameters
+        ----------
+        first : LicensingContextType
+            The first licensing context to compare.
+        second : LicensingContextType
+            The second licensing context to compare.
+
+        Returns
+        -------
+        bool
+            True if the licensing contexts are compatible, False otherwise.
+        """
         if (first == LicensingContextType.none and second != LicensingContextType.none) or (
             first != LicensingContextType.none and second == LicensingContextType.none
         ):
@@ -73,6 +98,7 @@ def same_licensing_context(first, second):
 
 class LicenseContextManager:
     """Can optionally be used to check out a license before using licensed DPF Operators.
+
     Improves performance if you are using multiple Operators that require licensing.
     It can also be used to force checkout before running a script when few
     Ansys license increments are available.
@@ -152,13 +178,45 @@ def release_data(self):
         self._license_checkout_operator = None
 
     def __enter__(self):
+        """
+        Enter the runtime context for the license context manager.
+
+        This method is called when the object is used within a `with` statement.
+        It ensures that the license is checked out before the operations within the context block are executed.
+
+        Returns
+        -------
+        LicenseContextManager
+            The current instance of the license context manager.
+        """
         return self
 
     def __exit__(self, type, value, tb):
+        """
+        Exit the runtime context for the license context manager.
+
+        This method is called at the end of a `with` statement. It ensures
+        that the license is checked in and any resources allocated are released.
+
+        Parameters
+        ----------
+        type : type or None
+            The exception type, if an exception occurred within the context block, or None otherwise.
+        value : Exception or None
+            The exception instance, if an exception occurred within the context block, or None otherwise.
+        tb : traceback or None
+            The traceback object, if an exception occurred within the context block, or None otherwise.
+
+        Returns
+        -------
+        bool
+            If True, suppresses the exception. Otherwise, the exception is propagated.
+        """
         if tb is None:
             self.release_data()
 
     def __del__(self):
+        """Release the license when the instance is deleted."""
         self.release_data()
         pass
 
@@ -176,6 +234,7 @@ def status(self):
 
 class ServerContext:
     """The context defines whether DPF capabilities requiring a license checkout are allowed.
+
     xml_path argument won't be taken into account if using LicensingContextType.entry.
 
     Parameters
@@ -211,13 +270,15 @@ def xml_path(self):
         return self._xml_path
 
     def __str__(self):
+        """Return string representation of the ServerContext instance."""
         return (
             f"Server Context of type {self.licensing_context_type}"
             f" with {'no' if len(self.xml_path) == 0 else ''} xml path"
             f"{'' if len(self.xml_path) == 0 else ': ' + self.xml_path}"
         )
 
     def __eq__(self, other):
+        """Compare two ServerContext instances for equality."""
         if not isinstance(other, ServerContext):
             return False
         return os.path.normpath(self.xml_path) == os.path.normpath(
@@ -227,6 +288,7 @@ def __eq__(self, other):
         )
 
     def __ne__(self, other):
+        """Check that two server contexts are not equal."""
         return not self == other
 
 
@@ -266,8 +328,9 @@ class AvailableServerContexts:
 
 
 def set_default_server_context(context=AvailableServerContexts.premium) -> None:
-    """Sets this context as default for any new server. Also applies it to
-    the global server if it is running as Entry and requested context is Premium.
+    """Set this context as default for any new server.
+
+    Also applies it to the global server if it is running as Entry and requested context is Premium.
 
     The context enables to choose whether DPF capabilities requiring a license checkout are allowed.