feat: add get and create methods and **kwargs support for create

doc/changelog.d/4866.added.md

@@ -0,0 +1 @@
+Add get and create methods and **kwarg support for create

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

@@ -1389,7 +1389,7 @@ def to_python_keys(cls, value):
     query_names = []
     _child_aliases = {}
 
-    def _create_child_object(self, cname: str):
+    def _create_child_object(self, cname: str, **kwargs: Any):
         ret = self._objects.get(cname)
         if not ret:
             cls = self.__class__.child_object_type
@@ -1399,6 +1399,7 @@ def _create_child_object(self, cname: str):
             "rename",
             types.MethodType(lambda obj, name: _rename(self, name, cname), ret),
         )
+        ret.set_state(kwargs)
         return ret
 
     def _update_objects(self):
@@ -1451,7 +1452,7 @@ def get_object_names(self):
         obj_names_list = obj_names if isinstance(obj_names, list) else list(obj_names)
         return obj_names_list
 
-    def __getitem__(self, name: str) -> ChildTypeT:
+    def __getitem__(self, name: str, **kwargs: Any) -> ChildTypeT:
         if name not in self.get_object_names():
             if self.flproxy.has_wildcard(name):
                 child_cls = self.__class__.child_object_type
@@ -1473,7 +1474,7 @@ def __getitem__(self, name: str) -> ChildTypeT:
 
         obj = self._objects.get(name)
         if not obj:
-            obj = self._create_child_object(name)
+            obj = self._create_child_object(name, **kwargs)
         return obj
 
     def get(self, name: str) -> ChildTypeT:
@@ -1843,7 +1844,8 @@ def execute_command(self, *args, **kwds):
             and isinstance(self._parent, NamedObject)
             and ret in self._parent
         ):
-            return self._parent[ret]
+            child_attributes = {k: v for k, v in kwds.items() if k != "name"}
+            return self._parent.__getitem__(ret, **child_attributes)
         return_t = getattr(self, "return_type", None)
         if return_t:
             base_t = _baseTypes.get(return_t)

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

@@ -22,7 +22,9 @@
 
 """Base classes for builtin setting classes."""
 
