pyproject.toml

[tool.poetry]
name = "pandas-stubs"
version = "3.0.0.260204"
description = "Type annotations for pandas"
authors = ["The Pandas Development Team <pandas-dev@python.org>"]
license = "BSD-3-Clause"
readme = "README.md"
homepage = "https://pandas.pydata.org"
repository = "https://github.com/pandas-dev/pandas-stubs"
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Environment :: Console",
  "Intended Audience :: Science/Research",
  "License :: OSI Approved :: BSD License",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Topic :: Scientific/Engineering",
  "Typing :: Stubs Only",
]
packages = [{ include = "pandas-stubs" }]
exclude = ["pandas-stubs/__init__.py"]

[tool.poetry.urls]
"Bug Tracker" = "https://github.com/pandas-dev/pandas-stubs/issues"
"Documentation" = "https://pandas.pydata.org/pandas-docs/stable"

[tool.poetry.dependencies]
python = ">=3.11"
numpy = ">=1.23.5"

[tool.poetry.group.dev.dependencies]
mypy = ">=1.19.1"
pandas = "3.0.1"
pyarrow = ">=10.0.1"
pytest = ">=8.4.2"
pyright = ">=1.1.408"
ty = ">=0.0.12"
pyrefly = ">=0.53.0"
poethepoet = ">=0.16.5"
loguru = ">=0.6.0"
typing-extensions = ">=4.5.0"
matplotlib = ">=3.10.1"
pre-commit = ">=4.3.0"
black = ">=25.9.0"
isort = ">=7.0.0"
openpyxl = ">=3.0.10"
numexpr = ">=2.13.1"
lxml = ">=4.9.1"
pyreadstat = ">=1.2.0"
xlrd = ">=2.0.1"
xlsxwriter = ">=3.0.3"
pyxlsb = ">=1.0.10"
odfpy = ">=1.4.1"
xarray = ">=22.6.0"
tabulate = ">=0.8.10"
jinja2 = ">=3.1"
scipy = ">=1.9.1"
scipy-stubs = ">=1.15.3.0"
SQLAlchemy = ">=2.0.39"
types-python-dateutil = ">=2.8.19"
beautifulsoup4 = ">=4.14.2"
html5lib = ">=1.1"
python-calamine = ">=0.2.0"
pyarrow-stubs = { version = ">=20.0.0.20250928", python = "<4" }
fsspec = "^2025.10.0"
tables = ">=3.10.2"
pytz = "^2025.2"
types-pytz = ">=2022.1.1"
pyiceberg = "^0.10.0"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.poe.tasks.test_all]
help = "Run all tests"
script = "scripts.test:run_tests(src=True, dist=True)"

[tool.poe.tasks.test]
help = "Run local tests (includes 'mypy', 'pyright', 'pytest', and 'style')"
script = "scripts.test:run_tests(src=True)"

[tool.poe.tasks.test_dist]
help = "Run tests on the installed stubs (includes 'mypy_dist' and 'pyright_dist')"
script = "scripts.test:run_tests(dist=True)"

[tool.poe.tasks.pytest]
help = "Run pytest"
script = "scripts.test:pytest(nightly)"
args = [
  { name = "nightly", positional = false, default = false, type = "boolean", required = false, help = "Use pandas nightly (off by default)" },
]

[tool.poe.tasks.style]
help = "Run pre-commit"
script = "scripts.test.run:style"

[tool.poe.tasks.mypy]
help = "Run mypy on 'tests' (using the local stubs) and on the local stubs"
args = [
  { name = "mypy_nightly", positional = false, default = false, type = "boolean", required = false, help = "Use mypy nightly (off by default)" },
]
script = "scripts.test:mypy_src(mypy_nightly)"

[tool.poe.tasks.mypy_dist]
help = "Run mypy on 'tests' using the installed stubs"
script = "scripts.test:run_tests(dist=True, type_checker='mypy')"

[tool.poe.tasks.ty]
help = "Run ty on pandas-stubs"
script = "scripts.test.run:ty"

[tool.poe.tasks.pyrefly]
help = "Run pyrefly on pandas-stubs"
script = "scripts.test.run:pyrefly"

