sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-09-01 10:52:19 +01:00
Code Issues Releases Wiki Activity

Raise minimum python version to 3.8 (#3176)

Browse Source
This commit is contained in:
Jesse Hills
2022-02-10 21:55:11 +13:00
committed by GitHub
parent ad6c5ff11d
commit 40e06c9819
18 changed files with 253 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

217
script/clang-tidy
View File

@@ -1,7 +1,17 @@
#!/usr/bin/env python3
from helpers import print_error_for_file, get_output, filter_grep, \
build_all_include, temp_header_file, git_ls_files, filter_changed, load_idedata, root_path, basepath
from helpers import (
print_error_for_file,
get_output,
filter_grep,
build_all_include,
temp_header_file,
git_ls_files,
filter_changed,
load_idedata,
root_path,
basepath,
)
import argparse
import click
import colorama
@@ -20,67 +30,81 @@ def clang_options(idedata):
cmd = []
# extract target architecture from triplet in g++ filename
triplet = os.path.basename(idedata['cxx_path'])[:-4]
triplet = os.path.basename(idedata["cxx_path"])[:-4]
if triplet.startswith("xtensa-"):
# clang doesn't support Xtensa (yet?), so compile in 32-bit mode and pretend we're the Xtensa compiler
cmd.append('-m32')
cmd.append('-D__XTENSA__')
cmd.append("-m32")
cmd.append("-D__XTENSA__")
else:
cmd.append(f'--target={triplet}')
cmd.append(f"--target={triplet}")
# set flags
cmd.extend([
# disable built-in include directories from the host
'-nostdinc',
'-nostdinc++',
# replace pgmspace.h, as it uses GNU extensions clang doesn't support
# https://github.com/earlephilhower/newlib-xtensa/pull/18
'-D_PGMSPACE_H_',
'-Dpgm_read_byte(s)=(*(const uint8_t *)(s))',
'-Dpgm_read_byte_near(s)=(*(const uint8_t *)(s))',
'-Dpgm_read_word(s)=(*(const uint16_t *)(s))',
'-Dpgm_read_dword(s)=(*(const uint32_t *)(s))',
'-DPROGMEM=',
'-DPGM_P=const char *',
'-DPSTR(s)=(s)',
# this next one is also needed with upstream pgmspace.h
# suppress warning about identifier naming in expansion of this macro
'-DPSTRN(s, n)=(s)',
# suppress warning about attribute cannot be applied to type
# https://github.com/esp8266/Arduino/pull/8258
'-Ddeprecated(x)=',
# allow to condition code on the presence of clang-tidy
'-DCLANG_TIDY',
# (esp-idf) Disable this header because they use asm with registers clang-tidy doesn't know
'-D__XTENSA_API_H__',
# (esp-idf) Fix __once_callable in some libstdc++ headers
'-D_GLIBCXX_HAVE_TLS',
])
cmd.extend(
[
# disable built-in include directories from the host
"-nostdinc",
"-nostdinc++",
# replace pgmspace.h, as it uses GNU extensions clang doesn't support
# https://github.com/earlephilhower/newlib-xtensa/pull/18
"-D_PGMSPACE_H_",
"-Dpgm_read_byte(s)=(*(const uint8_t *)(s))",
"-Dpgm_read_byte_near(s)=(*(const uint8_t *)(s))",
"-Dpgm_read_word(s)=(*(const uint16_t *)(s))",
"-Dpgm_read_dword(s)=(*(const uint32_t *)(s))",
"-DPROGMEM=",
"-DPGM_P=const char *",
"-DPSTR(s)=(s)",
# this next one is also needed with upstream pgmspace.h
# suppress warning about identifier naming in expansion of this macro
"-DPSTRN(s, n)=(s)",
# suppress warning about attribute cannot be applied to type
# https://github.com/esp8266/Arduino/pull/8258
"-Ddeprecated(x)=",
# allow to condition code on the presence of clang-tidy
"-DCLANG_TIDY",
# (esp-idf) Disable this header because they use asm with registers clang-tidy doesn't know
"-D__XTENSA_API_H__",
# (esp-idf) Fix __once_callable in some libstdc++ headers
"-D_GLIBCXX_HAVE_TLS",
]
)
# copy compiler flags, except those clang doesn't understand.
cmd.extend(flag for flag in idedata['cxx_flags'].split(' ')
if flag not in ('-free', '-fipa-pta', '-fstrict-volatile-bitfields',
'-mlongcalls', '-mtext-section-literals',
'-mfix-esp32-psram-cache-issue', '-mfix-esp32-psram-cache-strategy=memw'))
cmd.extend(
flag
for flag in idedata["cxx_flags"].split(" ")
if flag
not in (
"-free",
"-fipa-pta",
"-fstrict-volatile-bitfields",
"-mlongcalls",
"-mtext-section-literals",
"-mfix-esp32-psram-cache-issue",
"-mfix-esp32-psram-cache-strategy=memw",
)
)
# defines
cmd.extend(f'-D{define}' for define in idedata['defines'])
cmd.extend(f"-D{define}" for define in idedata["defines"])
# add toolchain include directories using -isystem to suppress their errors
# idedata contains include directories for all toolchains of this platform, only use those from the one in use
toolchain_dir = os.path.normpath(f"{idedata['cxx_path']}/../../")
for directory in idedata['includes']['toolchain']:
for directory in idedata["includes"]["toolchain"]:
if directory.startswith(toolchain_dir):
cmd.extend(['-isystem', directory])
cmd.extend(["-isystem", directory])
# add library include directories using -isystem to suppress their errors
for directory in sorted(set(idedata['includes']['build'])):
for directory in sorted(set(idedata["includes"]["build"])):
# skip our own directories, we add those later
if not directory.startswith(f"{root_path}/") or directory.startswith(f"{root_path}/.pio/"):
cmd.extend(['-isystem', directory])
if not directory.startswith(f"{root_path}/") or directory.startswith(
f"{root_path}/.pio/"
):
cmd.extend(["-isystem", directory])
# add the esphome include directory using -I
cmd.extend(['-I', root_path])
cmd.extend(["-I", root_path])
return cmd
@@ -88,28 +112,28 @@ def clang_options(idedata):
def run_tidy(args, options, tmpdir, queue, lock, failed_files):
while True:
path = queue.get()
invocation = ['clang-tidy-11']
invocation = ["clang-tidy-11"]
if tmpdir is not None:
invocation.append('--export-fixes')
invocation.append("--export-fixes")
# Get a temporary file. We immediately close the handle so clang-tidy can
# overwrite it.
(handle, name) = tempfile.mkstemp(suffix='.yaml', dir=tmpdir)
(handle, name) = tempfile.mkstemp(suffix=".yaml", dir=tmpdir)
os.close(handle)
invocation.append(name)
if args.quiet:
invocation.append('--quiet')
invocation.append("--quiet")
if sys.stdout.isatty():
invocation.append('--use-color')
invocation.append("--use-color")
invocation.append(f"--header-filter={os.path.abspath(basepath)}/.*")
invocation.append(os.path.abspath(path))
invocation.append('--')
invocation.append("--")
invocation.extend(options)
proc = subprocess.run(invocation, capture_output=True, encoding='utf-8')
proc = subprocess.run(invocation, capture_output=True, encoding="utf-8")
if proc.returncode != 0:
with lock:
print_error_for_file(path, proc.stdout)
@@ -119,43 +143,60 @@ def run_tidy(args, options, tmpdir, queue, lock, failed_files):
def progress_bar_show(value):
if value is None:
return ''
return ""
def split_list(a, n):
k, m = divmod(len(a), n)
return [a[i * k + min(i, m):(i + 1) * k + min(i + 1, m)] for i in range(n)]
return [a[i * k + min(i, m) : (i + 1) * k + min(i + 1, m)] for i in range(n)]
def main():
colorama.init()
parser = argparse.ArgumentParser()
parser.add_argument('-j', '--jobs', type=int,
default=multiprocessing.cpu_count(),
help='number of tidy instances to be run in parallel.')
parser.add_argument('-e', '--environment', default='esp32-arduino-tidy',
help='the PlatformIO environment to use (as defined in platformio.ini)')
parser.add_argument('files', nargs='*', default=[],
help='files to be processed (regex on path)')
parser.add_argument('--fix', action='store_true', help='apply fix-its')
parser.add_argument('-q', '--quiet', action='store_false',
help='run clang-tidy in quiet mode')
parser.add_argument('-c', '--changed', action='store_true',
help='only run on changed files')
parser.add_argument('-g', '--grep', help='only run on files containing value')
parser.add_argument('--split-num', type=int, help='split the files into X jobs.',
default=None)
parser.add_argument('--split-at', type=int, help='which split is this? starts at 1',
default=None)
parser.add_argument('--all-headers', action='store_true',
help='create a dummy file that checks all headers')
parser.add_argument(
"-j",
"--jobs",
type=int,
default=multiprocessing.cpu_count(),
help="number of tidy instances to be run in parallel.",
)
parser.add_argument(
"-e",
"--environment",
default="esp32-arduino-tidy",
help="the PlatformIO environment to use (as defined in platformio.ini)",
)
parser.add_argument(
"files", nargs="*", default=[], help="files to be processed (regex on path)"
)
parser.add_argument("--fix", action="store_true", help="apply fix-its")
parser.add_argument(
"-q", "--quiet", action="store_false", help="run clang-tidy in quiet mode"
)
parser.add_argument(
"-c", "--changed", action="store_true", help="only run on changed files"
)
parser.add_argument("-g", "--grep", help="only run on files containing value")
parser.add_argument(
"--split-num", type=int, help="split the files into X jobs.", default=None
)
parser.add_argument(
"--split-at", type=int, help="which split is this? starts at 1", default=None
)
parser.add_argument(
"--all-headers",
action="store_true",
help="create a dummy file that checks all headers",
)
args = parser.parse_args()
try:
get_output('clang-tidy-11', '-version')
get_output("clang-tidy-11", "-version")
except:
print("""
print(
"""
Oops. It looks like clang-tidy-11 is not installed.
Please check you can run "clang-tidy-11 -version" in your terminal and install
@@ -163,19 +204,20 @@ def main():
Note you can also upload your code as a pull request on GitHub and see the CI check
output to apply clang-tidy.
""")
"""
)
return 1
idedata = load_idedata(args.environment)
options = clang_options(idedata)
files = []
for path in git_ls_files(['*.cpp']):
for path in git_ls_files(["*.cpp"]):
files.append(os.path.relpath(path, os.getcwd()))
if args.files:
# Match against files specified on command-line
file_name_re = re.compile('|'.join(args.files))
file_name_re = re.compile("|".join(args.files))
files = [p for p in files if file_name_re.search(p)]
if args.changed:
@@ -202,14 +244,17 @@ def main():
task_queue = queue.Queue(args.jobs)
lock = threading.Lock()
for _ in range(args.jobs):
t = threading.Thread(target=run_tidy,
args=(args, options, tmpdir, task_queue, lock, failed_files))
t = threading.Thread(
target=run_tidy,
args=(args, options, tmpdir, task_queue, lock, failed_files),
)
t.daemon = True
t.start()
# Fill the queue with files.
with click.progressbar(files, width=30, file=sys.stderr,
item_show_func=progress_bar_show) as bar:
with click.progressbar(
files, width=30, file=sys.stderr, item_show_func=progress_bar_show
) as bar:
for name in bar:
task_queue.put(name)
@@ -218,21 +263,21 @@ def main():
except KeyboardInterrupt:
print()
print('Ctrl-C detected, goodbye.')
print("Ctrl-C detected, goodbye.")
if tmpdir:
shutil.rmtree(tmpdir)
os.kill(0, 9)
if args.fix and failed_files:
print('Applying fixes ...')
print("Applying fixes ...")
try:
subprocess.call(['clang-apply-replacements-11', tmpdir])
subprocess.call(["clang-apply-replacements-11", tmpdir])
except:
print('Error applying fixes.\n', file=sys.stderr)
print("Error applying fixes.\n", file=sys.stderr)
raise
sys.exit(len(failed_files))
if __name__ == '__main__':
if __name__ == "__main__":
main()