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
|
"""
This is a very small 'tox' plugin.
'toxfile.py' is a special name for auto-loading a plugin without defining package
metadata.
For full doc, see: https://tox.wiki/en/latest/plugins.html
Methods decorated below with `tox.plugin.impl` are hook implementations.
We only implement hooks which we need.
"""
from __future__ import annotations
import logging
import pathlib
import shutil
import typing as t
from tox.plugin import impl
if t.TYPE_CHECKING:
from tox.config.sets import EnvConfigSet
from tox.session.state import State
from tox.tox_env.api import ToxEnv
log = logging.getLogger(__name__)
REPO_ROOT = pathlib.Path(__file__).parent
BUILD_DIR = REPO_ROOT / "build"
@impl
def tox_on_install(
tox_env: ToxEnv, arguments: t.Any, section: str, of_type: str
) -> None:
# when setting up the wheel build, clear the 'build/' directory if present
if tox_env.name != "build_wheel":
return
if BUILD_DIR.exists():
shutil.rmtree(BUILD_DIR)
@impl
def tox_add_env_config(env_conf: EnvConfigSet, state: State) -> None:
env_conf.add_config(
keys=["globus_sdk_rmtree"],
of_type=list[str],
default=[],
desc="A dir tree to remove before running the environment commands",
)
@impl
def tox_before_run_commands(tox_env: ToxEnv) -> None:
sdk_rmtree = tox_env.conf.load("globus_sdk_rmtree")
for name in sdk_rmtree:
path = pathlib.Path(name)
if path.exists():
log.warning(f"globus_sdk_rmtree: {path}")
shutil.rmtree(path)
|