This is an archive of the discontinued LLVM Phabricator instance.

Differential D150545

[NFC][Py Reformat] Reformat python files in llvm
ClosedPublic

Authored by thieta on May 15 2023, 2:05 AM.

Details

Reviewers
jhenderson
JDevlieghere
alexander-shaposhnikov
jdoerfert
MatzeB
Commits
rGb71edfaa4ec3: [NFC][Py Reformat] Reformat python files in llvm
Summary

This is the first commit in a series that will reformat
all the python files in the LLVM repository.

Reformatting is done with black.

See more information here:

https://discourse.llvm.org/t/rfc-document-and-standardize-python-code-style

Diff Detail

Event Timeline

thieta created this revision.May 15 2023, 2:05 AM
Herald added a reviewer: alexander-shaposhnikov. · View Herald TranscriptMay 15 2023, 2:05 AM
Herald added a project: Restricted Project. · View Herald Transcript
Herald added subscribers: luismarques, mattd, gchakrabarti and 17 others. · View Herald Transcript
thieta requested review of this revision.May 15 2023, 2:05 AM
Herald added a reviewer: jdoerfert. · View Herald TranscriptMay 15 2023, 2:05 AM
Herald added a project: Restricted Project. · View Herald Transcript
Herald added subscribers: jplehr, • pcwang-thead, sstefan1 and 3 others. · View Herald Transcript
Harbormaster completed remote builds in B231933: Diff 522087.May 15 2023, 2:59 AM
JDevlieghere accepted this revision.May 15 2023, 10:58 AM

LGTM. I would include something in the commit to make things easier for downstream users. If there are conflicts, they're probably better off keeping their version (git checkout --ours) and rerunning the same black command. I would also make sure to specify which version of black to use (23) as the output changes between versions and some distros might have older versions (when using their package manager instead of pip).

This revision is now accepted and ready to land.May 15 2023, 10:58 AM
MatzeB accepted this revision.May 15 2023, 11:27 AM

Thanks for pushing this!

LGTM too

arichardson added a comment.May 16 2023, 7:54 PM

Having a tool-enforces style will make reviewing contributions to the python scripts much easier since we don't have to worry about coding style. I wonder if it would make sense to also add a pre-commit (https://pre-commit.com/) config file to make it easy to automate?

jhenderson accepted this revision.May 17 2023, 12:17 AM

I picked a few random files and saw no issues from my point of view in them. LGTM.

In D150545#4343142, @JDevlieghere wrote:

LGTM. I would include something in the commit to make things easier for downstream users. If there are conflicts, they're probably better off keeping their version (git checkout --ours) and rerunning the same black command. I would also make sure to specify which version of black to use (23) as the output changes between versions and some distros might have older versions (when using their package manager instead of pip).

This sounds like a good plan to me.

thieta updated this revision to Diff 522949.May 17 2023, 1:45 AM

Rebased and fixed commit message

This revision was landed with ongoing or failed builds.May 17 2023, 1:49 AM
Closed by commit rGb71edfaa4ec3: [NFC][Py Reformat] Reformat python files in llvm (authored by thieta). · Explain Why
This revision was automatically updated to reflect the committed changes.
thieta added a commit: rGb71edfaa4ec3: [NFC][Py Reformat] Reformat python files in llvm.
barannikov88 added a subscriber: barannikov88.May 17 2023, 1:52 AM

There are many lit.local.cfg files in the tree, I suppose some of them need to be reformatted too.

thieta added a comment.May 17 2023, 1:55 AM

Ah, I forgot to update the summary in this diff so the final commit message doesn't contain my help info :(

If anyone finds this diff and are having problems with the commit because rebase/merge issues here is what I wrote and the rest of the commits will contain:

This is the first commit in a series that will reformat
all the python files in the LLVM repository.

Reformatting is done with `black`.

If you end up having problems merging this commit because you
have made changes to a python file, the best way to handle that
is to run git checkout --ours <yourfile> and then reformat it
with black.

If you run into any problems, post to discourse about it and
we will try to help.

RFC Thread below:

https://discourse.llvm.org/t/rfc-document-and-standardize-python-code-style
thieta added a comment.May 17 2023, 1:56 AM
In D150545#4349043, @barannikov88 wrote:

There are many lit.local.cfg files in the tree, I suppose some of them need to be reformatted too.

Thanks for spotting that. Will post another diff for that.

kwk added a subscriber: kwk.May 17 2023, 2:41 AM

@thieta can you please add the commit to the .git-blame-ignore-revs file?

thieta added a comment.May 17 2023, 2:43 AM
In D150545#4349171, @kwk wrote:

@thieta can you please add the commit to the .git-blame-ignore-revs file?

Already did that as soon as I landed it:

https://github.com/llvm/llvm-project/commit/2e18e7bac9c8e11b55a8b4f6c2b63b22b668cc0b

Harbormaster completed remote builds in B232539: Diff 522949.May 17 2023, 3:16 AM
barannikov88 added inline comments.May 17 2023, 1:48 PM
llvm/utils/lit/lit/main.py
97

It appears that the concatenated strings are not really concatenated. Note the " ".

thieta added inline comments.May 17 2023, 1:53 PM
llvm/utils/lit/lit/main.py
97

In Python you can concat strings without the + sign. In this case it's not necessary- but I doubt it will have any impact on the functionality

barannikov88 added inline comments.May 17 2023, 2:04 PM
llvm/utils/lit/lit/main.py
97

Yeah, I know. This just strains a reader's brain. Might be worth doing a post-processing pass to eliminate these, but they are not easy to grep...

MaskRay mentioned this in D119049: [LLD] Allow usage of LLD as a library.Jun 16 2023, 3:31 PM

Large Diff

This large diff affects 262 files. Files without inline comments have been collapsed. Expand All Files

Revision Contents

