onnxruntime/pyproject.toml

[tool.black]
line-length = 120
# extend-exclude needs to be a regular expression
extend-exclude = "cmake|onnxruntime/core/flatbuffers/"
target-version = ["py37", "py38", "py39", "py310"]

[tool.isort]
profile = "black"
line_length = 120
extend_skip_glob = [
    "cmake/*",
    "orttraining/*",
    "onnxruntime/core/flatbuffers/*",
]

[tool.pydocstyle]
convention = "google"

[tool.pylint.BASIC]
good-names = [
    "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n",
    "p", "q", "r", "s", "t", "u", "v", "w", "ex", "Run", "_", "x", "y", "z"
]

[tool.pylint.messages_control]
disable = [
    "format",
    "line-too-long",
    "import-error",
    "no-name-in-module",
    "no-member",
    "too-many-arguments",
    "too-many-locals",
    "too-few-public-methods",
    "missing-docstring",
    "fixme",
]

[tool.pyright]
exclude = ["onnxruntime/core/flatbuffers/*"]
reportMissingImports = false
Add python docstring linting in vscode settings (#11316) Add python docstring linting in vscode settings Use black and isort for python code formatting in VScode. Import sorting enabled on save. Code formatting available in VSCode with manual trigger. Adopted from pytorch https://github.com/pytorch/pytorch/blob/master/.vscode/settings_recommended.json 2022-04-23 13:23:04 +00:00			`[tool.black]`
			`line-length = 120`
Format all python files under onnxruntime with black and isort (#11324) Description: Format all python files under onnxruntime with black and isort. After checking in, we can use .git-blame-ignore-revs to ignore the formatting PR in git blame. #11315, #11316 2022-04-26 16:35:16 +00:00			`# extend-exclude needs to be a regular expression`
			`extend-exclude = "cmake\|onnxruntime/core/flatbuffers/"`
Set black's target version (#11370) Description: Set black's target version to be py37 - py310 Motivation and Context Black by default targets its format for py3.10. Since our project supports python 3.7, we need to target version to all the python versions supported. Re-ran black. 13 files reformatted. 2022-04-27 21:52:19 +00:00			`target-version = ["py37", "py38", "py39", "py310"]`
Add python docstring linting in vscode settings (#11316) Add python docstring linting in vscode settings Use black and isort for python code formatting in VScode. Import sorting enabled on save. Code formatting available in VSCode with manual trigger. Adopted from pytorch https://github.com/pytorch/pytorch/blob/master/.vscode/settings_recommended.json 2022-04-23 13:23:04 +00:00
			`[tool.isort]`
			`profile = "black"`
			`line_length = 120`
Format all python files under onnxruntime with black and isort (#11324) Description: Format all python files under onnxruntime with black and isort. After checking in, we can use .git-blame-ignore-revs to ignore the formatting PR in git blame. #11315, #11316 2022-04-26 16:35:16 +00:00			`extend_skip_glob = [`
			`"cmake/*",`
			`"orttraining/*",`
			`"onnxruntime/core/flatbuffers/*",`
			`]`
Add python docstring linting in vscode settings (#11316) Add python docstring linting in vscode settings Use black and isort for python code formatting in VScode. Import sorting enabled on save. Code formatting available in VSCode with manual trigger. Adopted from pytorch https://github.com/pytorch/pytorch/blob/master/.vscode/settings_recommended.json 2022-04-23 13:23:04 +00:00
			`[tool.pydocstyle]`
			`convention = "google"`
Add python static type checking in CI checks (#11518) - Enable pyright and pylint (https://github.com/microsoft/pyright) in CI - Enable pyright, pylint and bandit by default in VS code Pylint has some good style checks. pyright is Microsoft's static type checker. 2022-05-16 20:26:56 +00:00
Update pylint config to include valid short names (#13631) ### Description Update pylint config to include valid short names Also disabled `too-many-arguments` and `too-many-locals` ### Motivation and Context Refine config to reduce lint noise 2022-11-14 18:00:25 +00:00			`[tool.pylint.BASIC]`
			`good-names = [`
			`"a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n",`
			`"p", "q", "r", "s", "t", "u", "v", "w", "ex", "Run", "_", "x", "y", "z"`
			`]`

Reduce CI noise from Python lint (#12270) Description: Reduce CI noise from Python lint Motivation and Context Disable "missing-docstring" in pylint. This is usually noisy in tests Show only added lint messages only for pyright 2022-07-27 20:42:29 +00:00			`[tool.pylint.messages_control]`
			`disable = [`
			`"format",`
			`"line-too-long",`
			`"import-error",`
			`"no-name-in-module",`
			`"no-member",`
Update pylint config to include valid short names (#13631) ### Description Update pylint config to include valid short names Also disabled `too-many-arguments` and `too-many-locals` ### Motivation and Context Refine config to reduce lint noise 2022-11-14 18:00:25 +00:00			`"too-many-arguments",`
			`"too-many-locals",`
Reduce CI noise from Python lint (#12270) Description: Reduce CI noise from Python lint Motivation and Context Disable "missing-docstring" in pylint. This is usually noisy in tests Show only added lint messages only for pyright 2022-07-27 20:42:29 +00:00			`"too-few-public-methods",`
			`"missing-docstring",`
			`"fixme",`
			`]`
Add python static type checking in CI checks (#11518) - Enable pyright and pylint (https://github.com/microsoft/pyright) in CI - Enable pyright, pylint and bandit by default in VS code Pylint has some good style checks. pyright is Microsoft's static type checker. 2022-05-16 20:26:56 +00:00
			`[tool.pyright]`
			`exclude = ["onnxruntime/core/flatbuffers/*"]`
			`reportMissingImports = false`