-from typing import Protocol, runtime_checkable
+from typing import Any, Protocol, runtime_checkable
+
+from typing_extensions import Self
 
 from ansys.fluent.core.solver.flobject import (
     InactiveObjectError,
@@ -82,19 +84,32 @@ def _get_settings_obj(settings_root, builtin_settings_obj):
     return obj
 
 
-def _initialize_settings(instance, defaults: dict, settings_source=None, **kwargs):
-    active_session = _get_active_session()
-    instance.__dict__.update(defaults | kwargs)
-    if settings_source is not None:
-        instance.settings_source = settings_source
-    elif active_session:
-        instance.settings_source = active_session
-
-
-class _SingletonSetting:
+class _SettingsObjectMixin:
+    def __init__(self, defaults: dict, settings_source: SettingsBase | Solver | None = None, **kwargs: Any):
+        active_session = _get_active_session()
+        self.__dict__.update(defaults | kwargs)
+        if settings_source is not None:
+            self.settings_source = settings_source
+        elif active_session:
+            self.settings_source = active_session
+
+    @classmethod
+    def get(cls, settings_source: SettingsBase | Solver | None = None, /, *, name: str) -> Self:
+        """Get and return the singleton instance of this object in Fluent.
+
+        Parameters
+        ----------
+        settings_source
+            Something with a ``settings`` attribute. If omitted the active session is assumed from the :func:`using` context manager.
+        name
+            Name of the object to get, if applicable, can be a wildcard pattern.
+        """
+        return cls(settings_source=settings_source, name=name)
+
+class _SingletonSetting(_SettingsObjectMixin):
     # Covers groups, named-object containers and commands.
     def __init__(self, settings_source: SettingsBase | Solver | None = None, **kwargs):
-        _initialize_settings(self, {"settings_source": None}, settings_source, **kwargs)
+        super().__init__({"settings_source": None}, settings_source, **kwargs)
 
     def __setattr__(self, name, value):
         if name == "settings_source":
@@ -107,13 +122,12 @@ def __setattr__(self, name, value):
             super().__setattr__(name, value)
 
 
-class _NonCreatableNamedObjectSetting:
+
+class _NonCreatableNamedObjectSetting(_SettingsObjectMixin):
     def __init__(
         self, name: str, settings_source: SettingsBase | Solver | None = None, **kwargs
     ):
-        _initialize_settings(
-            self, {"settings_source": None, "name": name}, settings_source, **kwargs
-        )
+        super().__init__({"settings_source": None, "name": name}, settings_source, **kwargs)
 
     def __setattr__(self, name, value):
         if name == "settings_source":
@@ -126,8 +140,7 @@ def __setattr__(self, name, value):
         else:
             super().__setattr__(name, value)
 
-
-class _CreatableNamedObjectSetting:
+class _CreatableNamedObjectSetting(_SettingsObjectMixin):
     def __init__(
         self,
         settings_source: SettingsBase | Solver | None = None,
@@ -137,8 +150,7 @@ def __init__(
     ):
         if name and new_instance_name:
             raise ValueError("Cannot specify both name and new_instance_name.")
-        _initialize_settings(
-            self,
+        super().__init__(
             {
                 "settings_source": None,
                 "name": name,
@@ -148,6 +160,27 @@ def __init__(
             **kwargs,
         )
 
+    @classmethod
+    def create(cls, settings_source: SettingsBase | Solver | None = None, /, name: str | None = None, **kwargs: Any) -> Self:
+        """Create and return an instance of this object in Fluent.
+
+        Parameters
+        ----------
+        settings_source
+            Something with a ``settings`` attribute. If omitted the active session is assumed from the :func:`using` context manager.
+        name
+            Name of the new object to create. If omitted, a default name will be assigned by Fluent.
+        **kwargs
+            Additional attributes to set on the created object. This only works for direct value assignments, not for nested objects.
+        """
+        self = cls(
+            settings_source=settings_source,
+            new_instance_name=name,
+        )
+        self.set_state(kwargs)
+
+        return self
+
     def __setattr__(self, name, value):
         if name == "settings_source":
             settings_root = _get_settings_root(value)

tests/test_builtin_settings.py

@@ -23,6 +23,7 @@
 from pathlib import Path
 import tempfile
 
+from ansys.fluent.core.session_solver import Solver
 import pytest
 
 import ansys.fluent.core as pyfluent
@@ -98,6 +99,12 @@ def test_builtin_settings(mixing_elbow_case_data_session):
     )
     with pytest.raises(TypeError):
         BoundaryCondition(settings_source=solver, new_instance_name="bc-1")
+
+    assert (
+        BoundaryCondition.get(settings_source=solver, name="cold-inlet")
+        == solver.setup.boundary_conditions["cold-inlet"]
+    )
+
     assert (
         VelocityInlets(settings_source=solver)
         == solver.setup.boundary_conditions.velocity_inlet
@@ -368,6 +375,29 @@ def test_builtin_settings(mixing_elbow_case_data_session):
     )
 
 
+@pytest.mark.codegen_required
+def test_builtin_settings_methods(mixing_elbow_case_data_session: Solver):
+    solver = mixing_elbow_case_data_session
+    assert (
+        ReportFile.create(solver, name="report-file-1")
+        == ReportFile.get(solver, name="report-file-1")
+    )
+
+    file = ReportFile.create(solver, name="report-file-2", file_name="foo.out")
+    assert (
+        file
+        == ReportFile.get(solver, name="report-file-2")
+    )
+    assert file.file_name == "foo.out"
+
+    file_2 = ReportFile.create(solver)
+    assert file_2.name()  # it should have a default anonymous name assigned by Fluent
+
+    assert BoundaryCondition.get(
+        solver, name="cold-inlet"
+    )
+
+
 @pytest.mark.codegen_required
 @pytest.mark.fluent_version(">=23.2")
 def test_builtin_singleton_setting_assign_session(