pyproject.toml

[build-system]
build-backend = 'mesonpy'
requires = [
  'meson-python',
  "cython>=3.1.0,<4",  # Sync with the Cython check in meson.build
  "numpy>=2.0.0,<3",
  "setuptools_scm>=9.2.0,<10",
]

[project]
name = "linearmodels"
# Keep in sync with requirements.txt
dependencies = [
  "numpy>=1.23.5,<3",
  "pandas>=1.4.0",
  "scipy>=1.8.0",
  "statsmodels>=0.14.6",  # The first release that imports with pandas 3
  "mypy_extensions>=0.4",
  "pyhdfe>=0.2.0",
  "formulaic>=1.2.1",
  "packaging",
]
authors = [{ name = "Kevin Sheppard", email = "kevin.k.sheppard@gmail.com" }]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: End Users/Desktop",
  "Intended Audience :: Financial and Insurance Industry",
  "Intended Audience :: Science/Research",
  "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",
  "Programming Language :: Python :: 3.15",
  "Operating System :: MacOS :: MacOS X",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX",
  "Programming Language :: Python",
  "Programming Language :: Cython",
  "Topic :: Scientific/Engineering",
]
description = "Linear Panel, Instrumental Variable, Asset Pricing, and System Regression models for Python"
# The version is set in meson.build, which runs linearmodels/_build/git_version.py
dynamic = [
  'version'
]
keywords=[
  "linear models",
  "regression",
  "instrumental variables",
  "IV",
  "panel",
  "fixed effects",
  "clustered",
  "heteroskedasticity",
  "endogeneity",
  "instruments",
  "statistics",
  "statistical inference",
  "econometrics",
]
license = "NCSA"
license-files = [ "LICENSE.md" ]
maintainers = [
  { name = "Kevin Sheppard", email = "kevin.k.sheppard@gmail.com" },
]
readme = "README.md"
requires-python = ">=3.10"

[project.optional-dependencies]
test = [
  # test
  "pytest>=9,<10",
  "pytest-randomly",
  "pytest-xdist",
  "pytest-cov",
  "coverage[toml]",
  "xarray>=0.16",  # The tests import xarray
  "meson",
  "ninja",
]
doc = [
  # Documentation
  "setuptools>=61",
  "wheel",
  "setuptools_scm[toml]>=9.2.0,<10",
  "cython>=3.1.0,<4",  # Sync with the Cython check in meson.build
  "numpy >=1.23.5",
  "scipy >=1.5.0",
  "ipython >=8.0.1",
  "matplotlib >=3.0",
  "statsmodels >=0.14.6",
  "jinja2",
  "sphinx>=7",
  "seaborn",
  "numpydoc>=1.10",
  "nbsphinx",
  "sphinx-immaterial",
  "jupyter",
  "notebook",
  "sphinx-autodoc-typehints",
  "fonttools>=4.43.0", # not directly required, pinned by Snyk to avoid a vulnerability
  "jupyterlab>=4.4.8", # not directly required, pinned by Snyk to avoid a vulnerability
  "nbconvert",
  "pickleshare",
  "sphinxcontrib-spelling",
]
dev = [
  "xarray>=0.16",
  "pandas-stubs",
  "wheel",
  # versioning
  "setuptools_scm[toml]>=9.2.0,<10",
  "packaging",
  # Performance
  "cython>=3.1.0,<4",
  "numba>=0.55",
  # Graphics
  "matplotlib>=3",
  "seaborn",
  # Tests
  "pytest>=9,<10",
  "pytest-randomly",
  "pytest-xdist",
  "pytest-cov",
  # formatting
  "black[jupyter]~=26.5.0",
  "isort~=9.0",
  "colorama",
  "flake8",
  "flake8-bugbear",
  "mypy>=1.3",
  "ruff>=0.16.0",
  "pyupgrade>=3.4.0",
  "numpydoc>=1.10",  # The exclude_files setting of numpydoc lint needs 1.10
  "jupyterlab-code-formatter",
  "jupyterlab>=4.4.8",  # not directly required, pinned by Snyk to avoid a vulnerability
  "zipp>=3.19.1", # not directly required, pinned by Snyk to avoid a vulnerability
]


[project.urls]
homepage = "https://github.com/bashtage/linearmodels"
documentation = "https://bashtage.github.io/linearmodels/"
repository = "https://github.com/bashtage/linearmodels"
changelog = "https://bashtage.github.io/linearmodels/changes.html"

