Add a less verbose second hook

[randolf-scholz]

pyright's output is quite verbose for a pre-commit hook. We can combine it with grep to give much less verbose output:

hooks:
  - id: pyright
    entry: bash -c '! pyright "$@" | grep -Po "(?<=$PWD/)(.*:.*)"' --

Does it make sense to add this as a second hook, maybe "pyright-minimal"?

Of course, a caveat here is that it is less robust and could silently fail if $PWD contains funny special characters.

[randolf-scholz]

A version that preserves the coloring of pyright, based on https://stackoverflow.com/a/20401674:

entry: bash -c '! script -fqc "$(printf "%q " pyright "$@")" /dev/null | grep --color=never -Po "(?<=$PWD/)(.*:.*)"' --

EDIT: This should also work

entry: sh -c '! script -c "pyright $*" /dev/null | grep --color=never -Po "(?<=$PWD/)(.*:.*)"' --

[randolf-scholz]

There seems to be no interest in such a feature, therefore closing. People who want more concise output can use a config like:

  - repo: https://github.com/RobertCraigie/pyright-python
    rev: <version>
    hooks:
      - id: pyright
        entry: |
          sh -c '
              result=$(script -c "pyright $*" /dev/null | grep --color=never -Po "(?<=$PWD/)(.*:.*)");
              count=$(echo -n "$result" | grep -c "^");
              if [ "$count" -ne 0 ]; then
                  echo "$result";
                  echo "\033[1;31mFound ${count} errors\033[0m";
                  exit 1;
              fi
          ' --

[RobertCraigie]

Sorry for the lack of response @randolf-scholz, to be clear you'd want the ouptut to just include the number of errors / warnings, no additional information?

[randolf-scholz]

pyright often gives detailed information that can be really useful, but feels too verbose for a pre-commit hook for my taste. The script above limits the output to one line per error message, and includes the total count of violations.

[randolf-scholz]

Here is a more updated version of what I like to use (requires ripgrep)

#!/bin/env bash

# check that the git root is relative to the current path PWD
# run git root, terminate early if it fails
git_root=$(git rev-parse --show-toplevel) || exit 1
if [[ ! "$PWD" =~ ^"$git_root".* ]]; then
    echo "Error: git root is not a parent of the current path";
    exit 1;
fi

# ANSI color codes with escaping '['.
red="\x1b\[31m"
yellow="\x1b\[33m"
blue="\x1b\[34m"
teal="\x1b\[36m"
default="\x1b\[39m"
grey="\x1b\[90m"

# ANSI color codes without escaping '['.
BLUE_BOLD="\x1b[1;34m"
RED_BOLD="\x1b[1;31m"
TEAL_BOLD="\x1b[1;36m"
RESET="\x1b[0m"  # resets all attributes

# line + column position.
position_regex="${yellow}\d+${default}:${yellow}\d+${default}"
# capture path without the git root.
path_group="${git_root}/(?P<path>[^\r\n]*?:${position_regex})"

fail_pattern="${red}error${default}"
warn_pattern="${teal}warning${default}"
info_pattern="${blue}information${default}"
ecode_pattern="${grey}\x20*\(report\w+\)${default}";

# capture only the first line of the error message and the error code
fail_group="(?P<fail>${fail_pattern}: [^\r\n]*?)(?:[\r\n].*?)?(?P<fail_code>${ecode_pattern})"
warn_group="(?P<warn>${warn_pattern}: [^\r\n]*?)(?:[\r\n].*?)?(?P<warn_code>${ecode_pattern})"
info_group="(?P<info>${info_pattern}: [^\r\n]*)"

# final regex and output format
regex="\x20+${path_group} - (?:${fail_group}|${warn_group}|${info_group})";
output="\$path - \$fail\$fail_code\$warn\$warn_code\$info";

# handling of arguments (needed to deal with files with spaces)
cmd="$(printf '%q ' pyright "$@")";

# run the command and capture the exit code
result="$(
  script /dev/null -efqc "$cmd" |  # -e: forward exit code, -q: quiet, -f: flush output
  rg --multiline --multiline-dotall "$regex" -or "$output";
  exit "${PIPESTATUS[0]}"  # capture the exit code of pyright
)";
pyright_exit_code=$?;
echo "$result";

# summary statistics
fail_count=$(echo -n "$result" | rg -c --include-zero "${fail_pattern}");
warn_count=$(echo -n "$result" | rg -c --include-zero "${warn_pattern}");
info_count=$(echo -n "$result" | rg -c --include-zero "${info_pattern}");
echo -e -n "${RED_BOLD}${fail_count} error${RESET}, "
echo -e -n "${TEAL_BOLD}${warn_count} warning${RESET}, "
echo -e "${BLUE_BOLD}${info_count} information${RESET}"

# check that pyright_exit_code agrees with (fail_count == 0):
if [ "$pyright_exit_code" -ne $(( fail_count > 0 )) ]; then
    echo "Error: pyright exit code does not agree with error count!";
    echo "pyright_exit_code: $pyright_exit_code, fail_count: $fail_count";
    echo "Please file a bug report.";
    exit 1;
fi

exit "$pyright_exit_code"

[randolf-scholz]

What it does is:

• removes lines containing only filename
• shortens paths to be relative to the git root directory
• only print 1 line per error (but goes to some trouble to preserve the error code)

The latter is often enough and feels sufficient for a pre-commit hook. If I need more detailed information on a typing problem, I just call pyright manually on that file or use inline information through pyright plugin.

Before:

After:

[randolf-scholz]

I am hosting this script at https://github.com/randolf-scholz/assorted-hooks/blob/main/src/pyright_wrapper.sh as the hook pyright-concise.