fix: example deprecation warnings and improvements #4579

Gobot1234 · 2025-11-03T10:56:24Z

Context

When solver session settings access was deprecated directly on solver the code wasn't updated I've also sprinkled in a couple of small improvements to the examples

Change Summary

Updated all references direct access patterns (solver.setup.models) to the correct settings-based access pattern (solver.settings.setup.models) along with adding PEP 723 styles dependencies to the examples to make them easier to run as standalone scripts.

Rationale

Fixes all the deprecation warnings

Impact

Changes basically everywhere

Co-authored-by: Copilot <[email protected]>

Copilot

Pull Request Overview

This PR fixes deprecation warnings by updating all references from direct solver session settings access (solver.setup.models) to the correct settings-based access pattern (solver.settings.setup.models). Additionally, it adds PEP 723 style dependencies to example scripts and includes minor improvements throughout.

Updates deprecated direct access patterns to settings-based access across all test files and examples
Adds PEP 723 dependency declarations to example scripts for standalone execution
Includes miscellaneous code improvements and cleanups

Reviewed Changes

Copilot reviewed 67 out of 68 changed files in this pull request and generated 4 comments.

File	Description
tests/	Updates test files to use `solver.settings` instead of direct access patterns
examples/	Adds PEP 723 dependency headers and updates deprecated settings access
src/	Updates core library files to use settings-based access pattern
doc/	Updates documentation examples to reflect new access patterns

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

examples/00-fluent/tyler_sofrin_modes.py

examples/00-fluent/modeling_ablation.py

examples/00-fluent/frozen_rotor_workflow.py

Gobot1234 · 2025-11-04T13:35:06Z

Anyone have any opinions on #4512 (review)?

doc/source/user_guide/session/launching_ansys_fluent.rst

seanpearsonuk · 2025-12-03T09:37:17Z

doc/source/user_guide/solver_settings/solver_settings_contents.rst

 -------------------------

-Following the introduction of the new format, the traditional method remains available for those 
+Following the introduction of the new format, the traditional method remains available for those


This sentence is out of place and lacks context:

“Following the introduction of the new format, the traditional method remains available for those who prefer the existing hierarchy.”

It doesn’t belong at the start of this section and should instead be integrated into the previous section—after introducing the new-style API—so that the relationship between the new and existing APIs is clear and non-redundant. The goal is simply to mention that the existing hierarchy-based API remains fully supported and is not deprecated.

Below are suggested rewrites for both sections.

Suggested rewrite for the previous section (new-style API introduction)

To simplify access to solver settings and improve readability, you can now instantiate settings objects directly using a concise constructor-style syntax. This avoids navigating the full hierarchy of solver settings while preserving the same functional capabilities.

<Example>

The traditional hierarchy-based API remains fully supported. The new syntax is an additional, more convenient option and not a replacement.

Suggested rewrite for the Accessing solver settings section

The hierarchy-based settings API continues to be available for users who prefer explicit navigation of the settings structure. For example, when working with string lists that support wildcard expansion:

<Code>

Co-authored-by: Sean Pearson <[email protected]>

examples/00-fluent/DOE_ML.py

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

seanpearsonuk · 2025-12-03T10:04:44Z

@Gobot1234 I made a number of remarks unconnected with the changes but I didn't want to miss the opportunity to fix some badly broken windows. My comments can be addressed either here or subsequently. For any that we do subsequently, we need to generate Issues from the comments.

Copilot

Pull request overview

Copilot reviewed 67 out of 68 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 67 out of 68 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-03T20:51:58Z

tests/test_tui_api.py

+        assert s.split("\n")[-2].split("(")[0] == r"<solver_session>.file.read_case"
+    else:
        assert (
            s.split("\n")[-2].split("(")[0]
            == r"<solver_session>.settings.file.read_case"
        )


The version comparison logic is inverted. For Fluent version >= v251, the assertion expects <solver_session>.file.read_case, but based on the PR description (updating to use solver.settings.*), newer versions should use the .settings. prefix. The conditional branches should be swapped.

Suggested change

assert s.split("\n")[-2].split("(")[0] == r"<solver_session>.file.read_case"

else:

assert (

s.split("\n")[-2].split("(")[0]

== r"<solver_session>.settings.file.read_case"

)

assert (

s.split("\n")[-2].split("(")[0]

== r"<solver_session>.settings.file.read_case"

)

else:

assert s.split("\n")[-2].split("(")[0] == r"<solver_session>.file.read_case"

Copilot · 2025-12-03T20:51:59Z

