spin 0.9__tar.gz → 0.10__tar.gz

{spin-0.9/spin.egg-info → spin-0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spin
-Version: 0.9
+Version: 0.10
 Summary: Developer tool for scientific Python libraries
 Maintainer-email: Scientific Python <spin@discuss.scientific-python.org>
 License: BSD 3-Clause License
@@ -120,7 +120,7 @@ These commands will then be rendered as:
 
 ```
 Build:
-  build  🔧 Build package with Meson/ninja and install
+  build  🔧 Build package with Meson/ninja
   test   🔧 Run tests
 
 Environments:
@@ -147,7 +147,7 @@ python -m spin
 Available as `spin.cmds.meson.*`.
 
 ```
-  build    🔧 Build package with Meson/ninja and install to `build-install`
+  build    🔧 Build package with Meson/ninja
   ipython  💻 Launch IPython shell with PYTHONPATH set
   python   🐍 Launch Python shell with PYTHONPATH set
   shell    💻 Launch shell with PYTHONPATH set
@@ -171,9 +171,6 @@ Available as `spin.cmds.build.*`:
 `pip` allows for editable installs, another common
 development workflow.
 
-Note that, for now, the meson commands above do not work with an
-editable install of the package. We're [working on changing that](https://github.com/scientific-python/spin/pull/141).
-
 Available as `spin.cmds.pip.*`:
 
 ```

{spin-0.9 → spin-0.10}/README.md

@@ -59,7 +59,7 @@ These commands will then be rendered as:
 
 ```
 Build:
-  build  🔧 Build package with Meson/ninja and install
+  build  🔧 Build package with Meson/ninja
   test   🔧 Run tests
 
 Environments:
@@ -86,7 +86,7 @@ python -m spin
 Available as `spin.cmds.meson.*`.
 
 ```
-  build    🔧 Build package with Meson/ninja and install to `build-install`
+  build    🔧 Build package with Meson/ninja
   ipython  💻 Launch IPython shell with PYTHONPATH set
   python   🐍 Launch Python shell with PYTHONPATH set
   shell    💻 Launch shell with PYTHONPATH set
@@ -110,9 +110,6 @@ Available as `spin.cmds.build.*`:
 `pip` allows for editable installs, another common
 development workflow.
 
-Note that, for now, the meson commands above do not work with an
-editable install of the package. We're [working on changing that](https://github.com/scientific-python/spin/pull/141).
-
 Available as `spin.cmds.pip.*`:
 
 ```

{spin-0.9 → spin-0.10}/pyproject.toml

@@ -54,6 +54,8 @@ filterwarnings = [
 [tool.ruff]
 line-length = 88
 target-version = "py38"
+
+[tool.ruff.lint]
 select = [
     "C",
     "E",

{spin-0.9 → spin-0.10}/spin/__init__.py

@@ -6,7 +6,7 @@ For usage information see `python -m spin`.
 Read more at https://github.com/scientific-python/spin
 """
 
-__version__ = "0.9"
+__version__ = "0.10"
 
 from .cmds import util
 

{spin-0.9 → spin-0.10}/spin/__main__.py

@@ -3,6 +3,8 @@ import importlib
 import importlib.util
 import os
 import sys
+import textwrap
+import traceback
 
 import click
 
@@ -152,8 +154,25 @@ def main():
 
     try:
         group()
-    except Exception as e:
-        print(f"Error: {e}; aborting.", file=sys.stderr)
+    except Exception:
+        click.secho("\n" + traceback.format_exc(limit=-3), fg="red", file=sys.stderr)
+        click.secho(
+            textwrap.dedent(
+                f"""\
+        An internal error has occurred. Please file a bug report at
+
+          https://github.com/scientific-python/spin
+
+        including the above traceback and the following information:
+
+          spin: {__version__}, package: {proj_name}
+
+        Aborting."""
+            ),
+            fg="red",
+            bold=True,
+            file=sys.stderr,
+        )
         sys.exit(1)
 
 

{spin-0.9 → spin-0.10}/spin/cmds/meson.py

@@ -45,7 +45,9 @@ def _editable_install_path(distname):
     except importlib_metadata.PackageNotFoundError:
         return None
 
-    if getattr(dist.origin.dir_info, "editable", False):
+    if hasattr(dist.origin, "dir_info") and getattr(
+        dist.origin.dir_info, "editable", False
+    ):
         if sys.platform == "win32":
             return dist.origin.url.removeprefix("file:///")
         else:
@@ -213,9 +215,9 @@ def _check_coverage_tool_installation(coverage_type: GcovReportFormat):
 
     # Verify the tools are installed prior to the build
     p = _run(["ninja", "-C", build_dir, "-t", "targets", "all"], output=False)
-    if f"coverage-{coverage_type.value}" not in p.stdout.decode("ascii"):
+    if f"coverage-{coverage_type}" not in p.stdout.decode("ascii"):
         raise click.ClickException(
-            f"coverage-{coverage_type.value} is not supported... "
+            f"coverage-{coverage_type} is not supported... "
             f"Ensure the following are installed: {', '.join(requirements[coverage_type])} "
             "and rerun `spin test --gcov`"
         )
@@ -233,15 +235,17 @@ def _check_coverage_tool_installation(coverage_type: GcovReportFormat):
     help="Enable C code coverage using `gcov`. Use `spin test --gcov` to generate reports.",
 )
 @click.argument("meson_args", nargs=-1)
-def build(meson_args, jobs=None, clean=False, verbose=False, gcov=False, quiet=False):
-    """🔧 Build package with Meson/ninja and install
+def build(
+    *, meson_args, jobs=None, clean=False, verbose=False, gcov=False, quiet=False
+):
+    """🔧 Build package with Meson/ninja
+
+    The package is installed to `build-install`.
 
     MESON_ARGS are passed through e.g.:
 
       spin build -- -Dpkg_config_path=/lib64/pkgconfig
 
-    The package is installed to build-install
-
     By default meson-python does release builds. To be able to use a debugger,
     tell meson to build in debug mode:
 
@@ -361,13 +365,14 @@ Which tests to run. Can be a module, function, class, or method:
 )
 @click.option(
     "--gcov-format",
-    type=click.Choice(GcovReportFormat),
+    type=click.Choice([e.name for e in GcovReportFormat]),
     default="html",
     help=f"Format of the gcov report. Can be one of {', '.join(e.value for e in GcovReportFormat)}.",
 )
 @click.pass_context
 def test(
     ctx,
+    *,
     pytest_args,
     n_jobs,
     tests,
@@ -433,16 +438,20 @@ def test(
         click.secho(
             "Invoking `build` prior to running tests:", bold=True, fg="bright_green"
         )
-        ctx.invoke(build_cmd, gcov=bool(gcov))
+        if gcov is not None:
+            ctx.invoke(build_cmd, gcov=bool(gcov))
+        else:
+            ctx.invoke(build_cmd)
 
     package = cfg.get("tool.spin.package", None)
+    if package is None:
+        print(
+            "Please specify `package = packagename` under `tool.spin` section of `pyproject.toml`"
+        )
+        raise SystemExit(1)
+
     if (not pytest_args) and (not tests):
-        pytest_args = (package,)
-        if pytest_args == (None,):
-            print(
-                "Please specify `package = packagename` under `tool.spin` section of `pyproject.toml`"
-            )
-            sys.exit(1)
+        tests = package
 
     site_path = _set_pythonpath()
     if site_path:
@@ -491,12 +500,9 @@ def test(
     else:
         cmd = ["pytest"]
 
-    cwd = os.getcwd()
     pytest_p = _run(
-        cmd + ([f"--rootdir={site_path}"] if site_path else []) + list(pytest_args),
-        cwd=site_path,
+        cmd + list(pytest_args),
     )
-    os.chdir(cwd)
 
     if gcov:
         # Verify the tools are present
@@ -509,7 +515,7 @@ def test(
 
         # Generate report
         click.secho(
-            f"Generating {gcov_format.value} coverage report...",
+            f"Generating {gcov_format} coverage report...",
             bold=True,
             fg="bright_yellow",
         )
@@ -518,7 +524,7 @@ def test(
                 "ninja",
                 "-C",
                 build_dir,
-                f"coverage-{gcov_format.value.lower()}",
+                f"coverage-{gcov_format.lower()}",
             ],
             output=False,
         )
@@ -540,7 +546,7 @@ def test(
 @click.option("--code", "-c", help="Python program passed in as a string")
 @click.argument("gdb_args", nargs=-1)
 @click.pass_context
-def gdb(ctx, code, gdb_args):
+def gdb(ctx, *, code, gdb_args):
     """👾 Execute code through GDB
 
       spin gdb -c 'import numpy as np; print(np.__version__)'
@@ -592,7 +598,7 @@ def gdb(ctx, code, gdb_args):
 @click.command()
 @click.argument("ipython_args", nargs=-1)
 @click.pass_context
-def ipython(ctx, ipython_args):
+def ipython(ctx, *, ipython_args):
     """💻 Launch IPython shell with PYTHONPATH set
 
     IPYTHON_ARGS are passed through directly to IPython, e.g.:
@@ -646,7 +652,7 @@ def shell(ctx, shell_args=[]):
 @click.command()
 @click.argument("python_args", nargs=-1)
 @click.pass_context
-def python(ctx, python_args):
+def python(ctx, *, python_args):
     """🐍 Launch Python shell with PYTHONPATH set
 
     PYTHON_ARGS are passed through directly to Python, e.g.:
@@ -687,7 +693,7 @@ def python(ctx, python_args):
 @click.command(context_settings={"ignore_unknown_options": True})
 @click.argument("args", nargs=-1)
 @click.pass_context
-def run(ctx, args):
+def run(ctx, *, args):
     """🏁 Run a shell command with PYTHONPATH set
 
     \b
@@ -761,7 +767,16 @@ def run(ctx, args):
 )
 @click.option("--jobs", "-j", default="auto", help="Number of parallel build jobs")
 @click.pass_context
-def docs(ctx, sphinx_target, clean, first_build, jobs, sphinx_gallery_plot):
+def docs(
+    ctx,
+    *,
+    sphinx_target,
+    clean,
+    first_build,
+    jobs,
+    sphinx_gallery_plot,
+    clean_dirs=None,
+):
     """📖 Build Sphinx documentation
 
     By default, SPHINXOPTS="-W", raising errors on warnings.
@@ -793,13 +808,18 @@ def docs(ctx, sphinx_target, clean, first_build, jobs, sphinx_gallery_plot):
         sphinx_target = "help"
 
     if clean:
-        doc_dirs = [
-            f"./{doc_dir}/build/",
-            f"./{doc_dir}/source/api/",
-            f"./{doc_dir}/source/auto_examples/",
-            f"./{doc_dir}/source/jupyterlite_contents/",
-        ]
-        for target_dir in doc_dirs:
+        if clean_dirs is None:
+            clean_dirs = []
+            for prefix in ("", "_"):
+                clean_dirs += [
+                    f"./{doc_dir}/{prefix}build/",
+                    f"./{doc_dir}/{prefix}build/",
+                    f"./{doc_dir}/{prefix}source/api/",
+                    f"./{doc_dir}/{prefix}source/auto_examples/",
+                    f"./{doc_dir}/{prefix}source/jupyterlite_contents/",
+                ]
+
+        for target_dir in clean_dirs:
             if os.path.isdir(target_dir):
                 print(f"Removing {target_dir!r}")
                 shutil.rmtree(target_dir)
@@ -844,7 +864,7 @@ def docs(ctx, sphinx_target, clean, first_build, jobs, sphinx_gallery_plot):
 @click.option("--code", "-c", help="Python program passed in as a string")
 @click.argument("lldb_args", nargs=-1)
 @click.pass_context
-def lldb(ctx, code, lldb_args):
+def lldb(ctx, *, code, lldb_args):
     """👾 Execute code through LLDB
 
       spin lldb -c 'import numpy as np; print(np.__version__)'

{spin-0.9 → spin-0.10}/spin/cmds/pip.py

@@ -5,20 +5,19 @@ from .util import run as _run
 
 @click.command()
 @click.option(
-    "-v",
-    "--verbose",
-    is_flag=True,
-    default=False,
-    help="Print detailed build and installation output",
+    "--editable/--no-editable",
+    default=True,
+    help="Install in editable mode.",
 )
+@click.option("-v", "--verbose", is_flag=True, help="Print detailed build output.")
 @click.option(
-    "--editable/--no-editable",
+    "--verbose-import/--no-verbose-import",
     is_flag=True,
     default=True,
-    help="Install in editable mode",
+    help="Meson only: importing an editable install may trigger a build. This flag determines whether to print that build's output.",
 )
 @click.argument("pip_args", nargs=-1)
-def install(pip_args, verbose, editable):
+def install(*, pip_args, editable, verbose, verbose_import):
     """💽 Build and install package using pip.
 
     By default, the package is installed in editable mode.
@@ -34,9 +33,14 @@ def install(pip_args, verbose, editable):
     pip_args = list(pip_args)
     pip_cmd = ["pip", "install"]
     pip_args += ["--no-build-isolation"]
+
     if editable:
         pip_args += ["--editable"]
 
-    pip_args = (["-v"] if verbose else []) + pip_args
+        if verbose_import:
+            pip_args = ["--config-settings=editable-verbose=true"] + pip_args
+
+    if verbose:
+        pip_args = ["-v"] + pip_args
 
     _run(pip_cmd + pip_args + ["."], sys_exit=False, replace=True)

{spin-0.9 → spin-0.10}/spin/cmds/util.py

@@ -2,13 +2,21 @@ import os
 import shlex
 import subprocess
 import sys
+from typing import Optional
 
 import click
 
 
 def run(
-    cmd, cwd=None, replace=False, sys_exit=True, output=True, echo=True, *args, **kwargs
-):
+    cmd: list[str],
+    cwd: Optional[str] = None,  # in 3.10 and up: str | None
+    replace: bool = False,
+    sys_exit: bool = True,
+    output: bool = True,
+    echo: bool = True,
+    *args,
+    **kwargs,
+) -> subprocess.CompletedProcess:
     """Run a shell command.
 
     Parameters

{spin-0.9 → spin-0.10}/spin/tests/test_build_cmds.py

@@ -5,7 +5,7 @@ import tempfile
 from pathlib import Path
 
 import pytest
-from testutil import skip_on_windows, skip_unless_linux, spin, stdout
+from testutil import skip_on_windows, skip_unless_linux, skip_unless_macos, spin, stdout
 
 from spin.cmds.util import run
 
@@ -143,3 +143,17 @@ def test_gdb():
         "--batch",
     )
     assert "hi" in stdout(p)
+
+
+@skip_unless_macos
+def test_lldb():
+    p = spin(
+        "lldb",
+        "-c",
+        'import example_pkg; example_pkg.echo("hi")',
+        "--",
+        "-o",
+        "run",
+        "--batch",
+    )
+    assert "hi" in stdout(p)

{spin-0.9 → spin-0.10}/spin/tests/testutil.py

@@ -13,6 +13,10 @@ skip_unless_linux = pytest.mark.skipif(
     not sys.platform.startswith("linux"), reason="Skipped; platform not Linux"
 )
 
+skip_unless_macos = pytest.mark.skipif(
+    not sys.platform.startswith("darwin"), reason="Skipped; platform not macOS"
+)
+
 
 def spin(*args, **user_kwargs):
     args = (str(el) for el in args)

{spin-0.9 → spin-0.10/spin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spin
-Version: 0.9
+Version: 0.10
 Summary: Developer tool for scientific Python libraries
 Maintainer-email: Scientific Python <spin@discuss.scientific-python.org>
 License: BSD 3-Clause License
@@ -120,7 +120,7 @@ These commands will then be rendered as:
 
 ```
 Build:
-  build  🔧 Build package with Meson/ninja and install
+  build  🔧 Build package with Meson/ninja
   test   🔧 Run tests
 
 Environments:
@@ -147,7 +147,7 @@ python -m spin
 Available as `spin.cmds.meson.*`.
 
 ```
-  build    🔧 Build package with Meson/ninja and install to `build-install`
+  build    🔧 Build package with Meson/ninja
   ipython  💻 Launch IPython shell with PYTHONPATH set
   python   🐍 Launch Python shell with PYTHONPATH set
   shell    💻 Launch shell with PYTHONPATH set
@@ -171,9 +171,6 @@ Available as `spin.cmds.build.*`:
 `pip` allows for editable installs, another common
 development workflow.
 
-Note that, for now, the meson commands above do not work with an
-editable install of the package. We're [working on changing that](https://github.com/scientific-python/spin/pull/141).
-
 Available as `spin.cmds.pip.*`:
 
 ```