[tool.poe.tasks.pyright]
help = "Run pyright on 'tests' (using the local stubs) and on the local stubs"
script = "scripts.test.run:pyright_src"

[tool.poe.tasks.pyright_dist]
help = "Run pyright on 'tests' using the installed stubs"
script = "scripts.test:run_tests(dist=True, type_checker='pyright')"

[tool.poe.tasks.stubtest]
script = "scripts.test:stubtest(allowlist, check_missing, nightly)"
help = "Run stubtest to compare the installed stubs against pandas"
args = [
  { name = "allowlist", positional = true, default = "", required = false, help = "Path to an allowlist (optional)" },
  { name = "check_missing", positional = false, default = false, type = "boolean", required = false, help = "Report errors when the stubs are incomplete (off by default)" },
  { name = "nightly", positional = false, default = false, type = "boolean", required = false, help = "Compare against pandas nightly (off by default)" },
]

[tool.poe.tasks.type_completeness]
help = "Check type completeness"
script = "scripts.test.run:type_completeness"

[tool.black]
target-version = ["py311"]

[tool.isort]
known_pre_libs = "pandas._config"
known_pre_core = [
  "pandas._libs",
  "pandas._typing",
  "pandas.util._*",
  "pandas.compat",
  "pandas.errors",
]
known_dtypes = "pandas.core.dtypes"
known_post_core = ["pandas.tseries", "pandas.io", "pandas.plotting"]
sections = [
  "FUTURE",
  "STDLIB",
  "THIRDPARTY",
  "PRE_LIBS",
  "PRE_CORE",
  "DTYPES",
  "FIRSTPARTY",
  "POST_CORE",
  "LOCALFOLDER",
]
profile = "black"
combine_as_imports = true
force_grid_wrap = 2
force_sort_within_sections = true
skip_glob = "env"


[tool.ruff]
target-version = "py311"
fix = true


[tool.ruff.lint]
extend-select = ["ALL"]
ignore = [
  # The following rules are ignored permanently for good reasons
  "COM",    # https://docs.astral.sh/ruff/rules/#flake8-commas-com
  "D",      # https://docs.astral.sh/ruff/rules/#pydocstyle-d
  "E501",   # handled by black https://docs.astral.sh/ruff/rules/line-too-long/
  "FBT",    # https://docs.astral.sh/ruff/rules/#flake8-boolean-trap-fbt
  "I",      # handled by isort
  "TRY003", # https://docs.astral.sh/ruff/rules/raise-vanilla-args/
]


[tool.ruff.lint.per-file-ignores]
"*.pyi" = [
  # The following rules are ignored permanently for good reasons
  "A002",   # https://docs.astral.sh/ruff/rules/builtin-argument-shadowing/
  "ANN401", # https://docs.astral.sh/ruff/rules/any-type/
  "FIX002", # https://docs.astral.sh/ruff/rules/line-contains-todo/
  "N",      # https://docs.astral.sh/ruff/rules/#pep8-naming-n
  "TD002",  # https://docs.astral.sh/ruff/rules/missing-todo-author/
  # The following rules are ignored temporarily. Either fix them or move to the permanent list above.
  "A001",    # https://docs.astral.sh/ruff/rules/builtin-variable-shadowing/
  "A004",    # https://docs.astral.sh/ruff/rules/builtin-import-shadowing/
  "PYI001",  # https://docs.astral.sh/ruff/rules/unprefixed-type-param/
  "PYI042",  # https://docs.astral.sh/ruff/rules/snake-case-type-alias/
  "ERA001",
  "PLR0402",
  "PLC0105",
]

