Pyosys Wheels

* Created `setup.py`: Python package manifest to build `pyosys` wheels with a custom extension to build and include `libyosys.so` using Make
* `.gitignore`: Added byproducts of the Python wheel build process
* `Makefile`: Added `-undefined dynamic_lookup` to `libyosys.so` so missing symbols can be resolved by importing into a Python interpreter
* `kernel/yosys.cc`: Gated `PyImport_AppendInittab` with `!Py_IsInitialized`; as of Python 3.12, the interpreter is already initialized and `PyImport_AppendInittab` would cause an exception to be raised
* Created `wheels.yml`: CI workflow for building wheels for CPython on:
  * Linux (glibc, musl) and Darwin
  * x86-64 and arm64

setup.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python3
+# Copyright (C) 2024 Efabless Corporation
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+import os
+import re
+import shlex
+import shutil
+from setuptools import setup, Extension
+from setuptools.command.build_ext import build_ext
+
+__dir__ = os.path.dirname(os.path.abspath(__file__))
+
+yosys_version_rx = re.compile(r"YOSYS_VER\s*:=\s*([\w\-\+\.]+)")
+
+version = yosys_version_rx.search(
+    open(os.path.join(__dir__, "Makefile"), encoding="utf8").read()
+)[1]
+
+
+class libyosys_so_ext(Extension):
+    def __init__(
+        self,
+    ) -> None:
+        super().__init__(
+            "libyosys.so",
+            [],
+        )
+        self.args = [
+            "ENABLE_PYOSYS=1",
+            # Wheel meant to be imported from interpreter
+            "ENABLE_PYTHON_CONFIG_EMBED=0",
+            # Would need to be installed separately by the user
+            "ENABLE_TCL=0",
+            # Would need to be installed separately by the user
+            "ENABLE_READLINE=0",
+            # Show compile commands
+            "PRETTY=0",
+        ]
+
+    def custom_build(self, bext: build_ext):
+        bext.spawn(
+            ["make", f"-j{os.cpu_count() or 1}", self.name]
+            + shlex.split(os.getenv("makeFlags", ""))
+            + self.args
+        )
+        build_path = os.path.dirname(os.path.dirname(bext.get_ext_fullpath(self.name)))
+        pyosys_path = os.path.join(build_path, "pyosys")
+        target = os.path.join(pyosys_path, os.path.basename(self.name))
+        os.makedirs(pyosys_path, exist_ok=True)
+        shutil.copyfile(self.name, target)
+
+        # I don't know how debug info is getting here.
+        bext.spawn(["strip", "-S", target])
+
+
+class custom_build_ext(build_ext):
+    def build_extension(self, ext) -> None:
+        if not hasattr(ext, "custom_build"):
+            return super().build_extension(ext)
+        return ext.custom_build(self)
+
+
+setup(
+    name="pyosys",
+    packages=["pyosys"],
+    version=version,
+    description="Python access to libyosys",
+    long_description=open(os.path.join(__dir__, "README.md")).read(),
+    long_description_content_type="text/markdown",
+    author="Claire Xenia Wolf",
+    author_email="claire@yosyshq.com",
+    install_requires=["wheel", "setuptools"],
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Intended Audience :: Developers",
+        "Operating System :: POSIX :: Linux",
+        "Operating System :: MacOS :: MacOS X",
+    ],
+    package_dir={"pyosys": "misc"},
+    python_requires=">=3.8",
+    ext_modules=[libyosys_so_ext()],
+    cmdclass={
+        "build_ext": custom_build_ext,
+    },
+)