consistently use context manager to write files in software-markdown-…

…pages.py script
easybuilders · Sep 11, 2024 · c79e934 · c79e934
1 parent 8e15a34
commit c79e934
Showing 1 changed file with 45 additions and 49 deletions.
diff --git a/docs/version-specific/software-markdown-pages.py b/docs/version-specific/software-markdown-pages.py
@@ -34,55 +34,51 @@ def output_markdown(processed, output_base_path):
     :param output_base_path: Pathlib object for base path of output
     """
     packages = sum(len(v) for v in processed.values())
-    top_page = open(output_base_path / 'index.md', 'w')
-    top_page.write(MKDOCS_SEARCH_PRIORITY)
-    top_page.write("# List of supported software\n\n")
-    top_page.write(f"EasyBuild supports {packages} different software packages (incl. toolchains, bundles):\n\n")
-
-    for letter in processed:
-        top_page.write(f" * [{letter}]({letter}/index.md)\n")
-
-        letter_dir = output_base_path / letter
-        letter_dir.mkdir()
-        letter_page = open(letter_dir / 'index.md', 'w')
-        letter_page.write(MKDOCS_SEARCH_PRIORITY)
-        letter_page.write(f"# List of supported software ({letter})\n\n")
-        letter_page.write(generate_character_links_line([v for v in processed], current=letter))
-
-        for software in processed[letter]:
-            top_page.write(f"    * [{software}]({letter}/{software}.md)\n")
-            letter_page.write(f" * [{software}]({software}.md)\n")
-
-            versionsuffix = any(v['versionsuffix'] for v in processed[letter][software])
-
-            software_page = open(letter_dir / f'{software}.md', 'w')
-            software_page.write(MKDOCS_SEARCH_PRIORITY)
-            software_page.write(f"# {software}\n\n")
-            software_page.write(f"{processed[letter][software][0]['description']}\n\n")
-            software_page.write(f"*homepage*: <{processed[letter][software][0]['homepage']}>\n\n")
-
-            if versionsuffix:
-                software_page.write("version | versionsuffix | toolchain\n")
-                software_page.write("--------|---------------|----------\n")
-            else:
-                software_page.write("version | toolchain\n")
-                software_page.write("--------|----------\n")
-
-            for version in processed[letter][software]:
-                software_page.write(f"``{version['version']}`` | ")
-                if versionsuffix:
-                    if version['versionsuffix']:
-                        software_page.write(f"``{version['versionsuffix']}``")
-                    software_page.write(" | ")
-                software_page.write(f"``{version['toolchain']}``\n")
-
-            software_page.write('\n')
-            software_page.write(generate_character_links_line([v for v in processed]))
-            software_page.close()
-
-        letter_page.close()
-
-    top_page.close()
+
+    with open(output_base_path / 'index.md', 'w') as top_page:
+        top_page.write(MKDOCS_SEARCH_PRIORITY)
+        top_page.write("# List of supported software\n\n")
+        top_page.write(f"EasyBuild supports {packages} different software packages (incl. toolchains, bundles):\n\n")
+
+        for letter in processed:
+            top_page.write(f" * [{letter}]({letter}/index.md)\n")
+
+            letter_dir = output_base_path / letter
+            letter_dir.mkdir()
+            with open(letter_dir / 'index.md', 'w') as letter_page:
+                letter_page.write(MKDOCS_SEARCH_PRIORITY)
+                letter_page.write(f"# List of supported software ({letter})\n\n")
+                letter_page.write(generate_character_links_line([v for v in processed], current=letter))
+
+                for software in processed[letter]:
+                    top_page.write(f"    * [{software}]({letter}/{software}.md)\n")
+                    letter_page.write(f" * [{software}]({software}.md)\n")
+
+                    versionsuffix = any(v['versionsuffix'] for v in processed[letter][software])
+
+                    with open(letter_dir / f'{software}.md', 'w') as software_page:
+                        software_page.write(MKDOCS_SEARCH_PRIORITY)
+                        software_page.write(f"# {software}\n\n")
+                        software_page.write(f"{processed[letter][software][0]['description']}\n\n")
+                        software_page.write(f"*homepage*: <{processed[letter][software][0]['homepage']}>\n\n")
+
+                        if versionsuffix:
+                            software_page.write("version | versionsuffix | toolchain\n")
+                            software_page.write("--------|---------------|----------\n")
+                        else:
+                            software_page.write("version | toolchain\n")
+                            software_page.write("--------|----------\n")
+
+                        for version in processed[letter][software]:
+                            software_page.write(f"``{version['version']}`` | ")
+                            if versionsuffix:
+                                if version['versionsuffix']:
+                                    software_page.write(f"``{version['versionsuffix']}``")
+                                software_page.write(" | ")
+                            software_page.write(f"``{version['toolchain']}``\n")
+
+                        software_page.write('\n')
+                        software_page.write(generate_character_links_line([v for v in processed]))
 
 
 def generate_markdown_pages(jsonfile, output_base, delete_existing):