Skip to content

Improve ImportWarning in check_ansys_grpc_dpf_version #208

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 7 commits into from
Apr 7, 2022
Merged

Improve ImportWarning in check_ansys_grpc_dpf_version #208

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c6a4bbf
Update ImportWarning in check_ansys_grpc_dpf_version to give better i…
PProfizi Apr 7, 2022
6e4e14b
Corrected for flake8
PProfizi Apr 7, 2022
f9e3b94
Corrected for flake8
PProfizi Apr 7, 2022
07e4f69
Improved per recommendations, now mentions 2022R1
PProfizi Apr 7, 2022
7183b01
Improved message
PProfizi Apr 7, 2022
a934d92
Improved message
PProfizi Apr 7, 2022
28b880b
Improved message
PProfizi Apr 7, 2022
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
27 changes: 21 additions & 6 deletions ansys/dpf/core/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,8 @@ def read_stderr():
pass
errstr = "\n".join(errors)
if "Only one usage of each socket address" in errstr:
raise errors.InvalidPortError(f"Port {port} in use")
from ansys.dpf.core.errors import InvalidPortError
raise InvalidPortError(f"Port {port} in use")
raise RuntimeError(errstr)

if len(docker_id) > 0:
Expand All @@ -685,11 +686,25 @@ def check_ansys_grpc_dpf_version(server, timeout=10.):
server_version = server.version
right_grpc_module_version = server_to_ansys_grpc_dpf_version.get(server_version, None)
if right_grpc_module_version and right_grpc_module_version != grpc_module_version:
raise ImportWarning(f"2022R1 Ansys unified install is available. "
f"To use DPF server from Ansys "
f"{server_to_ansys_version.get(server_version, 'Unknown')}"
f" (dpf.SERVER.version=='{server_version}'), "
f"install version {right_grpc_module_version} of ansys-grpc-dpf"
compatibility_link = (f"https://dpfdocs.pyansys.com/getting_started/"
f"index.html#client-server-compatibility")
raise ImportWarning(f"An incompatibility has been detected between the DPF server version "
f"({server_version} "
f"from Ansys {server_to_ansys_version.get(server_version, 'Unknown')})"
f" and the ansys-grpc-dpf version installed ({grpc_module_version})."
f" Please consider using the latest DPF server available in the "
f"2022R1 Ansys unified install.\n"
f"To follow the compatibility guidelines given in "
f"{compatibility_link} while still using DPF server {server_version}, "
f"please install version {right_grpc_module_version} of ansys-grpc-dpf"
f" with the command: \n"
f" pip install ansys-grpc-dpf=={right_grpc_module_version}"
)
# raise ImportWarning(f"2022R1 Ansys unified install is available. "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PProfizi the goal of this message is also to inform the user that a newer Ansys version is available and can be installed. This is important to mention

Copy link
Contributor Author

@PProfizi PProfizi Apr 7, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rlagha , ok, noted, I modified the message to:

An incompatibility has been detected between the DPF server version (2.0 from Ansys 2021R2) and the ansys-grpc-dpf version installed (0.4.0). Please consider using the latest DPF server available in the 2022R1 Ansys unified install.
To follow the compatibility guidelines given in https://dpfdocs.pyansys.com/getting_started/index.html#client-server-compatibility while still using DPF server 2.0, please install version 0.3.0 of ansys-grpc-dpf with the command:
pip install ansys-grpc-dpf==0.3.0

# f"To use DPF server from Ansys "
# f"{server_to_ansys_version.get(server_version, 'Unknown')}"
# f" (dpf.SERVER.version=='{server_version}'), "
# f"install version {right_grpc_module_version} of ansys-grpc-dpf"
# f" with the command: \n"
# f" pip install ansys-grpc-dpf=={right_grpc_module_version}"
# )