Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to switch pre-build on/off #272

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add ability to switch pre-build on/off #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e895a02
Add ability to switch pre-build on/off
stefanv Mar 19, 2025
27df5d9
Add test for --no-build
stefanv Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 83 additions & 60 deletions spin/cmds/meson.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,13 @@ def _check_coverage_tool_installation(coverage_type: GcovReportFormat, build_dir
else:
DEFAULT_PREFIX = "/usr"


build_option = click.option(
"--build/--no-build",
default=True,
help="Whether to build or not before executing commands",
)

build_dir_option = click.option(
"-C",
"--build-dir",
Expand Down Expand Up @@ -447,6 +454,7 @@ def _get_configured_command(command_name):
default="html",
help=f"Format of the gcov report. Can be one of {', '.join(e.value for e in GcovReportFormat)}.",
)
@build_option
@build_dir_option
@click.pass_context
def test(
Expand All @@ -459,6 +467,7 @@ def test(
coverage=False,
gcov=None,
gcov_format=None,
build=None,
build_dir=None,
):
"""🔧 Run tests
Expand Down Expand Up @@ -541,15 +550,16 @@ def test(
)
raise SystemExit(1)

build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to running tests:", bold=True, fg="bright_green"
)
if gcov is not None:
ctx.invoke(build_cmd, build_dir=build_dir, gcov=bool(gcov))
else:
ctx.invoke(build_cmd, build_dir=build_dir)
if build:
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to running tests:", bold=True, fg="bright_green"
)
if gcov is not None:
ctx.invoke(build_cmd, build_dir=build_dir, gcov=bool(gcov))
else:
ctx.invoke(build_cmd, build_dir=build_dir)

site_path = _set_pythonpath(build_dir)

Expand Down Expand Up @@ -647,9 +657,10 @@ def test(
"--code", "-c", metavar="CODE", help="Python program passed in as a string"
)
@click.argument("gdb_args", nargs=-1)
@build_option
@build_dir_option
@click.pass_context
def gdb(ctx, *, code, gdb_args, build_dir):
def gdb(ctx, *, code, gdb_args, build=None, build_dir=None):
"""👾 Execute code through GDB

spin gdb -c 'import numpy as np; print(np.__version__)'
Expand All @@ -670,12 +681,13 @@ def gdb(ctx, *, code, gdb_args, build_dir):
spin gdb my_tests.py
spin gdb -- my_tests.py --mytest-flag
"""
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking gdb:", bold=True, fg="bright_green"
)
ctx.invoke(build_cmd, build_dir=build_dir)
if build:
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking gdb:", bold=True, fg="bright_green"
)
ctx.invoke(build_cmd, build_dir=build_dir)

_set_pythonpath(build_dir)
gdb_args = list(gdb_args)
Expand All @@ -700,21 +712,25 @@ def gdb(ctx, *, code, gdb_args, build_dir):

@click.command()
@click.argument("ipython_args", nargs=-1)
@build_option
@build_dir_option
@click.pass_context
def ipython(ctx, *, ipython_args, build_dir, pre_import=""):
def ipython(ctx, *, ipython_args, build=None, build_dir=None, pre_import=""):
"""💻 Launch IPython shell with PYTHONPATH set

IPYTHON_ARGS are passed through directly to IPython, e.g.:

spin ipython -- -i myscript.py
"""
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to launching ipython:", bold=True, fg="bright_green"
)
ctx.invoke(build_cmd, build_dir=build_dir)
if build:
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to launching ipython:",
bold=True,
fg="bright_green",
)
ctx.invoke(build_cmd, build_dir=build_dir)

p = _set_pythonpath(build_dir)
if p:
Expand All @@ -726,9 +742,10 @@ def ipython(ctx, *, ipython_args, build_dir, pre_import=""):

@click.command()
@click.argument("shell_args", nargs=-1)
@build_option
@build_dir_option
@click.pass_context
def shell(ctx, shell_args=[], build_dir=None):
def shell(ctx, shell_args=[], build=None, build_dir=None):
"""💻 Launch shell with PYTHONPATH set

SHELL_ARGS are passed through directly to the shell, e.g.:
Expand All @@ -738,12 +755,15 @@ def shell(ctx, shell_args=[], build_dir=None):
Ensure that your shell init file (e.g., ~/.zshrc) does not override
the PYTHONPATH.
"""
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking shell:", bold=True, fg="bright_green"
)
ctx.invoke(build_cmd, build_dir=build_dir)
if build:
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking shell:",
bold=True,
fg="bright_green",
)
ctx.invoke(build_cmd, build_dir=build_dir)

p = _set_pythonpath(build_dir)
if p:
Expand All @@ -758,21 +778,25 @@ def shell(ctx, shell_args=[], build_dir=None):

@click.command()
@click.argument("python_args", nargs=-1)
@build_option
@build_dir_option
@click.pass_context
def python(ctx, *, python_args, build_dir):
def python(ctx, *, python_args, build=None, build_dir=None):
"""🐍 Launch Python shell with PYTHONPATH set

PYTHON_ARGS are passed through directly to Python, e.g.:

spin python -- -c 'import sys; print(sys.path)'
"""
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking Python:", bold=True, fg="bright_green"
)
ctx.invoke(build_cmd, build_dir=build_dir)
if build:
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking Python:",
bold=True,
fg="bright_green",
)
ctx.invoke(build_cmd, build_dir=build_dir)

p = _set_pythonpath(build_dir)
if p:
Expand All @@ -799,10 +823,11 @@ def python(ctx, *, python_args, build_dir):


@click.command(context_settings={"ignore_unknown_options": True})
@build_option
@build_dir_option
@click.argument("args", nargs=-1)
@click.pass_context
def run(ctx, *, args, build_dir=None):
def run(ctx, *, args, build=None, build_dir=None):
"""🏁 Run a shell command with PYTHONPATH set

\b
Expand All @@ -821,12 +846,13 @@ def run(ctx, *, args, build_dir=None):
if not len(args) > 0:
raise RuntimeError("No command given")

build_cmd = _get_configured_command("build")
if build_cmd:
# Redirect spin generated output
with contextlib.redirect_stdout(sys.stderr):
# Also ask build to be quiet
ctx.invoke(build_cmd, build_dir=build_dir, quiet=True)
if build:
build_cmd = _get_configured_command("build")
if build_cmd:
# Redirect spin generated output
with contextlib.redirect_stdout(sys.stderr):
# Also ask build to be quiet
ctx.invoke(build_cmd, build_dir=build_dir, quiet=True)

is_posix = sys.platform in ("linux", "darwin")
shell = len(args) == 1
Expand Down Expand Up @@ -882,12 +908,6 @@ def attach_sigint():
default=False,
help="Clean previously built docs before building",
)
@click.option(
"--build/--no-build",
"first_build",
default=True,
help="Build project before generating docs",
)
@click.option(
"--plot/--no-plot",
"sphinx_gallery_plot",
Expand All @@ -901,17 +921,18 @@ def attach_sigint():
metavar="N_JOBS",
help="Number of parallel build jobs",
)
@build_option
@build_dir_option
@click.pass_context
def docs(
ctx,
*,
sphinx_target,
clean,
first_build,
jobs,
sphinx_gallery_plot,
clean_dirs=None,
build=None,
build_dir=None,
):
"""📖 Build Sphinx documentation
Expand Down Expand Up @@ -941,7 +962,7 @@ def docs(

if sphinx_target in ("targets", "help"):
clean = False
first_build = False
build = False
sphinx_target = "help"

if clean:
Expand All @@ -963,7 +984,7 @@ def docs(

build_cmd = _get_configured_command("build")

if build_cmd and first_build:
if build_cmd and build:
click.secho(
"Invoking `build` prior to building docs:", bold=True, fg="bright_green"
)
Expand Down Expand Up @@ -1007,9 +1028,10 @@ def docs(
"--code", "-c", metavar="CODE", help="Python program passed in as a string"
)
@click.argument("lldb_args", nargs=-1)
@build_option
@build_dir_option
@click.pass_context
def lldb(ctx, *, code, lldb_args, build_dir=None):
def lldb(ctx, *, code, lldb_args, build=None, build_dir=None):
"""👾 Execute code through LLDB

spin lldb -c 'import numpy as np; print(np.__version__)'
Expand All @@ -1032,12 +1054,13 @@ def lldb(ctx, *, code, lldb_args, build_dir=None):
spin lldb -- --arch x86_64 -- my_tests.py
spin lldb -c 'import numpy as np; print(np.__version__)' -- --arch x86_64
"""
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking lldb:", bold=True, fg="bright_green"
)
ctx.invoke(build_cmd, build_dir=build_dir)
if build:
build_cmd = _get_configured_command("build")
if build_cmd:
click.secho(
"Invoking `build` prior to invoking lldb:", bold=True, fg="bright_green"
)
ctx.invoke(build_cmd, build_dir=build_dir)

_set_pythonpath(build_dir)
lldb_args = list(lldb_args)
Expand Down
10 changes: 10 additions & 0 deletions spin/tests/test_build_cmds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
skip_unless_linux,
skip_unless_macos,
spin,
stderr,
stdout,
)

Expand Down Expand Up @@ -90,6 +91,15 @@ def test_run_stdout(example_pkg):
), f"`spin run` stdout did not yield version, but {stdout(p)}"


def test_run_no_build(example_pkg):
"""Does spin run ... --no-build correctly avoid building."""
output = stderr(spin("run", "echo $PYTHONPATH"))
assert "meson compile" in output

output = stderr(spin("run", "--no-build", "echo $PYTHONPATH"))
assert "meson compile" not in output


# Detecting whether a file is executable is not that easy on Windows,
# as it seems to take into consideration whether that file is associated as an executable.
@skip_on_windows
Expand Down
Loading