onnxruntime/cgmanifests
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
..
generated Extend memory efficient attention coverage in Attention/MHA cuda op (#15064) 2023-03-23 11:05:17 -07:00
cgmanifest.json [CPU] Resize of Opset 18 (#13890) 2023-01-14 08:57:23 +10:00
generate_cgmanifest.py Adopt linrtunner as the linting tool - take 2 (#15085) 2023-03-24 15:29:03 -07:00
print_submodule_info.py Adopt linrtunner as the linting tool - take 2 (#15085) 2023-03-24 15:29:03 -07:00
README.md Improve dependency management (#13523) 2022-12-01 09:51:59 -08:00

CGManifest Files

This directory contains CGManifest (cgmanifest.json) files. See here for details.

cgmanifests/generated/cgmanifest.json

This file contains generated CGManifest entries.

It covers these dependencies:

  • git submodules
  • dependencies from the Dockerfile tools/ci_build/github/linux/docker/Dockerfile.manylinux2014_cuda11
  • the entries in ../cmake/deps.txt

If any of these dependencies change, this file should be updated. When updating, please regenerate instead of editing manually.

How to Generate

  1. Change to the repository root directory.
  2. Ensure the git submodules are checked out and up to date. For example, with:
    $ git submodule update --init --recursive
    
  3. Run the generator script:
    $ python cgmanifests/generate_cgmanifest.py --username <xxx> --token <your_access_token>
    

Please supply your github username and access token to the script. If you don't have a token, you can generate one at https://github.com/settings/tokens. This is for authenticating with Github REST API so that you would not hit the rate limit.

cgmanifests/cgmanifest.json

This file contains non-generated CGManifest entries. Please edit directly as needed.