PathSize
llvm/
bindings/
python/
llvm/
9 lines
33 lines
99 lines
80 lines
328 lines
68 lines
tests/
18 lines
2 lines
16 lines
27 lines
1 line
docs/
194 lines
examples/
Kaleidoscope/
MCJIT/
cached/
153 lines
114 lines
complete/
166 lines
119 lines
lazy/
153 lines
lib/
Analysis/
models/
168 lines
64 lines
121 lines
128 lines
198 lines
42 lines
test/
BugPoint/
2 lines
CodeGen/
AArch64/
Atomics/
158 lines
MLRegalloc/
Inputs/
35 lines
NVPTX/
93 lines
1632 lines
1283 lines
SystemZ/
Large/
50 lines
32 lines
54 lines
54 lines
50 lines
50 lines
46 lines
46 lines
54 lines
54 lines
54 lines
54 lines
24 lines
24 lines
56 lines
WebAssembly/
269 lines
MC/
COFF/
7 lines
Other/
18 lines
TableGen/
13 lines
Transforms/
Inline/
ML/
Inputs/
23 lines
Unit/
49 lines
563 lines
tools/
llvm-debuginfod-find/
Inputs/
22 lines
llvm-libtool-darwin/
Inputs/
12 lines
llvm-objcopy/
Inputs/
19 lines
MachO/
Inputs/
56 lines
llvm-reduce/
Inputs/
6 lines
10 lines
14 lines
14 lines
8 lines
18 lines
llvm-symbolizer/
Inputs/
15 lines
tools/
llvm-shlib/
46 lines
opt-viewer/
22 lines
50 lines
56 lines
332 lines
23 lines
106 lines
sancov/
77 lines
utils/
49 lines
158 lines
Reviewing/
391 lines
Target/
ARM/
35 lines
UpdateTestChecks/
859 lines
2689 lines
91 lines
64 lines
58 lines
92 lines
48 lines
14 lines
303 lines
28 lines
62 lines
94 lines
docker/
scripts/
llvm_checksum/
335 lines
140 lines
121 lines
250 lines
26 lines
filecheck_lint/
364 lines
110 lines
gdb-scripts/
809 lines
git/
293 lines
158 lines
gn/
build/
2 lines
35 lines
16 lines
114 lines
50 lines
8 lines
6 lines
94 lines
51 lines
51 lines
secondary/
libcxx/
utils/
20 lines
llvm/
include/
llvm/
Support/
12 lines
tools/
llvm-config/
7 lines
18 lines
lint/
165 lines
161 lines
18 lines
lit/
examples/
many-tests/
1 line
2 lines
lit/
340 lines
133 lines
10 lines
215 lines
43 lines
139 lines
103 lines
966 lines
19 lines
203 lines
6 lines
builtin_commands/
50 lines
115 lines
461 lines
119 lines
75 lines
formats/
2 lines
68 lines
222 lines
17 lines
llvm/
691 lines
49 lines
184 lines
143 lines
40 lines
168 lines
4 lines
54 lines
tests/
Inputs/
allow-retries/
9 lines
6 lines
config-map-discovery/
7 lines
main-config/
2 lines
custom-result-category/
4 lines
5 lines
discovery/
13 lines
subsuite/
5 lines
exec-discovery-in-tree/
4 lines
fake-externals/
10 lines
googletest-cmd-wrapper/
7 lines
googletest-crash/
DummySubDir/
31 lines
5 lines
googletest-detect-duplicate/
DummySubDir/
22 lines
5 lines
googletest-discovery-failed/
5 lines
googletest-format-respect-gtest-sharding-env-vars/
DummySubDir/
28 lines
5 lines
googletest-format/
DummySubDir/
28 lines
5 lines
googletest-sanitizer-error/
DummySubDir/
26 lines
5 lines
googletest-timeout/
DummySubDir/
30 lines
11 lines
ignore-fail/
5 lines
lit-opts/
7 lines
lld-features/
11 lines
max-failures/
5 lines
max-time/
7 lines
parallelism-groups/
9 lines
progress-bar/
5 lines
py-config-discovery/
5 lines
reorder/
5 lines
show-result-codes/
5 lines
show-used-features/
5 lines
shtest-define/
32 lines
shtest-env/
11 lines
4 lines
shtest-format-argv0/
7 lines
shtest-format/
13 lines
shtest-if-else/
9 lines
shtest-inject/
9 lines
shtest-keyword-parse-errors/
5 lines
shtest-not/
7 lines
5 lines
shtest-output-printing/
5 lines
shtest-pushd-popd/
5 lines
shtest-recursive-substitution/
does-not-substitute-no-limit/
15 lines
does-not-substitute-within-limit/
15 lines
escaping/
5 lines
negative-integer/
5 lines
not-an-integer/
5 lines
set-to-none/
5 lines
substitutes-within-limit/
15 lines
shtest-run-at-line/
4 lines
shtest-shell/
5 lines
9 lines
7 lines
shtest-timeout/
32 lines
standalone-tests-with-excludes/
5 lines
standalone-tests-with-suffixes/
5 lines
standalone-tests/
3 lines
test-data-micro/
17 lines
5 lines
test-data/
12 lines
5 lines
test_retry_attempts/
9 lines
6 lines
testrunner-custom-parsers/
12 lines
unittest-adaptor/
5 lines
use-llvm-tool-required/
11 lines
use-llvm-tool/
43 lines
xfail-cl/
a/
5 lines
b/
5 lines
5 lines
xunit-output/
16 lines
5 lines
91 lines
unit/
196 lines
216 lines
15 lines
210 lines
104 lines
llvm-locstats/
782 lines
963 lines
29 lines
50 lines
212 lines
132 lines
reduce_pipeline_test/
49 lines
89 lines
85 lines
release/
16 lines
220 lines
269 lines
38 lines
76 lines
400 lines
185 lines
225 lines
rsp_bisect_test/
99 lines
10 lines
6 lines
38 lines
438 lines
578 lines
170 lines
116 lines
testgen/
150 lines
48 lines
332 lines
196 lines
906 lines
472 lines
1027 lines
357 lines
493 lines
62 lines
40 lines

Diff 522087

llvm/bindings/python/llvm/bit_reader.py

llvm/bindings/python/llvm/common.py

llvm/bindings/python/llvm/core.py

llvm/bindings/python/llvm/disassembler.py

llvm/bindings/python/llvm/enumerations.py

llvm/bindings/python/llvm/object.py

