onnxruntime/tools/python/run_android_emulator.py
Justin Chu d834ec895a
Adopt linrtunner as the linting tool - take 2 (#15085)
### Description

`lintrunner` is a linter runner successfully used by pytorch, onnx and
onnx-script. It provides a uniform experience running linters locally
and in CI. It supports all major dev systems: Windows, Linux and MacOs.
The checks are enforced by the `Python format` workflow.

This PR adopts `lintrunner` to onnxruntime and fixed ~2000 flake8 errors
in Python code. `lintrunner` now runs all required python lints
including `ruff`(replacing `flake8`), `black` and `isort`. Future lints
like `clang-format` can be added.

Most errors are auto-fixed by `ruff` and the fixes should be considered
robust.

Lints that are more complicated to fix are applied `# noqa` for now and
should be fixed in follow up PRs.

### Notable changes

1. This PR **removed some suboptimal patterns**:

	- `not xxx in` -> `xxx not in` membership checks
	- bare excepts (`except:` -> `except Exception`)
	- unused imports
	
	The follow up PR will remove:
	
	- `import *`
	- mutable values as default in function definitions (`def func(a=[])`)
	- more unused imports
	- unused local variables

2. Use `ruff` to replace `flake8`. `ruff` is much (40x) faster than
flake8 and is more robust. We are using it successfully in onnx and
onnx-script. It also supports auto-fixing many flake8 errors.

3. Removed the legacy flake8 ci flow and updated docs.

4. The added workflow supports SARIF code scanning reports on github,
example snapshot:
	

![image](https://user-images.githubusercontent.com/11205048/212598953-d60ce8a9-f242-4fa8-8674-8696b704604a.png)

5. Removed `onnxruntime-python-checks-ci-pipeline` as redundant

### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->

Unified linting experience in CI and local.

Replacing https://github.com/microsoft/onnxruntime/pull/14306

---------

Signed-off-by: Justin Chu <justinchu@microsoft.com>
2023-03-24 15:29:03 -07:00

93 lines
3 KiB
Python
Executable file

#!/usr/bin/env python3
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
import argparse
import contextlib
import shlex
import sys
import util.android as android
from util import get_logger
log = get_logger("run_android_emulator")
def parse_args():
parser = argparse.ArgumentParser(
description="Manages the running of an Android emulator. "
"Supported modes are to start and stop (default), only start, or only "
"stop the emulator."
)
parser.add_argument("--create-avd", action="store_true", help="Whether to create the Android virtual device.")
parser.add_argument("--start", action="store_true", help="Start the emulator.")
parser.add_argument("--stop", action="store_true", help="Stop the emulator.")
parser.add_argument("--android-sdk-root", required=True, help="Path to the Android SDK root.")
parser.add_argument(
"--system-image",
default="system-images;android-31;default;x86_64",
help="The Android system image package name.",
)
parser.add_argument("--avd-name", default="ort_android", help="The Android virtual device name.")
parser.add_argument(
"--emulator-extra-args", default="", help="A string of extra arguments to pass to the Android emulator."
)
parser.add_argument(
"--emulator-pid-file",
help="Output/input file containing the PID of the emulator process. "
"This is only required if exactly one of --start or --stop is given.",
)
args = parser.parse_args()
if not args.start and not args.stop:
# unspecified means start and stop
args.start = args.stop = True
if args.start != args.stop and args.emulator_pid_file is None:
raise ValueError("PID file must be specified if only starting or stopping.")
return args
def main():
args = parse_args()
sdk_tool_paths = android.get_sdk_tool_paths(args.android_sdk_root)
start_emulator_args = {
"sdk_tool_paths": sdk_tool_paths,
"avd_name": args.avd_name,
"extra_args": shlex.split(args.emulator_extra_args),
}
if args.create_avd:
android.create_virtual_device(sdk_tool_paths, args.system_image, args.avd_name)
if args.start and args.stop:
with contextlib.ExitStack() as context_stack:
emulator_proc = android.start_emulator(**start_emulator_args)
context_stack.enter_context(emulator_proc)
context_stack.callback(android.stop_emulator, emulator_proc)
log.info("Press Enter to close.")
sys.stdin.readline()
elif args.start:
emulator_proc = android.start_emulator(**start_emulator_args)
with open(args.emulator_pid_file, mode="w") as emulator_pid_file:
print(f"{emulator_proc.pid}", file=emulator_pid_file)
elif args.stop:
with open(args.emulator_pid_file) as emulator_pid_file:
emulator_pid = int(emulator_pid_file.readline().strip())
android.stop_emulator(emulator_pid)
if __name__ == "__main__":
sys.exit(main())