pyproject.toml

[tool.poetry]
name = "pythonboilerplate"
version = "0.0.0" # using poetry-dynamic-versioning
description = "Python を開発する時用ボイラープレート"
authors = [ "Naoki Aoyama" ]
license = "AGPL-3.0"

# Sphinx 用 Start
[project]
name = "pythonboilerplate"
version = "0.0.0" # using poetry-dynamic-versioning
description = "Python を開発する時用ボイラープレート"

[[project.authors]]
name = "Naoki Aoyama"
# Sphinx 用 End

[tool.poetry.dependencies]
python = "3.10.14"

[tool.poetry.group.dev.dependencies]
pip = "^24.0.0"
pre-commit = "~4.0.0"
taskipy = "~1.14.0"
tox = "~4.23.0"
tox-gh-actions = "~3.2.0"

[tool.poetry.group.docs.dependencies]
furo = "~2024.8.0"
sphinx = "~8.1.0"
sphinx-autobuild = "~2024.10.0"
sphinx-pyproject = "~0.3.0"

[tool.poetry.group.linting.dependencies]
mypy = "~1.13.0"
ruff = "^0.7.0"

[tool.poetry.group.tests.dependencies]
pytest = "~8.3.0"
pytest-azurepipelines = "~1.0.4"
pytest-cov = "~6.0.0"
pytest-mock = "~3.14.0"

[tool.poetry.group.types.dependencies]
types-requests = "~2.28.11.8"

[tool.poetry.scripts]
sample-cli = "pythonboilerplate.cli:main"

[tool.poetry-dynamic-versioning]
enable = true

[tool.poetry-dynamic-versioning.substitution]
folders = [ { path = "src" } ]

[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".vscode",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "site-packages",
    "venv",
]

fix = true
# Same as Black.
line-length = 99
indent-width = 4

# Assume Python 3.10
target-version = "py310"

[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
# McCabe complexity (`C901`) by default.
select = [ "ALL" ]
# E203: ":"の前の空白を入れないルール
# E501: 演算子の前に改行しないようにするルール
# W503: 二項演算子の後に改行が存在する
# ANN101: メソッド内の self の型アノテーションがありません
ignore = [
    "E203",
    "E501",
    "ANN101",
]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = [ "ALL" ]
# unfixable = []

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

[tool.ruff.lint.per-file-ignores]
"**/tests/**/*.py" = [
    "S101", #    asserts allowed in tests...
    "FBT", #     don't care about booleans as positional arguments in tests
    "INP001", #  no implicit namespace
    "D", #       don"t care about documentation in tests
    "S603", #   `subprocess` call: check for execution of untrusted input
    "PLR2004", # Magic value used in comparison, consider replacing with a constant variable
]

[tool.ruff.lint.pydocstyle]
# Use Google-style docstrings.
convention = "google"

[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

# Enable auto-formatting of code examples in docstrings. Markdown,
# reStructuredText code/literal blocks and doctests are all supported.
#
# This is currently disabled by default, but it is planned for this
# to be opt-out in the future.
docstring-code-format = true

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"

[tool.ruff.lint.isort]
force-single-line = true
force-sort-within-sections = true
default-section = "third-party"

[tool.mypy]
# Ref: https://mypy.readthedocs.io/en/stable/config_file.html?highlight=pyproject

## Import discovery
mypy_path = [ 'src', 'tests' ]
ignore_missing_imports = true
warn_unused_configs = true

## Disallow dynamic typing
disallow_any_unimported = true
#disallow_any_generics      = true
disallow_untyped_defs = true

## Untyped definitions and calls
disallow_untyped_calls = true
disallow_incomplete_defs = true
check_untyped_defs = true
strict_optional = true

## Configuring warnings
warn_unused_ignores = true
warn_no_return = true
warn_return_any = true
warn_unreachable = true

## Miscellaneous
scripts_are_modules = true

[tool.pytest]
[tool.pytest.ini_options]
minversion = "6.0"
addopts = [
    "--cov-branch",
    "--cov-report=html",
    "--cov-report=lcov",
    "--cov-report=term-missing",
    "--cov-report=term-missing",
    "--cov-report=term",
    "--cov-report=xml",
    "--cov=src",
    "--durations=0",
    "--verbose",
    "-r sfp",
]

[tool.sphinx-pyproject]
autosummary_generate = true
copyright = "2022, naa0yama"
exclude_patterns = [
    "_build",
    ".DS_Store",
    ".gitkeep",
    "Thumbs.db",
]
extensions = [
    'sphinx.ext.autosummary',
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.todo",
    "sphinx.ext.viewcode",
]
html_last_updated_fmt = "%Y-%m-%dT%H:%M:%S%Z"
html_static_path = [ "_static" ]
html_theme = "furo"
language = "en"
package_root = "src/pythonboilerplate"
project = "pythonboilerplate"
templates_path = [
    "_templates",
]
todo_include_todos = true

[tool.taskipy.tasks]
test = "pytest"
testview = "python3 -m http.server 8000 --directory htmlcov/"

docs = "task doc_cleanup && task docs_apidoc && task docs_build"
doc_cleanup = "rm -rfv docs/*.rst docs/*.bat docs/Makefile"
docs_apidoc = "sphinx-apidoc -F -e -d 2 -o docs src"
docs_build = "sphinx-build docs docs/_build"
docslive = "task docs && sphinx-autobuild --watch src docs docs/_build"

[build-system]
requires = [
    "poetry-core>=1.0.0",
    "poetry-dynamic-versioning>=1.0.0,<2.0.0",
]
build-backend = "poetry_dynamic_versioning.backend"