llvm/bindings/python/llvm/tests/base.py

llvm/bindings/python/llvm/tests/test_bitreader.py

llvm/bindings/python/llvm/tests/test_core.py

llvm/bindings/python/llvm/tests/test_disassembler.py

llvm/bindings/python/llvm/tests/test_object.py

llvm/docs/conf.py

llvm/examples/Kaleidoscope/MCJIT/cached/genk-timing.py

llvm/examples/Kaleidoscope/MCJIT/cached/split-lib.py

llvm/examples/Kaleidoscope/MCJIT/complete/genk-timing.py

llvm/examples/Kaleidoscope/MCJIT/complete/split-lib.py

llvm/examples/Kaleidoscope/MCJIT/lazy/genk-timing.py

llvm/lib/Analysis/models/gen-inline-oz-test-model.py

llvm/lib/Analysis/models/gen-regalloc-eviction-test-model.py

llvm/lib/Analysis/models/gen-regalloc-priority-test-model.py

llvm/lib/Analysis/models/interactive_host.py

llvm/lib/Analysis/models/log_reader.py

llvm/lib/Analysis/models/saved-model-to-tflite.py

llvm/test/BugPoint/compile-custom.ll.py

llvm/test/CodeGen/AArch64/Atomics/generate-tests.py

llvm/test/CodeGen/MLRegalloc/Inputs/interactive_main.py

llvm/test/CodeGen/NVPTX/ld-st-addrrspace.py

llvm/test/CodeGen/NVPTX/surf-tex.py

llvm/test/CodeGen/NVPTX/wmma.py

llvm/test/CodeGen/SystemZ/Large/branch-range-01.py

llvm/test/CodeGen/SystemZ/Large/branch-range-02.py

llvm/test/CodeGen/SystemZ/Large/branch-range-03.py

llvm/test/CodeGen/SystemZ/Large/branch-range-04.py

llvm/test/CodeGen/SystemZ/Large/branch-range-05.py

llvm/test/CodeGen/SystemZ/Large/branch-range-06.py

llvm/test/CodeGen/SystemZ/Large/branch-range-07.py

llvm/test/CodeGen/SystemZ/Large/branch-range-08.py

llvm/test/CodeGen/SystemZ/Large/branch-range-09.py

llvm/test/CodeGen/SystemZ/Large/branch-range-10.py

llvm/test/CodeGen/SystemZ/Large/branch-range-11.py

llvm/test/CodeGen/SystemZ/Large/branch-range-12.py

llvm/test/CodeGen/SystemZ/Large/branch-range-13.py

llvm/test/CodeGen/SystemZ/Large/spill-01.py

llvm/test/CodeGen/SystemZ/Large/spill-02.py

llvm/test/CodeGen/WebAssembly/multivalue-stackify.py

llvm/test/MC/COFF/bigobj.py

llvm/test/Other/opt-bisect-helper.py

llvm/test/TableGen/JSON-check.py

llvm/test/Transforms/Inline/ML/Inputs/interactive_main.py

llvm/test/Unit/lit.cfg.py

llvm/test/lit.cfg.py

llvm/test/tools/llvm-debuginfod-find/Inputs/capture_req.py

llvm/test/tools/llvm-libtool-darwin/Inputs/DependencyDump.py

llvm/test/tools/llvm-objcopy/Inputs/ungzip.py

llvm/test/tools/llvm-objcopy/MachO/Inputs/code-signature-check.py

llvm/test/tools/llvm-reduce/Inputs/llvm-dis-and-filecheck.py

llvm/test/tools/llvm-reduce/Inputs/remove-args.py

llvm/test/tools/llvm-reduce/Inputs/remove-bbs.py

llvm/test/tools/llvm-reduce/Inputs/remove-instructions.py

llvm/test/tools/llvm-reduce/Inputs/sleep-and-check-stores.py

llvm/test/tools/llvm-reduce/remove-bbs-sequence.py

llvm/test/tools/llvm-symbolizer/Inputs/flush-output.py

llvm/tools/llvm-shlib/gen-msvc-exports.py

llvm/tools/opt-viewer/extract-reproducers.py

llvm/tools/opt-viewer/opt-diff.py

llvm/tools/opt-viewer/opt-stats.py

llvm/tools/opt-viewer/opt-viewer.py

llvm/tools/opt-viewer/optpmap.py

llvm/tools/opt-viewer/optrecord.py

llvm/tools/sancov/coverage-report-server.py

llvm/utils/DSAclean.py

llvm/utils/DSAextract.py

llvm/utils/Reviewing/find_interesting_reviews.py

llvm/utils/Target/ARM/analyze-match-table.py

llvm/utils/UpdateTestChecks/asm.py

llvm/utils/UpdateTestChecks/common.py

llvm/utils/UpdateTestChecks/isel.py

llvm/utils/abtest.py

llvm/utils/add_argument_names.py

llvm/utils/bugpoint_gisel_reducer.py

llvm/utils/check_ninja_deps.py

llvm/utils/chunk-print-before-all.py

llvm/utils/collect_and_build_with_pgo.py

llvm/utils/convert-constraint-log-to-z3.py

llvm/utils/create_ladder_graph.py

llvm/utils/demangle_tree.py

llvm/utils/docker/scripts/llvm_checksum/llvm_checksum.py

llvm/utils/docker/scripts/llvm_checksum/project_tree.py

llvm/utils/extract-section.py

llvm/utils/extract_symbols.py

llvm/utils/extract_vplan.py

llvm/utils/filecheck_lint/filecheck_lint.py

llvm/utils/filecheck_lint/filecheck_lint_test.py

llvm/utils/gdb-scripts/prettyprinters.py

llvm/utils/git/github-automation.py

llvm/utils/git/pre-push.py

llvm/utils/gn/build/run_built_binary.py

llvm/utils/gn/build/symbol_exports.py

llvm/utils/gn/build/symlink_or_copy.py

llvm/utils/gn/build/sync_source_lists_from_cmake.py

llvm/utils/gn/build/write_cmake_config.py

llvm/utils/gn/build/write_file.py

llvm/utils/gn/build/write_library_dependencies.py

