tools(metadata): make warnings visible and robust summary extraction

tools/02_generate_metadata.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env -S uv run
 """
 Collect relevant metadata from local UD directories:
-- extracting the '# Summary' from the beginning and machine readable
-  metadata from the end of the README.{md,txt} file
+- extracting a markdown Summary section and machine-readable metadata
+  from README.{md,txt}
 - using the UD directory name for collecting metadata from the
   codes_and_flags.yaml file
 - collecting {dev,train,test}.conllu files.
@@ -13,6 +13,7 @@ import os
 import xml.etree.ElementTree as ET
 import argparse
 import logging
+import re
 from collections import defaultdict
 from pathlib import Path
 
@@ -39,12 +40,16 @@ UD_VER = args.ud_ver
 
 # Set up logging
 logging.basicConfig(
-    level = max(logging.DEBUG, logging.INFO - args.verbose * 10),
+    level = max(logging.DEBUG, logging.WARNING - args.verbose * 10),
     format='%(asctime)s [%(levelname)s] %(message)s',
-    datefmt='%Y-%m-%d %H:%M:%S'
+    datefmt='%Y-%m-%d %H:%M:%S',
+    force=True
 )
 
 GENUS_SEPARATED_FROM_UD_VERSION = (2, 15)
+SUMMARY_HEADING_SCAN_LIMIT = 120
+SUMMARY_HEADING_RE = re.compile(r"^#{1,2}\s+summary\s*$", re.IGNORECASE)
+MARKDOWN_HEADING_RE = re.compile(r"^#{1,6}\s+\S")
 
 
 def parse_ud_version(version: str) -> tuple[int, ...] | None:
@@ -82,6 +87,35 @@ def normalize_codes_and_flags_entry(entry: dict, ud_version: str) -> dict:
     return normalized
 
 
+def find_summary_bounds(lines: list[str]) -> tuple[int, int] | None:
+    """
+    Find the markdown Summary section bounds.
+
+    We look for an H1/H2 heading named "Summary" near the beginning
+    of the file and collect lines until the next markdown heading.
+    Returns (start_index, end_index_exclusive) for summary content lines.
+    """
+    scan_limit = min(len(lines), SUMMARY_HEADING_SCAN_LIMIT)
+    summary_heading_idx = None
+
+    for i in range(scan_limit):
+        line = lines[i].strip()
+        if SUMMARY_HEADING_RE.match(line):
+            summary_heading_idx = i
+            break
+
+    if summary_heading_idx is None:
+        return None
+
+    start = summary_heading_idx + 1
+    end = len(lines)
+    for i in range(start, len(lines)):
+        if MARKDOWN_HEADING_RE.match(lines[i].strip()):
+            end = i
+            break
+    return (start, end)
+
+
 def extract_metadata(file_path) -> {}:
     """
     Collect relevant metadata from UD directories.
@@ -114,22 +148,18 @@ def extract_metadata(file_path) -> {}:
 
     with open(file_path, 'r') as file:
         lines = [line.strip() for line in file.readlines()]
-        summary_start = None
-        summary_end = None
-        for i, line in enumerate(lines):
-            if not summary_start and line.strip().startswith('# '):
-                summary_start = i + 1
-            elif summary_start and line.strip().startswith('# '):
-                summary_end = i - 1
-                break
-
-        if summary_start and summary_end:
-            # we have a summary
-            metadata["summary"] = (' '.join(lines[summary_start:summary_end])).strip()
+        summary_bounds = find_summary_bounds(lines)
+        metadata_scan_start = 0
+        if summary_bounds is not None:
+            summary_start, summary_end = summary_bounds
+            metadata_scan_start = summary_end
+            summary = (' '.join(lines[summary_start:summary_end])).strip()
+            if summary:
+                metadata["summary"] = summary
 
         # This is a (quite hackish) approach inspired by:
         # https://github.com/UniversalDependencies/LICENSE/blob/master/generate_license_for_lindat.pl
-        for line in lines[summary_end:]:
+        for line in lines[metadata_scan_start:]:
             if ":" in line:
                 key, val = line.split(":", 1)
                 if key.lower() in metadata.keys():