ansys-fluent-core 0.27.dev1__py3-none-any.whl → 0.28.dev0__py3-none-any.whl

ansys/fluent/core/services/datamodel_se.py

@@ -59,6 +59,7 @@ class DisallowedFilePurpose(ValueError):
         name: Any | None = None,
         allowed_values: Any | None = None,
     ):
+        """Initialize DisallowedFilePurpose."""
         super().__init__(
             allowed_name_error_message(
                 context=context, trial_name=name, allowed_values=allowed_values
@@ -70,6 +71,7 @@ class InvalidNamedObject(RuntimeError):
     """Raised when the object is not a named object."""
 
     def __init__(self, class_name):
+        """Initialize InvalidNamedObject."""
         super().__init__(f"{class_name} is not a named object class.")
 
 
@@ -77,6 +79,7 @@ class SubscribeEventError(RuntimeError):
     """Raised when server fails to subscribe from event."""
 
     def __init__(self, request):
+        """Initialize SubscribeEventError."""
         super().__init__(f"Failed to subscribe event: {request}!")
 
 
@@ -84,6 +87,7 @@ class UnsubscribeEventError(RuntimeError):
     """Raised when server fails to unsubscribe from event."""
 
     def __init__(self, request):
+        """Initialize UnsubscribeEventError."""
         super().__init__(f"Failed to unsubscribe event: {request}!")
 
 
@@ -91,6 +95,7 @@ class ReadOnlyObjectError(RuntimeError):
     """Raised on an attempt to mutate a read-only object."""
 
     def __init__(self, obj_name):
+        """Initialize ReadOnlyObjectError."""
         super().__init__(f"{obj_name} is readonly!")
 
 
@@ -137,8 +142,6 @@ class _FilterDatamodelNames:
         if self._filter_fn is None:
             return names
 
-        filtered_children = []
-
         def validate_name(name):
             obj = getattr(parent, name)
             # might need to make this more flexible (e.g., enhanced workflow types)
@@ -177,87 +180,87 @@ class DatamodelServiceImpl:
     def initialize_datamodel(
         self, request: DataModelProtoModule.InitDatamodelRequest
     ) -> DataModelProtoModule.InitDatamodelResponse:
-        """initDatamodel RPC of DataModel service."""
+        """RPC initDatamodel of DataModel service."""
         return self._stub.initDatamodel(request, metadata=self._metadata)
 
     def get_attribute_value(
         self, request: DataModelProtoModule.GetAttributeValueRequest
     ) -> DataModelProtoModule.GetAttributeValueResponse:
-        """getAttributeValue RPC of DataModel service."""
+        """RPC getAttributeValue of DataModel service."""
         return self._stub.getAttributeValue(request, metadata=self._metadata)
 
     def get_state(
         self, request: DataModelProtoModule.GetStateRequest
     ) -> DataModelProtoModule.GetStateResponse:
-        """getState RPC of DataModel service."""
+        """RPC getState of DataModel service."""
         return self._stub.getState(request, metadata=self._metadata)
 
     def rename(
         self, request: DataModelProtoModule.RenameRequest
     ) -> DataModelProtoModule.RenameResponse:
-        """getState RPC of DataModel service."""
+        """RPC rename of DataModel service."""
         return self._stub.rename(request, metadata=self._metadata)
 
     def get_object_names(
         self, request: DataModelProtoModule.GetObjectNamesRequest
     ) -> DataModelProtoModule.GetObjectNamesResponse:
-        """getState RPC of DataModel service."""
+        """RPC getObjectNames of DataModel service."""
         return self._stub.getObjectNames(request, metadata=self._metadata)
 
     def delete_child_objects(
         self, request: DataModelProtoModule.DeleteChildObjectsRequest
     ) -> DataModelProtoModule.DeleteChildObjectsResponse:
-        """getState RPC of DataModel service."""
+        """RPC deleteChildObjects of DataModel service."""
         return self._stub.deleteChildObjects(request, metadata=self._metadata)
 
     def set_state(
         self, request: DataModelProtoModule.SetStateRequest
     ) -> DataModelProtoModule.SetStateResponse:
-        """setState RPC of DataModel service."""
+        """RPC setState of DataModel service."""
         return self._stub.setState(request, metadata=self._metadata)
 
     def fix_state(
         self, request: DataModelProtoModule.FixStateRequest
     ) -> DataModelProtoModule.FixStateResponse:
-        """setState RPC of DataModel service."""
+        """RPC fixState of DataModel service."""
         return self._stub.fixState(request, metadata=self._metadata)
 
     def update_dict(
         self, request: DataModelProtoModule.UpdateDictRequest
     ) -> DataModelProtoModule.UpdateDictResponse:
-        """updateDict RPC of DataModel service."""
+        """RPC updateDict of DataModel service."""
         return self._stub.updateDict(request, metadata=self._metadata)
 
     def delete_object(
         self, request: DataModelProtoModule.DeleteObjectRequest
     ) -> DataModelProtoModule.DeleteObjectResponse:
-        """deleteObject RPC of DataModel service."""
+        """RPC deleteObject of DataModel service."""
         return self._stub.deleteObject(request, metadata=self._metadata)
 
     def execute_command(
         self, request: DataModelProtoModule.ExecuteCommandRequest
     ) -> DataModelProtoModule.ExecuteCommandResponse:
-        """executeCommand RPC of DataModel service."""
+        """RPC executeCommand of DataModel service."""
         logger.debug(f"Command: {request.command}")
         return self._stub.executeCommand(request, metadata=self._metadata)
 
     def execute_query(
         self, request: DataModelProtoModule.ExecuteQueryRequest
     ) -> DataModelProtoModule.ExecuteQueryResponse:
-        """ExecuteQuery rpc of DataModel service."""
+        """RPC executeQuery of DataModel service."""
         logger.debug(f"Query: {request.query}")
         return self._stub.executeQuery(request, metadata=self._metadata)
 
     def create_command_arguments(
         self, request: DataModelProtoModule.CreateCommandArgumentsRequest
     ) -> DataModelProtoModule.CreateCommandArgumentsResponse:
-        """createCommandArguments RPC of DataModel service."""
+        """RPC createCommandArguments of DataModel service."""
         return self._stub.createCommandArguments(request, metadata=self._metadata)
 
     def delete_command_arguments(
         self, request: DataModelProtoModule.DeleteCommandArgumentsRequest
     ) -> DataModelProtoModule.DeleteCommandArgumentsResponse:
-        """deleteCommandArguments RPC of DataModel service.
+        """RPC deleteCommandArguments of DataModel service.
 
         Raises
         ------
@@ -276,25 +279,25 @@ class DatamodelServiceImpl:
     def get_specs(
         self, request: DataModelProtoModule.GetSpecsRequest
     ) -> DataModelProtoModule.GetSpecsResponse:
-        """getSpecs RPC of DataModel service."""
+        """RPC getSpecs of DataModel service."""
         return self._stub.getSpecs(request, metadata=self._metadata)
 
     def get_static_info(
         self, request: DataModelProtoModule.GetStaticInfoRequest
     ) -> DataModelProtoModule.GetStaticInfoResponse:
-        """getStaticInfo RPC of DataModel service."""
+        """RPC getStaticInfo of DataModel service."""
         return self._stub.getStaticInfo(request, metadata=self._metadata)
 
     def subscribe_events(
         self, request: DataModelProtoModule.SubscribeEventsRequest
     ) -> DataModelProtoModule.SubscribeEventsResponse:
-        """subscribeEvents RPC of DataModel service."""
+        """RPC subscribeEvents of DataModel service."""
         return self._stub.subscribeEvents(request, metadata=self._metadata)
 
     def unsubscribe_events(
         self, request: DataModelProtoModule.UnsubscribeEventsRequest
     ) -> DataModelProtoModule.UnsubscribeEventsResponse:
-        """unsubscribeEvents RPC of DataModel service."""
+        """RPC unsubscribeEvents of DataModel service."""
         return self._stub.unsubscribeEvents(request, metadata=self._metadata)
 
 
@@ -400,6 +403,7 @@ class SubscriptionList:
     """Stores subscription objects by tag."""
 
     def __init__(self):
+        """Initialize SubscriptionList."""
         self._subscriptions = {}
         self._lock = RLock()
 
@@ -602,7 +606,7 @@ class DatamodelService(StreamingService):
     ) -> None:
         """Update the dict."""
         request = DataModelProtoModule.UpdateDictRequest(
-            rules=rules, path=path, wait=True
+            rules=rules, path=path, wait=True, recursive=recursive
         )
         _convert_value_to_variant(dict_state, request.dicttomerge)
         response = self._impl.update_dict(request)
@@ -1514,9 +1518,12 @@ class PyNamedObjectContainer:
 
     def get_object_names(self) -> Any:
         """Displays the name of objects within a container."""
-        return self.service.get_object_names(
-            self.rules, convert_path_to_se_path(self.path)
-        )
+        if self.service.version <= FluentVersion.v241:
+            return self._get_child_object_display_names()
+        else:
+            return self.service.get_object_names(
+                self.rules, convert_path_to_se_path(self.path)
+            )
 
     getChildObjectDisplayNames = get_object_names
 
@@ -1528,7 +1535,7 @@ class PyNamedObjectContainer:
         int
             Count of child objects.
         """
-        return len(self._get_child_object_display_names())
+        return len(self.get_object_names())
 
     def __iter__(self) -> Iterator[PyMenu]:
         """Return the next child object.
@@ -1538,7 +1545,7 @@ class PyNamedObjectContainer:
         Iterator[PyMenu]
             Iterator of child objects.
         """
-        for name in self._get_child_object_display_names():
+        for name in self.get_object_names():
             child_path = self.path[:-1]
             child_path.append((self.path[-1][0], name))
             yield getattr(self.__class__, f"_{self.__class__.__name__}")(
@@ -1546,7 +1553,7 @@ class PyNamedObjectContainer:
             )
 
     def _get_item(self, key: str) -> PyMenu:
-        if key in self._get_child_object_display_names():
+        if key in self.get_object_names():
             child_path = self.path[:-1]
             child_path.append((self.path[-1][0], key))
             return getattr(self.__class__, f"_{self.__class__.__name__}")(
@@ -1558,7 +1565,7 @@ class PyNamedObjectContainer:
             )
 
     def _del_item(self, key: str) -> None:
-        if key in self._get_child_object_display_names():
+        if key in self.get_object_names():
             child_path = self.path[:-1]
             child_path.append((self.path[-1][0], key))
             se_path = convert_path_to_se_path(child_path)
@@ -2231,13 +2238,13 @@ class PyNamedObjectContainerGeneric(PyNamedObjectContainer):
     available."""
 
     def __iter__(self) -> Iterator[PyMenuGeneric]:
-        for name in self._get_child_object_display_names():
+        for name in self.get_object_names():
             child_path = self.path[:-1]
             child_path.append((self.path[-1][0], name))
             yield PyMenuGeneric(self.service, self.rules, child_path)
 
     def _get_item(self, key: str) -> PyMenuGeneric:
-        if key in self._get_child_object_display_names():
+        if key in self.get_object_names():
             child_path = self.path[:-1]
             child_path.append((self.path[-1][0], key))
             return PyMenuGeneric(self.service, self.rules, child_path)

ansys/fluent/core/services/datamodel_tui.py

@@ -222,6 +222,10 @@ class PyMenu:
 
         Parameters
         ----------
+        *args
+            Positional arguments of the command or qyery.
+        **kwargs
+            Keyword arguments of the command or query.
 
         Returns
         -------
@@ -303,6 +307,7 @@ class TUIMethod:
     """
 
     def __init__(self, service, version, mode, path):
+        """Initialize TUIMethod."""
         self._service = service
         self._version = version
         self._mode = mode
@@ -330,13 +335,13 @@ class TUIMenu:
             for x in PyMenu(
                 self._service, self._version, self._mode, self._path
             ).get_child_names()
-            if x != "exit"
+            if x not in ["exit", "switch_to_meshing_mode"]
         ]
 
     def __getattribute__(self, name) -> Any:
-        if name == "exit" and not self._path:
+        if name in ["exit", "switch_to_meshing_mode"] and not self._path:
             raise AttributeError(
-                f"'{self.__class__.__name__}' object has no attribute 'exit'"
+                f"'{self.__class__.__name__}' object has no attribute '{name}'"
             )
         try:
             attr = super().__getattribute__(name)