llvm/utils/gn/build/write_vcsrevision.py

llvm/utils/gn/get.py

llvm/utils/gn/gn.py

llvm/utils/gn/secondary/libcxx/utils/gen_link_script.py

llvm/utils/gn/secondary/llvm/include/llvm/Support/write_extension_def.py

llvm/utils/gn/secondary/llvm/tools/llvm-config/write_extension_dependencies.py

llvm/utils/indirect_calls.py

llvm/utils/lint/common_lint.py

llvm/utils/lint/cpp_lint.py

llvm/utils/lint/generic_lint.py

llvm/utils/lit/examples/many-tests/lit.cfg

llvm/utils/lit/lit.py

llvm/utils/lit/lit/BooleanExpression.py

llvm/utils/lit/lit/LitConfig.py

llvm/utils/lit/lit/LitTestCase.py

llvm/utils/lit/lit/ProgressBar.py

llvm/utils/lit/lit/ShCommands.py

llvm/utils/lit/lit/ShUtil.py

llvm/utils/lit/lit/Test.py

llvm/utils/lit/lit/TestRunner.py

llvm/utils/lit/lit/TestTimes.py

llvm/utils/lit/lit/TestingConfig.py

llvm/utils/lit/lit/__init__.py

llvm/utils/lit/lit/builtin_commands/cat.py

llvm/utils/lit/lit/builtin_commands/diff.py

llvm/utils/lit/lit/cl_arguments.py

llvm/utils/lit/lit/discovery.py

llvm/utils/lit/lit/display.py

llvm/utils/lit/lit/formats/__init__.py

llvm/utils/lit/lit/formats/base.py

llvm/utils/lit/lit/formats/googletest.py

llvm/utils/lit/lit/formats/shtest.py

llvm/utils/lit/lit/llvm/config.py

llvm/utils/lit/lit/llvm/subst.py

llvm/utils/lit/lit/main.py

