mirror of
https://github.com/google/benchmark.git
synced 2025-01-13 21:30:14 +08:00
b93f5a5929
* Add pre-commit config and GitHub Actions job Contains the following hooks: * buildifier - for formatting and linting Bazel files. * mypy, ruff, isort, black - for Python typechecking, import hygiene, static analysis, and formatting. The pylint CI job was changed to be a pre-commit CI job, where pre-commit is bootstrapped via Python. Pylint is currently no longer part of the code checks, but can be re-added if requested. The reason to drop was that it does not play nicely with pre-commit, and lots of its functionality and responsibilities are actually covered in ruff. * Add dev extra to pyproject.toml for development installs * Clarify that pre-commit contains only Python and Bazel hooks * Add one-line docstrings to Bazel modules * Apply buildifier pre-commit fixes to Bazel files * Apply pre-commit fixes to Python files * Supply --profile=black to isort to prevent conflicts * Fix nanobind build file formatting * Add tooling configs to `pyproject.toml` In particular, set line length 80 for all Python files. * Reformat all Python files to line length 80, fix return type annotations Also ignores the `tools/compare.py` and `tools/gbench/report.py` files for mypy, since they emit a barrage of errors which we can deal with later. The errors are mostly related to dynamic classmethod definition.
115 lines
3.8 KiB
Python
115 lines
3.8 KiB
Python
import contextlib
|
|
import os
|
|
import platform
|
|
import shutil
|
|
import sysconfig
|
|
from pathlib import Path
|
|
from typing import Generator
|
|
|
|
import setuptools
|
|
from setuptools.command import build_ext
|
|
|
|
PYTHON_INCLUDE_PATH_PLACEHOLDER = "<PYTHON_INCLUDE_PATH>"
|
|
|
|
IS_WINDOWS = platform.system() == "Windows"
|
|
IS_MAC = platform.system() == "Darwin"
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def temp_fill_include_path(fp: str) -> Generator[None, None, None]:
|
|
"""Temporarily set the Python include path in a file."""
|
|
with open(fp, "r+") as f:
|
|
try:
|
|
content = f.read()
|
|
replaced = content.replace(
|
|
PYTHON_INCLUDE_PATH_PLACEHOLDER,
|
|
Path(sysconfig.get_paths()["include"]).as_posix(),
|
|
)
|
|
f.seek(0)
|
|
f.write(replaced)
|
|
f.truncate()
|
|
yield
|
|
finally:
|
|
# revert to the original content after exit
|
|
f.seek(0)
|
|
f.write(content)
|
|
f.truncate()
|
|
|
|
|
|
class BazelExtension(setuptools.Extension):
|
|
"""A C/C++ extension that is defined as a Bazel BUILD target."""
|
|
|
|
def __init__(self, name: str, bazel_target: str):
|
|
super().__init__(name=name, sources=[])
|
|
|
|
self.bazel_target = bazel_target
|
|
stripped_target = bazel_target.split("//")[-1]
|
|
self.relpath, self.target_name = stripped_target.split(":")
|
|
|
|
|
|
class BuildBazelExtension(build_ext.build_ext):
|
|
"""A command that runs Bazel to build a C/C++ extension."""
|
|
|
|
def run(self):
|
|
for ext in self.extensions:
|
|
self.bazel_build(ext)
|
|
super().run()
|
|
# explicitly call `bazel shutdown` for graceful exit
|
|
self.spawn(["bazel", "shutdown"])
|
|
|
|
def bazel_build(self, ext: BazelExtension) -> None:
|
|
"""Runs the bazel build to create the package."""
|
|
with temp_fill_include_path("WORKSPACE"):
|
|
temp_path = Path(self.build_temp)
|
|
|
|
bazel_argv = [
|
|
"bazel",
|
|
"build",
|
|
ext.bazel_target,
|
|
f"--symlink_prefix={temp_path / 'bazel-'}",
|
|
f"--compilation_mode={'dbg' if self.debug else 'opt'}",
|
|
# C++17 is required by nanobind
|
|
f"--cxxopt={'/std:c++17' if IS_WINDOWS else '-std=c++17'}",
|
|
]
|
|
|
|
if IS_WINDOWS:
|
|
# Link with python*.lib.
|
|
for library_dir in self.library_dirs:
|
|
bazel_argv.append("--linkopt=/LIBPATH:" + library_dir)
|
|
elif IS_MAC:
|
|
if platform.machine() == "x86_64":
|
|
# C++17 needs macOS 10.14 at minimum
|
|
bazel_argv.append("--macos_minimum_os=10.14")
|
|
|
|
# cross-compilation for Mac ARM64 on GitHub Mac x86 runners.
|
|
# ARCHFLAGS is set by cibuildwheel before macOS wheel builds.
|
|
archflags = os.getenv("ARCHFLAGS", "")
|
|
if "arm64" in archflags:
|
|
bazel_argv.append("--cpu=darwin_arm64")
|
|
bazel_argv.append("--macos_cpus=arm64")
|
|
|
|
elif platform.machine() == "arm64":
|
|
bazel_argv.append("--macos_minimum_os=11.0")
|
|
|
|
self.spawn(bazel_argv)
|
|
|
|
shared_lib_suffix = ".dll" if IS_WINDOWS else ".so"
|
|
ext_name = ext.target_name + shared_lib_suffix
|
|
ext_bazel_bin_path = (
|
|
temp_path / "bazel-bin" / ext.relpath / ext_name
|
|
)
|
|
|
|
ext_dest_path = Path(self.get_ext_fullpath(ext.name))
|
|
shutil.copyfile(ext_bazel_bin_path, ext_dest_path)
|
|
|
|
|
|
setuptools.setup(
|
|
cmdclass=dict(build_ext=BuildBazelExtension),
|
|
ext_modules=[
|
|
BazelExtension(
|
|
name="google_benchmark._benchmark",
|
|
bazel_target="//bindings/python/google_benchmark:_benchmark",
|
|
)
|
|
],
|
|
)
|