Review suggestions

davidrudlstorfer · davidrudlstorfer · commit ff2e7e4f5cd1 · 2025-04-11T16:32:19.000+02:00
diff --git a/src/meshpy/core/conf.py b/src/meshpy/core/conf.py
@@ -181,14 +181,11 @@ def set_default_values(self):
 
         # Lines to be added to each created input file
         self.input_file_meshpy_header = [
-            "-" * 77,
+            "-" * 40,
             "This input file was created with MeshPy.",
-            "Copyright (c) 2018-2025",
-            "    Ivo Steinbrecher",
-            "    Institute for Mathematics and Computer-Based Simulation",
-            "    Universitaet der Bundeswehr Muenchen",
-            "    https://www.unibw.de/imcs-en",
-            "-" * 77,
+            "Copyright (c) 2018-2025 MeshPy Authors",
+            "https://imcs-compsim.github.io/meshpy/",
+            "-" * 40,
         ]
 
 
diff --git a/src/meshpy/four_c/input_file.py b/src/meshpy/four_c/input_file.py
@@ -351,7 +351,8 @@ def write_input_file(
         file_path: _Path,
         *,
         nox_xml_file: _Optional[str] = None,
-        add_application_script: _Optional[bool] = False,
+        add_header_default: bool = True,
+        add_footer_application_script: bool = True,
         **kwargs,
     ):
         """Write the input file to disk.
@@ -362,10 +363,11 @@ def write_input_file(
             nox_xml_file:
                 (optional) If this argument is given, the xml file will be created
                 with this name, in the same directory as the input file.
-            add_application_script:
-                (optional) If this argument is set to True, the script that
-                created this input file will be added to the input file as a
-                comment.
+            add_header_default:
+                Prepend the default MeshPy header comment to the input file.
+            add_footer_application_script:
+                Append the application script which creates the input files as a
+                comment at the end of the input file.
         """
 
         # Check if a xml file needs to be written.
