Refactor: apply pyformat for coding style consistency
add pyformat for presubmit hook Flag: EXEMPT mainline Bug: 419423721 Test: atest CtsConnectivityMultiDevicesTestCases Change-Id: I9abc5cee454e8c8e21ce7e3c134145857680251f
This commit is contained in:
parent
5e69785de3
commit
dcbe9b403d
1 changed files with 644 additions and 522 deletions
93
preupload_hook_script.py
Executable file
93
preupload_hook_script.py
Executable file
|
|
@ -0,0 +1,93 @@
|
|||
#!/usr/bin/env python3
|
||||
# Copyright 2025, The Android Open Source Project
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""Preupload hook to perform necessary checks and formatting on python files."""
|
||||
|
||||
import argparse
|
||||
import concurrent.futures
|
||||
import multiprocessing
|
||||
import pathlib
|
||||
import shlex
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
|
||||
def _filter_python_files(files: list[pathlib.Path]) -> list[pathlib.Path]:
|
||||
"""Filter a list of files and return a new list of python files only."""
|
||||
return [file for file in files if file.suffix == '.py']
|
||||
|
||||
|
||||
def _check_run_shell_command(cmd: str, cwd: str = None) -> None:
|
||||
"""Run a shell command and raise error if failed."""
|
||||
if subprocess.run(shlex.split(cmd), cwd=cwd, check=False).returncode:
|
||||
print('Preupload files did not pass Connectivity preupload hook script.')
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
def _run_pyformat(files: list[pathlib.Path]) -> None:
|
||||
"""Run pyformat on certain projects."""
|
||||
if subprocess.run(
|
||||
shlex.split('which pyformat'),
|
||||
check=False,
|
||||
).returncode:
|
||||
print('pyformat not available. Please run sudo apt install pyformat.')
|
||||
sys.exit(1)
|
||||
|
||||
def _run_pyformat_on_file(file):
|
||||
completed_process = subprocess.run(
|
||||
shlex.split('pyformat --force_quote_type single ' + file.as_posix()),
|
||||
capture_output=True,
|
||||
check=False,
|
||||
)
|
||||
|
||||
if completed_process.stdout:
|
||||
subprocess.run(
|
||||
shlex.split(
|
||||
'pyformat -i --force_quote_type single ' + file.as_posix()
|
||||
),
|
||||
check=False,
|
||||
)
|
||||
return True
|
||||
return False
|
||||
|
||||
cpu_count = multiprocessing.cpu_count()
|
||||
with concurrent.futures.ThreadPoolExecutor(max_workers=cpu_count) as executor:
|
||||
need_reformat = executor.map(
|
||||
_run_pyformat_on_file, _filter_python_files(files)
|
||||
)
|
||||
|
||||
if any(need_reformat):
|
||||
print(
|
||||
'Reformatting completed. Please add the modified files to git and rerun'
|
||||
' the repo preupload hook.'
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
def get_preupload_files() -> list[pathlib.Path]:
|
||||
"""Get the list of files to be uploaded."""
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('preupload_files', nargs='*', help='Files to upload.')
|
||||
args = parser.parse_args()
|
||||
files_to_upload = args.preupload_files
|
||||
file_paths_to_upload = [
|
||||
pathlib.Path(file).resolve() for file in files_to_upload
|
||||
]
|
||||
return [file for file in file_paths_to_upload if file.exists()]
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
preupload_files = get_preupload_files()
|
||||
_run_pyformat(preupload_files)
|
||||
Loading…
Reference in a new issue