1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
|
"""Development tasks."""
from __future__ import annotations
import os
import re
import sys
import warnings
from contextlib import contextmanager
from functools import partial, wraps
from importlib.metadata import version as pkgversion
from pathlib import Path
from random import sample
from tempfile import gettempdir
from typing import TYPE_CHECKING, Any, Callable
from duty import duty, tools
from pysource_codegen import generate
from pysource_minimize import minimize
from griffe import visit
if TYPE_CHECKING:
from collections.abc import Callable, Iterator
from duty.context import Context
PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "duties.py", "scripts"))
PY_SRC_LIST = tuple(str(_) for _ in PY_SRC_PATHS)
PY_SRC = " ".join(PY_SRC_LIST)
CI = os.environ.get("CI", "0") in {"1", "true", "yes", ""}
WINDOWS = os.name == "nt"
PTY = not WINDOWS and not CI
MULTIRUN = os.environ.get("MULTIRUN", "0") == "1"
PY_VERSION = f"{sys.version_info.major}{sys.version_info.minor}"
PY_DEV = "314"
def _pyprefix(title: str) -> str:
if MULTIRUN:
prefix = f"(python{sys.version_info.major}.{sys.version_info.minor})"
return f"{prefix:14}{title}"
return title
def _not_from_insiders(func: Callable) -> Callable:
@wraps(func)
def wrapper(ctx: Context, *args: Any, **kwargs: Any) -> None:
origin = ctx.run("git config --get remote.origin.url", silent=True)
if "pawamoy-insiders/griffe" in origin:
ctx.run(
lambda: False,
title="Not running this task from insiders repository (do that from public repo instead!)",
)
return
func(ctx, *args, **kwargs)
return wrapper
@contextmanager
def _material_insiders() -> Iterator[bool]:
if "+insiders" in pkgversion("mkdocs-material"):
os.environ["MATERIAL_INSIDERS"] = "true"
try:
yield True
finally:
os.environ.pop("MATERIAL_INSIDERS")
else:
yield False
def _get_changelog_version() -> str:
changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file:
return next(filter(bool, map(changelog_version_re.match, file))).group(1) # type: ignore[union-attr]
@duty
def changelog(ctx: Context, bump: str = "") -> None:
"""Update the changelog in-place with latest commits.
```bash
make changelog [bump=VERSION]
```
Update the changelog in-place. The changelog task uses [git-changelog](https://pawamoy.github.io/git-changelog/)
to read Git commits and parse their messages to infer the new version based
on our [commit message convention][commit-message-convention].
The new version will be based on the types of the latest commits,
unless a specific version is provided with the `bump` parameter.
If the group of commits contains only bug fixes (`fix:`)
and/or commits that are not interesting for users (`chore:`, `style:`, etc.),
the changelog will gain a new **patch** entry.
It means that the new suggested version will be a patch bump
of the previous one: `0.1.1` becomes `0.1.2`.
If the group of commits contains at least one feature (`feat:`),
the changelog will gain a new **minor** entry.
It means that the new suggested version will be a minor bump
of the previous one: `0.1.1` becomes `0.2.0`.
If there is, in the group of commits, a commit whose body contains something like `Breaking change`,
the changelog will gain a new **major** entry, unless the version is still an "alpha" version (starting with 0),
in which case it gains a **minor** entry.
It means that the new suggested version will be a major bump
of the previous one: `1.2.1` becomes `2.0.0`, but `0.2.1` is only bumped up to `0.3.0`.
Moving from "alpha" status to "beta" or "stable" status is a choice left to the developers,
when they consider the package is ready for it.
The configuration for git-changelog is located at `config/git-changelog.toml`.
Parameters:
bump: Bump option passed to git-changelog.
"""
ctx.run(tools.git_changelog(bump=bump or None), title="Updating changelog")
ctx.run(tools.yore.check(bump=bump or _get_changelog_version()), title="Checking legacy code")
@duty(pre=["check-quality", "check-types", "check-docs", "check-api"])
def check(ctx: Context) -> None:
"""Check it all!
```bash
make check
```
Composite command to run all the check commands:
- [`check-quality`][], to check the code quality on all Python versions
- [`check-types`][], to type-check the code on all Python versions
- [`check-docs`][], to check the docs on all Python versions
- [`check-api`][], to check for API breaking changes
"""
@duty(nofail=PY_VERSION == PY_DEV)
def check_quality(ctx: Context) -> None:
"""Check the code quality.
```bash
make check-quality
```
Check the code quality using [Ruff](https://astral.sh/ruff).
The configuration for Ruff is located at `config/ruff.toml`.
In this file, you can deactivate rules or activate others to customize your analysis.
Rule identifiers always start with one or more capital letters, like `D`, `S` or `BLK`,
then followed by a number.
You can ignore a rule on a specific code line by appending
a `noqa` comment ("no quality analysis/assurance"):
```python title="src/your_package/module.py"
print("a code line that triggers a Ruff warning") # noqa: ID
```
...where ID is the identifier of the rule you want to ignore for this line.
Example:
```python title="src/your_package/module.py"
import subprocess
```
```console
$ make check-quality
✗ Checking code quality (1)
> ruff check --config=config/ruff.toml src/ tests/ scripts/
src/your_package/module.py:2:1: S404 Consider possible security implications associated with subprocess module.
```
Now add a comment to ignore this warning.
```python title="src/your_package/module.py"
import subprocess # noqa: S404
```
```console
$ make check-quality
✓ Checking code quality
```
You can disable multiple different warnings on a single line
by separating them with commas, for example `# noqa: D300,D301`.
You can disable a warning globally by adding its ID
into the list in `config/ruff.toml`.
You can also disable warnings per file, like so:
```toml title="config/ruff.toml"
[per-file-ignores]
"src/your_package/your_module.py" = [
"T201", # Print statement
]
```
"""
ctx.run(
tools.ruff.check(*PY_SRC_LIST, config="config/ruff.toml"),
title=_pyprefix("Checking code quality"),
)
@duty(nofail=PY_VERSION == PY_DEV)
def check_docs(ctx: Context) -> None:
"""Check if the documentation builds correctly.
```bash
make check-docs
```
Build the docs with [MkDocs](https://www.mkdocs.org/) in strict mode.
The configuration for MkDocs is located at `mkdocs.yml`.
This task builds the documentation with strict behavior:
any warning will be considered an error and the command will fail.
The warnings/errors can be about incorrect docstring format,
or invalid cross-references.
"""
Path("htmlcov").mkdir(parents=True, exist_ok=True)
Path("htmlcov/index.html").touch(exist_ok=True)
if CI:
os.environ["DEPLOY"] = "true"
with _material_insiders():
ctx.run(
tools.mkdocs.build(strict=True, verbose=True),
title=_pyprefix("Building documentation"),
)
@duty(nofail=PY_VERSION == PY_DEV)
def check_types(ctx: Context) -> None:
"""Check that the code is correctly typed.
```bash
make check-types
```
Run type-checking on the code with [Mypy](https://mypy.readthedocs.io/).
The configuration for Mypy is located at `config/mypy.ini`.
If you cannot or don't know how to fix a typing error in your code,
as a last resort you can ignore this specific error with a comment:
```python title="src/your_package/module.py"
print("a code line that triggers a Mypy warning") # type: ignore[ID]
```
...where ID is the name of the warning.
Example:
```python title="src/your_package/module.py"
result = data_dict.get(key, None).value
```
```console
$ make check-types
✗ Checking types (1)
> mypy --config-file=config/mypy.ini src/ tests/ scripts/
src/your_package/module.py:2:1: Item "None" of "Data | None" has no attribute "value" [union-attr]
```
Now add a comment to ignore this warning.
```python title="src/your_package/module.py"
result = data_dict.get(key, None).value # type: ignore[union-attr]
```
```console
$ make check-types
✓ Checking types
```
"""
os.environ["FORCE_COLOR"] = "1"
ctx.run(
tools.mypy(*PY_SRC_LIST, config_file="config/mypy.ini"),
title=_pyprefix("Type-checking"),
)
@duty(nofail=PY_VERSION == PY_DEV)
def check_api(ctx: Context, *cli_args: str) -> None:
"""Check for API breaking changes.
```bash
make check-api
```
Compare the current code to the latest version (Git tag)
using [Griffe](https://mkdocstrings.github.io/griffe/),
to search for API breaking changes since latest version.
It is set to allow failures, and is more about providing information
than preventing CI to pass.
Parameters:
*cli_args: Additional Griffe CLI arguments.
"""
ctx.run(
tools.griffe.check(
"griffe",
search=["src"],
color=True,
# YORE: Bump 2: Remove line.
extensions=["scripts/griffe_exts.py"],
).add_args(*cli_args),
title="Checking for API breaking changes",
nofail=True,
)
@duty
def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000) -> None:
"""Serve the documentation (localhost:8000).
```bash
make docs
```
This task uses [MkDocs](https://www.mkdocs.org/) to serve the documentation locally.
Parameters:
*cli_args: Additional MkDocs CLI arguments.
host: The host to serve the docs from.
port: The port to serve the docs on.
"""
with _material_insiders():
ctx.run(
tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
title="Serving documentation",
capture=False,
)
@duty
def docs_deploy(ctx: Context, *, force: bool = False) -> None:
"""Deploy the documentation to GitHub pages.
```bash
make docs-deploy
```
Use [MkDocs](https://www.mkdocs.org/) to build and deploy the documentation to GitHub pages.
Parameters:
force: Whether to force deployment, even from non-Insiders version.
"""
os.environ["DEPLOY"] = "true"
with _material_insiders() as insiders:
if not insiders:
ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
origin = ctx.run("git config --get remote.origin.url", silent=True, allow_overrides=False)
if "pawamoy-insiders/griffe" in origin:
ctx.run(
"git remote add upstream git@github.com:mkdocstrings/griffe",
silent=True,
nofail=True,
allow_overrides=False,
)
ctx.run(
tools.mkdocs.gh_deploy(remote_name="upstream", force=True),
title="Deploying documentation",
)
elif force:
ctx.run(
tools.mkdocs.gh_deploy(force=True),
title="Deploying documentation",
)
else:
ctx.run(
lambda: False,
title="Not deploying docs from public repository (do that from insiders instead!)",
nofail=True,
)
@duty
def format(ctx: Context) -> None:
"""Run formatting tools on the code.
```bash
make format
```
Format the code with [Ruff](https://astral.sh/ruff).
This command will also automatically fix some coding issues when possible.
"""
ctx.run(
tools.ruff.check(*PY_SRC_LIST, config="config/ruff.toml", fix_only=True, exit_zero=True),
title="Auto-fixing code",
)
ctx.run(tools.ruff.format(*PY_SRC_LIST, config="config/ruff.toml"), title="Formatting code")
@duty
def build(ctx: Context) -> None:
"""Build source and wheel distributions.
```bash
make build
```
Build distributions of your project for the current version.
The build task uses the [`build` tool](https://build.pypa.io/en/stable/)
to build `.tar.gz` (Gzipped sources archive) and `.whl` (wheel) distributions
of your project in the `dist` directory.
"""
ctx.run(
tools.build(),
title="Building source and wheel distributions",
pty=PTY,
)
@duty
@_not_from_insiders
def publish(ctx: Context) -> None:
"""Publish source and wheel distributions to PyPI.
```bash
make publish
```
Publish the source and wheel distributions of your project to PyPI
using [Twine](https://twine.readthedocs.io/).
"""
if not Path("dist").exists():
ctx.run("false", title="No distribution files found")
dists = [str(dist) for dist in Path("dist").iterdir()]
ctx.run(
tools.twine.upload(*dists, skip_existing=True),
title="Publishing source and wheel distributions to PyPI",
pty=PTY,
)
@duty(post=["build", "publish", "docs-deploy"])
@_not_from_insiders
def release(ctx: Context, version: str = "") -> None:
"""Release a new version of the project.
```bash
make release [version=VERSION]
```
This task will:
- Stage changes to `pyproject.toml` and `CHANGELOG.md`
- Commit the changes with a message like `chore: Prepare release 1.0.0`
- Tag the commit with the new version number
- Push the commit and the tag to the remote repository
- Build source and wheel distributions
- Publish the distributions to PyPI
- Deploy the documentation to GitHub pages
Parameters:
version: The new version number to use. If not provided, you will be prompted for it.
"""
if not (version := (version or input("> Version to release: ")).strip()):
ctx.run("false", title="A version must be provided")
ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY)
ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY)
ctx.run(f"git tag {version}", title="Tagging commit", pty=PTY)
ctx.run("git push", title="Pushing commits", pty=False)
ctx.run("git push --tags", title="Pushing tags", pty=False)
@duty(silent=True, aliases=["cov"])
def coverage(ctx: Context) -> None:
"""Report coverage as text and HTML.
```bash
make coverage
```
Combine coverage data from multiple test runs with [Coverage.py](https://coverage.readthedocs.io/),
then generate an HTML report into the `htmlcov` directory,
and print a text report in the console.
"""
ctx.run(tools.coverage.combine(), nofail=True)
ctx.run(tools.coverage.report(rcfile="config/coverage.ini"), capture=False)
ctx.run(tools.coverage.html(rcfile="config/coverage.ini"))
@duty(nofail=PY_VERSION == PY_DEV)
def test(ctx: Context, *cli_args: str, match: str = "") -> None: # noqa: PT028
"""Run the test suite.
```bash
make test [match=EXPR]
```
Run the test suite with [Pytest](https://docs.pytest.org/) and plugins.
Code source coverage is computed thanks to
[coveragepy](https://coverage.readthedocs.io/en/coverage-5.1/).
Parameters:
*cli_args: Additional Pytest CLI arguments.
match: A pytest expression to filter selected tests.
"""
os.environ["COVERAGE_FILE"] = f".coverage.{PY_VERSION}"
ctx.run(
tools.pytest(
"tests",
config_file="config/pytest.ini",
select=match,
color="yes",
).add_args("-n", "auto", *cli_args),
title=_pyprefix("Running tests"),
)
class _Seeds(list):
def __init__(self, cli_value: str = "") -> None:
if cli_value:
self.extend(int(seed) for seed in cli_value.split(","))
@duty
def fuzz(
ctx: Context,
*,
size: int = 20,
min_seed: int = 0,
max_seed: int = 1_000_000,
seeds: _Seeds = _Seeds(), # noqa: B008
) -> None:
"""Fuzz Griffe against generated Python code.
Parameters:
ctx: The context instance (passed automatically).
size: The size of the case set (number of cases to test).
seeds: Seeds to test or exclude (comma-separated integers).
min_seed: Minimum value for the seeds range.
max_seed: Maximum value for the seeds range.
"""
warnings.simplefilter("ignore", SyntaxWarning)
def fails(code: str, filepath: Path) -> bool:
try:
visit(filepath.stem, filepath=filepath, code=code)
except Exception: # noqa: BLE001
return True
return False
def test_seed(seed: int, revisit: bool = False) -> bool: # noqa: FBT001,FBT002
filepath = Path(gettempdir(), f"fuzz_{seed}_{sys.version_info.minor}.py")
if filepath.exists():
if revisit:
code = filepath.read_text()
else:
return True
else:
code = generate(seed)
filepath.write_text(code)
if fails(code, filepath):
new_code = minimize(code, partial(fails, filepath=filepath))
if code != new_code:
filepath.write_text(new_code)
return False
return True
revisit = bool(seeds)
seeds = seeds or sample(range(min_seed, max_seed + 1), size) # type: ignore[assignment]
for seed in seeds:
ctx.run(test_seed, args=[seed, revisit], title=f"Visiting code generated with seed {seed}")
|