ansys-fluent-core 0.20.dev8__py3-none-any.whl → 0.20.dev10__py3-none-any.whl

ansys/fluent/core/meta.py

@@ -13,6 +13,8 @@ from ansys.fluent.core.exceptions import DisallowedValuesError, InvalidArgument
 
 
 class Attribute:
+    """Attributes."""
+
     VALID_NAMES = [
         "range",
         "allowed_values",
@@ -57,6 +59,8 @@ class Attribute:
 
 
 class Command:
+    """Executes command."""
+
     def __init__(self, method):
         self.arguments_attrs = {}
         cmd_args = inspect.signature(method).parameters
@@ -137,6 +141,8 @@ class Command:
 
 
 def CommandArgs(command_object, argument_name):
+    """Command arguments."""
+
     def wrapper(attribute):
         if argument_name in command_object.arguments_attrs:
             command_object.arguments_attrs[argument_name].update(
@@ -150,6 +156,8 @@ def CommandArgs(command_object, argument_name):
 
 
 class PyLocalBaseMeta(type):
+    """Local base metaclass."""
+
     @classmethod
     def __create_get_ancestors_by_type(cls):
         def wrapper(self, obj_type, obj=None):
@@ -613,6 +621,8 @@ class PyLocalObjectMeta(PyLocalBaseMeta):
 
 
 class PyLocalCommandMeta(PyLocalObjectMeta):
+    """Local object metaclass."""
+
     @classmethod
     def __create_init(cls):
         def wrapper(self, parent, api_helper, name=""):
@@ -720,6 +730,8 @@ class PyLocalNamedObjectMeta(PyLocalObjectMeta):
 
 
 class PyLocalNamedObjectMetaAbstract(ABCMeta, PyLocalNamedObjectMeta):
+    """Local named object abstract metaclass."""
+
     pass
 
 
@@ -830,6 +842,7 @@ class PyLocalContainer(MutableMapping):
         return self.get_session_handle()
 
     def get_root(self, obj=None):
+        """Get root object."""
         obj = self if obj is None else obj
         parent = obj
         if getattr(obj, "_parent", None):
@@ -837,20 +850,24 @@ class PyLocalContainer(MutableMapping):
         return parent
 
     def get_session(self, obj=None):
+        """Get session object."""
         root = self.get_root(obj)
         return root.session
 
     def get_path(self):
+        """Get parent path."""
         if getattr(self, "_parent", None):
             return self._parent.get_path() + "/" + self._name
         return self._name
 
     @property
     def path(self):
+        """Get path."""
         return self.get_path()
 
     @property
     def session(self):
+        """Get session object."""
         return self.get_session()
 
     def __iter__(self):
@@ -893,18 +910,25 @@ class PyLocalContainer(MutableMapping):
         return unique_name
 
     class Delete(metaclass=PyLocalCommandMeta):
+        """Local delete command."""
+
         def _exe_cmd(self, names):
             for item in names:
                 self._parent.__delitem__(item)
 
         class names(metaclass=PyLocalPropertyMeta):
+            """Local names property."""
+
             value: List[str] = []
 
             @Attribute
             def allowed_values(self):
+                """Get allowed values."""
                 return list(self._parent._parent)
 
     class Create(metaclass=PyLocalCommandMeta):
+        """Local create command."""
+
         def _exe_cmd(self, name=None):
             if name is None:
                 name = self._parent._get_unique_chid_name()
@@ -912,4 +936,6 @@ class PyLocalContainer(MutableMapping):
             return new_object._name
 
         class name(metaclass=PyLocalPropertyMeta):
+            """Local name property."""
+
             value: str = None

ansys/fluent/core/post_objects/post_helper.py

@@ -1,3 +1,5 @@
+"""Provides a module for post objects."""
+
 import re
 
 

ansys/fluent/core/post_objects/post_object_definitions.py

@@ -230,6 +230,7 @@ class SurfaceDefn(GraphicsDefn):
 
             @Attribute
             def is_active(self):
+                """Check whether current object is active or not."""
                 return self._parent.type() == "plane-surface"
 
             class creation_method(metaclass=PyLocalPropertyMeta):
@@ -247,6 +248,7 @@ class SurfaceDefn(GraphicsDefn):
 
                 @Attribute
                 def is_active(self):
+                    """Check whether current object is active or not."""
                     return self._parent.creation_method() == "xy-plane"
 
                 class z(metaclass=PyLocalPropertyMeta):
@@ -266,6 +268,7 @@ class SurfaceDefn(GraphicsDefn):
 
                 @Attribute
                 def is_active(self):
+                    """Check whether current object is active or not."""
                     return self._parent.creation_method() == "yz-plane"
 
                 class x(metaclass=PyLocalPropertyMeta):
@@ -285,6 +288,7 @@ class SurfaceDefn(GraphicsDefn):
 
                 @Attribute
                 def is_active(self):
+                    """Check whether current object is active or not."""
                     return self._parent.creation_method() == "zx-plane"
 
                 class y(metaclass=PyLocalPropertyMeta):
@@ -304,6 +308,7 @@ class SurfaceDefn(GraphicsDefn):
 
             @Attribute
             def is_active(self):
+                """Check whether current object is active or not."""
                 return self._parent.type() == "iso-surface"
 
             class field(metaclass=PyLocalPropertyMeta):
@@ -444,6 +449,7 @@ class ContourDefn(GraphicsDefn):
 
             @Attribute
             def is_active(self):
+                """Check whether current object is active or not."""
                 return self._parent.option() == "auto-range-on"
 
             class global_range(metaclass=PyLocalPropertyMeta):
@@ -456,6 +462,7 @@ class ContourDefn(GraphicsDefn):
 
             @Attribute
             def is_active(self):
+                """Check whether current object is active or not."""
                 return self._parent.option() == "auto-range-off"
 
             class clip_to_range(metaclass=PyLocalPropertyMeta):
@@ -595,6 +602,7 @@ class VectorDefn(GraphicsDefn):
 
             @Attribute
             def is_active(self):
+                """Check whether current object is active or not."""
                 return self._parent.option() == "auto-range-on"
 
             class global_range(metaclass=PyLocalPropertyMeta):
@@ -607,6 +615,7 @@ class VectorDefn(GraphicsDefn):
 
             @Attribute
             def is_active(self):
+                """Check whether current object is active or not."""
                 return self._parent.option() == "auto-range-off"
 
             class clip_to_range(metaclass=PyLocalPropertyMeta):

ansys/fluent/core/post_objects/post_objects_container.py

@@ -47,6 +47,7 @@ class Container:
         )
 
     def get_path(self):
+        """Get container path."""
         return self._path
 
     @property
@@ -55,6 +56,7 @@ class Container:
         return "object"
 
     def update(self, value):
+        """Update the value."""
         for name, val in value.items():
             o = getattr(self, name)
             o.update(val)

ansys/fluent/core/services/__init__.py

@@ -1,3 +1,5 @@
+"""Provides a module to create gRPC services."""
+
 from ansys.fluent.core.services.batch_ops import BatchOpsService
 from ansys.fluent.core.services.datamodel_se import (
     DatamodelService as DatamodelService_SE,
@@ -37,8 +39,11 @@ _service_cls_by_name = {
 
 
 class service_creator:
+    """A gRPC service creator."""
+
     def __init__(self, service_name: str):
         self._service_cls = _service_cls_by_name[service_name]
 
     def create(self, *args, **kwargs):
+        """Create a gRPC service."""
         return self._service_cls(*args, **kwargs)

ansys/fluent/core/services/api_upgrade.py

@@ -1,3 +1,5 @@
+"""Provides a module for the API upgrade advisor."""
+
 import os
 from typing import TypeVar
 
@@ -8,6 +10,8 @@ _TApiUpgradeAdvisor = TypeVar("_TApiUpgradeAdvisor", bound="ApiUpgradeAdvisor")
 
 
 class ApiUpgradeAdvisor:
+    """API upgrade advisor."""
+
     def __init__(self, scheme_eval: SchemeEval, version: str, mode: str) -> None:
         self._scheme_eval = scheme_eval.scheme_eval
         self._version = version

ansys/fluent/core/services/datamodel_se.py

@@ -88,6 +88,13 @@ class UnsubscribeEventError(RuntimeError):
         super().__init__(f"Failed to unsubscribe event: {request}!")
 
 
+class ReadOnlyObjectError(RuntimeError):
+    """Raised on an attempt to mutate a read-only object."""
+
+    def __init__(self, obj_name):
+        super().__init__(f"{obj_name} is readonly!")
+
+
 class Attribute(Enum):
     """Contains the standard names of data model attributes associated with the data
     model service."""
@@ -226,11 +233,16 @@ class DatamodelServiceImpl:
         """createCommandArguments RPC of DataModel service."""
         return self._stub.createCommandArguments(request, metadata=self._metadata)
 
-    # pylint: disable=missing-raises-doc
     def delete_command_arguments(
         self, request: DataModelProtoModule.DeleteCommandArgumentsRequest
     ) -> DataModelProtoModule.DeleteCommandArgumentsResponse:
-        """deleteCommandArguments RPC of DataModel service."""
+        """deleteCommandArguments RPC of DataModel service.
+
+        Raises
+        ------
+        RuntimeError
+            If command instancing is not supported.
+        """
         try:
             return self._stub.deleteCommandArguments(request, metadata=self._metadata)
         except grpc.RpcError as ex:
@@ -382,6 +394,7 @@ class DatamodelService(StreamingService):
         self.file_transfer_service = file_transfer_service
 
     def get_attribute_value(self, rules: str, path: str, attribute: str) -> _TValue:
+        """Get attribute value."""
         request = DataModelProtoModule.GetAttributeValueRequest(
             rules=rules, path=path, attribute=attribute
         )
@@ -389,11 +402,13 @@ class DatamodelService(StreamingService):
         return _convert_variant_to_value(response.result)
 
     def get_state(self, rules: str, path: str) -> _TValue:
+        """Get state."""
         request = DataModelProtoModule.GetStateRequest(rules=rules, path=path)
         response = self._impl.get_state(request)
         return _convert_variant_to_value(response.state)
 
     def get_object_names(self, rules: str, path: str) -> list[str]:
+        """Get object names."""
         request = DataModelProtoModule.GetObjectNamesRequest()
         request.rules = rules
         request.path = path
@@ -401,6 +416,7 @@ class DatamodelService(StreamingService):
         return response.names
 
     def rename(self, rules: str, path: str, new_name: str) -> None:
+        """Rename an object."""
         request = DataModelProtoModule.RenameRequest()
         request.rules = rules
         request.path = path
@@ -411,6 +427,7 @@ class DatamodelService(StreamingService):
     def delete_child_objects(
         self, rules: str, path: str, obj_type: str, child_names: list[str]
     ) -> None:
+        """Delete child objects."""
         request = DataModelProtoModule.DeleteChildObjectsRequest()
         request.rules = rules
         request.path = path + "/" + obj_type
@@ -420,6 +437,7 @@ class DatamodelService(StreamingService):
         self._impl.delete_child_objects(request)
 
     def delete_all_child_objects(self, rules: str, path: str, obj_type: str) -> None:
+        """Delete all child objects."""
         request = DataModelProtoModule.DeleteChildObjectsRequest()
         request.rules = rules
         request.path = path + "/" + obj_type
@@ -428,6 +446,7 @@ class DatamodelService(StreamingService):
         self._impl.delete_child_objects(request)
 
     def set_state(self, rules: str, path: str, state: _TValue) -> None:
+        """Set state."""
         request = DataModelProtoModule.SetStateRequest(
             rules=rules, path=path, wait=True
         )
@@ -435,6 +454,7 @@ class DatamodelService(StreamingService):
         self._impl.set_state(request)
 
     def fix_state(self, rules, path) -> None:
+        """Fix state."""
         request = DataModelProtoModule.FixStateRequest()
         request.rules = rules
         request.path = convert_path_to_se_path(path)
@@ -443,6 +463,7 @@ class DatamodelService(StreamingService):
     def update_dict(
         self, rules: str, path: str, dict_state: dict[str, _TValue]
     ) -> None:
+        """Update the dict."""
         request = DataModelProtoModule.UpdateDictRequest(
             rules=rules, path=path, wait=True
         )
@@ -450,6 +471,7 @@ class DatamodelService(StreamingService):
         self._impl.update_dict(request)
 
     def delete_object(self, rules: str, path: str) -> None:
+        """Delete an object."""
         request = DataModelProtoModule.DeleteObjectRequest(
             rules=rules, path=path, wait=True
         )
@@ -458,6 +480,7 @@ class DatamodelService(StreamingService):
     def execute_command(
         self, rules: str, path: str, command: str, args: dict[str, _TValue]
     ) -> _TValue:
+        """Execute the command."""
         request = DataModelProtoModule.ExecuteCommandRequest(
             rules=rules, path=path, command=command, wait=True
         )
@@ -468,6 +491,7 @@ class DatamodelService(StreamingService):
     def execute_query(
         self, rules: str, path: str, query: str, args: dict[str, _TValue]
     ) -> _TValue:
+        """Execute the query."""
         request = DataModelProtoModule.ExecuteQueryRequest(
             rules=rules, path=path, query=query
         )
@@ -476,6 +500,7 @@ class DatamodelService(StreamingService):
         return _convert_variant_to_value(response.result)
 
     def create_command_arguments(self, rules: str, path: str, command: str) -> str:
+        """Create command arguments."""
         request = DataModelProtoModule.CreateCommandArgumentsRequest(
             rules=rules, path=path, command=command
         )
@@ -485,6 +510,7 @@ class DatamodelService(StreamingService):
     def delete_command_arguments(
         self, rules: str, path: str, command: str, commandid: str
     ) -> None:
+        """Delete command arguments."""
         request = DataModelProtoModule.DeleteCommandArgumentsRequest(
             rules=rules, path=path, command=command, commandid=commandid
         )
@@ -495,6 +521,7 @@ class DatamodelService(StreamingService):
         rules: str,
         path: str,
     ) -> dict[str, Any]:
+        """Get specifications."""
         request = DataModelProtoModule.GetSpecsRequest(
             rules=rules,
             path=path,
@@ -504,12 +531,14 @@ class DatamodelService(StreamingService):
         )
 
     def get_static_info(self, rules: str) -> dict[str, Any]:
+        """Get static info."""
         request = DataModelProtoModule.GetStaticInfoRequest(rules=rules)
         return MessageToDict(
             self._impl.get_static_info(request).info, use_integers_for_enums=True
         )
 
     def subscribe_events(self, request_dict: dict[str, Any]) -> dict[str, Any]:
+        """Subscribe events."""
         request = DataModelProtoModule.SubscribeEventsRequest()
         ParseDict(request_dict, request)
         return [
@@ -518,6 +547,7 @@ class DatamodelService(StreamingService):
         ]
 
     def unsubscribe_events(self, tags: list[str]) -> dict[str, Any]:
+        """Unsubscribe events."""
         request = DataModelProtoModule.UnsubscribeEventsRequest()
         request.tag[:] = tags
         return [
@@ -534,6 +564,7 @@ class DatamodelService(StreamingService):
     def add_on_child_created(
         self, rules: str, path: str, child_type: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on child created."""
         request_dict = {
             "eventrequest": [
                 {
@@ -552,6 +583,7 @@ class DatamodelService(StreamingService):
     def add_on_deleted(
         self, rules: str, path: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on deleted."""
         request_dict = {
             "eventrequest": [
                 {
@@ -567,6 +599,7 @@ class DatamodelService(StreamingService):
     def add_on_changed(
         self, rules: str, path: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on changed."""
         request_dict = {
             "eventrequest": [
                 {
@@ -582,6 +615,7 @@ class DatamodelService(StreamingService):
     def add_on_affected(
         self, rules: str, path: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on affected."""
         request_dict = {
             "eventrequest": [
                 {
@@ -597,6 +631,7 @@ class DatamodelService(StreamingService):
     def add_on_affected_at_type_path(
         self, rules: str, path: str, child_type: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on affected at type path."""
         request_dict = {
             "eventrequest": [
                 {
@@ -615,6 +650,7 @@ class DatamodelService(StreamingService):
     def add_on_command_executed(
         self, rules: str, path: str, command: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on command executed."""
         request_dict = {
             "eventrequest": [
                 {
@@ -633,6 +669,7 @@ class DatamodelService(StreamingService):
     def add_on_attribute_changed(
         self, rules: str, path: str, attribute: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on attribute changed."""
         request_dict = {
             "eventrequest": [
                 {
@@ -651,6 +688,7 @@ class DatamodelService(StreamingService):
     def add_on_command_attribute_changed(
         self, rules: str, path: str, command: str, attribute: str, obj, cb: Callable
     ) -> EventSubscription:
+        """Add on command attribute changed."""
         request_dict = {
             "eventrequest": [
                 {
@@ -744,6 +782,7 @@ class PyStateContainer(PyCallableStateObject):
         return self.service.get_state(self.rules, convert_path_to_se_path(self.path))
 
     def get_state(self) -> Any:
+        """Get state."""
         if pyfluent.DATAMODEL_USE_STATE_CACHE:
             state = DataModelCache.get_state(self.rules, self, NameKey.DISPLAY)
             if DataModelCache.is_unassigned(state):
@@ -755,12 +794,28 @@ class PyStateContainer(PyCallableStateObject):
     getState = get_state
 
     def fix_state(self) -> None:
+        """Fix state."""
         self.service.fix_state(self.rules, self.path)
 
     fixState = fix_state
 
     def set_state(self, state: Optional[Any] = None, **kwargs) -> None:
-        """Set state of the current object."""
+        """Set state of the current object.
+
+        Parameters
+        ----------
+        state : Any, optional
+            state
+        kwargs : Any
+            Keyword arguments.
+
+        Raises
+        ------
+        ReadOnlyObjectError
+            If the object is read-only.
+        """
+        if self.get_attr(Attribute.IS_READ_ONLY.value):
+            raise ReadOnlyObjectError(type(self).__name__)
         self.service.set_state(
             self.rules, convert_path_to_se_path(self.path), kwargs or state
         )
@@ -877,6 +932,13 @@ class PyStateContainer(PyCallableStateObject):
             self.rules, convert_path_to_se_path(self.path), command, attribute, self, cb
         )
 
+    def __dir__(self):
+        dir_list = set(list(self.__dict__.keys()) + dir(type(self)))
+        if self.get_attr(Attribute.IS_READ_ONLY.value):
+            dir_list = dir_list - {"setState", "set_state"}
+
+        return sorted(dir_list)
+
 
 class PyMenu(PyStateContainer):
     """Object class using StateEngine based DatamodelService as backend. Use this class
@@ -934,6 +996,7 @@ class PyMenu(PyStateContainer):
         raise AttributeError("This method is yet to be implemented in pyfluent.")
 
     def delete_child(self) -> None:
+        """Delete child object."""
         self._raise_method_not_yet_implemented_exception()
 
     def rename(self, new_name: str) -> None:
@@ -1152,6 +1215,7 @@ class PyTextual(PyParameter):
     """Provides interface for textual parameters."""
 
     def allowed_values(self) -> list[str]:
+        """Get allowed values."""
         return self.get_attr(Attribute.ALLOWED_VALUES.value)
 
 
@@ -1193,13 +1257,27 @@ class PyDictionary(PyParameter):
         ----------
         dict_state : dict[str, Any]
             Incoming dict state
+
+        Raises
+        ------
+        ReadOnlyObjectError
+            If the object is read-only.
         """
+        if self.get_attr(Attribute.IS_READ_ONLY.value):
+            raise ReadOnlyObjectError(type(self).__name__)
         self.service.update_dict(
             self.rules, convert_path_to_se_path(self.path), dict_state
         )
 
     updateDict = update_dict
 
+    def __dir__(self):
+        dir_list = set(list(self.__dict__.keys()) + dir(type(self)))
+        if self.get_attr(Attribute.IS_READ_ONLY.value):
+            dir_list = dir_list - {"updateDict", "update_dict"}
+
+        return sorted(dir_list)
+
 
 class PyNamedObjectContainer:
     """Container class using the StateEngine-based DatamodelService as the backend. Use
@@ -1475,10 +1553,12 @@ class PyCommand:
             pass
 
     def before_execute(self, value):
+        """Executes before command execution."""
         if hasattr(self, "_do_before_execute"):
             self._do_before_execute(value)
 
     def after_execute(self, value):
+        """Executes after command execution."""
         if hasattr(self, "_do_after_execute"):
             self._do_after_execute(value)
 
@@ -1549,7 +1629,7 @@ class PyCommand:
                 self.command,
                 self.path.copy(),
                 id,
-                static_info["args"],
+                static_info.get("args"),
             )
         except RuntimeError:
             logger.warning(
@@ -1632,6 +1712,7 @@ class PyCommandArgumentsSubItem(PyCallableStateObject):
     getAttribValue = get_attr
 
     def help(self) -> None:
+        """Get help."""
         pass
 
 

ansys/fluent/core/services/datamodel_tui.py

@@ -136,6 +136,7 @@ class DatamodelService:
     def get_attribute_value(
         self, path: str, attribute: str, include_unavailable: bool
     ) -> Any:
+        """Get the attribute value."""
         request = DataModelProtoModule.GetAttributeValueRequest()
         request.path = path
         request.attribute = DataModelProtoModule.Attribute.Value(attribute.upper())
@@ -145,6 +146,7 @@ class DatamodelService:
         return _convert_gvalue_to_value(response.value)
 
     def execute_command(self, path: str, *args, **kwargs) -> Any:
+        """Execute the command."""
         request = DataModelProtoModule.ExecuteCommandRequest()
         request.path = path
         if kwargs:
@@ -155,6 +157,7 @@ class DatamodelService:
         return self._impl.execute_command(request)
 
     def execute_query(self, path: str, *args, **kwargs) -> Any:
+        """Execute the query."""
         request = DataModelProtoModule.ExecuteQueryRequest()
         request.path = path
         if kwargs:
@@ -165,6 +168,7 @@ class DatamodelService:
         return self._impl.execute_query(request)
 
     def get_static_info(self, path: str):
+        """Get static info."""
         request = DataModelProtoModule.GetStaticInfoRequest()
         request.path = path
         response = self._impl.get_static_info(request)