Show All 19 Lines
import lit.util import lit.util
from lit.formats.googletest import GoogleTest from lit.formats.googletest import GoogleTest
from lit.TestTimes import record_test_times from lit.TestTimes import record_test_times
def main(builtin_params={}): def main(builtin_params={}):
opts = lit.cl_arguments.parse_args() opts = lit.cl_arguments.parse_args()
params = create_params(builtin_params, opts.user_params) params = create_params(builtin_params, opts.user_params)
is_windows = platform.system() == 'Windows' is_windows = platform.system() == "Windows"
lit_config = lit.LitConfig.LitConfig( lit_config = lit.LitConfig.LitConfig(
progname=os.path.basename(sys.argv[0]), progname=os.path.basename(sys.argv[0]),
path=opts.path, path=opts.path,
quiet=opts.quiet, quiet=opts.quiet,
useValgrind=opts.useValgrind, useValgrind=opts.useValgrind,
valgrindLeakCheck=opts.valgrindLeakCheck, valgrindLeakCheck=opts.valgrindLeakCheck,
valgrindArgs=opts.valgrindArgs, valgrindArgs=opts.valgrindArgs,
noExecute=opts.noExecute, noExecute=opts.noExecute,
debug=opts.debug, debug=opts.debug,
isWindows=is_windows, isWindows=is_windows,
order=opts.order, order=opts.order,
params=params, params=params,
config_prefix=opts.configPrefix, config_prefix=opts.configPrefix,
echo_all_commands=opts.echoAllCommands) echo_all_commands=opts.echoAllCommands,
)
discovered_tests = lit.discovery.find_tests_for_inputs(lit_config, opts.test_paths, discovered_tests = lit.discovery.find_tests_for_inputs(
opts.indirectlyRunCheck) lit_config, opts.test_paths, opts.indirectlyRunCheck
)
if not discovered_tests: if not discovered_tests:
sys.stderr.write('error: did not discover any tests for provided path(s)\n') sys.stderr.write("error: did not discover any tests for provided path(s)\n")
sys.exit(2) sys.exit(2)
if opts.show_suites or opts.show_tests: if opts.show_suites or opts.show_tests:
print_discovered(discovered_tests, opts.show_suites, opts.show_tests) print_discovered(discovered_tests, opts.show_suites, opts.show_tests)
sys.exit(0) sys.exit(0)
if opts.show_used_features: if opts.show_used_features:
features = set(itertools.chain.from_iterable(t.getUsedFeatures() for t in discovered_tests if t.gtest_json_file is None)) features = set(
print(' '.join(sorted(features))) itertools.chain.from_iterable(
t.getUsedFeatures()
for t in discovered_tests
if t.gtest_json_file is None
)
)
print(" ".join(sorted(features)))
sys.exit(0) sys.exit(0)
# Command line overrides configuration for maxIndividualTestTime. # Command line overrides configuration for maxIndividualTestTime.
if opts.maxIndividualTestTime is not None: # `not None` is important (default: 0) if opts.maxIndividualTestTime is not None: # `not None` is important (default: 0)
if opts.maxIndividualTestTime != lit_config.maxIndividualTestTime: if opts.maxIndividualTestTime != lit_config.maxIndividualTestTime:
lit_config.note(('The test suite configuration requested an individual' lit_config.note(
' test timeout of {0} seconds but a timeout of {1} seconds was' (
' requested on the command line. Forcing timeout to be {1}' "The test suite configuration requested an individual"
' seconds') " test timeout of {0} seconds but a timeout of {1} seconds was"
.format(lit_config.maxIndividualTestTime, " requested on the command line. Forcing timeout to be {1}"
opts.maxIndividualTestTime)) " seconds"
).format(lit_config.maxIndividualTestTime, opts.maxIndividualTestTime)
)
lit_config.maxIndividualTestTime = opts.maxIndividualTestTime lit_config.maxIndividualTestTime = opts.maxIndividualTestTime
determine_order(discovered_tests, opts.order) determine_order(discovered_tests, opts.order)
selected_tests = [t for t in discovered_tests if selected_tests = [
opts.filter.search(t.getFullName()) and not t
opts.filter_out.search(t.getFullName())] for t in discovered_tests
if opts.filter.search(t.getFullName())
and not opts.filter_out.search(t.getFullName())
]
if not selected_tests: if not selected_tests:
sys.stderr.write('error: filter did not match any tests ' sys.stderr.write(
'(of %d discovered). ' % len(discovered_tests)) "error: filter did not match any tests "
"(of %d discovered). " % len(discovered_tests)
)
if opts.allow_empty_runs: if opts.allow_empty_runs:
sys.stderr.write("Suppressing error because '--allow-empty-runs' " sys.stderr.write(
'was specified.\n') "Suppressing error because '--allow-empty-runs' " "was specified.\n"
barannikov88Unsubmitted
Not Done
ReplyInline Actions

It appears that the concatenated strings are not really concatenated. Note the " ".

barannikov88: It appears that the concatenated strings are not really concatenated. Note the `" "`.
thietaAuthorUnsubmitted
Done
ReplyInline Actions

In Python you can concat strings without the + sign. In this case it's not necessary- but I doubt it will have any impact on the functionality

thieta: In Python you can concat strings without the + sign. In this case it's not necessary- but I…
barannikov88Unsubmitted
Not Done
ReplyInline Actions

Yeah, I know. This just strains a reader's brain. Might be worth doing a post-processing pass to eliminate these, but they are not easy to grep...

barannikov88: Yeah, I know. This just strains a reader's brain. Might be worth doing a post-processing pass…
)
sys.exit(0) sys.exit(0)
else: else:
sys.stderr.write("Use '--allow-empty-runs' to suppress this " sys.stderr.write("Use '--allow-empty-runs' to suppress this " "error.\n")
'error.\n')
sys.exit(2) sys.exit(2)
# When running multiple shards, don't include skipped tests in the xunit # When running multiple shards, don't include skipped tests in the xunit
# output since merging the files will result in duplicates. # output since merging the files will result in duplicates.
if opts.shard: if opts.shard:
(run, shards) = opts.shard (run, shards) = opts.shard
selected_tests = filter_by_shard(selected_tests, run, shards, lit_config) selected_tests = filter_by_shard(selected_tests, run, shards, lit_config)
if not selected_tests: if not selected_tests:
sys.stderr.write('warning: shard does not contain any tests. ' sys.stderr.write(
'Consider decreasing the number of shards.\n') "warning: shard does not contain any tests. "
"Consider decreasing the number of shards.\n"
)
sys.exit(0) sys.exit(0)
selected_tests = selected_tests[:opts.max_tests] selected_tests = selected_tests[: opts.max_tests]
mark_xfail(discovered_tests, opts) mark_xfail(discovered_tests, opts)
mark_excluded(discovered_tests, selected_tests) mark_excluded(discovered_tests, selected_tests)
start = time.time() start = time.time()
run_tests(selected_tests, lit_config, opts, len(discovered_tests)) run_tests(selected_tests, lit_config, opts, len(discovered_tests))
elapsed = time.time() - start elapsed = time.time() - start
record_test_times(selected_tests, lit_config) record_test_times(selected_tests, lit_config)
selected_tests, discovered_tests = GoogleTest.post_process_shard_results( selected_tests, discovered_tests = GoogleTest.post_process_shard_results(
selected_tests, discovered_tests) selected_tests, discovered_tests
)
if opts.time_tests: if opts.time_tests:
print_histogram(discovered_tests) print_histogram(discovered_tests)
print_results(discovered_tests, elapsed, opts) print_results(discovered_tests, elapsed, opts)
tests_for_report = selected_tests if opts.shard else discovered_tests tests_for_report = selected_tests if opts.shard else discovered_tests
for report in opts.reports: for report in opts.reports:
report.write_results(tests_for_report, elapsed) report.write_results(tests_for_report, elapsed)
if lit_config.numErrors: if lit_config.numErrors:
sys.stderr.write('\n%d error(s) in tests\n' % lit_config.numErrors) sys.stderr.write("\n%d error(s) in tests\n" % lit_config.numErrors)
sys.exit(2) sys.exit(2)
if lit_config.numWarnings: if lit_config.numWarnings:
sys.stderr.write('\n%d warning(s) in tests\n' % lit_config.numWarnings) sys.stderr.write("\n%d warning(s) in tests\n" % lit_config.numWarnings)
has_failure = any(t.isFailure() for t in discovered_tests) has_failure = any(t.isFailure() for t in discovered_tests)
if has_failure: if has_failure:
if opts.ignoreFail: if opts.ignoreFail:
sys.stderr.write("\nExiting with status 0 instead of 1 because " sys.stderr.write(
"'--ignore-fail' was specified.\n") "\nExiting with status 0 instead of 1 because "
"'--ignore-fail' was specified.\n"
)
else: else:
sys.exit(1) sys.exit(1)
def create_params(builtin_params, user_params): def create_params(builtin_params, user_params):
def parse(p): def parse(p):
return p.split('=', 1) if '=' in p else (p, '') return p.split("=", 1) if "=" in p else (p, "")
params = dict(builtin_params) params = dict(builtin_params)
params.update([parse(p) for p in user_params]) params.update([parse(p) for p in user_params])
return params return params
def print_discovered(tests, show_suites, show_tests): def print_discovered(tests, show_suites, show_tests):
tests.sort(key=lit.reports.by_suite_and_test_path) tests.sort(key=lit.reports.by_suite_and_test_path)
if show_suites: if show_suites:
tests_by_suite = itertools.groupby(tests, lambda t: t.suite) tests_by_suite = itertools.groupby(tests, lambda t: t.suite)
print('-- Test Suites --') print("-- Test Suites --")
for suite, test_iter in tests_by_suite: for suite, test_iter in tests_by_suite:
test_count = sum(1 for _ in test_iter) test_count = sum(1 for _ in test_iter)
print(' %s - %d tests' % (suite.name, test_count)) print(" %s - %d tests" % (suite.name, test_count))
print(' Source Root: %s' % suite.source_root) print(" Source Root: %s" % suite.source_root)
print(' Exec Root : %s' % suite.exec_root) print(" Exec Root : %s" % suite.exec_root)
features = ' '.join(sorted(suite.config.available_features)) features = " ".join(sorted(suite.config.available_features))
print(' Available Features: %s' % features) print(" Available Features: %s" % features)
substitutions = sorted(suite.config.substitutions) substitutions = sorted(suite.config.substitutions)
substitutions = ('%s => %s' % (x, y) for (x, y) in substitutions) substitutions = ("%s => %s" % (x, y) for (x, y) in substitutions)
substitutions = '\n'.ljust(30).join(substitutions) substitutions = "\n".ljust(30).join(substitutions)
print(' Available Substitutions: %s' % substitutions) print(" Available Substitutions: %s" % substitutions)
if show_tests: if show_tests:
print('-- Available Tests --') print("-- Available Tests --")
for t in tests: for t in tests:
print(' %s' % t.getFullName()) print(" %s" % t.getFullName())
def determine_order(tests, order): def determine_order(tests, order):
from lit.cl_arguments import TestOrder from lit.cl_arguments import TestOrder
enum_order = TestOrder(order) enum_order = TestOrder(order)
if enum_order == TestOrder.RANDOM: if enum_order == TestOrder.RANDOM:
import random import random
random.shuffle(tests) random.shuffle(tests)
elif enum_order == TestOrder.LEXICAL: elif enum_order == TestOrder.LEXICAL:
tests.sort(key=lambda t: t.getFullName()) tests.sort(key=lambda t: t.getFullName())
else: else:
assert enum_order == TestOrder.SMART, 'Unknown TestOrder value' assert enum_order == TestOrder.SMART, "Unknown TestOrder value"
tests.sort(key=lambda t: (not t.previous_failure, -t.previous_elapsed, t.getFullName())) tests.sort(
key=lambda t: (not t.previous_failure, -t.previous_elapsed, t.getFullName())
)
def filter_by_shard(tests, run, shards, lit_config): def filter_by_shard(tests, run, shards, lit_config):
test_ixs = range(run - 1, len(tests), shards) test_ixs = range(run - 1, len(tests), shards)
selected_tests = [tests[i] for i in test_ixs] selected_tests = [tests[i] for i in test_ixs]
# For clarity, generate a preview of the first few test indices in the shard # For clarity, generate a preview of the first few test indices in the shard
# to accompany the arithmetic expression. # to accompany the arithmetic expression.
preview_len = 3 preview_len = 3
preview = ', '.join([str(i + 1) for i in test_ixs[:preview_len]]) preview = ", ".join([str(i + 1) for i in test_ixs[:preview_len]])
if len(test_ixs) > preview_len: if len(test_ixs) > preview_len:
preview += ', ...' preview += ", ..."
msg = f'Selecting shard {run}/{shards} = ' \ msg = (
f'size {len(selected_tests)}/{len(tests)} = ' \ f"Selecting shard {run}/{shards} = "
f'tests #({shards}*k)+{run} = [{preview}]' f"size {len(selected_tests)}/{len(tests)} = "
f"tests #({shards}*k)+{run} = [{preview}]"
)
lit_config.note(msg) lit_config.note(msg)
return selected_tests return selected_tests
def mark_xfail(selected_tests, opts): def mark_xfail(selected_tests, opts):
for t in selected_tests: for t in selected_tests:
test_file = os.sep.join(t.path_in_suite) test_file = os.sep.join(t.path_in_suite)
test_full_name = t.getFullName() test_full_name = t.getFullName()
if test_file in opts.xfail or test_full_name in opts.xfail: if test_file in opts.xfail or test_full_name in opts.xfail:
t.xfails += '*' t.xfails += "*"
if test_file in opts.xfail_not or test_full_name in opts.xfail_not: if test_file in opts.xfail_not or test_full_name in opts.xfail_not:
t.xfail_not = True t.xfail_not = True
def mark_excluded(discovered_tests, selected_tests): def mark_excluded(discovered_tests, selected_tests):
excluded_tests = set(discovered_tests) - set(selected_tests) excluded_tests = set(discovered_tests) - set(selected_tests)
result = lit.Test.Result(lit.Test.EXCLUDED) result = lit.Test.Result(lit.Test.EXCLUDED)
for t in excluded_tests: for t in excluded_tests:
t.setResult(result) t.setResult(result)
def run_tests(tests, lit_config, opts, discovered_tests): def run_tests(tests, lit_config, opts, discovered_tests):
workers = min(len(tests), opts.workers) workers = min(len(tests), opts.workers)
display = lit.display.create_display(opts, tests, discovered_tests, workers) display = lit.display.create_display(opts, tests, discovered_tests, workers)
run = lit.run.Run(tests, lit_config, workers, display.update, run = lit.run.Run(
opts.max_failures, opts.timeout) tests, lit_config, workers, display.update, opts.max_failures, opts.timeout
)
display.print_header() display.print_header()
interrupted = False interrupted = False
error = None error = None
try: try:
execute_in_tmp_dir(run, lit_config) execute_in_tmp_dir(run, lit_config)
except KeyboardInterrupt: except KeyboardInterrupt:
interrupted = True interrupted = True
error = ' interrupted by user' error = " interrupted by user"
except lit.run.MaxFailuresError: except lit.run.MaxFailuresError:
error = 'warning: reached maximum number of test failures' error = "warning: reached maximum number of test failures"
except lit.run.TimeoutError: except lit.run.TimeoutError:
error = 'warning: reached timeout' error = "warning: reached timeout"
display.clear(interrupted) display.clear(interrupted)
if error: if error:
sys.stderr.write('%s, skipping remaining tests\n' % error) sys.stderr.write("%s, skipping remaining tests\n" % error)
def execute_in_tmp_dir(run, lit_config): def execute_in_tmp_dir(run, lit_config):
# Create a temp directory inside the normal temp directory so that we can # Create a temp directory inside the normal temp directory so that we can
# try to avoid temporary test file leaks. The user can avoid this behavior # try to avoid temporary test file leaks. The user can avoid this behavior
# by setting LIT_PRESERVES_TMP in the environment, so they can easily use # by setting LIT_PRESERVES_TMP in the environment, so they can easily use
# their own temp directory to monitor temporary file leaks or handle them at # their own temp directory to monitor temporary file leaks or handle them at
# the buildbot level. # the buildbot level.
tmp_dir = None tmp_dir = None
if 'LIT_PRESERVES_TMP' not in os.environ: if "LIT_PRESERVES_TMP" not in os.environ:
import tempfile import tempfile
# z/OS linker does not support '_' in paths, so use '-'. # z/OS linker does not support '_' in paths, so use '-'.
tmp_dir = tempfile.mkdtemp(prefix='lit-tmp-') tmp_dir = tempfile.mkdtemp(prefix="lit-tmp-")
tmp_dir_envs = {k: tmp_dir for k in ['TMP', 'TMPDIR', 'TEMP', 'TEMPDIR']} tmp_dir_envs = {k: tmp_dir for k in ["TMP", "TMPDIR", "TEMP", "TEMPDIR"]}
os.environ.update(tmp_dir_envs) os.environ.update(tmp_dir_envs)
for cfg in {t.config for t in run.tests}: for cfg in {t.config for t in run.tests}:
cfg.environment.update(tmp_dir_envs) cfg.environment.update(tmp_dir_envs)
try: try:
run.execute() run.execute()
finally: finally:
if tmp_dir: if tmp_dir:
try: try:
import shutil import shutil
shutil.rmtree(tmp_dir) shutil.rmtree(tmp_dir)
except Exception as e: except Exception as e:
lit_config.warning("Failed to delete temp directory '%s', try upgrading your version of Python to fix this" % tmp_dir) lit_config.warning(
"Failed to delete temp directory '%s', try upgrading your version of Python to fix this"
% tmp_dir
)
def print_histogram(tests): def print_histogram(tests):
test_times = [(t.getFullName(), t.result.elapsed) test_times = [
for t in tests if t.result.elapsed] (t.getFullName(), t.result.elapsed) for t in tests if t.result.elapsed
]
if test_times: if test_times:
lit.util.printHistogram(test_times, title='Tests') lit.util.printHistogram(test_times, title="Tests")
def print_results(tests, elapsed, opts): def print_results(tests, elapsed, opts):
tests_by_code = {code: [] for code in lit.Test.ResultCode.all_codes()} tests_by_code = {code: [] for code in lit.Test.ResultCode.all_codes()}
for test in tests: for test in tests:
tests_by_code[test.result.code].append(test) tests_by_code[test.result.code].append(test)
for code in lit.Test.ResultCode.all_codes(): for code in lit.Test.ResultCode.all_codes():
print_group(sorted(tests_by_code[code], key=lambda t: t.getFullName()), code, opts.shown_codes) print_group(
sorted(tests_by_code[code], key=lambda t: t.getFullName()),
code,
opts.shown_codes,
)
print_summary(tests_by_code, opts.quiet, elapsed) print_summary(tests_by_code, opts.quiet, elapsed)
def print_group(tests, code, shown_codes): def print_group(tests, code, shown_codes):
if not tests: if not tests:
return return
if not code.isFailure and code not in shown_codes: if not code.isFailure and code not in shown_codes:
return return
print('*' * 20) print("*" * 20)
print('{} Tests ({}):'.format(code.label, len(tests))) print("{} Tests ({}):".format(code.label, len(tests)))
for test in tests: for test in tests:
print(' %s' % test.getFullName()) print(" %s" % test.getFullName())
sys.stdout.write('\n') sys.stdout.write("\n")
def print_summary(tests_by_code, quiet, elapsed): def print_summary(tests_by_code, quiet, elapsed):
if not quiet: if not quiet:
print('\nTesting Time: %.2fs' % elapsed) print("\nTesting Time: %.2fs" % elapsed)
codes = [c for c in lit.Test.ResultCode.all_codes() codes = [c for c in lit.Test.ResultCode.all_codes() if not quiet or c.isFailure]
if not quiet or c.isFailure]
groups = [(c.label, len(tests_by_code[c])) for c in codes] groups = [(c.label, len(tests_by_code[c])) for c in codes]
groups = [(label, count) for label, count in groups if count] groups = [(label, count) for label, count in groups if count]
if not groups: if not groups:
return return
max_label_len = max(len(label) for label, _ in groups) max_label_len = max(len(label) for label, _ in groups)
max_count_len = max(len(str(count)) for _, count in groups) max_count_len = max(len(str(count)) for _, count in groups)
for (label, count) in groups: for (label, count) in groups:
label = label.ljust(max_label_len) label = label.ljust(max_label_len)
count = str(count).rjust(max_count_len) count = str(count).rjust(max_count_len)
print(' %s: %s' % (label, count)) print(" %s: %s" % (label, count))

