Skip to content

refactor: Update deprecate arguments. #4553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Oct 17, 2025
Merged

refactor: Update deprecate arguments. #4553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
518222d
refactor: Update deprecate arguments.
prmukherj Oct 12, 2025
e3771b9
chore: adding changelog file 4553.miscellaneous.md [dependabot-skip]
pyansys-ci-bot Oct 12, 2025
4ce6ca9
Sample Implementation.
prmukherj Oct 13, 2025
15024cb
Update src/ansys/fluent/core/launcher/launcher.py
prmukherj Oct 13, 2025
1e655f5
Update src/ansys/fluent/core/utils/deprecate_new.py
prmukherj Oct 13, 2025
a191e06
Refactor.
prmukherj Oct 13, 2025
2c5555b
Update src/ansys/fluent/core/launcher/launcher.py
prmukherj Oct 13, 2025
8919d88
Update signature.
prmukherj Oct 15, 2025
532a912
Clean up.
prmukherj Oct 15, 2025
1775fe3
Renaming
prmukherj Oct 15, 2025
2ffa6e2
Merge branch 'main' into maint/deprecate_arguments_updated
prmukherj Oct 15, 2025
5de5ed9
Graceful handling of TypeError.
prmukherj Oct 15, 2025
b89b2e9
Added tests and minor updates.
prmukherj Oct 16, 2025
e049092
Update logic.
prmukherj Oct 16, 2025
7d508c3
Fix file session test.
prmukherj Oct 16, 2025
82ea05e
Add licensing info.
prmukherj Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changelog.d/4553.miscellaneous.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update deprecate arguments.
234 changes: 91 additions & 143 deletions src/ansys/fluent/core/file_session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@
_to_scalar_field_name,
_to_vector_field_name,
)
from ansys.fluent.core.utils.deprecate import all_deprecators
from ansys.fluent.core.utils.deprecate import (
deprecate_arguments,
deprecate_function,
)


class InvalidMultiPhaseFieldName(ValueError):
Expand All @@ -73,7 +76,7 @@ def __init__(self):
super().__init__("The only allowed field is 'velocity'.")


def _data_type_convertor(args_dict):
def _data_type_converter(args_dict):
d_type_list = []
d_type_map = {
"provide_vertices": SurfaceDataType.Vertices,
Expand Down Expand Up @@ -253,24 +256,23 @@ def get_surface_ids(self, surfaces: List[str | int]) -> List[int]:
surfaces=surfaces,
)

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=_data_type_convertor,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
warn_message="'add_surfaces_request' is deprecated, use 'add_requests' instead.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args=["provide_vertices", "provide_faces"],
new_args="data_types",
version="v0.25.0",
converter=_data_type_converter,
)
@deprecate_function(version="v0.25.0", new_func="add_requests")
def add_surfaces_request(
self,
data_types: List[SurfaceDataType] | List[str],
Expand Down Expand Up @@ -311,24 +313,17 @@ def _add_surfaces_request(
Batch._SurfaceTransaction(surface_id, provide_vertices, provide_faces)
)

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=None,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
warn_message="'add_scalar_fields_request' is deprecated, use 'add_requests' instead.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_function(version="v0.25.0", new_func="add_requests")
def add_scalar_fields_request(
self,
field_name: str,
Expand Down Expand Up @@ -388,24 +383,17 @@ def _add_scalar_fields_request(
Batch._ScalarFieldTransaction(field_name, surface_ids)
)

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=None,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
warn_message="'add_vector_fields_request' is deprecated, use 'add_requests' instead.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_function(version="v0.25.0", new_func="add_requests")
def add_vector_fields_request(
self,
field_name: str,
Expand Down Expand Up @@ -450,24 +438,17 @@ def _add_vector_fields_request(
Batch._VectorFieldTransaction(field_name, surface_ids)
)

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=None,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
warn_message="Pathlines are not supported.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_function(version="v0.25.0", new_func="add_requests")
def add_pathlines_fields_request(
self,
field_name: str,
Expand Down Expand Up @@ -659,29 +640,17 @@ def get_surface_ids(self, surfaces: List[str | int]) -> List[int]:
surfaces=surfaces,
)

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: [old_arg_val],
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
{
"old_arg": "data_type",
"new_arg": "data_types",
"converter": lambda old_arg_val: [old_arg_val] if old_arg_val else None,
},
],
data_type_converter=None,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids', 'surface_names' and 'data_type' are deprecated. Use 'surfaces' and 'data_types' instead.",
warn_message="'get_surface_data' is deprecated, use 'get_field_data' instead.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_function(version="v0.25.0", new_func="get_field_data")
def get_surface_data(
self,
data_types: List[SurfaceDataType] | List[str],
Expand Down Expand Up @@ -762,24 +731,17 @@ def _get_surface_data(
for count, surface in enumerate(surfaces)
}

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: [old_arg_val],
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=None,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
warn_message="'get_scalar_field_data' is deprecated, use 'get_field_data' instead.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_function(version="v0.25.0", new_func="get_field_data")
def get_scalar_field_data(
self,
field_name: str,
Expand Down Expand Up @@ -848,24 +810,17 @@ def _get_scalar_field_data(
for count, surface in enumerate(surfaces)
}

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: [old_arg_val],
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=None,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
warn_message="'get_vector_field_data' is deprecated, use 'get_field_data' instead.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_function(version="v0.25.0", new_func="get_field_data")
def get_vector_field_data(
self,
field_name: str,
Expand Down Expand Up @@ -929,24 +884,17 @@ def _get_vector_field_data(
for count, surface in enumerate(surfaces)
}

@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "surface_names",
"new_arg": "surfaces",
"converter": lambda old_arg_val: [old_arg_val],
},
{
"old_arg": "surface_ids",
"new_arg": "surfaces",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=None,
deprecated_version="v0.25.0",
deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
warn_message="Pathlines are not supported.",
@deprecate_arguments(
old_args="surface_names",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_arguments(
old_args="surface_ids",
new_args="surfaces",
version="v0.25.0",
)
@deprecate_function(version="v0.25.0", new_func="get_field_data")
def get_pathlines_field_data(
self,
field_name: str,
Expand Down
28 changes: 10 additions & 18 deletions src/ansys/fluent/core/launcher/fluent_container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
from ansys.fluent.core.launcher.launcher_utils import ComposeConfig
from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
from ansys.fluent.core.session import _parse_server_info_file
from ansys.fluent.core.utils.deprecate import all_deprecators
from ansys.fluent.core.utils.deprecate import deprecate_arguments
from ansys.fluent.core.utils.execution import timeout_loop
from ansys.fluent.core.utils.networking import get_free_port

Expand Down Expand Up @@ -139,23 +139,15 @@ def dict_to_str(dict: dict) -> str:
return pformat(dict)


@all_deprecators(
deprecate_arg_mappings=[
{
"old_arg": "container_mount_path",
"new_arg": "mount_target",
"converter": lambda old_arg_val: old_arg_val,
},
{
"old_arg": "host_mount_path",
"new_arg": "mount_source",
"converter": lambda old_arg_val: old_arg_val,
},
],
data_type_converter=None,
deprecated_version="v0.23.dev1",
deprecated_reason="'container_mount_path' and 'host_mount_path' are deprecated. Use 'mount_target' and 'mount_source' instead.",
warn_message="",
@deprecate_arguments(
old_args="container_mount_path",
new_args="mount_target",
version="v0.23.0",
)
@deprecate_arguments(
old_args="host_mount_path",
new_args="mount_source",
version="v0.23.0",
)
def configure_container_dict(
args: List[str],
Expand Down
Loading