pyproject.toml

# SPDX-License-Identifier: Apache-2.0

[build-system]
requires = ["setuptools>=64", "protobuf>=3.20.2", "cmake"]
build-backend = "setuptools.build_meta"

[project]
name = "onnx"
dynamic = ["version", "dependencies", "optional-dependencies"]
description = "Open Neural Network Exchange"
readme = "README.md"
authors = [
    {name = "ONNX Contributors", email = "onnx-technical-discuss@lists.lfaidata.foundation"},
]
classifiers = [
    "Programming Language :: Python :: 3",
]
license = {text = "Apache License v2.0"}
requires-python = ">=3.8"

[project.urls]
Homepage = "https://onnx.ai/"
Repository = "https://github.com/onnx/onnx"

[project.scripts]
backend-test-tools = "onnx.backend.test.cmd_tools:main"
check-model = "onnx.bin.checker:check_model"
check-node = "onnx.bin.checker:check_node"

[tool.setuptools.dynamic]
dependencies = {file = "requirements.txt"}

[tool.setuptools.dynamic.optional-dependencies]
reference = {file = "requirements-reference.txt"}

[tool.setuptools.packages.find]
include = ["onnx*"]

[tool.setuptools.package-data]
onnx = [
    "**/*.c",
    "**/*.cc",
    "**/*.h",
    "**/*.proto",
    "**/*.pyi",
    "backend/test/data/**/*",
    "py.typed",
]

[tool.pytest.ini_options]

addopts = "--nbval --nbval-current-env --tb=short --color=yes"
testpaths = [
    "onnx/test",
    "onnx/examples",
]

[tool.mypy]
follow_imports = "silent"
strict_optional = true
warn_return_any = true
warn_no_return = true
# TODO warn_unused_ignores = true
warn_redundant_casts = true
warn_incomplete_stub = true
# TODO disallow_untyped_calls = true
check_untyped_defs = true
# Allow bare generics like np.ndarray
disallow_any_generics = false
no_implicit_optional = true
# TODO disallow_incomplete_defs = true
# TODO disallow_subclassing_any = true
warn_unused_configs = true
show_error_codes = true
show_column_numbers = true
ignore_missing_imports = true
# NOTE: Do not grow the exclude list. Edit .lintrunner.toml instead
exclude = [
    '^third_party',
]

# NOTE: Avoid adding overrides unless for exceptional cases. Prefer inline ignores.
# If you must ignore error for the whole file, consider adapting the example
# `# mypy: disable-error-code="misc,arg-type,type-arg"`
# and put this comment on the top of the file.
[[tool.mypy.overrides]]
module = [
    'onnx.onnx_data_pb',
    'onnx.onnx_data_pb2',
    'onnx.onnx_pb',
    'onnx.onnx_pb2',
    'onnx.onnx_ml_pb2',
    'onnx.onnx_operators_pb',
    'onnx.onnx_operators_ml_pb2',
]
ignore_errors = true

[tool.black]
# NOTE: Do not create an exclude list. Edit .lintrunner.toml instead
target-version = ["py38", "py39", "py310", "py311"]

[tool.isort]
# NOTE: Do not create an exclude list. Edit .lintrunner.toml instead
profile = "black"

[tool.pylint.message_control]
# This list is for vscode. Add new disables in pyproject_pylint.toml for lintrunner and CI.
# Exclude patterns should be modified in .lintrunner.toml
disable = [
    "format",
    "import-error",
    "line-too-long",
    "no-name-in-module",
    "use-dict-literal",     # Dict literals are sometimes preferable when creating kwargs
    "useless-return",
]

