onnxruntime/tools/python/run_CIs_for_external_pr.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

99 lines
3 KiB
Python

#!/usr/bin/env python3
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
import argparse
import os
import subprocess
import sys
import typing
def parse_args():
parser = argparse.ArgumentParser(
os.path.basename(__file__),
formatter_class=argparse.RawDescriptionHelpFormatter,
description="""Trigger CIs running for the specified pull request.
Requires the GitHub CLI to be installed. See https://github.com/cli/cli#installation for details.
After installation you will also need to setup an auth token to access the ONNX Runtime repository by running
`gh auth login`. Easiest is to run that from a directory in your local copy of the repo.
""",
)
parser.add_argument("pr", help="Specify the pull request ID.")
args = parser.parse_args()
return args
def run_gh_pr_command(command: typing.List[str]):
try:
return subprocess.run(["gh", "pr", *command], capture_output=True, text=True, check=True)
except subprocess.CalledProcessError as cpe:
print(cpe)
print(cpe.stderr)
sys.exit(-1)
def main():
args = parse_args()
pr_id = args.pr
# validate PR
gh_out = run_gh_pr_command(["view", pr_id])
info = gh_out.stdout.split("\n")
for line in info:
pieces = line.split("\t")
if len(pieces) != 2:
continue
if pieces[0] == "state:":
if pieces[1] != "OPEN":
print(f"PR {pr_id} is not OPEN. Currently in state {pieces[1]}.")
sys.exit(-1)
print("Adding azp run commands")
# Current pipelines. These change semi-frequently and may need updating.
pipelines = [
# windows
"Windows CPU CI Pipeline",
"Windows GPU CI Pipeline",
"Windows GPU TensorRT CI Pipeline",
"ONNX Runtime Web CI Pipeline",
# linux
"Linux CPU CI Pipeline",
"Linux CPU Minimal Build E2E CI Pipeline",
"Linux GPU CI Pipeline",
"Linux GPU TensorRT CI Pipeline",
"Linux OpenVINO CI Pipeline",
# mac
"MacOS CI Pipeline",
# training
"orttraining-amd-gpu-ci-pipeline",
"orttraining-linux-ci-pipeline",
"orttraining-linux-gpu-ci-pipeline",
"orttraining-ortmodule-distributed",
# checks
"onnxruntime-python-checks-ci-pipeline",
"onnxruntime-binary-size-checks-ci-pipeline",
]
# azp run is limited to 10 pipelines at a time
max_pipelines_per_comment = 10
start = 0
num_pipelines = len(pipelines)
while start < num_pipelines:
end = start + max_pipelines_per_comment
if end > num_pipelines:
end = num_pipelines
run_gh_pr_command(["comment", pr_id, "--body", f"/azp run {str.join(',', pipelines[start:end])}"])
start += max_pipelines_per_comment
print(f"Done. Check status at https://github.com/microsoft/onnxruntime/pull/{pr_id}/checks")
if __name__ == "__main__":
main()