printing data frames with validation function information

bg_atlasgen/validate_atlases.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 
 import numpy as np
+import pandas as pd
 from bg_atlasapi import BrainGlobeAtlas
 from bg_atlasapi.config import get_brainglobe_dir
 from bg_atlasapi.list_atlases import (
@@ -15,10 +16,10 @@
 from bg_atlasapi.update_atlases import update_atlas
 
 
 def validate_atlas_files(atlas: BrainGlobeAtlas):
     """Checks if basic files exist in the atlas folder"""
 
     atlas_path = (
         Path(get_brainglobe_dir())
         / f"{atlas.atlas_name}_v{get_local_atlas_version(atlas.atlas_name)}"
     )
@@ -95,26 +96,26 @@
     return True
 
 
 def open_for_visual_check(atlas: BrainGlobeAtlas):
     # implement visual checks later
     pass
 
 
 def validate_checksum(atlas: BrainGlobeAtlas):
     # implement later
     pass
 
 
 def check_additional_references(atlas: BrainGlobeAtlas):
     # check additional references are different, but have same dimensions
     pass
 
 
 def validate_mesh_structure_pairs(atlas: BrainGlobeAtlas):
     """Ensure mesh files (.obj) exist for each expected structure in the atlas."""
     ids_from_bg_atlas_api = list(atlas.structures.keys())
 
     atlas_path = (
         Path(get_brainglobe_dir())
         / f"{atlas.atlas_name}_v{get_local_atlas_version(atlas.atlas_name)}"
     )
@@ -143,7 +144,7 @@
         )
 
 
 def validate_atlas(atlas_name, version, validation_functions):
     """Validates the latest version of a given atlas"""
 
     print(atlas_name, version)
@@ -153,15 +154,15 @@
         update_atlas(atlas_name)
 
     # list to store the errors of the failed validations
     failed_validations = {atlas_name: []}
     successful_validations = {atlas_name: []}
 
     for i, validation_function in enumerate(validation_functions):
         try:
             validation_function(BrainGlobeAtlas(atlas_name))
             successful_validations[atlas_name].append(validation_function)
         except AssertionError as error:
             failed_validations[atlas_name].append((validation_function, error))
 
     return successful_validations, failed_validations
 
@@ -179,17 +180,42 @@
 
     valid_atlases = []
     invalid_atlases = []
+    df_successful = pd.DataFrame()
+    df_failed = pd.DataFrame()
+
     for atlas_name, version in get_all_atlases_lastversions().items():
         successful_validations, failed_validations = validate_atlas(
             atlas_name, version, all_validation_functions
         )
         for item in successful_validations:
             valid_atlases.append(item)
+
         for item in failed_validations:
             invalid_atlases.append(item)
 
+        for k, v in successful_validations.items():
+            new_row = pd.DataFrame({"Atlas": [k], "Function": [v]})
+            df_successful = pd.concat(
+                [df_successful, new_row], ignore_index=True
+            )
+            # df_successful["Function"] = df_successful["Function"].apply(lambda x: x[0].__name__ if x else pd.NA)
+
+        for k, v in failed_validations.items():
+            new_row = pd.DataFrame({"Atlas": [k], "Function": [v]})
+            df_failed = pd.concat([df_failed, new_row], ignore_index=True)
+            # df_failed["Function"] = df_failed["Function"].apply(lambda x: x[0].__name__ if x else pd.NA)
+
     print("Summary")
     print("### Valid atlases ###")
     print(valid_atlases)
     print("### Invalid atlases ###")
     print(invalid_atlases)
+
+    # df_successful = pd.DataFrame(data=successful_validations.items(), columns=["Atlas", "Function"])
+    # df_successful["Function"] = df_successful["Function"].apply(lambda x: x[0].__name__ if x else pd.NA)
+    #
+    # df_failed = pd.DataFrame(failed_validations.items(), columns=["Atlas", "Function"])
+    # df_failed["Function"] = df_failed["Function"].apply(lambda x: x[0].__name__ if x else pd.NA)
+
+    print(df_successful)
+    print(df_failed)