llvm/utils/lit/lit/reports.py

llvm/utils/lit/lit/run.py

llvm/utils/lit/lit/util.py

llvm/utils/lit/lit/worker.py

llvm/utils/lit/setup.py

llvm/utils/lit/tests/Inputs/allow-retries/lit.cfg

llvm/utils/lit/tests/Inputs/allow-retries/succeeds-within-limit.py

llvm/utils/lit/tests/Inputs/config-map-discovery/driver.py

llvm/utils/lit/tests/Inputs/config-map-discovery/main-config/lit.cfg

llvm/utils/lit/tests/Inputs/custom-result-category/format.py

llvm/utils/lit/tests/Inputs/custom-result-category/lit.cfg

llvm/utils/lit/tests/Inputs/discovery/lit.cfg

llvm/utils/lit/tests/Inputs/discovery/subsuite/lit.cfg

llvm/utils/lit/tests/Inputs/exec-discovery-in-tree/lit.cfg

llvm/utils/lit/tests/Inputs/fake-externals/fake_external.py

llvm/utils/lit/tests/Inputs/googletest-cmd-wrapper/lit.cfg

llvm/utils/lit/tests/Inputs/googletest-crash/DummySubDir/OneTest.py

llvm/utils/lit/tests/Inputs/googletest-crash/lit.cfg

