Merge pull request #197 from davidhewitt/abi3-suffix-bug

build: don't use abi3 lib suffix when py_limited_api unspecified

Author: davidhewitt

.github/workflows/ci.yml

@@ -34,6 +34,20 @@ jobs:
 
       - run: tox -e mypy
 
+  pytest:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+
+      - run: pip install tox
+
+      - run: tox -e pytest
+
   build:
     name:  ${{ matrix.python-version }} ${{ matrix.platform.os }}-${{ matrix.platform.python-architecture }}
     runs-on: ${{ matrix.platform.os }}

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Fix regression from `setuptools-rust` 1.1.0 which broke builds for the `x86_64-unknown-linux-musl` target. [#194](https://github.com/PyO3/setuptools-rust/pull/194)
 - Fix `--target` command line option being unable to take a value. [#195](https://github.com/PyO3/setuptools-rust/pull/195)
 - Fix regression from `setuptools-rust` 1.0.0 which broke builds on arm64 macos conda builds. [#196](https://github.com/PyO3/setuptools-rust/pull/196)
+- Fix regression from `setuptools-rust` 1.1.0 which incorrectly converted library extension suffixes to the "abi3" suffix when `py_limited_api` was unspecified. [#197](https://github.com/PyO3/setuptools-rust/pull/197)
 
 ## 1.1.0 (2021-11-30)
 ### Added

setuptools_rust/build.py

@@ -6,6 +6,7 @@
 import subprocess
 import sys
 import sysconfig
+from distutils import log
 from distutils.command.build import build as CommandBuild
 from distutils.errors import (
     CompileError,
@@ -15,10 +16,11 @@
 )
 from distutils.sysconfig import get_config_var
 from subprocess import check_output
-from typing import Dict, List, NamedTuple, Optional, cast
+from typing import Dict, List, NamedTuple, Optional, Union, cast
 
 from setuptools.command.build_ext import build_ext as CommandBuildExt
 from setuptools.command.build_ext import get_abi3_suffix
+from typing_extensions import Literal
 
 from .command import RustCommand
 from .extension import Binding, RustExtension, Strip
@@ -298,6 +300,7 @@ def install_extension(
                 ext_path = self.get_dylib_ext_path(ext, module_name)
                 os.makedirs(os.path.dirname(ext_path), exist_ok=True)
 
+            log.info("Copying rust artifact from %s to %s", dylib_path, ext_path)
             shutil.copyfile(dylib_path, ext_path)
 
             if sys.platform != "win32" and not debug_build:
@@ -327,9 +330,7 @@ def get_dylib_ext_path(self, ext: RustExtension, target_fname: str) -> str:
 
         ext_path: str = build_ext.get_ext_fullpath(target_fname)
 
-        if (ext.py_limited_api == "auto" and self._py_limited_api()) or (
-            ext.py_limited_api
-        ):
+        if _is_py_limited_api(ext.py_limited_api, self._py_limited_api()):
             abi3_suffix = get_abi3_suffix()
             if abi3_suffix is not None:
                 so_ext = get_config_var("EXT_SUFFIX")
@@ -683,3 +684,30 @@ def _base_cargo_target_dir(ext: RustExtension) -> str:
         target_directory, str
     ), "expected cargo metadata to return a string target directory"
     return target_directory
+
+
+def _is_py_limited_api(
+    ext_setting: Literal["auto", True, False],
+    wheel_setting: Optional[PyLimitedApi],
+) -> bool:
+    """Returns whether this extension is being built for the limited api.
+
+    >>> _is_py_limited_api("auto", None)
+    False
+
+    >>> _is_py_limited_api("auto", True)
+    True
+
+    >>> _is_py_limited_api(True, False)
+    True
+
+    >>> _is_py_limited_api(False, True)
+    False
+    """
+
+    # If the extension explicitly states to use py_limited_api or not, use that.
+    if ext_setting != "auto":
+        return ext_setting
+
+    # "auto" setting - use whether the bdist_wheel option is truthy.
+    return bool(wheel_setting)

setuptools_rust/extension.py

@@ -113,7 +113,7 @@ def __init__(
         script: bool = False,
         native: bool = False,
         optional: bool = False,
-        py_limited_api: Union[bool, Literal["auto"]] = "auto",
+        py_limited_api: Literal["auto", True, False] = "auto",
     ):
         if isinstance(target, dict):
             name = "; ".join("%s=%s" % (key, val) for key, val in target.items())

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = mypy
+envlist = mypy,pytest
 
 [testenv:mypy]
 deps =
@@ -11,3 +11,8 @@ deps =
 setenv =
     MYPYPATH={toxinidir}
 commands = mypy setuptools_rust {posargs}
+
+[testenv:pytest]
+deps =
+    pytest
+commands = pytest --doctest-modules setuptools_rust {posargs}