build: Bump version 0.30.4 (#3954)

Integrate #3951 in 0.30 release

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Harshal Pohekar <[email protected]>

Author: 3 people

doc/changelog.d/3939.fixed.md

@@ -0,0 +1 @@
+Skip test_reduction_does_not_modify_case [skip tests]

doc/changelog.d/3951.fixed.md

@@ -0,0 +1 @@
+Preprocess xml content before sending it to ElementTree parser

src/ansys/fluent/core/__init__.py

@@ -62,7 +62,7 @@
 from ansys.fluent.core.utils.fluent_version import FluentVersion  # noqa: F401
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
 
-__version__ = "0.30.3"
+__version__ = "0.30.4"
 
 _VERSION_INFO = None
 """

src/ansys/fluent/core/filereader/case_file.py

@@ -45,12 +45,13 @@
 from pathlib import Path
 from typing import Dict, List
 
-from defusedxml.ElementTree import parse
+import defusedxml.ElementTree as ET
 import numpy as np
 
 from ansys.fluent.core.solver.error_message import allowed_name_error_message
 
 from . import lispy
+from .pre_processor import remove_unsupported_xml_chars
 
 try:
     import h5py
@@ -731,15 +732,17 @@ def _get_processed_string(input_string: bytes) -> str:
 
 
 def _get_case_file_name_from_flprj(flprj_file):
-    tree = parse(flprj_file)
-    root = tree.getroot()
-    folder_name = root.find("Metadata").find("CurrentSimulation").get("value")[5:-1]
-    # If the project file name begins with a digit then the node to find will be prepended
-    # with "_". Rather than making any assumptions that this is a hard rule, or what
-    # the scope of the rule is, simply retry with the name prepended:
-    folder_obj = (
-        root.find(folder_name)
-        if root.find(folder_name) and len(root.find(folder_name)) > 0
-        else root.find("_" + folder_name)
-    )
-    return folder_obj.find("Input").find("Case").find("Target").get("value")
+    with open(flprj_file, "r") as file:
+        content = file.read()
+        content = remove_unsupported_xml_chars(content)
+        root = ET.fromstring(content)
+        folder_name = root.find("Metadata").find("CurrentSimulation").get("value")[5:-1]
+        # If the project file name begins with a digit then the node to find will be prepended
+        # with "_". Rather than making any assumptions that this is a hard rule, or what
+        # the scope of the rule is, simply retry with the name prepended:
+        folder_obj = (
+            root.find(folder_name)
+            if root.find(folder_name) and len(root.find(folder_name)) > 0
+            else root.find("_" + folder_name)
+        )
+        return folder_obj.find("Input").find("Case").find("Target").get("value")

src/ansys/fluent/core/filereader/data_file.py

@@ -39,10 +39,11 @@
 from os.path import dirname
 from pathlib import Path
 
-from defusedxml.ElementTree import parse
+import defusedxml.ElementTree as ET
 import numpy as np
 
 from . import lispy
+from .pre_processor import remove_unsupported_xml_chars
 
 try:
     import h5py
@@ -224,7 +225,15 @@ def get_face_vector_field_data(self, phase_name: str, surface_id: int) -> np.arr
 
 
 def _get_data_file_name_from_flprj(flprj_file):
-    tree = parse(flprj_file)
-    root = tree.getroot()
-    folder_name = root.find("Metadata").find("CurrentSimulation").get("value")[5:-1]
-    return root.find(folder_name).find("Input").find("Case").find("Target").get("value")
+    with open(flprj_file, "r") as file:
+        content = file.read()
+        content = remove_unsupported_xml_chars(content)
+        root = ET.fromstring(content)
+        folder_name = root.find("Metadata").find("CurrentSimulation").get("value")[5:-1]
+        return (
+            root.find(folder_name)
+            .find("Input")
+            .find("Case")
+            .find("Target")
+            .get("value")
+        )

src/ansys/fluent/core/filereader/pre_processor.py

@@ -0,0 +1,35 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Pre-processor for XML content from Fluent project files.
+"""
+
+import re
+
+
+def remove_unsupported_xml_chars(content: str):
+    """Remove unsupported XML characters from the content."""
+    # Replace double colons in tag names with double underscores
+    content = re.sub(r"</?([^> ]+)::", r"<\1__", content)
+
+    return content

tests/test_casereader.py

@@ -21,9 +21,10 @@
 # SOFTWARE.
 
 from os.path import dirname, join
-import pathlib
+from pathlib import Path
 import shutil
 
+import defusedxml.ElementTree as ET
 import pytest
 
 from ansys.fluent.core import examples
@@ -34,7 +35,9 @@
     MeshType,
     _get_processed_string,
 )
+from ansys.fluent.core.filereader.case_file import CaseFile
 from ansys.fluent.core.filereader.case_file import CaseFile as CaseReader
+from ansys.fluent.core.filereader.pre_processor import remove_unsupported_xml_chars
 
 
 def call_casereader(
@@ -145,7 +148,7 @@ def create_dir_structure_locally(copy_1: bool = False, copy_2: bool = False):
         return_without_path=False,
     )
     prj_dir = join(dirname(case_file_name), case_file_dir)
-    pathlib.Path(prj_dir).mkdir(parents=True, exist_ok=True)
+    Path(prj_dir).mkdir(parents=True, exist_ok=True)
     if copy_1:
         shutil.copy2(case_file_name, prj_dir)
     if copy_2:
@@ -344,3 +347,39 @@ def test_mesh_reader():
     assert mesh_reader_2d.precision() is None
     assert mesh_reader_3d.precision() is None
     assert case_reader.precision() == 2
+
+
+def test_preprocessor():
+    content = """
+    <Project type="object" class="PFolder">
+    <Metadata type="object" class="ansys::Project::MetadataHoof">
+        <ProjectStoragePolicy::FolderEnabled class="string" value="true"/>
+    </Metadata>
+    </Project>
+    """
+    expected = """
+    <Project type="object" class="PFolder">
+    <Metadata type="object" class="ansys::Project::MetadataHoof">
+        <ProjectStoragePolicy__FolderEnabled class="string" value="true"/>
+    </Metadata>
+    </Project>
+    """
+    with pytest.raises(ET.ParseError):
+        ET.fromstring(content)
+    pre_processed = remove_unsupported_xml_chars(content)
+    assert pre_processed == expected
+    assert ET.fromstring(pre_processed)
+
+
+def test_read_flprj_3891():
+    # Read the .flprj file from https://github.com/ansys/pyfluent/issues/3891
+    data_zip = examples.download_file(
+        "data.zip",
+        "pyfluent/flprj_3891",
+        return_without_path=False,
+    )
+    prj_file_name = next(Path(data_zip).with_suffix("").glob("*.flprj"))
+    assert (
+        CaseFile(project_file_name=prj_file_name).get_mesh().get_mesh_type()
+        == MeshType.VOLUME
+    )

tests/test_reduction.py

@@ -442,6 +442,7 @@ def test_reductions(
     _test_centroid_2_sources(solver1, solver2)
 
 
+@pytest.mark.skip("https://github.com/ansys/pyfluent/issues/3938")
 @pytest.mark.fluent_version(">=24.2")
 def test_reduction_does_not_modify_case(static_mixer_case_session: Any):
     solver = static_mixer_case_session