llvm/utils/lit/tests/Inputs/googletest-detect-duplicate/DummySubDir/OneTest.py

llvm/utils/lit/tests/Inputs/googletest-detect-duplicate/lit.cfg

llvm/utils/lit/tests/Inputs/googletest-discovery-failed/lit.cfg

llvm/utils/lit/tests/Inputs/googletest-format-respect-gtest-sharding-env-vars/DummySubDir/OneTest.py

llvm/utils/lit/tests/Inputs/googletest-format-respect-gtest-sharding-env-vars/lit.cfg

llvm/utils/lit/tests/Inputs/googletest-format/DummySubDir/OneTest.py

llvm/utils/lit/tests/Inputs/googletest-format/lit.cfg

llvm/utils/lit/tests/Inputs/googletest-sanitizer-error/DummySubDir/OneTest.py

llvm/utils/lit/tests/Inputs/googletest-sanitizer-error/lit.cfg

llvm/utils/lit/tests/Inputs/googletest-timeout/DummySubDir/OneTest.py

llvm/utils/lit/tests/Inputs/googletest-timeout/lit.cfg

llvm/utils/lit/tests/Inputs/ignore-fail/lit.cfg

llvm/utils/lit/tests/Inputs/lit-opts/lit.cfg

llvm/utils/lit/tests/Inputs/lld-features/lit.cfg

