mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-06-22 02:30:26 +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>
76 lines
2.7 KiB
Python
76 lines
2.7 KiB
Python
# Copyright (c) Microsoft Corporation. All rights reserved.
|
|
# Licensed under the MIT License.
|
|
|
|
import argparse # noqa: F401
|
|
import collections
|
|
import csv
|
|
import re # noqa: F401
|
|
import sys
|
|
|
|
Comparison = collections.namedtuple("Comparison", ["name", "fn"])
|
|
|
|
|
|
class Comparisons:
|
|
@staticmethod
|
|
def eq():
|
|
return Comparison(name="equal to", fn=(lambda actual, expected: actual == expected))
|
|
|
|
@staticmethod
|
|
def float_le(tolerance=None):
|
|
actual_tolerance = 0.0 if tolerance is None else tolerance
|
|
return Comparison(
|
|
name="less than or equal to" + (f" (tolerance: {str(actual_tolerance)})" if tolerance is not None else ""),
|
|
fn=(lambda actual, expected: float(actual) <= float(expected) + actual_tolerance),
|
|
)
|
|
|
|
|
|
def _printf_stderr(fmt, *args):
|
|
print(fmt.format(*args), file=sys.stderr)
|
|
|
|
|
|
def _read_results_file(results_path):
|
|
with open(results_path) as results_file:
|
|
csv_reader = csv.DictReader(results_file)
|
|
return [row for row in csv_reader]
|
|
|
|
|
|
def _compare_results(expected_results, actual_results, field_comparisons):
|
|
if len(field_comparisons) == 0:
|
|
return True
|
|
|
|
if len(expected_results) != len(actual_results):
|
|
_printf_stderr("Expected and actual result sets have different sizes.")
|
|
return False
|
|
|
|
mismatch_detected = False
|
|
for row_idx, (expected_row, actual_row) in enumerate(zip(expected_results, actual_results)):
|
|
for field_name, comparison in field_comparisons.items():
|
|
actual, expected = actual_row[field_name], expected_row[field_name]
|
|
if not comparison.fn(actual, expected):
|
|
_printf_stderr(
|
|
"Comparison '{}' failed for {} in row {}, actual: {}, expected: {}",
|
|
comparison.name,
|
|
field_name,
|
|
row_idx,
|
|
actual,
|
|
expected,
|
|
)
|
|
mismatch_detected = True
|
|
return not mismatch_detected
|
|
|
|
|
|
def compare_results_files(expected_results_path: str, actual_results_path: str, field_comparisons: dict):
|
|
expected_results = _read_results_file(expected_results_path)
|
|
actual_results = _read_results_file(actual_results_path)
|
|
|
|
comparison_result = _compare_results(expected_results, actual_results, field_comparisons)
|
|
|
|
if not comparison_result:
|
|
with open(expected_results_path) as expected_results_file, open(actual_results_path) as actual_results_file:
|
|
_printf_stderr(
|
|
"===== Expected results =====\n{}\n===== Actual results =====\n{}",
|
|
expected_results_file.read(),
|
|
actual_results_file.read(),
|
|
)
|
|
|
|
return comparison_result
|