$ $PYREFLY check $TMPDIR/does_not_exist --python-version 3.13.0 Path `*/does_not_exist` does not exist (glob) [1]
$ echo "" > $TMPDIR/empty.py && $PYREFLY check $TMPDIR/empty.py --search-path $TMPDIR/does_not_exist Invalid --search-path: `*/does_not_exist` does not exist (glob) [1]
$ touch $TMPDIR/pyrefly.toml && \ > echo "x: str = 12" > $TMPDIR/shown1.py && \ > echo "import shown1; y: int = shown1.x" > $TMPDIR/shown2.py && \ > $PYREFLY check --python-version 3.13.0 $TMPDIR/shown2.py --check-all --output-format=min-text --min-severity=warn WARN importlib/abc.pyi:147:9-41: `ResourceReader` is deprecated [deprecated] WARN importlib/resources/__init__.pyi:49:9-29: `contents` is deprecated [deprecated] WARN importlib/resources/__init__.pyi:79:41-73: `ResourceReader` is deprecated [deprecated] WARN importlib/resources/_common.pyi:8:41-55: `ResourceReader` is deprecated [deprecated] */shown*.py:1:* (glob) */shown*.py:1:* (glob) [1]
$ $PYREFLY check --python-version 3.13.0 "$TMPDIR/*" --project-excludes="$TMPDIR/*" WARN Skipping include pattern `*` because it is matched by `project-excludes` or an ignore file. (glob) `project-excludes`: * (glob) No Python files matched pattern `*` (glob) [1]
$ touch $TMPDIR/pyrefly.toml && \ > echo "1 + '2'" > $TMPDIR/bad.py && \ > $PYREFLY check $TMPDIR/bad.py --output-format=full-text ERROR `+` is not supported * (glob) --> */bad.py:1:1 (glob) | 1 | 1 + '2' | -^^^--- | | | | | has type `Literal['2']` | has type `Literal[1]` | Argument * is not assignable * (glob) [1]
$ touch $TMPDIR/pyrefly.toml && \ > echo "1 + '2'" > $TMPDIR/bad.py && \ > $PYREFLY check $TMPDIR/bad.py --output-format=min-text ERROR */bad.py:1:1-8: `+` is not supported * (glob) [1]
--output emits multiple formats from one checkAn output without a format prefix uses --output-format; an explicit prefix overrides it for that destination.
$ touch $TMPDIR/pyrefly.toml && \ > echo "x: str = 0" > $TMPDIR/bad_multi.py && \ > $PYREFLY check $TMPDIR/bad_multi.py --summary=none --relative-to "$TMPDIR" \ > --output-format=json --output=min-text:- \ > --output="$TMPDIR/diagnostics.json" \ > --output="sarif:$TMPDIR/diagnostics.sarif"; rc=$?; \ > $JQ -r '.errors[0].name' $TMPDIR/diagnostics.json; \ > $JQ -r '.runs[0].results[0].ruleId' $TMPDIR/diagnostics.sarif; \ > exit $rc ERROR bad_multi.py:1:10-11: `Literal[0]` is not assignable to `str` [bad-assignment] bad-assignment bad-assignment [1]
full-text-with-github preserves diagnostics in GitHub Actions logs$ echo "x: str = 0" > $TMPDIR/bad_combined.py && \ > $PYREFLY check $TMPDIR/bad_combined.py --preset strict --output-format=full-text-with-github --summary=none ERROR `Literal[0]` is not assignable to `str` [bad-assignment] --> */bad_combined.py:1:10 (glob) | 1 | x: str = 0 | --- ^ | | | declared type | ::error file=*/bad_combined.py,line=1,col=10,endLine=1,endColumn=11,title=Pyrefly bad-assignment::`Literal[0]` is not assignable to `str` (glob) [1]
$ touch $TMPDIR/pyrefly.toml && \ > echo -e "def f(x: str): ...\nf(0.0)" > $TMPDIR/bad_call.py && \ > $PYREFLY check $TMPDIR/bad_call.py ERROR Argument `float` is not assignable * (glob) --> */bad_call.py:2:3 (glob) | 2 | f(0.0) | ^^^ | [1]
$ touch $TMPDIR/pyrefly.toml && \ > echo -e "def f(x: str): ...\nλ = 0\nf(λ)" > $TMPDIR/bad_call.py && \ > $PYREFLY check $TMPDIR/bad_call.py ERROR Argument `Literal[0]` is not assignable * (glob) --> */bad_call.py:3:3 (glob) | 3 | f(λ) | ^ | [1]
$ touch $TMPDIR/pyrefly.toml && \ > mkdir $TMPDIR/compiled && touch $TMPDIR/compiled/a.pyc && \ > touch $TMPDIR/compiled/b.pyc && touch $TMPDIR/c.pyc && touch $TMPDIR/d.pyc && \ > echo "from compiled import a; import compiled.b; import c; from . import d; reveal_type((a, compiled.b, c, d))" > $TMPDIR/compiled_import.py && \ > $PYREFLY check $TMPDIR/compiled_import.py *ERROR `reveal_type` must be imported from `typing` for runtime usage* (glob) * (glob+) *INFO revealed type: tuple[Unknown, Module[compiled.b], Module[c], Unknown]* (glob) * (glob+) [1]
--min-severity warn causes nonzero exit on warnings$ echo "x: str = 0" > $TMPDIR/test.py && \ > $PYREFLY check $TMPDIR/test.py --warn=bad-assignment --min-severity=warn --output-format=min-text WARN */test.py:1:10-11: `Literal[0]` is not assignable to `str` [bad-assignment] (glob) [1]
--min-severity info causes nonzero exit on directives$ touch $TMPDIR/pyrefly.toml && \ > printf "from typing import reveal_type\nreveal_type(1)\n" > $TMPDIR/test.py && \ > $PYREFLY check $TMPDIR/test.py --min-severity=info --output-format=min-text INFO */test.py:2:12-15: revealed type: Literal[1] [reveal-type] (glob) [1]
--output-format junit-xml emits well-formed XML$ touch $TMPDIR/pyrefly.toml && \ > echo "x: str = 0" > $TMPDIR/bad.py && \ > $PYREFLY check --output-format junit-xml $TMPDIR/bad.py 2>/dev/null <?xml version="1.0" encoding="UTF-8"?> <testsuites> <testsuite name="pyrefly" tests="1" failures="1" errors="0" time="0"> <testcase classname="*/bad.py" name="bad-assignment:L1" file="*/bad.py" line="1" time="0"> (glob) <failure type="bad-assignment" message="`Literal[0]` is not assignable to `str`"><![CDATA[`Literal[0]` is not assignable to `str`]]></failure> </testcase> </testsuite> </testsuites> [1]
--output-format junit-xml omits warnings unless --min-severity=warnSeverity filtering happens before formatting, so by default a warning-level finding produces an empty suite:
$ touch $TMPDIR/pyrefly.toml && \ > echo "x: str = 0" > $TMPDIR/warn.py && \ > $PYREFLY check --warn=bad-assignment --output-format junit-xml $TMPDIR/warn.py 2>/dev/null <?xml version="1.0" encoding="UTF-8"?> <testsuites> <testsuite name="pyrefly" tests="0" failures="0" errors="0" time="0"> </testsuite> </testsuites>
Lowering the threshold with --min-severity=warn includes it, rendered like any other failure with type set to the error kind:
$ touch $TMPDIR/pyrefly.toml && \ > echo "x: str = 0" > $TMPDIR/warn.py && \ > $PYREFLY check --warn=bad-assignment --min-severity=warn --output-format junit-xml $TMPDIR/warn.py 2>/dev/null <?xml version="1.0" encoding="UTF-8"?> <testsuites> <testsuite name="pyrefly" tests="1" failures="1" errors="0" time="0"> <testcase classname="*/warn.py" name="bad-assignment:L1" file="*/warn.py" line="1" time="0"> (glob) <failure type="bad-assignment" message="`Literal[0]` is not assignable to `str`"><![CDATA[`Literal[0]` is not assignable to `str`]]></failure> </testcase> </testsuite> </testsuites> [1]
--output-format sarif emits a complete SARIF report$ SARIF_TEST=$(dirname $TEST_PY)/test/sarif && \ > ($PYREFLY check --python-version 3.13.0 --output-format sarif --relative-to "$SARIF_TEST" \ > "$SARIF_TEST/diagnostics.py" > $TMPDIR/diagnostics.raw.sarif 2>/dev/null; test $? -eq 1) && \ > $JQ '.runs[0].tool.driver.version = "0.0.0"' $TMPDIR/diagnostics.raw.sarif > $TMPDIR/actual.sarif && \ > $JQ . "$SARIF_TEST/diagnostics.expected.sarif" > $TMPDIR/expected.sarif && \ > diff -u $TMPDIR/expected.sarif $TMPDIR/actual.sarif [0]