feat: call .name() if it's a SettingsBase + Path support

doc/changelog.d/4932.added.md

@@ -0,0 +1 @@
+Call .name if it's a SettingsBase + Path support

src/ansys/fluent/core/codegen/settingsgen.py

@@ -188,13 +188,13 @@ def _get_unique_name(name):
     "Integer": "int",
     "Real": "float | str",
     "String": "str",
-    "Filename": "str",
+    "Filename": "PathType",
     "BooleanList": "list[bool]",
     "IntegerList": "list[int]",
     "RealVector": "tuple[float | str, float | str, float | str]",
     "RealList": "list[float | str]",
     "StringList": "list[str]",
-    "FilenameList": "list[str]",
+    "FilenameList": "list[PathType]",
 }
 
 
@@ -381,6 +381,7 @@ def generate(version: str, static_infos: dict, verbose: bool = False) -> None:
         header.write("# This is an auto-generated file.  DO NOT EDIT!\n")
         header.write("#\n")
         header.write("\n")
+        header.write("from ansys.fluent.core._types import PathType\n")
         header.write("from ansys.fluent.core.solver.flobject import *\n\n")
         header.write("from ansys.fluent.core.solver.flobject import (\n")
         header.write("    _ChildNamedObjectAccessorMixin,\n")

src/ansys/fluent/core/solver/flobject.py

@@ -40,7 +40,8 @@
 
 from __future__ import annotations
 
-import collections
+import collections.abc
+from collections.abc import Sequence
 from contextlib import contextmanager, nullcontext
 import fnmatch
 import hashlib
@@ -54,13 +55,15 @@
 import sys
 import types
 from typing import (
+    TYPE_CHECKING,
     Any,
     Callable,
     Dict,
     ForwardRef,
     Generic,
     List,
     NewType,
+    Protocol,
     Tuple,
     TypeVar,
     Union,
@@ -71,6 +74,9 @@
 import warnings
 import weakref
 
+from typing_extensions import override
+
+from ansys.fluent.core._types import PathType
 from ansys.fluent.core.pyfluent_warnings import (
     PyFluentDeprecationWarning,
     PyFluentUserWarning,
@@ -673,24 +679,36 @@ def units(self) -> str | None:
         return get_si_unit_for_fluent_quantity(quantity)
 
 
+class SettingsBaseWithName(Protocol):  # pylint: disable=missing-class-docstring
+    __class__: type["SettingsBase"]  # pyright: ignore[reportIncompatibleMethodOverride]
+    name: Callable[[], str]
+
+
 class Textual(Property):
     """Exposes attribute accessor on settings object - specific to string objects."""
 
-    def set_state(self, state: StateT | None = None, **kwargs):
+    def set_state(
+        self,
+        state: str | VariableDescriptor | SettingsBaseWithName | None = None,
+        **kwargs,
+    ):
         """Set the state of the object.
 
         Parameters
         ----------
         state
-            Either str or VariableDescriptor.
+            Either str, settings object with a ``name()`` method or VariableDescriptor.
         kwargs : Any
             Keyword arguments.
 
         Raises
         ------
         TypeError
-            If state is not a string.
+            If state is not an appropriate type.
         """
+        if isinstance(state, SettingsBase) and hasattr(state, "name"):
+            state = state.name()
+
         allowed_types = (str, VariableDescriptor)
 
         if not isinstance(state, allowed_types):
@@ -943,11 +961,17 @@ class String(SettingsBase[str], Textual):
     set_state = Textual.set_state
 
 
-class Filename(SettingsBase[str], Textual):
+class Filename(SettingsBase[PathType], Textual):
     """A ``Filename`` object representing a file name."""
 
     _state_type = str
 
+    @override
+    def set_state(self, state: PathType | None = None, **kwargs):
+        if state is not None:
+            state = os.fspath(state)
+        return super().set_state(state, **kwargs)
+
     def file_purpose(self):
         """Specifies whether this file is used as input or output by Fluent."""
         return self.get_attr(_InlineConstants.file_purpose)
@@ -958,6 +982,16 @@ class FilenameList(SettingsBase[StringListType], Textual):
 
     _state_type = StringListType
 
+    if TYPE_CHECKING:
+
+        @override
+        def set_state(self, state: Sequence[PathType] | None = None, **kwargs): ...
+
+    @override
+    def set_state(self, state: Sequence[PathType] | None = None, **kwargs):
+        if state is not None:
+            state = [os.fspath(path) for path in state]
+        return super().set_state(state, **kwargs)
     def file_purpose(self):
         """Specifies whether this file is used as input or output by Fluent."""
         return self.get_attr(_InlineConstants.file_purpose)