[tool.ruff]
# NOTE: Do not create an exclude list. Edit .lintrunner.toml instead
target-version = "py38"
unsafe-fixes = true
lint.select = [
    "A", # flake8-builtins
    "ARG", # flake8-unused-arguments
    "B", # flake8-bugbear
    "BLE", # flake8-blind-except
    "C4", # flake8-comprehensions
    "D", # pydocstyle
    "E", # pycodestyle
    "F", # Pyflakes
    "FA", # flake8-future-annotations
    "G", # flake8-logging-format
    "I002", # isort: required imports
    "ISC", # flake8-implicit-str-concat
    "LOG", # flake8-logging
    "N", # pep8-naming
    "NPY", # modern numpy
    "PERF", # Perflint
    "PIE", # flake8-pie
    "PL", # pylint
    "PYI", # flake8-pyi
    "RUF", # Ruff-specific rules
    "SIM", # flake8-simplify
    "SLOT", # flake8-slot
    "T10", # flake8-debugger
    "TID", # Disallow relative imports
    "TRY", # flake8-try-except-raise
    "UP", # pyupgrade
    "W", # pycodestyle
    "YTT", # flake8-2020
]
# NOTE: Refrain from growing the ignore list unless for exceptional cases.
# Always include a comment to explain why.
lint.ignore = [
    "D1", # D1 is for missing docstrings, which is not yet enforced.
    "D205", # D205 Too strict. "1 blank line required between summary line and description"
    "D400",
    "D415",
    "E501", # Line length controlled by black
    "N803", # Argument casing
    "N806", # Relax: Variable name in function should be lowercase
    "N999", # Module names
    "NPY002", # np.random.Generator may not be preferred in all cases
    "PLR0912", # Too many branches
    "PLR0913", # Too many arguments to function call
    "PLR0915", # Too many statements
    "PYI011", # Allow protobuf enums as defaults to function arguments
    "PYI021", # Allow docstrings in pyi files
    "PYI041", # int | float is sometimes more clear than float
    "RUF015", # next(iter(...)) sometimes obscures the intent when we access the 0th element of a shape
    "SIM102", # We don't perfer always combining if branches
    "SIM108", # We don't always encourage ternary operators
    "SIM114", # Don't always combine if branches for debugability
    "SIM116", # Don't use dict lookup to replace if-else
    "TRY003", # Messages can be constructed in the exception
]
lint.ignore-init-module-imports = false
lint.unfixable = [
    "SIM112", # Envvars should not be modified
]

[tool.ruff.lint.flake8-builtins]
builtins-ignorelist = ["id", "input"]

[tool.ruff.lint.flake8-tidy-imports]
# Disallow all relative imports.
ban-relative-imports = "all"

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.lint.isort]
required-imports = ["from __future__ import annotations"]

[tool.ruff.lint.per-file-ignores]
"**/*.pyi" = ["I002"] # from __future__ import annotations` has no effect in stub files
# NOTE: Refrain from growing the ignore list unless for exceptional cases.
# Prefer inline ignores with `noqa: xxx`.
# Eventually this list should become empty.
"**/*_test*" = ["N802"] # Function casing
"onnx/backend/test/**" = ["PLR2004"] # Magic numbers allowed in tests
"onnx/backend/test/case/**" = ["N802"] # Function casing
"onnx/reference/ops/**" = [
    "N801", # Class casing
    "PLR2004", # Magic numbers
]
"onnx/reference/ops/_op_list.py" = ["F401"]
"onnx/__init__.py" = ["F401"]
"onnx/reference/__init__.py" = ["F401"]
"onnx/reference/ops/__init__.py" = ["F401"]
"onnx/reference/ops/aionnxml/_op_list.py" = ["F401"]
"onnx/reference/ops/aionnxml/__init__.py" = ["F401"]
"onnx/reference/ops/aionnx_preview_training/__init__.py" = ["F401"]
"onnx/reference/ops/aionnx_preview_training/_op_list.py" = ["F401"]
"onnx/reference/ops/experimental/__init__.py" = ["F401"]
"onnx/test/reference_evaluator_test.py"= ["C408"]  # dict(...) -> { ... }
"onnx/test/**" = ["PLR2004"] # Magic numbers allowed in tests
"onnx/onnx_cpp2py_export/defs.pyi" = ["N802"]