"scripts/*" = [
  # The following rules are ignored permanently for good reasons
  "EM",   # https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
  "S603", # https://docs.astral.sh/ruff/rules/subprocess-without-shell-equals-true/
]
"tests/*" = [
  # The following rules are ignored permanently for good reasons
  "ANN401",  # https://docs.astral.sh/ruff/rules/any-type/
  "ARG",     # https://docs.astral.sh/ruff/rules/#flake8-unused-arguments-arg
  "B905",    # https://docs.astral.sh/ruff/rules/zip-without-explicit-strict/
  "E731",    # https://docs.astral.sh/ruff/rules/lambda-assignment/
  "EM",      # https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
  "FIX002",  # https://docs.astral.sh/ruff/rules/line-contains-todo/
  "PD",      # Pandas is here
  "PLC0415", # https://docs.astral.sh/ruff/rules/import-outside-top-level/
  "PLW0108", # https://docs.astral.sh/ruff/rules/unnecessary-lambda/
  "S101",    # https://docs.astral.sh/ruff/rules/assert/
  "TD002",   # https://docs.astral.sh/ruff/rules/missing-todo-author/
  # The following rules are ignored temporarily. Either fix them or move to the permanent list above.
  "A001",   # https://docs.astral.sh/ruff/rules/builtin-variable-shadowing/
  "PYI042", # https://docs.astral.sh/ruff/rules/snake-case-type-alias/
  "SLF001", # https://docs.astral.sh/ruff/rules/private-member-access/
  "ERA",
  "RUF",
  "SIM",
  "TRY",
  "PT",
  "NPY",
  "N",
  "DTZ",
  "PLR",
  "TC",
  "PGH",
  "S311",
  "C901",
]
"tests/test_io.py" = [
  # The following rules are ignored permanently for good reasons
  "S301", # https://docs.astral.sh/ruff/rules/suspicious-pickle-usage/
]


[tool.mypy]
# Import discovery
namespace_packages = false
explicit_package_bases = false
ignore_missing_imports = true
follow_imports = "normal"
follow_imports_for_stubs = false
no_site_packages = false
no_silence_site_packages = false
# Disallow dynamic typing
disallow_any_unimported = false  # TODO
disallow_any_expr = false        # TODO
disallow_any_decorated = false   # TODO
disallow_any_explicit = false    # TODO
disallow_any_generics = false    # TODO
disallow_subclassing_any = false # TODO
# Untyped definitions and calls
disallow_untyped_calls = false     # TODO
disallow_untyped_defs = false      # TODO
disallow_incomplete_defs = false   # TODO
check_untyped_defs = true
disallow_untyped_decorators = true
# None and Optional handling
no_implicit_optional = true
strict_optional = true
# Configuring warnings
warn_redundant_casts = true
warn_unused_ignores = true
warn_no_return = true
warn_return_any = false     # TODO
warn_unreachable = true
# Suppressing errors
ignore_errors = false
enable_error_code = "ignore-without-code" # same as in pandas
# Miscellaneous strictness flags
allow_untyped_globals = false
allow_redefinition = false
local_partial_types = false
implicit_reexport = false     # pyright behaves the same
strict_equality = true
# Configuring error messages
show_error_context = false
show_column_numbers = false
show_error_codes = true

[tool.pyright]
typeCheckingMode = "strict"
stubPath = "."
include = ["tests", "pandas-stubs"]
enableTypeIgnoreComments = false    # use pyright-specific ignores
reportUnnecessaryTypeIgnoreComment = true
# enable optional checks
reportMissingModuleSource = true

[tool.codespell]
ignore-words-list = "indext, mose, sav, ser, ttest"

[tool.pytest.ini_options]
filterwarnings = [
  # treat warnings as errors
  "error",
]

# Next line needed to avoid poetry complaint
[tool.setuptools_scm]

[tool.pyrefly]
project-includes = ["pandas-stubs", "tests"]
enabled-ignores = ["pyrefly"]
python-version = "3.11"

[tool.pyrefly.errors]
# Import discovery
untyped-import = false
# enable optional checks
implicit-abstract-class = true
implicitly-defined-attribute = true
open-unpacking = true
unannotated-attribute = true
# TODO: enable
# implicit-any = true
# missing-source = true
# missing-override-decorator = true
# unannotated-parameter = true
# unannotated-return = true

[tool.ty.environment]
python-platform = "all"
python-version = "3.11"

[tool.ty.rules]
possibly-unresolved-reference = "error"

[tool.ty.analysis]
respect-type-ignore-comments = false