spin 0.14__tar.gz → 0.16__tar.gz

{spin-0.14/spin.egg-info → spin-0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spin
-Version: 0.14
+Version: 0.16
 Summary: Developer tool for scientific Python libraries
 Maintainer-email: Scientific Python <spin@discuss.scientific-python.org>
 License: BSD 3-Clause License
@@ -41,21 +41,22 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click
+Requires-Dist: click<=8.2,>=8; python_version == "3.10"
+Requires-Dist: click!=8.3.0,<8.4,>=8
 Requires-Dist: tomli; python_version < "3.11"
 Requires-Dist: colorama; platform_system == "Windows"
 Requires-Dist: importlib_metadata>=7
 Provides-Extra: lint
-Requires-Dist: pre-commit==4.2.0; extra == "lint"
+Requires-Dist: pre-commit==4.3.0; extra == "lint"
 Provides-Extra: dev
 Requires-Dist: changelist==0.5; extra == "dev"
 Dynamic: license-file
@@ -188,6 +189,7 @@ Available as `spin.cmds.build.*`:
 
 ```
 sdist      📦 Build a source distribution in `dist/`
+wheel      📦 Build a wheel distribution in `dist/`
 ```
 
 ### [pip](https://pip.pypa.io) (Package Installer for Python)
@@ -358,6 +360,9 @@ nox -s test -- -v
 nox -s test -- -v spin/tests/test_meson.py
 ```
 
+`spin` takes a slightly more conservative approach than [SPEC 0](https://scientific-python.org/specs/spec-0000/), and
+supports all non-EOL versions of Python.
+
 ## History
 
 The `dev.py` tool was [proposed for SciPy](https://github.com/scipy/scipy/issues/15489) by Ralf Gommers and [implemented](https://github.com/scipy/scipy/pull/15959) by Sayantika Banik, Eduardo Naufel Schettino, and Ralf Gommers (also see [Sayantika's blog post](https://labs.quansight.org/blog/the-evolution-of-the-scipy-developer-cli)).

{spin-0.14 → spin-0.16}/README.md

@@ -126,6 +126,7 @@ Available as `spin.cmds.build.*`:
 
 ```
 sdist      📦 Build a source distribution in `dist/`
+wheel      📦 Build a wheel distribution in `dist/`
 ```
 
 ### [pip](https://pip.pypa.io) (Package Installer for Python)
@@ -296,6 +297,9 @@ nox -s test -- -v
 nox -s test -- -v spin/tests/test_meson.py
 ```
 
+`spin` takes a slightly more conservative approach than [SPEC 0](https://scientific-python.org/specs/spec-0000/), and
+supports all non-EOL versions of Python.
+
 ## History
 
 The `dev.py` tool was [proposed for SciPy](https://github.com/scipy/scipy/issues/15489) by Ralf Gommers and [implemented](https://github.com/scipy/scipy/pull/15959) by Sayantika Banik, Eduardo Naufel Schettino, and Ralf Gommers (also see [Sayantika's blog post](https://labs.quansight.org/blog/the-evolution-of-the-scipy-developer-cli)).

{spin-0.14 → spin-0.16}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "spin"
-requires-python = ">=3.9"
+requires-python = ">=3.10"  # Oldest non-EOL Python here
 description = "Developer tool for scientific Python libraries"
 readme = "README.md"
 license = {file = "LICENSE"}
@@ -15,15 +15,16 @@ classifiers = [
   "License :: OSI Approved :: BSD License",
   "Operating System :: OS Independent",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: 3 :: Only",
 ]
 dependencies = [
-  "click",
+  "click>=8,<=8.2; python_version == '3.10'",  # cannot deepcopy cmd params (specifically, Sentinel.UNSET) on 3.10
+  "click>=8,!=8.3.0,<8.4",
   "tomli; python_version < '3.11'",
   "colorama; platform_system == 'Windows'",
   "importlib_metadata >= 7"
@@ -34,7 +35,7 @@ dynamic = ['version']
 spin = "spin.__main__:main"
 
 [project.optional-dependencies]
-lint = ["pre-commit == 4.2.0"]
+lint = ["pre-commit == 4.3.0"]
 dev = ["changelist == 0.5"]
 
 [project.urls]

{spin-0.14 → spin-0.16}/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.14"
+__version__ = "0.16"
 
 from .cmds import util
 

{spin-0.14 → spin-0.16}/spin/__main__.py

@@ -1,12 +1,11 @@
 import collections
 import importlib
 import importlib.util
-import inspect
 import os
 import pathlib
 import sys
 import textwrap
-from typing import Union
+import traceback
 
 import click
 
@@ -31,7 +30,7 @@ config_filenames = (
 )
 
 
-def _detect_config_dir(path: pathlib.Path) -> Union[pathlib.Path, None]:
+def _detect_config_dir(path: pathlib.Path) -> pathlib.Path | None:
     path = path.resolve()
     files = os.listdir(path)
     if any(f in files for f in config_filenames):
@@ -199,17 +198,16 @@ def main():
 
     try:
         group()
-    except Exception as e:
+    except Exception:
         click.secho(
-            textwrap.dedent(
-                f"""\
-
-            {type(e).__name__}: {e}
-
-            This exception was raised from:
-
-              {inspect.trace()[-1].filename}
+            "\n" + "".join(traceback.format_exception(*sys.exc_info(), limit=-1)),
+            fg="red",
+            bold=True,
+            file=sys.stderr,
+        )
 
+        click.secho(
+            textwrap.dedent(f"""\
             If you suspect this is a bug in `spin`, please file a report at:
 
               https://github.com/scientific-python/spin
@@ -218,9 +216,8 @@ def main():
 
               spin: {__version__}, package: {proj_name}
 
-            Aborting."""
-            ),
-            fg="red",
+            Aborting."""),
+            fg="yellow",
             bold=True,
             file=sys.stderr,
         )

{spin-0.14 → spin-0.16}/spin/cmds/build.py

@@ -13,3 +13,15 @@ def sdist(pyproject_build_args):
       spin sdist -- -x -n
     """
     run(["pyproject-build", ".", "--sdist"] + list(pyproject_build_args))
+
+
+@click.command()
+@click.argument("pyproject-build-args", metavar="", nargs=-1)
+def wheel(pyproject_build_args):
+    """📦 Build a wheel distribution in `dist/`
+
+    Extra arguments are passed to `pyproject-build`, e.g.
+
+      spin wheel -- -x -n
+    """
+    run(["pyproject-build", ".", "--wheel"] + list(pyproject_build_args))

{spin-0.14 → spin-0.16}/spin/cmds/meson.py

@@ -35,7 +35,15 @@ def _meson_cli():
         return [meson_cli]
 
 
-def _editable_install_path(distname):
+def editable_install_path(distname: str) -> str | None:
+    """Return path of the editable install for package `distname`.
+
+    If the package is not an editable install, return None.
+
+    See Also
+    --------
+    is_editable_install
+    """
     import importlib_metadata
 
     try:
@@ -57,16 +65,34 @@ def _editable_install_path(distname):
         return None
 
 
-def _is_editable_install(distname):
-    return _editable_install_path(distname) is not None
+# backward compat
+_editable_install_path = editable_install_path
+
+
+def is_editable_install(distname: str, verify_path: bool = False) -> bool:
+    """Whether or not an editable install of `distname` is present.
+
+    Parameters
+    ----------
+    `distname` : str
+        Name of the package. E.g., ``numpy`` or ``scikit-image``.
+        Not always the same as the module name (``numpy`` and
+        ``skimage`` for the above).
+    """
+    return editable_install_path(distname) is not None
+
+
+# backward compat
+_is_editable_install = is_editable_install
 
 
-def _is_editable_install_of_same_source(distname):
-    editable_path = _editable_install_path(distname)
-    return editable_path and os.path.samefile(_editable_install_path(distname), ".")
+def _is_editable_install_of_same_source(distname: str) -> bool:
+    """Check whether the editable install was made from the current directory."""
+    editable_path = editable_install_path(distname)
+    return (editable_path is not None) and os.path.samefile(editable_path, ".")
 
 
-def _set_pythonpath(build_dir, quiet=False):
+def _set_pythonpath(build_dir: str, quiet: bool = False) -> str:
     """Set first entry of PYTHONPATH to site packages directory.
 
     For editable installs, leave the PYTHONPATH alone.
@@ -78,12 +104,12 @@ def _set_pythonpath(build_dir, quiet=False):
     cfg = get_config()
     distname = cfg.get("project.name", None)
     if distname:
-        if _is_editable_install(distname):
+        if is_editable_install(distname):
             if _is_editable_install_of_same_source(distname):
                 if not (quiet):
                     click.secho(
                         "Editable install of same source directory detected; not setting PYTHONPATH",
-                        fg="bright_red",
+                        fg="yellow",
                     )
                 return ""
             else:
@@ -114,11 +140,11 @@ def _set_pythonpath(build_dir, quiet=False):
     return site_packages
 
 
-def _get_install_dir(build_dir):
+def _get_install_dir(build_dir: str) -> str:
     return f"{build_dir}-install"
 
 
-def _get_site_packages(build_dir):
+def _get_site_packages(build_dir: str) -> str:
     install_dir = _get_install_dir(build_dir)
     try:
         cfg = get_config()
@@ -140,13 +166,12 @@ def _get_site_packages(build_dir):
     site_packages = None
     if any(f"python{X}." in p for p in candidate_paths):
         # We have a system that uses `python3.X/site-packages` or `python3.X/dist-packages`
-        site_packages = [p for p in candidate_paths if f"python{X}.{Y}" in p]
-        if len(site_packages) == 0:
+        site_packages_paths = [p for p in candidate_paths if f"python{X}.{Y}" in p]
+        if len(site_packages_paths) == 0:
             raise FileNotFoundError(
                 f"No site-packages found in {install_dir} for Python {X}.{Y}"
             )
-        else:
-            site_packages = site_packages[0]
+        site_packages = site_packages_paths[0]
     else:
         # A naming scheme that does not encode the Python major/minor version is used, so return
         # whatever site-packages path was found
@@ -165,22 +190,22 @@ def _get_site_packages(build_dir):
     return site_packages
 
 
-def _meson_version():
+def _meson_version() -> str | None:
     try:
         p = _run(_meson_cli() + ["--version"], output=False, echo=False)
         return p.stdout.decode("ascii").strip()
     except:
-        pass
+        return None
 
 
-def _meson_version_configured(build_dir):
+def _meson_version_configured(build_dir: str) -> str | None:
     try:
         meson_info_fn = os.path.join(build_dir, "meson-info", "meson-info.json")
         with open(meson_info_fn) as f:
             meson_info = json.load(f)
         return meson_info["meson_version"]["full"]
     except:
-        pass
+        return None
 
 
 def _meson_coverage_configured() -> bool:
@@ -199,7 +224,7 @@ def _meson_coverage_configured() -> bool:
     return False
 
 
-def _check_coverage_tool_installation(coverage_type: GcovReportFormat, build_dir):
+def _check_coverage_tool_installation(coverage_type: GcovReportFormat, build_dir: str):
     requirements = {  # https://github.com/mesonbuild/meson/blob/6e381714c7cb15877e2bcaa304b93c212252ada3/docs/markdown/Unit-tests.md?plain=1#L49-L62
         GcovReportFormat.html: ["Gcovr/GenHTML", "lcov"],
         GcovReportFormat.xml: ["Gcovr (version 3.3 or higher)"],
@@ -336,7 +361,7 @@ def build(
         if not quiet:
             click.secho(
                 "Editable install of same source detected; skipping build",
-                fg="bright_red",
+                fg="yellow",
             )
         return
 
@@ -419,7 +444,7 @@ def _get_configured_command(command_name):
     metavar="N_JOBS",
     default="1",
     help=(
-        "Number of parallel jobs for testing. Can be set to `auto` to use all cores."
+        "Number of parallel jobs for testing with pytest-xdist. Can be set to `auto` to use all cores."
     ),
 )
 @click.option(
@@ -487,7 +512,7 @@ def test(
 
     To run test modules, functions, classes, or methods:
 
-      spin -t numpy.random
+      spin test -t numpy.random
 
     To report the durations of the N slowest tests:
 

{spin-0.14 → spin-0.16}/spin/cmds/pip.py

@@ -1,3 +1,5 @@
+import sys
+
 import click
 
 from .util import run as _run
@@ -37,7 +39,7 @@ def install(*, pip_args, editable, verbose, verbose_import):
       pip install . --no-build-isolation --editable --no-clean
     """
     pip_args = list(pip_args)
-    pip_cmd = ["pip", "install"]
+    pip_cmd = [sys.executable, "-m", "pip", "install"]
     pip_args += ["--no-build-isolation"]
 
     if editable:

{spin-0.14 → spin-0.16}/spin/cmds/util.py

@@ -127,7 +127,14 @@ def extend_command(
         Command to extend.
     doc : str
         Replacement docstring.
-        The wrapped function's docstring is also appended.
+        The decorated function's docstring is also appended.
+        This is done so that two modes of documenting are enabled:
+
+        1. Extend original command documentation.
+           Do this by providing a docstring on the decorated function.
+        2. Replace the original command's documentation.
+           Do this either by setting ``doc`` to a docstring, or by
+           setting ``doc=''`` and adding a docstring to the decorated function.
     remove_args : tuple of str
         List of arguments to remove from the parent command.
         These arguments can still be set explicitly by calling
@@ -168,7 +175,7 @@ def extend_command(
             return user_func(*args, parent_callback=parent_cmd, **kwargs)
 
         my_cmd.callback = click.pass_context(callback_with_parent_callback)
-        my_cmd.callback._parent = user_func
+        my_cmd.callback._parent = user_func  # type: ignore[attr-defined]
 
         if doc is not None:
             my_cmd.help = doc

{spin-0.14 → spin-0.16}/spin/tests/test_build_cmds.py

@@ -2,7 +2,7 @@ import os
 import subprocess
 import sys
 import tempfile
-from pathlib import Path
+from pathlib import Path, PureWindowsPath
 
 import pytest
 
@@ -19,6 +19,10 @@ from .testutil import (
 )
 
 
+def unix_path(p: str) -> str:
+    return PureWindowsPath(p).as_posix()
+
+
 def test_basic_build(example_pkg):
     """Does the package build?"""
     spin("build")
@@ -39,7 +43,7 @@ def test_debug_builds(example_pkg):
 
 def test_prefix_builds(example_pkg):
     """does spin build --prefix create a build-install directory with the correct structure?"""
-    spin("build", "--prefix=/foobar/")
+    spin("build", f"--prefix={os.path.abspath('/foobar')}")
     assert (Path("build-install") / Path("foobar")).exists()
 
 
@@ -116,6 +120,12 @@ def test_sdist(example_pkg):
     spin("sdist")
 
 
+def test_wheel(example_pkg):
+    spin("wheel")
+    wheel_file_list = list(Path("dist").glob("example_pkg-0.0.dev0-*.whl"))
+    assert len(wheel_file_list) == 1, "Wheel file not created in dist/"
+
+
 def test_example(example_pkg):
     spin("example")
 
@@ -178,7 +188,7 @@ def test_parallel_builds(example_pkg):
     spin("build")
     spin("build", "-C", "parallel/build")
     p = spin("python", "--", "-c", "import example_pkg; print(example_pkg.__file__)")
-    example_pkg_path = stdout(p).split("\n")[-1]
+    example_pkg_path = unix_path(stdout(p).split("\n")[-1])
     p = spin(
         "python",
         "-C",
@@ -187,7 +197,7 @@ def test_parallel_builds(example_pkg):
         "-c",
         "import example_pkg; print(example_pkg.__file__)",
     )
-    example_pkg_parallel_path = stdout(p).split("\n")[-1]
+    example_pkg_parallel_path = unix_path(stdout(p).split("\n")[-1])
     assert "build-install" in example_pkg_path
     assert "parallel/build-install" in example_pkg_parallel_path
     assert "parallel/build-install" not in example_pkg_path

{spin-0.14 → spin-0.16}/spin/tests/testutil.py

@@ -24,12 +24,21 @@ skip_py_lt_311 = pytest.mark.skipif(
 
 def spin(*args, **user_kwargs):
     args = (str(el) for el in args)
+    # Capture stdout, stderr separately
     default_kwargs = {
         "stdout": subprocess.PIPE,
         "stderr": subprocess.PIPE,
-        "sys_exit": True,
+        "sys_exit": False,
     }
-    return run(["spin"] + list(args), **{**default_kwargs, **user_kwargs})
+    p = run(["spin"] + list(args), **{**default_kwargs, **user_kwargs})
+    if p.returncode != 0:
+        print(p.stdout.decode("utf-8"), end="")
+        print(p.stderr.decode("utf-8"), end="")
+        # Exit unless the spin call explicitly asks us not to
+        # by setting sys_exit=False
+        if user_kwargs.get("sys_exit", True):
+            sys.exit(p.returncode)
+    return p
 
 
 def stdout(p):

{spin-0.14 → spin-0.16/spin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spin
-Version: 0.14
+Version: 0.16
 Summary: Developer tool for scientific Python libraries
 Maintainer-email: Scientific Python <spin@discuss.scientific-python.org>
 License: BSD 3-Clause License
@@ -41,21 +41,22 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click
+Requires-Dist: click<=8.2,>=8; python_version == "3.10"
+Requires-Dist: click!=8.3.0,<8.4,>=8
 Requires-Dist: tomli; python_version < "3.11"
 Requires-Dist: colorama; platform_system == "Windows"
 Requires-Dist: importlib_metadata>=7
 Provides-Extra: lint
-Requires-Dist: pre-commit==4.2.0; extra == "lint"
+Requires-Dist: pre-commit==4.3.0; extra == "lint"
 Provides-Extra: dev
 Requires-Dist: changelist==0.5; extra == "dev"
 Dynamic: license-file
@@ -188,6 +189,7 @@ Available as `spin.cmds.build.*`:
 
 ```
 sdist      📦 Build a source distribution in `dist/`
+wheel      📦 Build a wheel distribution in `dist/`
 ```
 
 ### [pip](https://pip.pypa.io) (Package Installer for Python)
@@ -358,6 +360,9 @@ nox -s test -- -v
 nox -s test -- -v spin/tests/test_meson.py
 ```
 
+`spin` takes a slightly more conservative approach than [SPEC 0](https://scientific-python.org/specs/spec-0000/), and
+supports all non-EOL versions of Python.
+
 ## History
 
 The `dev.py` tool was [proposed for SciPy](https://github.com/scipy/scipy/issues/15489) by Ralf Gommers and [implemented](https://github.com/scipy/scipy/pull/15959) by Sayantika Banik, Eduardo Naufel Schettino, and Ralf Gommers (also see [Sayantika's blog post](https://labs.quansight.org/blog/the-evolution-of-the-scipy-developer-cli)).

{spin-0.14 → spin-0.16}/spin.egg-info/requires.txt

@@ -1,4 +1,4 @@
-click
+click!=8.3.0,<8.4,>=8
 importlib_metadata>=7
 
 [:platform_system == "Windows"]
@@ -7,8 +7,11 @@ colorama
 [:python_version < "3.11"]
 tomli
 
+[:python_version == "3.10"]
+click<=8.2,>=8
+
 [dev]
 changelist==0.5
 
 [lint]
-pre-commit==4.2.0
+pre-commit==4.3.0