pyproject.toml

# -*- coding: utf-8 -*-

# License: BSD 3-Clause
[build-system]
requires = ["setuptools >= 61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "openml"
dynamic = ["version"]  # Will take it from the __version__ file, update there
dependencies = [
  "liac-arff>=2.4.0",
  "xmltodict",
  "requests",
  "scikit-learn>=0.18",
  "python-dateutil",  # Installed through pandas anyway.
  "pandas>=1.0.0",
  "scipy>=0.13.3",
  "numpy>=1.6.2",
  "minio",
  "pyarrow",
  "tqdm",  # For MinIO download progress bars
]
requires-python = ">=3.10,<3.15"
maintainers = [
  { name = "Pieter Gijsbers", email="p.gijsbers@tue.nl"},
  { name = "Lennart Purucker"},
]
authors = [
  { name = "Matthias Feurer"},
  { name = "Jan van Rijn" },
  { name = "Arlind Kadra" },
  { name = "Pieter Gijsbers" },
  { name = "Neeratyoy Mallik" },
  { name = "Sahithya Ravi" },
  { name = "Andreas Müller" },
  { name = "Joaquin Vanschoren " },
  { name = "Frank Hutter" },
]
readme = "README.md"
description = "Python API for OpenML"
classifiers = [
  "Intended Audience :: Science/Research",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: BSD License",
  "Programming Language :: Python",
  "Topic :: Software Development",
  "Topic :: Scientific/Engineering",
  "Operating System :: POSIX",
  "Operating System :: Unix",
  "Operating System :: MacOS",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
]
license = { file = "LICENSE" }

[project.scripts]
openml = "openml.cli:main"

[project.optional-dependencies]
test=[
    "nbconvert",
    "jupyter_client",
    "matplotlib",
    "pytest",
    "pytest-xdist",
    "pytest-timeout",
    "nbformat",
    "oslo.concurrency",
    "flaky",
    "pre-commit",
    "pytest-cov",
    "pytest-rerunfailures",
    "mypy",
    "ruff",
    "requests-mock",
    "openml-sklearn",
    "packaging",
    "pytest-mock",
    "openml-sklearn",
]
examples=[
    "matplotlib",
    "jupyter",
    "notebook",
    "nbconvert",
    "nbformat",
    "jupyter_client",
    "ipython",
    "ipykernel",
    "seaborn",
]
docs=[
    "mkdocs",
    "numpydoc",
    "mkdocs-material",
    "mkdocs-autorefs",
    "mkdocstrings[python]",
    "mkdocs-gen-files",
    "mkdocs-literate-nav",
    "mkdocs-section-index",
    "mkdocs-jupyter",
    "mkdocs-linkcheck",
    "mike",
    "pymdown-extensions<12.2",  # 2026-10-10: incompatibility of 12.2 with mkdocstrings
]

[project.urls]
home="https://openml.org/"
documentation = "https://openml.github.io/openml-python/"
source = "https://github.com/openml/openml-python"

[tool.setuptools.packages.find]
where = [""]
include = ["openml*"]
namespaces = false

[tool.setuptools.package-data]
openml = ["*.txt", "*.md", "py.typed"]

[tool.setuptools.dynamic]
version = {attr = "openml.__version__.__version__"}

# https://docs.pytest.org/en/7.2.x/reference/reference.html#ini-options-ref
[tool.pytest.ini_options]
log_level="DEBUG"
testpaths = ["tests"]
minversion = "7.0"
xfail_strict = true
filterwarnings=[
    "ignore:the matrix subclass:PendingDeprecationWarning"
]
markers = [
  "upload: anything that uploads to a server",
  "production_server: any interaction with the production server",
  "cache: anything that interacts with the (test) cache",
  "test_server: tests that require the OpenML test server",
]
addopts = "--ignore=tests/files"

# https://github.com/charliermarsh/ruff
[tool.ruff]
target-version = "py310"
line-length = 100
output-format = "grouped"
unsafe-fixes = true

exclude = [
  ".bzr",
  ".direnv",
  ".eggs",
  ".git",
  ".hg",
  ".mypy_cache",
  ".nox",
  ".pants.d",
  ".ruff_cache",
  ".svn",
  ".tox",
  ".venv",
  "__pypackages__",
  "_build",
  "buck-out",
  "build",
  "dist",
  "node_modules",
  "venv",
  "docs",
]

# Exclude a variety of commonly ignored directories.
[tool.ruff.lint.per-file-ignores]
"tests/**/*.py" = [
  "D100",   # Undocumented public module
  "D101",   # Missing docstring in public class
  "D102",   # Missing docstring in public method
  "D103",   # Missing docstring in public function
  "S101",   # Use of assert
  "ANN201", # Missing return type annotation for public function
  "FBT001", # Positional boolean argument
  "PLR2004",# No use of magic numbers
  "PD901",  #  X is a bad variable name. (pandas)
  "TCH",    # https://docs.astral.sh/ruff/rules/#flake8-type-checking-tch
  "N803",   # Argument name {name} should be lowercase
]
"openml/cli.py" = [
  "T201",   # print found
  "T203",   # pprint found
]
"openml/__version__.py" = [
  "D100",   # Undocumented public module
]
"__init__.py" = [
  "I002",   # Missing required import (i.e. from __future__ import annotations)
]
"examples/*.py" = [
  "D101",   # Missing docstring in public class
  "D102",   # Missing docstring in public method
  "D103",   # Missing docstring in public function
  "D415",   # First line should end with a . or ? or !
  "INP001", # File is part of an implicit namespace package, add an __init__.py
  "I002",   # Missing required import (i.e. from __future__ import annotations)
  "E741",   # Ambigiuous variable name
  "T201",   # print found
  "T203",   # pprint found
  "ERA001", # found commeneted out code
  "E402",   # Module level import not at top of cell
  "E501",   # Line too long
]

[tool.ruff.lint]
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

select = [
  "A",
  # "ANN", # Handled by mypy
  "ARG",
  "B",
  "BLE",
  "COM",
  "C4",
  "D",
  # "DTZ",  # One day I should know how to utilize timezones and dates...
  "E",
  # "EXE", Meh
  "ERA",
  "F",
  "FBT",
  "I",
  # "ISC",  # Favours implicit string concatenation
  "INP",
  # "INT", # I don't understand this one
  "N",
  "NPY",
  "PD",
  "PLC",
  "PLE",
  "PLR",
  "PLW",
  "PIE",
  "PT",
  "PTH",
  # "PYI", # Specific to .pyi files for type stubs
  "Q",
  "PGH004",
  "RET",
  "RUF",
  "C90",
  "S",
  # "SLF",    # Private member accessed (sure, it's python)
  "SIM",
  # "TRY", # Good in principle, would take a lot of work to statisfy
  "T10",
  "T20",
  "TID",
  "TCH",
  "UP",
  "N",
  "W",
  "YTT",
]

ignore = [
  "D105",    # Missing docstring in magic mthod
  "D401",    # First line of docstring should be in imperative mood
  "N806",    # Variable X in function should be lowercase
  "E731",    # Do not assign a lambda expression, use a def
  "S101",    # Use of assert detected.
  "W292",    # No newline at end of file
  "PLC1901", # "" can be simplified to be falsey
  "COM812",  # Trailing comma missing (handled by linter, ruff recommend disabling if using formatter)
  "N803",    # Argument should be lowercase (but we accept things like `X`)
  "PLC0415", # Allow imports inside functions / non-top-level scope
  "FBT001",  # Allow Boolean-typed positional argument in function definition

  # TODO(@eddibergman): These should be enabled
  "D100",    # Missing docstring in public module
  "D103",    # Missing docstring in public function
  "D104",    # Missing docstring in public package

  # TODO(@eddiebergman): Maybe fix
   "PLR2004", # Magic value used in comparison, consider replacing 2 with a constant variable
  "D400",    # First line must end with a period (@eddiebergman too many to fix so ignoring this for now)
  "D203",    # 1 blank line required before class docstring
  "D205",    # 1 blank line between summary and description

  # TODO(@eddiebergman): Could be backwards breaking
  "N802",    # Public function name should be lower case (i.e. get_X())
]



[tool.ruff.lint.isort]
known-first-party = ["openml"]
no-lines-before = ["future"]
required-imports = ["from __future__ import annotations"]
combine-as-imports = true
extra-standard-library = ["typing_extensions"]
force-wrap-aliases = true

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

[tool.mypy]
python_version = "3.10"
packages = ["openml"]
explicit_package_bases = true

show_error_codes = true

warn_unused_configs = true # warn about unused [tool.mypy] lines

follow_imports = "normal"      # Type check top level api code we use from imports
ignore_missing_imports = false # prefer explicit ignores

disallow_untyped_defs = true       # All functions must have types
disallow_untyped_decorators = true # ... even decorators
disallow_incomplete_defs = true    # ...all types

no_implicit_optional = true
check_untyped_defs = true

warn_return_any = true

[[tool.mypy.overrides]]
module = [
  # Files that are being skipped because of the mypy version upgrade from v1.13.0 to v1.19.1
  "examples._external_or_deprecated.upload_amlb_flows_and_runs",
  "examples._external_or_deprecated.run_setup_tutorial",
  "examples._external_or_deprecated.flows_and_runs_tutorial",
  "examples._external_or_deprecated.flow_id_tutorial",
  "examples._external_or_deprecated.fetch_runtimes_tutorial",
  "examples._external_or_deprecated.benchmark_with_optunahub",
  "examples._external_or_deprecated.2018_neurips_perrone_example",
  "examples._external_or_deprecated.2018_ida_strang_example",
  "examples._external_or_deprecated.2015_neurips_feurer_example",
  "examples.Basics.simple_tasks_tutorial",
  "examples.Basics.simple_suites_tutorial",
  "examples.Basics.simple_flows_and_runs_tutorial",
  "examples.Basics.simple_datasets_tutorial",
  "examples.Advanced.task_manual_iteration_tutorial",
  "examples.Advanced.study_tutorial",
  "examples.Advanced.fetch_evaluations_tutorial",
  "examples.Advanced.datasets_tutorial",
  "examples.Advanced.create_upload_tutorial",

  # Files that need to be fixed after removing the entire tests directory from skipping mypy checks
  "tests.test_api.test_estimation_procedure",
  "tests.test_api.test_evaluation",
  "tests.test_api.test_evaluation_measure",
  "tests.test_api.test_flow",
  "tests.test_api.test_http",
  "tests.test_api.test_run",
  "tests.test_api.test_setup",
  "tests.test_api.test_study",
  "tests.test_api.test_versions",
  "tests.conftest",
  "tests.test_datasets.test_dataset",
  "tests.test_datasets.test_dataset_functions",
  "tests.test_evaluations.test_evaluation_functions",
  "tests.test_evaluations.test_evaluations_example",
  "tests.test_extensions.test_functions",
  "tests.test_flows.dummy_learn.dummy_forest",
  "tests.test_flows.test_flow",
  "tests.test_flows.test_flow_functions",
  "tests.test_openml.test_api_calls",
  "tests.test_openml.test_cli",
  "tests.test_openml.test_config",
  "tests.test_openml.test_openml",
  "tests.test_runs.test_run",
  "tests.test_runs.test_run_functions",
  "tests.test_runs.test_trace",
  "tests.test_setups.test_setup_functions",
  "tests.test_study.test_study_functions",
  "tests.test_tasks.test_classification_task",
  "tests.test_tasks.test_clustering_task",
  "tests.test_tasks.test_learning_curve_task",
  "tests.test_tasks.test_regression_task",
  "tests.test_tasks.test_split",
  "tests.test_tasks.test_supervised_task",
  "tests.test_tasks.test_task",
  "tests.test_tasks.test_task_functions",
  "tests.test_tasks.test_task_methods",
  "tests.test_utils.test_utils",
  ]

ignore_errors = true
disallow_untyped_defs = false
disallow_untyped_decorators = false
disallow_incomplete_defs = false
disable_error_code = ["var-annotated"]