espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-03 10:30:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

ci: remove duplicated new lines

Browse Source
This commit is contained in:
Fu Hanxi
2025-08-12 13:44:35 +02:00
parent e01cc4be89
commit 7198ae518c
1 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
tools/ci/check_build_test_rules.py
View File

@@ -5,7 +5,6 @@ import argparse
import os import os
import re import re
import sys import sys
import typing as t
from collections import defaultdict from collections import defaultdict
from pathlib import Path from pathlib import Path
@@ -42,7 +41,7 @@ FORMAL_TO_USUAL = {v: k for k, v in USUAL_TO_FORMAL.items()}
def print_diff_table( def print_diff_table(
list1: list[str], list2: list[str], title1: str, title2: str, excluded: t.Optional[list[str]] = None list1: list[str], list2: list[str], title1: str, title2: str, excluded: list[str] | None = None
) -> None: ) -> None:
left_set = set(list1) left_set = set(list1)
right_set = set(list2) right_set = set(list2)
@@ -82,7 +81,7 @@ def print_diff_table(
console.print(table) console.print(table)
def get_readme_path(app_dir: str) -> t.Optional[str]: def get_readme_path(app_dir: str) -> str | None:
readme_path = os.path.join(app_dir, 'README.md') readme_path = os.path.join(app_dir, 'README.md')
if not os.path.isfile(readme_path): if not os.path.isfile(readme_path):
@@ -105,7 +104,7 @@ def generate_new_support_table(targets: list[str]) -> str:
return res return res
def parse_existing_table(app_dir: str) -> t.Tuple[t.Optional[str], list[str]]: def parse_existing_table(app_dir: str) -> tuple[str | None, list[str]]:
readme_path = get_readme_path(app_dir) readme_path = get_readme_path(app_dir)
if not readme_path: if not readme_path:
return None, SUPPORTED_TARGETS return None, SUPPORTED_TARGETS
@@ -124,9 +123,9 @@ def parse_existing_table(app_dir: str) -> t.Tuple[t.Optional[str], list[str]]:
def get_grouped_apps( def get_grouped_apps(
paths: list[str], paths: list[str],
exclude_dirs: t.Optional[list[str]] = None, exclude_dirs: list[str] | None = None,
extra_targets: t.Optional[list[str]] = None, extra_targets: list[str] | None = None,
) -> t.Dict[str, t.List[App]]: ) -> dict[str, list[App]]:
apps = sorted( apps = sorted(
find_apps( find_apps(
paths, paths,
@@ -136,7 +135,7 @@ def get_grouped_apps(
) )
) )
grouped_apps: t.Dict[str, t.List[App]] = defaultdict(list) grouped_apps: dict[str, list[App]] = defaultdict(list)
for app in apps: for app in apps:
grouped_apps[app.app_dir].append(app) grouped_apps[app.app_dir].append(app)
@@ -145,9 +144,9 @@ def get_grouped_apps(
def check_readme( def check_readme(
paths: list[str], paths: list[str],
exclude_dirs: t.Optional[list[str]] = None, exclude_dirs: list[str] | None = None,
*, *,
extra_targets: t.Optional[list[str]] = None, extra_targets: list[str] | None = None,
) -> None: ) -> None:
grouped_apps = get_grouped_apps(paths, exclude_dirs, extra_targets) grouped_apps = get_grouped_apps(paths, exclude_dirs, extra_targets)
exit_code = 0 exit_code = 0
@@ -198,10 +197,8 @@ def check_readme(
print(f'Auto-fixing: Modified README: {readme_path}') print(f'Auto-fixing: Modified README: {readme_path}')
exit_code = 1 exit_code = 1
if exit_code != 0:
print('') # extra new line for readability
if exit_code != 0: if exit_code != 0:
print('') # extra new line for readability
print('Related documentation:') print('Related documentation:')
print( print(
'\t- https://docs.espressif.com/projects/idf-build-apps/en/latest/references/manifest.html#enable-disable-rules' '\t- https://docs.espressif.com/projects/idf-build-apps/en/latest/references/manifest.html#enable-disable-rules'
@@ -209,7 +206,7 @@ def check_readme(
sys.exit(exit_code) sys.exit(exit_code)
def get_grouped_cases(paths: list[str]) -> t.Dict[str, t.Dict[str, t.Set[str]]]: def get_grouped_cases(paths: list[str]) -> dict[str, dict[str, set[str]]]:
""" """
return something like this: return something like this:
{ {
@@ -244,10 +241,10 @@ def get_grouped_cases(paths: list[str]) -> t.Dict[str, t.Dict[str, t.Set[str]]]:
def check_test_scripts( def check_test_scripts(
paths: list[str], paths: list[str],
exclude_dirs: t.Optional[list[str]] = None, exclude_dirs: list[str] | None = None,
*, *,
extra_targets: t.Optional[list[str]] = None, extra_targets: list[str] | None = None,
bypass_targets: t.Optional[list[str]] = None, bypass_targets: list[str] | None = None,
) -> None: ) -> None:
# takes long time, run only in CI # takes long time, run only in CI
grouped_apps = get_grouped_apps(paths, exclude_dirs, extra_targets) grouped_apps = get_grouped_apps(paths, exclude_dirs, extra_targets)
@@ -283,9 +280,9 @@ def check_test_scripts(
for script_path in grouped_cases[app_dir]['script_paths']: for script_path in grouped_cases[app_dir]['script_paths']:
print(' - ' + script_path) print(' - ' + script_path)
exit_code = 1 exit_code = 1
print('') # extra new line for readability
if exit_code != 0: if exit_code != 0:
print('') # extra new line for readability
print('Related documentation:') print('Related documentation:')
print( print(
'\t- https://docs.espressif.com/projects/idf-build-apps/en/latest/references/manifest.html#enable-disable-rules' '\t- https://docs.espressif.com/projects/idf-build-apps/en/latest/references/manifest.html#enable-disable-rules'