tools: unify wrappers and optimize fetch/metadata scripts

ADDING_NEW_UD_VERSION.md

@@ -99,9 +99,12 @@ cat .env
 
 # This creates:
 # - etc/codes_and_flags-2.18.yaml
-# - etc/codes_and_flags-latest.yaml (updated symlink)
+# - etc/codes_and_flags-latest.yaml
 ```
 
+By default, the script fetches the configured `UD_VER` and `latest`.
+Use `--all` only when you want to refresh all mapped versions.
+
 **Before running**, update the script with the docs-automation commit hash:
 
 1. Open `00_fetch_ud_codes_and_flags.sh`

tools/00_fetch_ud_codes_and_flags.sh

@@ -1,6 +1,14 @@
 #!/usr/bin/env bash
 #
 
+set -euo pipefail
+
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
+ETC_DIR="${SCRIPT_DIR}/etc"
+ENV_FILE="${SCRIPT_DIR}/.env"
+
+[ -e "${ENV_FILE}" ] && . "${ENV_FILE}"
+
 # This is a manual mapping of versions of codes_and_flags.yaml from:
 # * https://github.com/UniversalDependencies/docs-automation/commits/master/codes_and_flags.yaml
 # (identified by commit hash) matched to the closest date of UD versions from:
@@ -25,8 +33,8 @@ VER_MAPPING["latest"]="e3847a587baa2a5a7345049b8b2c109ad2162c21"
 # USAGE
 #
 usage() { OUTPUT=${1:-"verbose"}
-echo "Usage: $0 [-o]" >&2
-[ $OUTPUT = "short" ] && exit 0
+echo "Usage: $0 [-o] [-r VER] [-a]" >&2
+[ "${OUTPUT}" = "short" ] && exit 0
 >&2 cat << EOF
 
 Download versions of
@@ -44,6 +52,8 @@ German:
 Options:
     -h              Print this help message
     -o|--online     Enable online mode: (re-fetch files from GitHub)
+    -r|--rev VER    Download one version (default: UD_VER from .env)
+    -a|--all        Download all mapped versions
 EOF
 }
 #
@@ -52,41 +62,72 @@ EOF
 ##################
 
 ONLINE_MODE=false
+ALL_MODE=false
+TARGET_VER="${UD_VER:-2.17}"
 
-VALID_ARGS=$(getopt -o ho --long help,online -- "$@")
+VALID_ARGS=$(getopt -o hoar: --long help,online,all,rev: -- "$@")
 if [[ $? -ne 0 ]]; then
   usage "short"
-  exit 1;
+  exit 1
 fi
 eval set -- "$VALID_ARGS"
 while [ : ]
 do
   case "$1" in
     -o | --online) ONLINE_MODE=true; shift   ;;
+    -a | --all)    ALL_MODE=true;    shift   ;;
+    -r | --rev)    TARGET_VER="$2";  shift 2 ;;
     -h | --help)   usage;            shift   ; exit 0;;
     --)                              shift   ; break ;;
     *) >&2 echo Unsupported option: $1; usage; exit 1;;
   esac
 done
 
-set -uo pipefail
-for key in ${!VER_MAPPING[@]}
-do
-    VER="${key}"
-    GIT_HASH="${VER_MAPPING[${key}]}"
-
-    CODES_AND_FLAGS_FN="etc/codes_and_flags-${VER}.yaml"
-    CODES_AND_FLAGS_URL="https://github.com/UniversalDependencies/docs-automation/blob/${GIT_HASH}/codes_and_flags.yaml"
-    CODES_AND_FLAGS_RAW_URL="https://raw.githubusercontent.com/UniversalDependencies/docs-automation/${GIT_HASH}/codes_and_flags.yaml"
-
-    # Fuction to get github API content
-    get_codes_and_flags() {
-        wget "${CODES_AND_FLAGS_RAW_URL}" -O "${CODES_AND_FLAGS_FN}"
-    }
-
-    # Check if the online argument is present
-    if [[ $ONLINE_MODE == true ]] || [[ ! -e ${CODES_AND_FLAGS_FN} ]]; then
-      # Download content
-      get_codes_and_flags
+download_codes_and_flags() {
+    local ver="$1"
+    local git_hash="$2"
+    local codes_and_flags_fn="${ETC_DIR}/codes_and_flags-${ver}.yaml"
+    local codes_and_flags_raw_url="https://raw.githubusercontent.com/UniversalDependencies/docs-automation/${git_hash}/codes_and_flags.yaml"
+
+    if [[ "${ONLINE_MODE}" != true ]] && [[ -e "${codes_and_flags_fn}" ]]; then
+        return 0
+    fi
+
+    if command -v curl >/dev/null 2>&1; then
+        curl -fL --retry 3 --retry-delay 1 "${codes_and_flags_raw_url}" -o "${codes_and_flags_fn}"
+    elif command -v wget >/dev/null 2>&1; then
+        wget "${codes_and_flags_raw_url}" -O "${codes_and_flags_fn}"
+    else
+        python3 - "${codes_and_flags_raw_url}" "${codes_and_flags_fn}" <<'PY'
+import sys
+from urllib.request import urlretrieve
+
+urlretrieve(sys.argv[1], sys.argv[2])
+PY
     fi
+}
+
+mkdir -p "${ETC_DIR}"
+
+declare -a TARGET_VERSIONS=()
+if [[ "${ALL_MODE}" == true ]]; then
+    mapfile -t TARGET_VERSIONS < <(printf '%s\n' "${!VER_MAPPING[@]}" | awk '/^[0-9]+\.[0-9]+$/' | sort -V)
+    if [[ -n "${VER_MAPPING[latest]:-}" ]]; then
+        TARGET_VERSIONS+=("latest")
+    fi
+else
+    if [[ -z "${VER_MAPPING[${TARGET_VER}]:-}" ]]; then
+        >&2 echo "Unsupported version: ${TARGET_VER}"
+        >&2 echo "Available versions: $(printf '%s ' "${!VER_MAPPING[@]}" | sed 's/ $//')"
+        exit 1
+    fi
+    TARGET_VERSIONS+=("${TARGET_VER}")
+    # Keep codes_and_flags-latest.yaml in sync when downloading a single version.
+    if [[ "${TARGET_VER}" != "latest" ]] && [[ -n "${VER_MAPPING[latest]:-}" ]]; then
+        TARGET_VERSIONS+=("latest")
+    fi
+fi
+
+for ver in "${TARGET_VERSIONS[@]}"; do
+    download_codes_and_flags "${ver}" "${VER_MAPPING[${ver}]}"
 done

tools/02_generate_metadata.py

@@ -268,17 +268,17 @@ def traverse_directory(directory):
             #   2. sets without a summary, files or license
             if not results[item]["summary"]:
                 del results[item]
-                print(f"ITEM DELETED - no summary: {item}")
+                logging.warning("ITEM DELETED - no summary: %s", item)
 
             if not any([value["files"] for value in
                         results[item]["splits"].values()]):
-                print(results[item]["splits"])
+                logging.debug(results[item]["splits"])
                 del results[item]
-                print(f"ITEM DELETED - no files  : {item}")
+                logging.warning("ITEM DELETED - no files: %s", item)
 
             if not results[item]["license"]:
                 del results[item]
-                print(f"ITEM DELETED - no license: {item}")
+                logging.warning("ITEM DELETED - no license: %s", item)
 
     # Swap keys and key.value()["name"]; add old key as key.value()["dirname"]
     for key in list(results.keys()):
@@ -317,9 +317,7 @@ if __name__ == '__main__':
             results[name]["blocked"] = False
 
     for name, metadata in results.items():
-        print(f"Directory: {metadata['dirname']}")
-        # print(metadata)
-        # print('---')
+        logging.debug("Directory: %s", metadata["dirname"])
 
     # Write the metadata to json
     output_fn = f"metadata-{UD_VER}.json"

tools/03_generate_README.py

@@ -7,7 +7,7 @@ import json
 import argparse
 import logging
 from os import getenv
-from pathlib import Path, PurePath
+from pathlib import Path
 
 import jinja2
 from dotenv import load_dotenv

tools/04_generate_parquet.py

@@ -29,10 +29,14 @@ Note for developers:
 import argparse
 import os
 import sys
-from pathlib import Path
 
 from dotenv import load_dotenv
-from ud_hf_parquet_tools.cli import main as ud_tools_main
+from _ud_hfp_wrapper import (
+    append_common_selection_args,
+    append_common_verbosity_args,
+    get_repo_paths,
+    run_ud_tools,
+)
 
 
 # Load environment variables
@@ -40,11 +44,7 @@ load_dotenv()
 UD_VER = os.getenv("UD_VER", "2.17")
 
 # Project paths
-REPO_ROOT = Path(__file__).parent.parent.resolve()
-METADATA_FILE = REPO_ROOT / f"metadata.json"
-UD_REPOS_DIR = REPO_ROOT / "tools" / "UD_repos"
-OUTPUT_DIR = REPO_ROOT / "parquet"
-BLOCKED_TREEBANKS_FILE = REPO_ROOT / "tools" / "blocked_treebanks.yaml"
+PATHS = get_repo_paths(__file__)
 
 
 def main():
@@ -62,39 +62,25 @@ def main():
     args = parser.parse_args()
 
     # Use default blocked treebanks file if not specified
-    blocked_treebanks_path = args.blocked_treebanks or str(BLOCKED_TREEBANKS_FILE)
+    blocked_treebanks_path = args.blocked_treebanks or str(PATHS.blocked_treebanks_file)
 
     # Build arguments for ud-hf-parquet-tools
     tool_args = [
         "ud-hfp-tools",
         "generate",
-        "--metadata", str(METADATA_FILE),
-        "--ud-repos-dir", str(UD_REPOS_DIR),
-        "--output-dir", str(OUTPUT_DIR),
+        "--metadata", str(PATHS.metadata_file),
+        "--ud-repos-dir", str(PATHS.ud_repos_dir),
+        "--output-dir", str(PATHS.parquet_dir),
         "--blocked-treebanks", blocked_treebanks_path,
     ]
 
-    if args.test:
-        tool_args.append("--test")
-
-    if args.treebanks:
-        tool_args.extend(["--treebanks", args.treebanks])
+    append_common_selection_args(args, tool_args)
 
     if args.overwrite:
         tool_args.append("--overwrite")
 
-    if args.quiet:
-        tool_args.append("--quiet")
-    elif args.verbose:
-        tool_args.append("--verbose")
-
-    # Replace sys.argv and call the library's main function
-    original_argv = sys.argv
-    try:
-        sys.argv = tool_args
-        return ud_tools_main()
-    finally:
-        sys.argv = original_argv
+    append_common_verbosity_args(args, tool_args)
+    return run_ud_tools(tool_args)
 
 
 if __name__ == "__main__":

tools/05_validate_parquet.py

@@ -45,10 +45,14 @@ Note for developers:
 import argparse
 import os
 import sys
-from pathlib import Path
 
 from dotenv import load_dotenv
-from ud_hf_parquet_tools.cli import main as ud_tools_main
+from _ud_hfp_wrapper import (
+    append_common_selection_args,
+    append_common_verbosity_args,
+    get_repo_paths,
+    run_ud_tools,
+)
 
 
 # Load environment variables
@@ -56,10 +60,7 @@ load_dotenv()
 UD_VER = os.getenv("UD_VER", "2.17")
 
 # Project paths
-REPO_ROOT = Path(__file__).parent.parent.resolve()
-METADATA_FILE = REPO_ROOT / "metadata.json"
-UD_REPOS_DIR = REPO_ROOT / "tools" / "UD_repos"
-PARQUET_DIR = REPO_ROOT / "parquet"
+PATHS = get_repo_paths(__file__)
 
 
 def main():
@@ -78,50 +79,27 @@ def main():
     parser.add_argument("-q", "--quiet", action="store_true", help="Quiet mode")
 
     args = parser.parse_args()
+    metadata_path = args.metadata or str(PATHS.metadata_file)
 
     # Build arguments for ud-hf-parquet-tools
     tool_args = [
         "ud-hfp-tools",
         "validate",
-        "--metadata", str(METADATA_FILE),
-        "--ud-repos-dir", str(UD_REPOS_DIR),
+        "--metadata", metadata_path,
+        "--ud-repos-dir", str(PATHS.ud_repos_dir),
     ]
 
     # Handle parquet directory
     if args.parquet_dir:
         tool_args.extend(["--parquet-dir", args.parquet_dir])
     elif args.local:
-        tool_args.extend(["--parquet-dir", str(PARQUET_DIR)])
+        tool_args.extend(["--parquet-dir", str(PATHS.parquet_dir)])
     else:
         # Remote validation
         tool_args.extend(["--revision", args.revision])
-
-    # Handle metadata file
-    if args.metadata:
-        tool_args.extend(["--metadata", args.metadata])
-    elif args.local:
-        tool_args.extend(["--metadata", str(METADATA_FILE)])
-
-    if args.test:
-        tool_args.append("--test")
-
-    if args.treebanks:
-        tool_args.extend(["--treebanks", args.treebanks])
-
-    if args.very_verbose:
-        tool_args.append("-vv")
-    elif args.quiet:
-        tool_args.append("--quiet")
-    elif args.verbose:
-        tool_args.append("--verbose")
-
-    # Replace sys.argv and call the library's main function
-    original_argv = sys.argv
-    try:
-        sys.argv = tool_args
-        return ud_tools_main()
-    finally:
-        sys.argv = original_argv
+    append_common_selection_args(args, tool_args)
+    append_common_verbosity_args(args, tool_args)
+    return run_ud_tools(tool_args)
 
 
 if __name__ == "__main__":

tools/README.md

@@ -40,7 +40,8 @@ git add ../parquet ../README.md ../metadata.json
 
 **00_fetch_ud_codes_and_flags.sh**
 - Downloads language codes and flags from UD docs-automation
-- Creates: `etc/codes_and_flags-{VER}.yaml`, `etc/codes_and_flags-latest.yaml`
+- Default output: `etc/codes_and_flags-{UD_VER}.yaml`, `etc/codes_and_flags-latest.yaml`
+- `--all` output: all mapped `etc/codes_and_flags-{VER}.yaml` files
 - Update `VER_MAPPING` for new versions
 
 ### 01 - Fetch Snapshot

tools/_ud_hfp_wrapper.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env -S uv run
+"""
+Shared wrapper utilities for ud-hf-parquet-tools entrypoint scripts.
+"""
+
+from dataclasses import dataclass
+import sys
+from pathlib import Path
+
+
+@dataclass(frozen=True)
+class RepoPaths:
+    repo_root: Path
+    metadata_file: Path
+    ud_repos_dir: Path
+    parquet_dir: Path
+    blocked_treebanks_file: Path
+
+
+def get_repo_paths(script_file: str) -> RepoPaths:
+    """
+    Resolve repository paths from a script file path.
+    """
+    repo_root = Path(script_file).parent.parent.resolve()
+    return RepoPaths(
+        repo_root=repo_root,
+        metadata_file=repo_root / "metadata.json",
+        ud_repos_dir=repo_root / "tools" / "UD_repos",
+        parquet_dir=repo_root / "parquet",
+        blocked_treebanks_file=repo_root / "tools" / "blocked_treebanks.yaml",
+    )
+
+
+def append_common_selection_args(args, tool_args: list[str]) -> None:
+    """
+    Append common subset-selection flags.
+    """
+    if getattr(args, "test", False):
+        tool_args.append("--test")
+
+    treebanks = getattr(args, "treebanks", None)
+    if treebanks:
+        tool_args.extend(["--treebanks", treebanks])
+
+
+def append_common_verbosity_args(args, tool_args: list[str]) -> None:
+    """
+    Append common verbosity flags with consistent precedence.
+    """
+    if getattr(args, "very_verbose", False):
+        tool_args.append("-vv")
+    elif getattr(args, "quiet", False):
+        tool_args.append("--quiet")
+    elif getattr(args, "verbose", False):
+        tool_args.append("--verbose")
+
+
+def run_ud_tools(tool_args: list[str]) -> int:
+    """
+    Run ud-hf-parquet-tools by emulating command-line invocation.
+    """
+    # Lazy import keeps wrapper help usable even when runtime deps are absent.
+    from ud_hf_parquet_tools.cli import main as ud_tools_main
+
+    original_argv = sys.argv
+    try:
+        sys.argv = tool_args
+        return int(ud_tools_main())
+    finally:
+        sys.argv = original_argv