llvm/utils/lit/tests/Inputs/max-failures/lit.cfg

llvm/utils/lit/tests/Inputs/max-time/lit.cfg

llvm/utils/lit/tests/Inputs/parallelism-groups/lit.cfg

llvm/utils/lit/tests/Inputs/progress-bar/lit.cfg

llvm/utils/lit/tests/Inputs/py-config-discovery/lit.site.cfg.py

llvm/utils/lit/tests/Inputs/reorder/lit.cfg

llvm/utils/lit/tests/Inputs/show-result-codes/lit.cfg

llvm/utils/lit/tests/Inputs/show-used-features/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-define/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-env/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-env/print_environment.py

llvm/utils/lit/tests/Inputs/shtest-format-argv0/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-format/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-if-else/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-inject/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-keyword-parse-errors/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-not/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-not/print_environment.py

llvm/utils/lit/tests/Inputs/shtest-output-printing/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-pushd-popd/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-recursive-substitution/does-not-substitute-no-limit/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-recursive-substitution/does-not-substitute-within-limit/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-recursive-substitution/escaping/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-recursive-substitution/negative-integer/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-recursive-substitution/not-an-integer/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-recursive-substitution/set-to-none/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-recursive-substitution/substitutes-within-limit/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-run-at-line/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-shell/check_args.py

llvm/utils/lit/tests/Inputs/shtest-shell/check_path.py

llvm/utils/lit/tests/Inputs/shtest-shell/lit.cfg

llvm/utils/lit/tests/Inputs/shtest-timeout/lit.cfg

llvm/utils/lit/tests/Inputs/standalone-tests-with-excludes/lit.cfg

llvm/utils/lit/tests/Inputs/standalone-tests-with-suffixes/lit.cfg

llvm/utils/lit/tests/Inputs/standalone-tests/lit.cfg

llvm/utils/lit/tests/Inputs/test-data-micro/dummy_format.py

llvm/utils/lit/tests/Inputs/test-data-micro/lit.cfg

llvm/utils/lit/tests/Inputs/test-data/dummy_format.py

llvm/utils/lit/tests/Inputs/test-data/lit.cfg

llvm/utils/lit/tests/Inputs/test_retry_attempts/lit.cfg

llvm/utils/lit/tests/Inputs/test_retry_attempts/test.py

llvm/utils/lit/tests/Inputs/testrunner-custom-parsers/lit.cfg

llvm/utils/lit/tests/Inputs/unittest-adaptor/lit.cfg

llvm/utils/lit/tests/Inputs/use-llvm-tool-required/lit.cfg

llvm/utils/lit/tests/Inputs/use-llvm-tool/lit.cfg

llvm/utils/lit/tests/Inputs/xfail-cl/a/lit.cfg

llvm/utils/lit/tests/Inputs/xfail-cl/b/lit.cfg

llvm/utils/lit/tests/Inputs/xfail-cl/lit.cfg

llvm/utils/lit/tests/Inputs/xunit-output/dummy_format.py

llvm/utils/lit/tests/Inputs/xunit-output/lit.cfg

llvm/utils/lit/tests/lit.cfg

llvm/utils/lit/tests/unit/ShUtil.py

llvm/utils/lit/tests/unit/TestRunner.py

llvm/utils/lit/tests/unparsed-requirements.py

llvm/utils/lldbDataFormatters.py

llvm/utils/llvm-gisel-cov.py

llvm/utils/llvm-locstats/llvm-locstats.py

llvm/utils/llvm-original-di-preservation.py

llvm/utils/merge-stats.py

llvm/utils/pipeline.py

llvm/utils/prepare-code-coverage-artifact.py

llvm/utils/reduce_pipeline.py

llvm/utils/reduce_pipeline_test/fake_opt.py

llvm/utils/reduce_pipeline_test/test.py

llvm/utils/relative_lines.py

llvm/utils/release/bump-version.py

llvm/utils/release/findRegressions-nightly.py

llvm/utils/release/findRegressions-simple.py

llvm/utils/release/github-upload-release.py

llvm/utils/remote-exec.py

llvm/utils/revert_checker.py

llvm/utils/revert_checker_test.py

llvm/utils/rsp_bisect.py

llvm/utils/rsp_bisect_test/test.py

llvm/utils/rsp_bisect_test/test_script.py

llvm/utils/rsp_bisect_test/test_script_inv.py

llvm/utils/schedcover.py

llvm/utils/shuffle_fuzz.py

llvm/utils/shuffle_select_fuzz_tester.py

llvm/utils/sort_includes.py

llvm/utils/sysroot.py

llvm/utils/testgen/mc-bundling-x86-gen.py

llvm/utils/unicode-case-fold.py

llvm/utils/update_analyze_test_checks.py

llvm/utils/update_any_test_checks.py

llvm/utils/update_cc_test_checks.py

llvm/utils/update_llc_test_checks.py

llvm/utils/update_mca_test_checks.py

llvm/utils/update_mir_test_checks.py

llvm/utils/update_test_checks.py

llvm/utils/update_test_prefix.py

llvm/utils/wciia.py