pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build]
sources = ["src"]
include = ["src"]

[project]
name = "databricks-labs-ucx"
dynamic = ["version"]
description = 'UCX - Unity Catalog Migration Toolkit'
readme = "README.md"
license-files = { paths = ["LICENSE", "NOTICE"] }
requires-python = ">=3.10.6" # latest available in DBR 13.2
keywords = ["Databricks", "Unity Catalog"]
authors = [
    { name = "Serge Smertin", email = "serge.smertin@databricks.com" },
    { name = "Ivan Trusov", email = "ivan.trusov@databricks.com" },
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "License :: Other/Proprietary License",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: Implementation :: CPython",
]
dependencies = [
    "databricks-sdk~=0.13.0",
    "PyYAML>=6.0.0,<7.0.0",
]

[project.optional-dependencies]
test = [
    "coverage[toml]>=6.5",
    "pytest",
    "pytest-cov>=4.0.0,<5.0.0",
    "pytest-mock>=3.0.0,<4.0.0",
]

[project.entry-points.databricks]
runtime = "databricks.labs.ucx.runtime:main"

[project.urls]
Issues = "https://github.com/databricks/ucx/issues"
Source = "https://github.com/databricks/ucx"

[tool.hatch.version]
path = "src/databricks/labs/ucx/__about__.py"

[tool.hatch.envs.unit]
dependencies = [
    "databricks-labs-ucx[test]"
]

[tool.hatch.envs.unit.scripts]
test = "pytest --cov src --cov-report=xml tests/unit"
test-cov-report = "pytest --cov src tests/unit --cov-report=html"

[tool.hatch.envs.integration]
dependencies = [
    "databricks-labs-ucx[test]",
]

[tool.hatch.envs.integration.scripts]
test = "pytest --cov src tests/integration"

[tool.hatch.envs.lint]
detached = true
dependencies = [
    "black>=23.1.0",
    "ruff>=0.0.243",
    "isort>=2.5.0"
]
[tool.hatch.envs.lint.scripts]
fmt = [
    "isort .",
    "black .",
    "ruff  . --fix",
]
verify = [
    "black --check .",
    "isort . --check-only",
    "ruff .",
]

[tool.isort]
skip_glob = [
    "notebooks/*.py"
]
profile = "black"

[tool.pytest.ini_options]
addopts = "-s -p no:warnings -vv --cache-clear"

[tool.black]
target-version = ["py310"]
line-length = 120
skip-string-normalization = true

[tool.ruff]
target-version = "py310"
line-length = 120
select = [
    "A",
    "ARG",
    "B",
    "C",
    "E",
    "EM",
    "F",
    "FBT",
    "I",
    "ICN",
    "ISC",
    "N",
    "PLC",
    "PLE",
    "PLR",
    "PLW",
    "Q",
    "RUF",
    "S",
    "T",
    "TID",
    "UP",
    "W",
    "YTT",
]
ignore = [
    # Allow non-abstract empty methods in abstract base classes
    "B027",
    # Allow boolean positional values in function calls, like `dict.get(... True)`
    "FBT003",
    # Ignore checks for possible passwords and SQL statement construction
    "S105", "S106", "S107", "S603", "S608",
    # Allow print statements
    "T201",
    # Allow asserts
    "S101",
    # Allow standard random generators
    "S311",
    # Ignore complexity
    "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
    # Ignore flaky Import block is un-sorted or un-formatted
    "I001"
]
extend-exclude = [
    "notebooks/*.py"
]

[tool.ruff.isort]
known-first-party = ["databricks.labs.ucx"]

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

[tool.ruff.per-file-ignores]

"tests/**/*" = [
    "PLR2004", "S101", "TID252", # tests can use magic values, assertions, and relative imports
    "ARG001" # tests may not use the provided fixtures
]

"src/databricks/labs/ucx/mixins/redash.py" = ["A002", "A003", "N815"]

[tool.coverage.run]
branch = true
parallel = true

[tool.coverage.report]
omit = ["src/databricks/labs/ucx/mixins/*", "*/working-copy/*", "*/fresh_wheel_file/*"]
exclude_lines = [
    "no cov",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
]