[tool.meson-python.args]
setup = ['--vsenv']

[tool.black]
target-version = ['py310', 'py311', 'py312', 'py313', 'py314']
exclude = '''
(
  \.egg
  | \.git
  | \.mypy_cache
  | \.oytest_cache
  | _build
  | buck-out
  | build
  | dist
)
'''

[tool.pyright]
exclude = [
  "**/tests/**",
]

[tool.ruff]
line-length = 88
fix = false
target-version = "py310"

[tool.ruff.lint]

select = [
  # pyflakes
  "F",
  # pycodestyle
  "E", "W",
  # flake8-2020
  "YTT",
  # flake8-bugbear
  "B",
  # flake8-quotes
  "Q",
  # flake8-debugger
  "T10",
  # flake8-gettext
  "INT",
  # pylint
  "PL",
  # flake8-pytest-style
  "PT",
  # misc lints
  "PIE",
  # flake8-pyi
  "PYI",
  # tidy imports
  "TID",
  # implicit string concatenation
  "ISC",
  # flake8-type-checking
  "TC",
  # comprehensions
  "C4",
  # pygrep-hooks
  "PGH",
  # Ruff-specific rules
  "RUF",
  # flake8-bandit: exec-builtin
  "S102",
  # Perflint
  "PERF",
  # flynt
  "FLY",
  # flake8-future-annotations
  "FA",
  # unconventional-import-alias
  "ICN001",
  # flake8-slots
  "SLOT",
  # flake8-raise
  "RSE"
]

ignore = [
  # Required to allow black formatting
  # Whitespace before ':' (Needed for black)
  "E203",
  # Line too long (### > 88 characters) (Needed for black)
  "E501",
  # Multiple statements on one line (colon) (E701)
  "E701",
  # Always ignore
  # TC do not work with doc building
  # Move application import `linearmodels....` into a type-checking block
  "TC001",
  # Move third-party import `...` into a type-checking block
  "TC002",
  # Move standard library import `...` into a type-checking block
  "TC003",

  #  ### Intentionally disabled
  # Too many arguments to function call
  "PLR0913", # 55
  # Too many branches
  "PLR0912", # 14
  # Too many statements
  "PLR0915", # 21
  # Magic number
  "PLR2004",
  # Too many positional arguments
  "PLR0917",
  # Like to suggest use [a, *b] instead of [a] + b
  "RUF005",
]

[tool.ruff.lint.per-file-ignores]
# relative imports allowed for asv_bench
"linearmodels/__init__.py" = ["PT028"]
"linearmodels/tests/panel/results/execute-stata-simulated-data.py" = ["E501"]
# Results import models, avoid circular
"linearmodels/iv/results.py" = ["PERF203", "PLC0415"]

[tool.pytest.ini_options]
minversion = "9.0"
testpaths = "linearmodels"
xfail_strict = true
strict = true
empty_parameter_set_mark = "xfail"
filterwarnings = [
  # Guards: nothing in linearmodels or its tests triggers these deprecations, and a
  # test that does fails. The comments give the versions of pandas that warn.
  # pandas 1.x
  "error:The pandas.datetime class is deprecated:FutureWarning:",
  "error:pandas.util.testing is deprecated:FutureWarning:",
  "error:Support for multi-dimensional indexing:FutureWarning",
  # pandas 1.4 to 2.3 start the message of SettingWithCopyWarning with a new line
  "error:\\s*A value is trying to be set::",
  # pandas 2.1 to 2.3 (a FutureWarning) and the development versions of 3.1 (a
  # Pandas4Warning, which is a DeprecationWarning)
  "error:Setting an item of incompatible dtype::",
  # Development versions of pandas 3.1
  "error:Constructing a DataFrame from a list of sequences with mismatched::",
  "error:assert_index_equal will check the::",
]
junit_family = "xunit2"
markers = [
  "slow: mark a test as slow",
  "smoke: mark a test as a coding error (smoke) test"
]

[tool.isort]
profile = "black"
src_paths = ["linearmodels"]
sections = ["FUTURE","COMPAT","STDLIB","THIRDPARTY","FIRSTPARTY","LOCALFOLDER"]
known_first_party = ["linearmodels"]
known_compat = ["linearmodels.compat.*"]
known_third_party=["Cython","numpy","matplotlib","pandas","pytest","cython","scipy","seaborn"]
line_length=88
force_grid_wrap=0
multi_line_output=3
combine_as_imports=true
force_sort_within_sections=true
include_trailing_comma=true
use_parentheses=true

