Switch to ABI3 compatible wheels

Author: amykyta3

.github/workflows/build.yml

@@ -40,20 +40,16 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
-        run: |
-          python -m pip install -U pytest pytest-cov coveralls>=3.0.0 parameterized
-
       - name: Install
         run: |
-          python -m pip install .
+          python -m pip install '.[dev]'
 
       - name: Test
         run: |
@@ -67,12 +63,12 @@ jobs:
           pytest
 
       - name: Coveralls
-        if: ${{ matrix.python-version != 3.5 }} # coveralls no longer works well on 3.5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COVERALLS_PARALLEL: true
         run: |
           cd test
+          python -m pip install -U coveralls>=3.0.0
           coveralls --service=github
 
   finish_coveralls:
@@ -96,44 +92,41 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
-
-      - name: Install dependencies
-        run: |
-          python -m pip install -U pylint
+          python-version: "3.11"
 
       - name: Install
+        env:
+          SYSTEMRDL_SKIP_BINARY_BUILD: ~
         run: |
-          python setup.py install
+          python -m pip install '.[dev]'
 
       - name: Run Lint
         run: |
-          pylint --rcfile test/pylint.rc systemrdl
+          pylint --rcfile test/pylint.rc src/systemrdl
 
 #-------------------------------------------------------------------------------
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.11"
 
-      - name: Install dependencies
+      - name: Install
+        env:
+          SYSTEMRDL_SKIP_BINARY_BUILD: ~
         run: |
-          python -m pip install -U types-Markdown
-
-          # Exclude version due to: https://github.com/python/mypy/issues/16770
-          python -m pip install -U "mypy != 1.8.0"
+          python -m pip install '.[dev]'
 
       - name: Type Check
         run: |
-          mypy --config-file test/mypy.ini systemrdl
+          mypy --config-file test/mypy.ini src/systemrdl
 
 #-------------------------------------------------------------------------------
   build_wheels:
@@ -149,47 +142,40 @@ jobs:
         os:
           - windows-latest
           - macos-latest
+          - ubuntu-latest
         include:
           # Only build CPython 3.x targets
           - cibw_build: "cp3*"
-            cibw_skip: ""
-            name_suffix: ""
-
-          # Parallelize Linux builds because there are many!
-          - os: ubuntu-latest
-            name_suffix: "manylinux_x86_64"
-            cibw_build: "cp3*-manylinux_x86_64"
-            cibw_skip: ""
-          - os: ubuntu-latest
-            name_suffix: "manylinux_i686"
-            cibw_build: "cp3*-manylinux_i686"
-            cibw_skip: ""
-          - os: ubuntu-latest
-            name_suffix: "musllinux_x86_64"
-            cibw_build: "cp3*-musllinux_x86_64"
-            cibw_skip: ""
-          - os: ubuntu-latest
-            name_suffix: "others"
-            cibw_build: "cp3*"
-            cibw_skip: "cp3*-{manylinux_x86_64,manylinux_i686,musllinux_x86_64}"
-
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.16.5
+        uses: pypa/cibuildwheel@v2.22.0
         env:
-          CIBW_BUILD: ${{ matrix.cibw_build }}
-          CIBW_SKIP: ${{ matrix.cibw_skip }}
+          # Only build CPython 3.x targets
+          CIBW_BUILD: "cp3*"
           # Ensure full C++17 availability on macOS builds
           MACOSX_DEPLOYMENT_TARGET: "10.13"
           # Signal setup.py to fail if binary build fails
           SYSTEMRDL_REQUIRE_BINARY_BUILD: ~
 
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install abi3audit
+
+      - name: ABI3 audit
+        run: |
+          abi3audit --debug --verbose --summary --strict wheelhouse/*.whl
+
       - uses: actions/upload-artifact@v4
         with:
-          name: whl-${{ matrix.os }}${{ matrix.name_suffix }}
+          name: whl-${{ matrix.os }}-${{ strategy.job-index }}
           path: ./wheelhouse/*.whl
 
 #-------------------------------------------------------------------------------
@@ -201,15 +187,19 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: actions/setup-python@v4
         name: Install Python
         with:
-          python-version: "3.10"
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install build
 
       - name: Build sdist
-        run: python setup.py sdist
+        run: python -m build --sdist
 
       - uses: actions/upload-artifact@v4
         name: sdist

MANIFEST.in

@@ -1,6 +1,4 @@
-include LICENSE
-include LICENSE-3RD-PARTY
-include systemrdl/preprocessor/ppp_runner.pl
-include systemrdl/py.typed
-recursive-include systemrdl/parser/ext *
 recursive-exclude test *
+recursive-exclude docs *
+recursive-exclude examples *
+recursive-exclude .github *

pyproject.toml

@@ -41,6 +41,20 @@ classifiers = [
     "Topic :: Software Development :: Code Generators",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "parameterized",
+    "pylint",
+
+    # Avoiding newer mypy for now because I didn't know how to do type hints
+    # 5 years ago...
+    #   https://github.com/python/mypy/issues/16770
+    "mypy < 1.8.0",
+    "types-Markdown",
+]
+
 [project.urls]
 Source = "https://github.com/SystemRDL/systemrdl-compiler"
 Tracker = "https://github.com/SystemRDL/systemrdl-compiler/issues"

setup.py

@@ -30,7 +30,9 @@ def run_setup(with_binary):
             sources=get_files("src/systemrdl/parser/ext", "*.cpp"),
             depends=get_files("src/systemrdl/parser/ext", "*.h"),
 
-            extra_compile_args=extra_compile_args.get(target, [])
+            extra_compile_args=extra_compile_args.get(target, []),
+            define_macros=[("Py_LIMITED_API", "0x03060000")],
+            py_limited_api=True,
         )
         ext_modules = [parser_ext]
     else:
@@ -39,6 +41,7 @@ def run_setup(with_binary):
     setuptools.setup(
         ext_modules=ext_modules,
         cmdclass={"build_ext": ve_build_ext},
+        options={"bdist_wheel": {"py_limited_api": "cp36"}},
     )
 
 
@@ -89,6 +92,9 @@ def build_extension(self, ext):
 # Force using fallback python parser under some conditions
 using_fallback = is_jython or is_pypy or is_old_python
 
+if 'SYSTEMRDL_SKIP_BINARY_BUILD' in os.environ:
+    using_fallback = True
+
 if not using_fallback:
     try:
         run_setup(with_binary=True)