tests/test_settings_api.py

    solver.tui.file.read_case(case_path)
    timeout_loop(
-        lambda: "<solver_session>.settings.file.read_case" in capsys.readouterr().out,
+        lambda: "<solver_session>.file.read_case" in capsys.readouterr().out,


The assertion checks for the deprecated access pattern <solver_session>.file.read_case instead of the updated pattern <solver_session>.settings.file.read_case. This contradicts the PR's goal of updating to the new API.

Suggested change

lambda: "<solver_session>.file.read_case" in capsys.readouterr().out,

lambda: "<solver_session>.settings.file.read_case" in capsys.readouterr().out,

Copilot · 2025-12-03T20:51:59Z

tests/test_reduction.py

    absolute_pressure_expression.definition = "AbsolutePressure"

-    s1_min = solver1.fields.reduction.minimum(
+    s1_min = solver1.settings.fields.reduction.minimum(


The path solver1.settings.fields.reduction is incorrect. Based on other usage in the codebase, it should be solver1.fields.reduction without the .settings prefix.

Suggested change

s1_min = solver1.settings.fields.reduction.minimum(

s1_min = solver1.fields.reduction.minimum(

Copilot · 2025-12-03T20:51:59Z

examples/00-fluent/brake.py

 # ---------------------------------------------------------------

-session = pyfluent.launch_fluent(precision="double", processor_count=2, version="3d")
+session = pyfluent.launch_fluent(precision="double", processor_count=2, dimension=3)


Changed parameter from version=\"3d\" to dimension=3. Verify that dimension=3 is the correct parameter name and value for specifying 3D mode, as this represents an API change.

examples/00-fluent/DOE_ML.py

Gobot1234 · 2025-12-04T09:19:19Z

@prmukherj / @seanpearsonuk are you okay with the tests that I've had to bump the markers of here?

Copilot

Pull request overview

Copilot reviewed 67 out of 68 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-04T09:24:18Z

tests/test_batch_ops.py



-@pytest.mark.fluent_version(">=24.1")
+@pytest.mark.fluent_version(">=25.1")


The minimum Fluent version requirement was changed from >=24.1 to >=25.1, which may unnecessarily restrict test execution on Fluent 24.x versions where the functionality should still work.

Suggested change

@pytest.mark.fluent_version(">=25.1")

@pytest.mark.fluent_version(">=24.1")

Copilot · 2025-12-04T09:24:18Z

tests/test_reduction.py



-@pytest.mark.fluent_version(">=24.1")
+@pytest.mark.fluent_version(">=25.2")


The minimum Fluent version requirement was changed from >=24.1 to >=25.2. Unless there's a specific feature dependency on 25.2, this unnecessarily restricts test coverage on earlier compatible versions.

Suggested change

@pytest.mark.fluent_version(">=25.2")

@pytest.mark.fluent_version(">=24.2")

Copilot · 2025-12-04T09:24:19Z

tests/test_reduction.py



-@pytest.mark.fluent_version(">=25.1")
+@pytest.mark.fluent_version(">=25.2")


The minimum Fluent version requirement was changed from >=25.1 to >=25.2. This should only be updated if there's a concrete dependency on 25.2 features; otherwise, it reduces test coverage.

Suggested change

@pytest.mark.fluent_version(">=25.2")

@pytest.mark.fluent_version(">=25.1")

Copilot · 2025-12-04T09:24:19Z

examples/00-fluent/tyler_sofrin_modes.py

+import csv
 import math
 import os


The csv import is now placed after the header comment but before other standard library imports (math, os, pathlib). Standard library imports should be grouped together following PEP 8 import ordering guidelines.

Suggested change

import csv

import math

import os

import math

import os

import csv

Copilot

Pull request overview

Copilot reviewed 52 out of 53 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-18T02:23:44Z

examples/00-fluent/external_compressible_flow.py

        "FileName": wing_intermediary_file,
    }
 )



The line meshing_session.upload(wing_intermediary_file) was removed before geo_import.Execute(). If geo_import.Execute() depends on the file being uploaded first, this removal will cause a runtime error. Verify that the file upload is handled elsewhere or is no longer needed.

Suggested change

# Ensure the geometry file is available to the meshing session before import.

meshing_session.upload(wing_intermediary_file)

Copilot · 2025-12-18T02:23:45Z

examples/00-fluent/exhaust_system_settings_api.py

 meshing_session.PartManagement.InputFileChanged(
    FilePath=import_file_name, IgnoreSolidNames=False, PartPerBody=False
 )


The line meshing_session.upload(import_file_name) was removed before calling PartManagement.InputFileChanged(). If the file needs to be uploaded before it can be referenced by FilePath, this will cause a file-not-found error. Confirm that the upload is handled automatically or is unnecessary.

Copilot · 2025-12-18T02:23:45Z

tests/test_flobject.py

+        assert set(solver.results.graphics.contour.command_names) == {
+            "create",
+            "delete",
+            "rename",
+            "list",
+            "list_properties",
+            "make_a_copy",
+            "display",
+            "add_to_graphics",
+            "clear_history",
+        }


Changed from issuperset to exact equality check (==). This is stricter and will fail if Fluent adds new commands in future versions. Consider whether this increased strictness is intentional or if issuperset was more appropriate for forward compatibility.

Copilot · 2025-12-18T02:23:45Z

tests/test_flobject.py

+    assert solver.results.graphics.contour.rename.argument_names == ["new", "old"]
    assert solver.results.graphics.contour.delete.argument_names == ["name_list"]


Changed from set comparison to list comparison. This now checks both the names and their order. Verify that the order of argument names is guaranteed to be stable across Fluent versions, or revert to set comparison if order is not significant.

Suggested change

assert solver.results.graphics.contour.rename.argument_names == ["new", "old"]

assert solver.results.graphics.contour.delete.argument_names == ["name_list"]

assert set(solver.results.graphics.contour.rename.argument_names) == {"new", "old"}

assert set(solver.results.graphics.contour.delete.argument_names) == {"name_list"}

Copilot · 2025-12-18T02:23:46Z

tests/test_field_data.py

    )
-    vertices_data = field_data.get_field_data(vertices_data_request)
-    assert round(vertices_data["interior-4"].vertices[5][0], 2) == 0.0
+    assert round(vertices_data["interior-4"][SurfaceDataType.Vertices][5][0], 2) == 0.0


The field data access pattern has changed significantly from using .vertices attribute to dictionary-style access with [SurfaceDataType.Vertices]. Ensure this new pattern is documented and consistent with the current API design, as it represents a breaking change in how users access field data.

Copilot

Pull request overview

Copilot reviewed 32 out of 33 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-18T02:45:53Z

examples/00-fluent/conjugate_heat_transfer.py

    mode="meshing",
-    dimension=3,
    precision="double",
    processor_count=4,


The removal of 'dimension=3' parameter should be verified. While dimension might be inferred or defaulted, ensure that this change doesn't affect the intended 3D simulation behavior.

Suggested change

processor_count=4,

processor_count=4,

dimension=3,

Copilot · 2025-12-18T02:45:53Z

examples/00-fluent/external_compressible_flow.py

 )

-meshing_session.upload(wing_intermediary_file)
 geo_import.Execute()


The removal of meshing_session.upload(wing_intermediary_file) at line 125 suggests that file upload is no longer necessary before Execute(). Verify that the file is accessible to the meshing session through other means (e.g., shared filesystem or automatic handling) to ensure the workflow remains functional.

Copilot · 2025-12-18T02:45:54Z

examples/00-fluent/exhaust_system_settings_api.py

 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Import the CAD geometry file (``exhaust_system.fmd``) and selectively manage some
 # parts.



The removal of meshing_session.upload(import_file_name) at line 113 suggests that file upload is no longer necessary before InputFileChanged(). Verify that the file is accessible to the meshing session through other means (e.g., shared filesystem or automatic handling) to ensure the workflow remains functional.

Suggested change

meshing_session.upload(import_file_name)

Gobot1234 and others added 15 commits October 7, 2025 11:13

Add type level support for passing Path instances to download_file

005b37a

Pre-emptively fix isort

a41b780

Fix black

e06bbbd

fix: solver session settings access in tests and examples

79beceb

revert: some of the broken updates

a9d95d3

chore: add acronym for DOE

c3fc60e

Move the boundary layer update

376508f

Apply suggestion from @Gobot1234

0063e0c

Fix some review issues

a6c1804

Merge branch 'main' into example-updates

0aa7841

Fix typo

9e02c58

Co-authored-by: Copilot <[email protected]>

fix: old syntax for camera position

5f9fd49

refactor: make the code more pythonic

e101c51

Merge branch 'main' into example-updates

313b069

fix ci

2343b7a

Copilot AI review requested due to automatic review settings November 3, 2025 10:56

Gobot1234 requested review from hpohekar, mayankansys, mkundu1, prmukherj and seanpearsonuk as code owners November 3, 2025 10:56

github-actions bot added documentation Documentation related (improving, adding, etc) examples Publishing PyFluent examples bug Issue, problem or error in PyFluent labels Nov 3, 2025

Gobot1234 mentioned this pull request Nov 3, 2025

fix: example deprecation warnings and improvements #4512

Closed

chore: adding changelog file 4579.fixed.md [dependabot-skip]

c8a59db

Copilot AI reviewed Nov 3, 2025

View reviewed changes

examples/00-fluent/tyler_sofrin_modes.py Show resolved Hide resolved

examples/00-fluent/tyler_sofrin_modes.py Show resolved Hide resolved

examples/00-fluent/modeling_ablation.py Show resolved Hide resolved

examples/00-fluent/frozen_rotor_workflow.py Show resolved Hide resolved

mkundu1 approved these changes Nov 3, 2025

View reviewed changes

hpohekar approved these changes Nov 4, 2025

View reviewed changes