[tool.numpydoc_validation]
# Docstring lint. Run it from the repository root with
#   python -m numpydoc lint $(git ls-files "linearmodels/*.py") --config .
# The rules are in "Docstring conventions" in doc/source/contributing.rst.
# Needs numpydoc 1.10 or later, which added exclude_files.
#
# Every check except the extended summary (ES01), See Also (SA01) and Examples (EX01).
checks = ["all", "ES01", "SA01", "EX01"]

# Files that are not linted. The patterns are matched at the start of the path as it
# is given on the command line, and accept both / and \ as the separator.
exclude_files = [
  # Tests
  '(?:.*[/\\])?tests[/\\]',
  '(?:.*[/\\])?conftest\.py$',
  # Generated and build files
  '(?:.*[/\\])?_version\.py$',
  '(?:.*[/\\])?_build[/\\]',
]

# Objects that are not linted. The patterns are searched in the dotted name of the
# object, which is the file name without .py, the class and the member. For example,
# the name of IVGMM.fit in linearmodels/iv/model.py is model.IVGMM.fit.
exclude = [
  # Special methods, such as __init__. The class docstring documents the constructor.
  '\.__\w+__$',
  # Private functions, methods and properties, and everything defined inside them.
  '\._[a-z0-9]',
  # Private classes, except _OLS and _Panel, which the reference pages list. The public
  # members of private base classes, such as _IVModelBase.predict, are linted because
  # the documentation shows them on the public subclasses.
  '\._(?!OLS$|Panel$)[A-Z][^.]*$',
  # Private modules, except LinearConstraint, which the reference pages list.
  '^_[a-z0-9][^.]*(\.(?!LinearConstraint(\.|$)).*)?$',
  # Functions defined inside other functions or methods.
  '^[^.]+\.(?:[^.]+\.)*_*[a-z][^.]*\.[^.]+$',
]

# numpydoc lint cannot see decorators, so it asks every property for a Returns section and
# for a summary that starts with an infinitive verb. Ignore both checks for docstrings
# without a Parameters section, which are the docstrings of properties.
override_RT01 = ['\A(?![\s\S]*\nParameters\n-+\n)']
override_SS05 = ['\A(?![\s\S]*\nParameters\n-+\n)']

[tool.coverage.run]
source = [ "linearmodels" ]
branch = true
plugins = [ "Cython.Coverage" ]
omit = [
  # Version file
  "*/_version.py",
  # Compatibility code
  "*/compat/*",
  "*/results/*",
  "*/conftest.py",
]

[tool.coverage.report]
show_missing = true
ignore_errors = false
# Regexes for lines to exclude from consideration
exclude_also = [
  # Have to re-enable the standard pragma
  "pragma: no cover",

  # Do not complain about missing debug-only code:
  "def __repr__",
  "if self\\.debug",

  # Don't complain if tests don't hit defensive assertion code:
  "raise NotImplementedError",
  "except NotImplementedError",
  "raise AssertionError",
  # Ignore pass
  "pass",
  # Ignore failure messages
  "pytest.xfail",
  # Ignore ImportError protection
  "raise ImportError",
  "except ImportError",
  # Ignore type checking code
  "if TYPE_CHECKING",
  "elif TYPE_CHECKING",
  # Cython function declarations
  "cdef",
  # Cython functions with void
  "cdef void",
  # Numba jit decorators
  "@jit",
  # Do not complain if non-runnable code is not run:
  "if 0:",
  "if __name__ == .__main__.:",
]
include = [ "*/linearmodels/*" ]
omit = [
  "*/_version.py",
  "*/compat/*",
  "*recursions.py",
  "*samplers.py",
]

[tool.coverage.html]
directory = "coverage_html_report"

[tool.mypy]
exclude = [
  "tests",
]
ignore_missing_imports=true
no_implicit_optional=true
strict_equality=true
disallow_untyped_defs=true
disallow_incomplete_defs=true
show_error_context=true

[[tool.mypy.overrides]]
module = "linearmodels.conftest"
check_untyped_defs=false
disallow_untyped_defs=false

[[tool.mypy.overrides]]
module = "linearmodels._version"
check_untyped_defs=false
disallow_untyped_defs=false
disallow_incomplete_defs=false

[[tool.mypy.overrides]]
module = "linearmodels.tests.*"
check_untyped_defs=false
disallow_untyped_defs=false
disallow_incomplete_defs=false