@@ -385,6 +387,12 @@ def write_input_file(
                 xml_file.write(self.nox_xml)
 
         with open(file_path, "w") as input_file:
+            # write MeshPy header
+            if add_header_default:
+                input_file.writelines(
+                    "# " + line + "\n" for line in _mpy.input_file_meshpy_header
+                )
+
             _yaml.dump(
                 self.get_dict_to_dump(**kwargs),
                 input_file,
@@ -393,7 +401,7 @@ def write_input_file(
             )
 
             # Add the application script to the input file.
-            if add_application_script:
+            if add_footer_application_script:
                 application_path = _Path(_sys.argv[0]).resolve()
                 application_script_lines = self._get_application_script(
                     application_path
@@ -403,14 +411,14 @@ def write_input_file(
     def get_dict_to_dump(
         self,
         *,
-        information_header: bool = False,
+        add_header_information: bool = True,
         check_nox: bool = True,
     ):
         """Return the dictionary representation of this input file for dumping
         to a yaml file.
 
         Args:
-            information_header:
+            add_header_information:
                 If the information header should be exported to the input file
                 Contains creation date, git details of MeshPy, CubitPy and
                 original application which created the input file if available.
@@ -429,7 +437,7 @@ def get_dict_to_dump(
         yaml_dict = _copy.deepcopy(self.sections)
 
         # Add information header to the input file
-        if information_header:
+        if add_header_information:
             yaml_dict["TITLE"] = self._get_header()
 
         # Check if a file has to be created for the NOX xml information.
@@ -688,10 +696,12 @@ def _get_git_data(repo_path: _Path) -> _Tuple[_Optional[str], _Optional[str]]:
             application_path.parent
         )
         if application_git_sha is not None and application_git_date is not None:
-            header["MeshPy"]["Application"] = {
-                "git_sha": application_git_sha,
-                "git_date": application_git_date,
-            }
+            header["MeshPy"]["Application"].update(
+                {
+                    "git_sha": application_git_sha,
+                    "git_date": application_git_date,
+                }
+            )
 
         # MeshPy information
         meshpy_git_sha, meshpy_git_date = _get_git_data(
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -278,6 +278,7 @@ def _assert_results_equal(
         result: Union[Path, str, dict, InputFile],
         rtol: Optional[float] = None,
         atol: Optional[float] = None,
+        input_file_kwargs: dict = {"add_header_information": False, "check_nox": False},
         **kwargs,
     ) -> None:
         """Comparison between reference and result with relative or absolute
@@ -290,6 +291,8 @@ def _assert_results_equal(
             result: The result data.
             rtol: The relative tolerance.
             atol: The absolute tolerance.
+            input_file_kwargs: Dictionary which contains the settings when
+                dumping the input file.
         """
 
         # Per default we do a string comparison of the objects. Some data types, e.g.,
@@ -341,7 +344,7 @@ def get_dictionary(data) -> dict:
 
                     return yaml.safe_load(
                         yaml.dump(
-                            data.get_dict_to_dump(check_nox=False),
+                            data.get_dict_to_dump(**input_file_kwargs),
                             Dumper=_MeshPyDumper,
                             width=float("inf"),
                         )
diff --git a/tests/reference-files/test_abaqus_frame_normal.inp b/tests/reference-files/test_abaqus_frame_normal.inp
@@ -1,11 +1,8 @@
-** -----------------------------------------------------------------------------
+** ----------------------------------------
 ** This input file was created with MeshPy.
-** Copyright (c) 2018-2025
-**     Ivo Steinbrecher
-**     Institute for Mathematics and Computer-Based Simulation
-**     Universitaet der Bundeswehr Muenchen
-**     https://www.unibw.de/imcs-en
-** -----------------------------------------------------------------------------
+** Copyright (c) 2018-2025 MeshPy Authors
+** https://imcs-compsim.github.io/meshpy/
+** ----------------------------------------
 *Node
      1,  0.00000000000000e+00,  0.00000000000000e+00,  0.00000000000000e+00
      2,  2.50000000000000e-01,  0.00000000000000e+00,  0.00000000000000e+00
diff --git a/tests/reference-files/test_abaqus_frame_normal_and_extra_node.inp b/tests/reference-files/test_abaqus_frame_normal_and_extra_node.inp
@@ -1,11 +1,8 @@
-** -----------------------------------------------------------------------------
+** ----------------------------------------
 ** This input file was created with MeshPy.
-** Copyright (c) 2018-2025
-**     Ivo Steinbrecher
-**     Institute for Mathematics and Computer-Based Simulation
-**     Universitaet der Bundeswehr Muenchen
-**     https://www.unibw.de/imcs-en
-** -----------------------------------------------------------------------------
+** Copyright (c) 2018-2025 MeshPy Authors
+** https://imcs-compsim.github.io/meshpy/
+** ----------------------------------------
 *Node
      1,  0.00000000000000e+00,  0.00000000000000e+00,  0.00000000000000e+00
      2,  2.50000000000000e-01,  0.00000000000000e+00,  0.00000000000000e+00
diff --git a/tests/reference-files/test_abaqus_helix_normal.inp b/tests/reference-files/test_abaqus_helix_normal.inp
@@ -1,11 +1,8 @@
-** -----------------------------------------------------------------------------
+** ----------------------------------------
 ** This input file was created with MeshPy.
-** Copyright (c) 2018-2025
-**     Ivo Steinbrecher
-**     Institute for Mathematics and Computer-Based Simulation
-**     Universitaet der Bundeswehr Muenchen
-**     https://www.unibw.de/imcs-en
-** -----------------------------------------------------------------------------
+** Copyright (c) 2018-2025 MeshPy Authors
+** https://imcs-compsim.github.io/meshpy/
+** ----------------------------------------
 *Node
      1,  5.00000000000000e-01,  0.00000000000000e+00,  0.00000000000000e+00
      2,  4.45503262094184e-01,  2.26995249869773e-01,  5.00000000000000e-02
diff --git a/tests/reference-files/test_abaqus_helix_normal_and_extra_node.inp b/tests/reference-files/test_abaqus_helix_normal_and_extra_node.inp
@@ -1,11 +1,8 @@
-** -----------------------------------------------------------------------------
+** ----------------------------------------
 ** This input file was created with MeshPy.
-** Copyright (c) 2018-2025
-**     Ivo Steinbrecher
-**     Institute for Mathematics and Computer-Based Simulation
-**     Universitaet der Bundeswehr Muenchen
-**     https://www.unibw.de/imcs-en
-** -----------------------------------------------------------------------------
+** Copyright (c) 2018-2025 MeshPy Authors
+** https://imcs-compsim.github.io/meshpy/
+** ----------------------------------------
 *Node
      1,  5.00000000000000e-01,  0.00000000000000e+00,  0.00000000000000e+00
      2,  4.45503262094184e-01,  2.26995249869773e-01,  5.00000000000000e-02
diff --git a/tests/test_meshpy.py b/tests/test_meshpy.py
@@ -1256,10 +1256,6 @@ def test_meshpy_beam_to_solid_conditions(
     assert_results_equal(
         get_corresponding_reference_file_path(additional_identifier=test_type),
         input_file,
-        input_file_kwargs={
-            "check_nox": False,
-            "header": False,
-        },
     )
 
 

Original file line number	Diff line number	Diff line change
`@@ -1256,10 +1256,6 @@ def test_meshpy_beam_to_solid_conditions(`
`1256`	`1256`	`assert_results_equal(`
`1257`	`1257`	`get_corresponding_reference_file_path(additional_identifier=test_type),`
`1258`	`1258`	`input_file,`
`1259`		`- input_file_kwargs={`
`1260`		`- "check_nox": False,`
`1261`		`- "header": False,`
`1262`		`- },`
`1263`	`1259`	`)`
`1264`	`1260`
`1265`	`1261`