Update script formatting

Author: MathyouMB

src/scripts/initial/defs_converter.py

@@ -1,6 +1,7 @@
 import os
 import re
 
+
 def update_question_file(file_path):
     with open(file_path, "r", encoding="utf-8") as f:
         lines = f.readlines()
@@ -23,16 +24,18 @@ def update_question_file(file_path):
     with open(file_path, "w", encoding="utf-8") as f:
         f.writelines(updated_lines)
 
+
 def find_and_update_question_files(directory):
     for root, _, files in os.walk(directory):
         for file in files:
             if file == "question.ts":
                 question_file_path = os.path.join(root, file)
                 update_question_file(question_file_path)
 
+
 if __name__ == "__main__":
     # Define the specific directory path here
     directory = r"C:\Users\johnl\OneDrive\Documents\GitHub\questions\src\content\questions\comp2804"
     find_and_update_question_files(directory)
-    
+
     print("question.ts files have been updated.")

src/scripts/initial/file finder programs/empty_solution_file_finder.py

@@ -1,5 +1,6 @@
 import os
 
+
 def find_empty_solution_files(directory):
     for root, _, files in os.walk(directory):
         for file in files:
@@ -11,6 +12,7 @@ def find_empty_solution_files(directory):
                     if not content:
                         print(f"Empty file: {relative_path}")
 
+
 if __name__ == "__main__":
     # Define the specific directory path here
     directory = r"C:\Users\johnl\OneDrive\Documents\GitHub\questions\src\content\questions\comp2804"

src/scripts/initial/file finder programs/no_solution_for_index.py

@@ -1,19 +1,23 @@
 import os
 
+
 def find_empty_solution_files(directory):
     for root, _, files in os.walk(directory):
         if "solution.md" in files and "index.md" in files:
             solution_file_path = os.path.join(root, "solution.md")
             index_file_path = os.path.join(root, "index.md")
-            
-            with open(solution_file_path, "r", encoding="utf-8") as sf, open(index_file_path, "r", encoding="utf-8") as inf:
+
+            with open(solution_file_path, "r", encoding="utf-8") as sf, open(
+                index_file_path, "r", encoding="utf-8"
+            ) as inf:
                 solution_content = sf.read().strip()
                 index_content = inf.read()
 
                 if not solution_content and "solution" in index_content:
                     relative_index_path = os.path.relpath(index_file_path, directory)
                     print(f"Index file: {relative_index_path}")
 
+
 if __name__ == "__main__":
     # Define the specific directory path here
     directory = r"C:\Users\johnl\OneDrive\Documents\GitHub\questions\src\content\questions\comp2804"

src/scripts/initial/file finder programs/warning_finder.py

@@ -1,5 +1,6 @@
 import os
 
+
 def find_solution_files_with_warning(directory):
     for root, _, files in os.walk(directory):
         for file in files:
@@ -11,6 +12,7 @@ def find_solution_files_with_warning(directory):
                     if "warning" in content.lower():
                         print(f"'Warning' found in file: {relative_path}")
 
+
 if __name__ == "__main__":
     # Define the specific directory path here
     directory = r"C:\Users\johnl\OneDrive\Documents\GitHub\questions\src\content\questions\comp2804"

src/scripts/initial/key_value_pair_tag_summarizer.py

@@ -1,60 +1,65 @@
 import os
 import re
 
+
 def find_unique_tags(directory):
     unique_tags = set()
-    tag_pattern = re.compile(r'tags:\s*\n((?:\s*-\s*[^\n]+\n)*)', re.IGNORECASE)
+    tag_pattern = re.compile(r"tags:\s*\n((?:\s*-\s*[^\n]+\n)*)", re.IGNORECASE)
 
     for root, _, files in os.walk(directory):
         if "index.md" in files:
             index_file_path = os.path.join(root, "index.md")
-            
+
             with open(index_file_path, "r", encoding="utf-8") as inf:
                 index_content = inf.read()
                 tag_match = tag_pattern.search(index_content)
-                
+
                 if tag_match:
                     tags_block = tag_match.group(1)
-                    tags = re.findall(r'-\s*([^\n]+)', tags_block)
+                    tags = re.findall(r"-\s*([^\n]+)", tags_block)
                     unique_tags.update(tags)
-    
+
     return unique_tags
 
+
 def parse_tag(tag):
-    match = re.search(r'\(([\d.]+)\)$', tag)
+    match = re.search(r"\(([\d.]+)\)$", tag)
     if match:
-        numbers = tuple(map(int, match.group(1).split('.')))
+        numbers = tuple(map(int, match.group(1).split(".")))
     else:
         numbers = ()
     return numbers
 
+
 def sort_tags(tags):
     return sorted(tags, key=lambda tag: (parse_tag(tag), tag))
 
+
 def create_display_tags(tags):
     display_tags = {}
     for tag in tags:
         key = "comp2804-" + tag.lower().replace(" ", "-")
         display_tags[key] = tag
     return display_tags
 
