-
Notifications
You must be signed in to change notification settings - Fork 35
FEAT: Modernize build system with pyproject.toml and custom build backend #408
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bewithgaurav
wants to merge
13
commits into
main
Choose a base branch
from
bewithgaurav/pyproject-modernization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+639
−159
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
7966b90
Modernize build system with pyproject.toml and custom build backend
bewithgaurav a5668d3
Merge branch 'main' into bewithgaurav/pyproject-modernization
bewithgaurav 2fefac9
CHORE: Clean up unused imports and fix cross-platform build script de…
bewithgaurav cc357ee
Merge branch 'bewithgaurav/pyproject-modernization' of https://github…
bewithgaurav 2aa2c05
Merge branch 'main' into bewithgaurav/pyproject-modernization
bewithgaurav 3409a70
CHORE: Update pyproject.toml - GA status and Python 3.14 support
bewithgaurav 4129ff5
Merge branch 'bewithgaurav/pyproject-modernization' of https://github…
bewithgaurav 56186bd
CHORE: Remove flake8 - not enforced, only Black is required
bewithgaurav a1667e6
CHORE: Update documentation URL to point to wiki
bewithgaurav c42f819
fix: Address all Copilot review comments
bewithgaurav 2084bb1
refactor: Use shared get_platform_info from build_ddbc.compiler
bewithgaurav f797db3
fix: Address David's code review feedback
bewithgaurav 6a50152
fix: Update setuptools requirement and remove duplicate coverage config
bewithgaurav File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| """ | ||
| build_ddbc - Build system for mssql-python native extensions. | ||
|
|
||
| This package provides: | ||
| 1. A CLI tool: `python -m build_ddbc` | ||
| 2. A PEP 517 build backend that auto-compiles ddbc_bindings | ||
|
|
||
| Usage: | ||
| python -m build_ddbc # Compile ddbc_bindings only | ||
| python -m build_ddbc --arch arm64 # Specify architecture (Windows) | ||
| python -m build_ddbc --coverage # Enable coverage (Linux) | ||
| python -m build # Compile + create wheel (automatic) | ||
| """ | ||
|
|
||
| from .compiler import compile_ddbc, get_platform_info | ||
|
|
||
| __all__ = ["compile_ddbc", "get_platform_info"] | ||
| __version__ = "1.2.0" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| """ | ||
| CLI entry point for build_ddbc. | ||
|
|
||
| Usage: | ||
| python -m build_ddbc # Compile ddbc_bindings | ||
| python -m build_ddbc --arch arm64 # Specify architecture (Windows) | ||
| python -m build_ddbc --coverage # Enable coverage (Linux) | ||
| python -m build_ddbc --help # Show help | ||
| """ | ||
|
|
||
| import argparse | ||
| import sys | ||
|
|
||
| from . import __version__ | ||
| from .compiler import compile_ddbc, get_platform_info | ||
|
|
||
|
|
||
| def main() -> int: | ||
| """Main entry point for the CLI.""" | ||
| parser = argparse.ArgumentParser( | ||
| prog="python -m build_ddbc", | ||
| description="Compile ddbc_bindings native extension for mssql-python", | ||
| formatter_class=argparse.RawDescriptionHelpFormatter, | ||
| epilog=""" | ||
| Examples: | ||
| python -m build_ddbc # Build for current platform | ||
| python -m build_ddbc --arch arm64 # Build for ARM64 (Windows) | ||
| python -m build_ddbc --coverage # Build with coverage (Linux) | ||
| python -m build_ddbc --quiet # Build without output | ||
| """, | ||
| ) | ||
|
|
||
| parser.add_argument( | ||
| "--arch", "-a", | ||
| choices=["x64", "x86", "arm64", "x86_64", "aarch64", "universal2"], | ||
| help="Target architecture (Windows: x64, x86, arm64)", | ||
| ) | ||
|
|
||
| parser.add_argument( | ||
| "--coverage", "-c", | ||
| action="store_true", | ||
| help="Enable coverage instrumentation (Linux only)", | ||
| ) | ||
|
|
||
| parser.add_argument( | ||
| "--quiet", "-q", | ||
| action="store_true", | ||
| help="Suppress build output", | ||
| ) | ||
|
|
||
| parser.add_argument( | ||
| "--version", "-V", | ||
| action="version", | ||
| version=f"%(prog)s {__version__}", | ||
| ) | ||
|
|
||
| args = parser.parse_args() | ||
|
|
||
| # Show platform info | ||
| if not args.quiet: | ||
| arch, platform_tag = get_platform_info() | ||
| print(f"[build_ddbc] Platform: {sys.platform}") | ||
| print(f"[build_ddbc] Architecture: {arch}") | ||
| print(f"[build_ddbc] Platform tag: {platform_tag}") | ||
| print() | ||
|
|
||
| try: | ||
| compile_ddbc( | ||
| arch=args.arch, | ||
| coverage=args.coverage, | ||
| verbose=not args.quiet, | ||
| ) | ||
| return 0 | ||
| except FileNotFoundError as e: | ||
| print(f"Error: {e}", file=sys.stderr) | ||
| return 1 | ||
| except RuntimeError as e: | ||
| print(f"Build failed: {e}", file=sys.stderr) | ||
| return 1 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| sys.exit(main()) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| """ | ||
| PEP 517 Build Backend for mssql-python. | ||
|
|
||
| This module wraps setuptools' build backend and adds automatic | ||
| ddbc_bindings compilation before building wheels. | ||
|
|
||
| Usage in pyproject.toml: | ||
| [build-system] | ||
| requires = ["setuptools>=61.0", "wheel", "pybind11"] | ||
| build-backend = "build_ddbc.build_backend" | ||
| backend-path = ["."] | ||
| """ | ||
|
|
||
| # Import setuptools build backend - we'll wrap its functions | ||
| from setuptools.build_meta import ( | ||
| build_wheel as _setuptools_build_wheel, | ||
| build_sdist as _setuptools_build_sdist, | ||
| get_requires_for_build_wheel as _get_requires_for_build_wheel, | ||
| get_requires_for_build_sdist as _get_requires_for_build_sdist, | ||
| prepare_metadata_for_build_wheel as _prepare_metadata_for_build_wheel, | ||
| ) | ||
|
|
||
| from .compiler import compile_ddbc | ||
|
|
||
|
|
||
| # ============================================================================= | ||
| # PEP 517 Required Hooks | ||
| # ============================================================================= | ||
|
|
||
|
|
||
| def get_requires_for_build_wheel(config_settings=None): | ||
| """Return build requirements for wheel.""" | ||
| return _get_requires_for_build_wheel(config_settings) | ||
|
|
||
|
|
||
| def get_requires_for_build_sdist(config_settings=None): | ||
| """Return build requirements for sdist.""" | ||
| return _get_requires_for_build_sdist(config_settings) | ||
|
|
||
|
|
||
| def prepare_metadata_for_build_wheel(metadata_directory, config_settings=None): | ||
| """Prepare wheel metadata.""" | ||
| return _prepare_metadata_for_build_wheel(metadata_directory, config_settings) | ||
|
|
||
|
|
||
| def build_wheel(wheel_directory, config_settings=None, metadata_directory=None): | ||
| """ | ||
| Build a wheel, compiling ddbc_bindings first. | ||
|
|
||
| This is the main hook - it compiles the native extension before | ||
| delegating to setuptools to create the wheel. | ||
| """ | ||
| print("[build_backend] Starting wheel build...") | ||
|
|
||
| # Check if we should skip compilation (e.g., for sdist-only builds) | ||
| skip_compile = False | ||
| if config_settings: | ||
| skip_compile = config_settings.get("--skip-ddbc-compile", False) | ||
|
|
||
| if not skip_compile: | ||
| # Extract build options from config_settings | ||
| arch = None | ||
| coverage = False | ||
|
|
||
| if config_settings: | ||
| arch = config_settings.get("--arch") | ||
| coverage = config_settings.get("--coverage", False) | ||
|
|
||
| print("[build_backend] Compiling ddbc_bindings...") | ||
| try: | ||
| compile_ddbc(arch=arch, coverage=coverage, verbose=True) | ||
| print("[build_backend] Compilation successful!") | ||
| except FileNotFoundError: | ||
| # If build scripts don't exist, assume pre-compiled binaries | ||
| print("[build_backend] Build scripts not found, assuming pre-compiled binaries") | ||
bewithgaurav marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| except (RuntimeError, OSError) as e: | ||
| print(f"[build_backend] Compilation failed: {e}") | ||
| raise | ||
| else: | ||
| print("[build_backend] Skipping ddbc compilation (--skip-ddbc-compile)") | ||
|
|
||
| # Now build the wheel using setuptools | ||
| print("[build_backend] Creating wheel...") | ||
| return _setuptools_build_wheel(wheel_directory, config_settings, metadata_directory) | ||
|
|
||
|
|
||
| def build_sdist(sdist_directory, config_settings=None): | ||
| """ | ||
| Build a source distribution. | ||
|
|
||
| For sdist, we don't compile - just package the source including build scripts. | ||
| """ | ||
| print("[build_backend] Building source distribution...") | ||
| return _setuptools_build_sdist(sdist_directory, config_settings) | ||
|
|
||
|
|
||
| # ============================================================================= | ||
| # Optional PEP 660 Hooks (Editable Installs) | ||
| # ============================================================================= | ||
|
|
||
|
|
||
| def get_requires_for_build_editable(config_settings=None): | ||
| """Return build requirements for editable install.""" | ||
| return get_requires_for_build_wheel(config_settings) | ||
|
|
||
|
|
||
| def build_editable(wheel_directory, config_settings=None, metadata_directory=None): | ||
| """ | ||
| Build an editable wheel, compiling ddbc_bindings first. | ||
|
|
||
| This enables `pip install -e .` to automatically compile. | ||
| """ | ||
| print("[build_backend] Starting editable install...") | ||
|
|
||
| # Compile ddbc_bindings for editable installs too | ||
| print("[build_backend] Compiling ddbc_bindings for editable install...") | ||
| try: | ||
| compile_ddbc(verbose=True) | ||
| print("[build_backend] Compilation successful!") | ||
| except FileNotFoundError: | ||
| print("[build_backend] Build scripts not found, assuming pre-compiled binaries") | ||
| except (RuntimeError, OSError) as e: | ||
| print(f"[build_backend] Compilation failed: {e}") | ||
| raise | ||
|
|
||
| # Import here and handle absence gracefully for older setuptools versions | ||
| try: | ||
| from setuptools.build_meta import build_editable as _setuptools_build_editable | ||
| except ImportError as exc: | ||
| raise RuntimeError( | ||
| "Editable installs are not supported with this setuptools version. " | ||
| "Please install setuptools>=64.0.0 to use PEP 660 editable installs." | ||
| ) from exc | ||
| return _setuptools_build_editable(wheel_directory, config_settings, metadata_directory) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.