mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-16 21:00:14 +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>
62 lines
1.6 KiB
Python
62 lines
1.6 KiB
Python
# Copyright (c) Microsoft Corporation. All rights reserved.
|
|
# Licensed under the MIT License.
|
|
|
|
import logging
|
|
import os
|
|
import shlex
|
|
import subprocess
|
|
|
|
_log = logging.getLogger("util.run")
|
|
|
|
|
|
def run(
|
|
*args,
|
|
cwd=None,
|
|
input=None,
|
|
capture_stdout=False,
|
|
capture_stderr=False,
|
|
shell=False,
|
|
env=None,
|
|
check=True,
|
|
quiet=False,
|
|
):
|
|
"""Runs a subprocess.
|
|
|
|
Args:
|
|
*args: The subprocess arguments.
|
|
cwd: The working directory. If None, specifies the current directory.
|
|
input: The optional input byte sequence.
|
|
capture_stdout: Whether to capture stdout.
|
|
capture_stderr: Whether to capture stderr.
|
|
shell: Whether to run using the shell.
|
|
env: The environment variables as a dict. If None, inherits the current
|
|
environment.
|
|
check: Whether to raise an error if the return code is not zero.
|
|
quiet: If true, do not print output from the subprocess.
|
|
|
|
Returns:
|
|
A subprocess.CompletedProcess instance.
|
|
"""
|
|
cmd = [*args]
|
|
|
|
_log.info(
|
|
"Running subprocess in '{}'\n {}".format(cwd or os.getcwd(), " ".join([shlex.quote(arg) for arg in cmd]))
|
|
)
|
|
|
|
def output(is_stream_captured):
|
|
return subprocess.PIPE if is_stream_captured else (subprocess.DEVNULL if quiet else None)
|
|
|
|
completed_process = subprocess.run(
|
|
cmd,
|
|
cwd=cwd,
|
|
check=check,
|
|
input=input,
|
|
stdout=output(capture_stdout),
|
|
stderr=output(capture_stderr),
|
|
env=env,
|
|
shell=shell,
|
|
)
|
|
|
|
_log.debug(f"Subprocess completed. Return code: {completed_process.returncode}")
|
|
|
|
return completed_process
|