feat: add better logging when a parsing error occurs

Author: SuperFola

arkdoc/generator/base.py

@@ -39,8 +39,12 @@ def _create_files_list(self, parsers: List[Parser]):
 
         for p in parsers:
             functions = []
-            for doc in p.extract_documentation():
-                functions.append(documentation_to_specification(doc))
+            for i, doc in enumerate(p.extract_documentation()):
+                try:
+                    functions.append(documentation_to_specification(doc))
+                except Exception as e:
+                    logger.error(f"Error while parsing documentation block no {i + 1} inside {p.filename}")
+                    raise e
 
             base = os.path.splitext(os.path.basename(p.filename))[0]
             if base in registered:

arkdoc/generator/utils.py

@@ -115,11 +115,18 @@ def from_txt(doc: Documentation) -> spec.Function:
 
 
 def documentation_to_specification(doc: Documentation) -> spec.Function:
-    if doc.source == Source.ArkScript:
-        return from_ark(doc)
-    elif doc.source == Source.Cpp:
-        return from_cpp(doc)
-    elif doc.source == Source.Txt:
-        return from_txt(doc)
-    else:
-        raise NotImplementedError
+    try:
+        if doc.source == Source.ArkScript:
+            return from_ark(doc)
+        elif doc.source == Source.Cpp:
+            return from_cpp(doc)
+        elif doc.source == Source.Txt:
+            return from_txt(doc)
+    except ValueError as e:
+        logger.error(f"While parsing file a {doc.source}, got an error")
+        try:
+            logger.error(str(doc))
+        except Exception:
+            logger.warn("Couldn't print the signature of the function")
+        raise e
+    raise NotImplementedError