+
 if __name__ == "__main__":
     # Define the specific directory path here
     directory = r"C:\Users\johnl\OneDrive\Documents\GitHub\questions\src\content\questions\comp2804"
     unique_tags = find_unique_tags(directory)
-    
+
     # Sort the tags with the custom sorting function
     sorted_tags = sort_tags(unique_tags)
-    
+
     # Create display tags
     display_tags = create_display_tags(sorted_tags)
-    
+
     # Write display tags to a file
     output_path = os.path.join(directory, "displayTags.js")
     with open(output_path, "w", encoding="utf-8") as f:
         f.write("const displayTags = {\n")
         for key, display in display_tags.items():
             f.write(f'  "{key}": "{display}",\n')
         f.write("};\n")
-    
+
     print(f"Display tags have been written to {output_path}")

src/scripts/initial/tag_checker.py

@@ -1,44 +1,48 @@
 import os
 import re
 
+
 def find_unique_tags(directory):
     unique_tags = set()
-    tag_pattern = re.compile(r'tags:\s*\n((?:\s*-\s*[^\n]+\n)*)', re.IGNORECASE)
+    tag_pattern = re.compile(r"tags:\s*\n((?:\s*-\s*[^\n]+\n)*)", re.IGNORECASE)
 
     for root, _, files in os.walk(directory):
         if "index.md" in files:
             index_file_path = os.path.join(root, "index.md")
-            
+
             with open(index_file_path, "r", encoding="utf-8") as inf:
                 index_content = inf.read()
                 tag_match = tag_pattern.search(index_content)
-                
+
                 if tag_match:
                     tags_block = tag_match.group(1)
-                    tags = re.findall(r'-\s*([^\n]+)', tags_block)
+                    tags = re.findall(r"-\s*([^\n]+)", tags_block)
                     unique_tags.update(tags)
-    
+
     return unique_tags
 
+
 def parse_tag(tag):
-    match = re.search(r'\(([\d.]+)\)$', tag)
+    match = re.search(r"\(([\d.]+)\)$", tag)
     if match:
-        numbers = tuple(map(int, match.group(1).split('.')))
+        numbers = tuple(map(int, match.group(1).split(".")))
     else:
         numbers = ()
     return numbers
 
+
 def sort_tags(tags):
     return sorted(tags, key=lambda tag: (parse_tag(tag), tag))
 
+
 if __name__ == "__main__":
     # Define the specific directory path here
     directory = r"C:\Users\johnl\OneDrive\Documents\GitHub\questions\src\content\questions\comp2804"
     unique_tags = find_unique_tags(directory)
-    
+
     # Sort the tags with the custom sorting function
     sorted_tags = sort_tags(unique_tags)
-    
+
     # Print the sorted unique tags
     for tag in sorted_tags:
         print(tag)

src/scripts/initial/tag_converter.py

@@ -1,39 +1,46 @@
 import os
 import re
 
+
 def update_tags_in_file(file_path):
     with open(file_path, "r", encoding="utf-8") as f:
         content = f.read()
 
-    tags_pattern = re.compile(r'(tags:\s*\n)((?:\s*-\s*[^\n]+\n)*)', re.IGNORECASE)
+    tags_pattern = re.compile(r"(tags:\s*\n)((?:\s*-\s*[^\n]+\n)*)", re.IGNORECASE)
     match = tags_pattern.search(content)
 
     if match:
         tags_block = match.group(2)
-        tags = re.findall(r'-\s*([^\n]+)', tags_block)
+        tags = re.findall(r"-\s*([^\n]+)", tags_block)
         updated_tags = []
 
         for tag in tags:
             if not tag.startswith("comp2804"):
                 tag = "comp2804 " + tag
             updated_tag = tag.lower().replace(" ", "-")
             updated_tags.append(updated_tag)
-        
-        updated_tags_block = "tags:\n" + "\n".join([f"  - {tag}" for tag in updated_tags]) + "\n"
-        updated_content = content[:match.start(2)] + updated_tags_block + content[match.end(2):]
+
+        updated_tags_block = (
+            "tags:\n" + "\n".join([f"  - {tag}" for tag in updated_tags]) + "\n"
+        )
+        updated_content = (
+            content[: match.start(2)] + updated_tags_block + content[match.end(2) :]
+        )
 
         with open(file_path, "w", encoding="utf-8") as f:
             f.write(updated_content)
 
+
 def find_and_update_tags(directory):
     for root, _, files in os.walk(directory):
         if "index.md" in files:
             index_file_path = os.path.join(root, "index.md")
             update_tags_in_file(index_file_path)
 
+
 if __name__ == "__main__":
     # Define the specific directory path here
     directory = r"C:\Users\johnl\OneDrive\Documents\GitHub\questions\src\content\questions\comp2804"
     find_and_update_tags(directory)
-    
+
     print("Tags have been updated in all index.md files.")