parallel_clang_tidy_runner_with_compilation_database.py

1#!/usr/bin/env python3
2#
3# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4# See https://llvm.org/LICENSE.txt for license information.
5# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
7import argparse
8import glob
9import json
10import multiprocessing
11import os
12import re
13import shutil
14import subprocess
15import sys
16import tempfile
17import threading
18import traceback
19
20def main():
21    parser = argparse.ArgumentParser(description='Runs clang-tidy over all files '
22                                     'in a compilation database. Will reuse '
23                                     'clang-tidy\'s config files that it finds '
24                                     'up the directory tree.')
25    parser.add_argument('-clang-tidy-binary', metavar='PATH',
26                        default='clang-tidy',
27                        help='path to clang-tidy binary')
28    parser.add_argument('-p', dest='build_path',
29                        help='build path')
30    parser.add_argument('-header-filter', default=None,
31                        help='regular expression matching the names of the '
32                        'headers to output diagnostics from')
33    parser.add_argument('-fix', action='store_true', help='apply suggested fixes')
34    parser.add_argument('-checks', default=None,
35                        help='checks filter, when not specified, use clang-tidy '
36                        'default')
37    parser.add_argument('files', nargs='*', default=['.*'],
38                        help='files to be processed (regex)')
39    
40    args = parser.parse_args()
41    
42    # Attempt to find the compilation database
43    db_path = 'compile_commands.json'
44    if args.build_path:
45        db_path = os.path.join(args.build_path, db_path)
46        
47    if not os.path.exists(db_path):
48        print(f"Error: could not find {db_path}")
49        sys.exit(1)
50
51    # Basic execution logic (simplified for quickstart representation)
52    command = [args.clang_tidy_binary, "-p", os.path.dirname(db_path)]
53    if args.checks:
54        command.append(f"-checks={args.checks}")
55    if args.fix:
56        command.append("-fix")
57    
58    print(f"Running: {' '.join(command)} on files matching {args.files}")
59    # In the full script, this would involve multiprocessing and parsing the JSON DB
60    
61if __name__ == '__main__':
62    main()