mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-14 20:48:00 +00:00
d834ec895a
### 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:  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>
51 lines
1.6 KiB
Python
51 lines
1.6 KiB
Python
# generate_skip_doc_change.py
|
|
import os
|
|
from pathlib import Path
|
|
|
|
from jinja2 import Environment, FileSystemLoader, Template
|
|
|
|
GITHUB_DIR = Path(__file__).resolve().parent.parent
|
|
|
|
|
|
class Skipped_Workflow: # noqa: N801
|
|
def __init__(self, workflow_name: str, job_names: list, output_file_name: str):
|
|
self.workflow_name = workflow_name
|
|
self.job_names = job_names
|
|
self.fake_file_name = output_file_name
|
|
|
|
|
|
WIN_GPU_CI_WORKFLOW = Skipped_Workflow(
|
|
workflow_name="Windows GPU CI Pipeline",
|
|
job_names=[
|
|
"cuda build_x64_RelWithDebInfo",
|
|
"dml build_x64_RelWithDebInfo",
|
|
"training build_x64_RelWithDebInfo",
|
|
"kernelDocumentation build_x64_RelWithDebInfo",
|
|
],
|
|
output_file_name=str(GITHUB_DIR.joinpath("workflows/generated_fake_win_gpu_ci.yml")),
|
|
)
|
|
|
|
|
|
def generate_fake_ci_yaml(template: Template, workflow: Skipped_Workflow):
|
|
py_file_name = os.path.basename(__file__)
|
|
content = template.render(
|
|
python_file_name=py_file_name, ci_workflow_name=workflow.workflow_name, job_names=workflow.job_names
|
|
)
|
|
|
|
filename = workflow.fake_file_name
|
|
with open(filename, mode="w", encoding="utf-8") as output_file:
|
|
output_file.write(content)
|
|
if content[-1] != "\n":
|
|
output_file.write("\n")
|
|
print(f"... wrote {filename}")
|
|
|
|
|
|
def main() -> None:
|
|
environment = Environment(loader=FileSystemLoader(str(GITHUB_DIR.joinpath("workflows/"))))
|
|
template = environment.get_template("skip-doc-change.yml.j2")
|
|
skipped_workflows = [WIN_GPU_CI_WORKFLOW]
|
|
[generate_fake_ci_yaml(template, workflow) for workflow in skipped_workflows]
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|