infra: add griffe to public-symbols check CI

Signed-off-by: emdneto <[email protected]>

Author: emdneto

scripts/eachdist.py

@@ -272,6 +272,21 @@ def setup_instparser(instparser):
         ),
     )
 
+    listparser = subparsers.add_parser(
+        "list",
+        help="List all packages with their relative paths",
+    )
+    listparser.set_defaults(func=list_args)
+    listparser.add_argument(
+        "--mode",
+        "-m",
+        default="DEFAULT",
+        help=cleandoc(
+            """Section of config file to use for target selection configuration.
+        See description of exec for available options."""
+        ),
+    )
+
     return parser.parse_args(args)
 
 
@@ -741,6 +756,22 @@ def version_args(args):
     print(cfg[args.mode]["version"])
 
 
+def list_args(args):
+    rootpath = find_projectroot()
+    targets = find_targets(args.mode, rootpath)
+
+    if not targets:
+        sys.exit(f"Error: No targets selected (root: {rootpath})")
+
+    excluded_dirs = ["docs", "scripts"]
+
+    for target in targets:
+        rel_path = target.relative_to(rootpath)
+        if any(excluded in str(rel_path) for excluded in excluded_dirs):
+            continue
+        print(str(rel_path))
+
+
 def main():
     args = parse_args()
     args.func(args)

scripts/griffe_check.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+OVERALL_EXIT_CODE=0
+BRANCH_TO_COMPARE="main"
+GRIFFE_CMD="griffe check -v -a $BRANCH_TO_COMPARE "
+
+run_griffe_check() {
+    local package_spec="$1"
+    local package_name
+    local search_path=""
+
+    if [[ "$package_spec" == *"/"* ]]; then
+        search_path=$(echo "$package_spec" | cut -d'/' -f1)
+        package_name=$(echo "$package_spec" | cut -d'/' -f2)
+        $GRIFFE_CMD -s "$search_path" "$package_name"
+    else
+        package_name="$package_spec"
+        $GRIFFE_CMD "$package_name"
+    fi
+}
+
+while read -r package; do
+    if ! run_griffe_check "$package"; then
+        OVERALL_EXIT_CODE=1
+    fi
+done < <(python "$(dirname "$0")/eachdist.py" list)
+
+exit $OVERALL_EXIT_CODE

tox.ini

@@ -309,11 +309,16 @@ commands_post =
   docker-compose down -v
 
 [testenv:public-symbols-check]
-basepython: python3
 recreate = True
+allowlist_externals =
+  {toxinidir}/scripts/griffe_check.sh
 deps =
   GitPython==3.1.40
+  griffe==1.7.3
+  toml
 commands =
+  ; griffe check before to fail fast if there are any issues
+  {toxinidir}/scripts/griffe_check.sh
   python {toxinidir}/scripts/public_symbols_checker.py
 
 [testenv:generate-workflows]