pyproject.toml

[project]
name = "measure"
version = "0.5.1"
description = "A metrics library that allows the user to swap metrics provider (statsd, cloudwatch, etc.) and provides an abstraction for creating metrics."
readme = "README.md"
requires-python = ">=3.13"
license = { text = "MIT" }
authors = [
    { name = "Adam Hitchcock", email = "adam@northisup.com" },
]
keywords = ["metrics", "statsd", "cloudwatch", "measurement"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: System :: Monitoring",
]
dependencies = []

[project.optional-dependencies]
boto3 = ["boto3"]
all = ["boto3"]

[project.urls]
Homepage = "https://github.com/NorthIsUp/measure"
Repository = "https://github.com/NorthIsUp/measure"
Issues = "https://github.com/NorthIsUp/measure/issues"

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

[tool.hatch.build.targets.wheel]
packages = ["measure"]

[tool.hatch.build.targets.sdist]
include = [
    "measure",
    "tests",
    "README.md",
    "pyproject.toml",
]

[dependency-groups]
dev = [
    "pytest",
    "pytest-cov",
    "mock",
    "django",
    "boto3",
    "ruff",
    "pyright",
]

[tool.ruff]
line-length = 140
preview = true
target-version = "py313"
extend-exclude = ["**/examples/**"]
# specific rules to enable
lint.extend-select = [
    "A",     # shadowing
    "ANN",   # annotations
    "ASYNC", # async rules
    "B",     # bugbear common python bugs
    "BLE",   # blind except
    "COM",   # comma rules
    "E",     # errors
    "F",     # pyflakes
    "FA",    # future annotations
    "FURB",  # refurb rules
    "I",     # imports + isort
    "ISC",   # implicit string concatenation
    "N",     # pep8-naming
    "PLR",   # refactor rules
    "RUF",   # ruff rules
    "TC",    # type checking
    "UP",    # upgrades
    "YTT",   # modern syntax
]
# specific rules to exclude
lint.ignore = [
    "A002",    # Function argument {name} is shadowing a Python builtin
    "A005",    # Module {name} shadows a Python standard-library module
    "ANN401",  # any-type — explicit Any is sometimes correct
    "BLE001",  # Blind Exception
    "COM812",  # Trailing comma missing
    "COM819",  # prohibited-trailing-comma
    "E501",    # line too long
    "E741",    # Ambiguous variable name
    "N806",    # Variable in function should be lowercase
    "N816",    # mixedCase variable in global scope (used for fallback import aliases)
    "N999",    # Invalid module name
    "PLR0911", # too many return statements for method
    "PLR0912", # too many branches
    "PLR0913", # too many arguments for method
    "PLR0914", # too many local variables
    "PLR0915", # too many statements
    "PLR0916", # too many Boolean expressions
    "PLR0917", # too many positional arguments for method
    "PLR2004", # Magic value used in comparison
    "PLR6301", # could be a function, class method, or static method
    "RET504",  # Unnecessary assignment to {name} before return statement
    "RUF001",  # Ambiguous unicode characters in strings
    "RUF067",  # __init__ module should only contain docstrings and re-exports
    "TC006",   # Type checking: Add quotes to type expression in typing.cast()
    "TC007",   # Type checking: Add quotes to type alias
    "TRY002",  # Create your own exception
    "TRY401",  # Redundant exception object in logging.exception
    "UP009",   # UTF-8 encoding declaration is unnecessary
]

# specific fixes to be more aggressive with
lint.extend-safe-fixes = [
    "FA",
    "FA102", # Add 'from __future__ import annotations' import
    "TC",
    "UP",
]

lint.future-annotations = true

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["ANN", "PLR", "S101", "N802", "COM818"]

[tool.pyproject-fmt]
column_width = 1          # always wrap lists
indent = 4
keep_full_version = false # remove unnecessary trailing ``.0``'s from version specifiers

[tool.pytest.ini_options]
addopts = [
    "-vv",
    "-ra",
]
filterwarnings = [
    "error::pytest.PytestUnknownMarkWarning",
    "ignore::DeprecationWarning",
    "ignore::ResourceWarning",
]
log_format = "%(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)"
log_level = "DEBUG"
testpaths = ["tests"]

[tool.pyright]
venv = ".venv"
venvPath = "."
exclude = [
    "**/__pycache__",
    "**/.venv",
    "tests",
]
pythonVersion = "3.13"
reportConstantRedefinition = "error"
reportDeprecated = "warning"
reportDuplicateImport = "error"
reportImportCycles = "none"
reportIncompatibleMethodOverride = "error"
reportInconsistentConstructor = "warning"
reportInvalidTypeVarUse = "error"
reportMatchNotExhaustive = "warning"
reportMissingImports = "error"
reportMissingModuleSource = "warning"
reportMissingTypeStubs = false
reportPrivateImportUsage = "error"
reportSelfClsParameterName = "error"
reportUnnecessaryTypeIgnoreComment = "warning"
reportUntypedBaseClass = "error"
reportUntypedClassDecorator = "error"
reportUntypedFunctionDecorator = "warning"
reportUnusedImport = "error"
strictDictionaryInference = true
strictListInference = true
strictSetInference = true
typeCheckingMode = "basic"