-
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
34
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.
Open
Changes from all commits
Commits
Show all changes
34 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 394b63a
Merge branch 'main' into bewithgaurav/pyproject-modernization
bewithgaurav 43337f8
Merge branch 'main' into bewithgaurav/pyproject-modernization
bewithgaurav 4b2a5cf
Merge branch 'main' into bewithgaurav/pyproject-modernization
bewithgaurav af72b63
Refactor: Move get_platform_info to mssql_python/platform_utils.py
bewithgaurav 9aa716b
Fix version to 1.3.0 and add py.typed to package-data
bewithgaurav da350de
Add tests for platform_utils (100% coverage)
bewithgaurav aa36078
Fix Black formatting in platform_utils tests
bewithgaurav ee794b5
Fix Black 26.1.0 formatting (multi-line string style change)
bewithgaurav 515b673
fix: address Copilot review comments
bewithgaurav a27b023
fix: avoid importing mssql_python in build_ddbc to prevent segfault o…
bewithgaurav 6bfe9fe
Merge branch 'main' into bewithgaurav/pyproject-modernization
bewithgaurav e363b72
refactor: rename build_ddbc → build_backend, move platform_utils
bewithgaurav 1e01c81
chore: remove [project.scripts] entry
bewithgaurav 74ba9ff
fix: fail build on FileNotFoundError instead of silently continuing
bewithgaurav f3c6ce1
test: add test_017_build_backend.py with 100% coverage
bewithgaurav a6d1525
Merge branch 'main' into bewithgaurav/pyproject-modernization
bewithgaurav e254995
style: fix black formatting in test files
bewithgaurav aaff546
fix: add create=True to build_editable patches for older setuptools
bewithgaurav d1b9601
fix: restore missing stress_threading and slow markers from pytest.ini
bewithgaurav 9afe5d5
fix: keep only stress marker (stress_threading/slow are from unmerged…
bewithgaurav 66c7808
style: fix black formatting in build_editable tests
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 |
|---|---|---|
|
|
@@ -63,3 +63,4 @@ build/ | |
|
|
||
| # learning files | ||
| learnings/ | ||
| .coverage | ||
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,19 @@ | ||
| """ | ||
| build_backend - Build system for mssql-python native extensions. | ||
| This package provides: | ||
| 1. A CLI tool: `python -m build_backend` | ||
| 2. A PEP 517 build backend that auto-compiles ddbc_bindings | ||
| Usage: | ||
| python -m build_backend # Compile ddbc_bindings only | ||
| python -m build_backend --arch arm64 # Specify architecture (Windows) | ||
| python -m build_backend --coverage # Enable coverage (Linux) | ||
| python -m build # Compile + create wheel (automatic) | ||
| """ | ||
|
|
||
| from .compiler import compile_ddbc | ||
| from .platform_utils import get_platform_info | ||
|
|
||
| __all__ = ["compile_ddbc", "get_platform_info"] | ||
| __version__ = "1.3.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,84 @@ | ||
| """ | ||
| CLI entry point for build_backend. | ||
|
|
||
| Usage: | ||
| python -m build_backend # Compile ddbc_bindings | ||
| python -m build_backend --arch arm64 # Specify architecture (Windows) | ||
| python -m build_backend --coverage # Enable coverage (Linux) | ||
| python -m build_backend --help # Show help | ||
| """ | ||
|
|
||
| import argparse | ||
| import sys | ||
|
|
||
| from . import __version__ | ||
| from .compiler import compile_ddbc | ||
| from .platform_utils import get_platform_info | ||
|
|
||
|
|
||
| def main() -> int: | ||
| """Main entry point for the CLI.""" | ||
| parser = argparse.ArgumentParser( | ||
| prog="python -m build_backend", | ||
| description="Compile ddbc_bindings native extension for mssql-python", | ||
| formatter_class=argparse.RawDescriptionHelpFormatter, | ||
| epilog=""" | ||
| Examples: | ||
| python -m build_backend # Build for current platform | ||
| python -m build_backend --arch arm64 # Build for ARM64 (Windows) | ||
| python -m build_backend --coverage # Build with coverage (Linux) | ||
| python -m build_backend --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_backend] Platform: {sys.platform}") | ||
| print(f"[build_backend] Architecture: {arch}") | ||
| print(f"[build_backend] 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,135 @@ | ||
| """Core compiler logic for ddbc_bindings. | ||
|
|
||
| Locates and runs the platform-specific build script | ||
| (``build.sh`` / ``build.bat``) in ``mssql_python/pybind/``. | ||
| """ | ||
|
|
||
| import sys | ||
| import subprocess | ||
| from pathlib import Path | ||
| from typing import Optional | ||
|
|
||
| from .platform_utils import get_platform_info | ||
|
|
||
|
|
||
| def find_pybind_dir() -> Path: | ||
| """Find the pybind directory containing build scripts.""" | ||
| # Try relative to this file first (for installed package) | ||
| possible_paths = [ | ||
| Path(__file__).parent.parent / "mssql_python" / "pybind", | ||
| Path.cwd() / "mssql_python" / "pybind", | ||
| ] | ||
|
|
||
| # Check for platform-appropriate build script | ||
| build_script = "build.bat" if sys.platform.startswith("win") else "build.sh" | ||
|
|
||
| for path in possible_paths: | ||
| if path.exists() and (path / build_script).exists(): | ||
| return path | ||
|
|
||
| raise FileNotFoundError( | ||
| f"Could not find mssql_python/pybind directory with {build_script}. " | ||
| "Make sure you're running from the project root." | ||
| ) | ||
|
|
||
|
|
||
| def compile_ddbc( | ||
| arch: Optional[str] = None, | ||
| coverage: bool = False, | ||
| verbose: bool = True, | ||
| ) -> bool: | ||
| """ | ||
| Compile ddbc_bindings using the platform-specific build script. | ||
|
|
||
| Args: | ||
| arch: Target architecture (Windows only: x64, x86, arm64) | ||
| coverage: Enable coverage instrumentation (Linux/macOS only) | ||
| verbose: Print build output | ||
|
|
||
| Returns: | ||
| True if build succeeded, False otherwise | ||
|
|
||
| Raises: | ||
| FileNotFoundError: If build script is not found | ||
| RuntimeError: If build fails | ||
| """ | ||
| pybind_dir = find_pybind_dir() | ||
|
|
||
| if arch is None: | ||
| arch, _ = get_platform_info() | ||
|
|
||
| if sys.platform.startswith("win"): | ||
| return _run_windows_build(pybind_dir, arch, verbose) | ||
| else: | ||
| return _run_unix_build(pybind_dir, coverage, verbose) | ||
|
|
||
|
|
||
| def _run_windows_build(pybind_dir: Path, arch: str, verbose: bool) -> bool: | ||
| """Run build.bat on Windows.""" | ||
| build_script = pybind_dir / "build.bat" | ||
| if not build_script.exists(): | ||
| raise FileNotFoundError(f"Build script not found: {build_script}") | ||
|
|
||
| cmd = [str(build_script), arch] | ||
|
|
||
| if verbose: | ||
| print(f"[build_backend] Running: {' '.join(cmd)}") | ||
| print(f"[build_backend] Working directory: {pybind_dir}") | ||
|
|
||
| result = subprocess.run( | ||
| cmd, | ||
| cwd=pybind_dir, | ||
| check=False, | ||
| capture_output=not verbose, | ||
| ) | ||
|
|
||
| if result.returncode != 0: | ||
| if not verbose: | ||
| if result.stdout: | ||
| print(result.stdout.decode(), file=sys.stderr) | ||
| if result.stderr: | ||
| print(result.stderr.decode(), file=sys.stderr) | ||
| raise RuntimeError(f"build.bat failed with exit code {result.returncode}") | ||
|
|
||
| if verbose: | ||
| print("[build_backend] Windows build completed successfully!") | ||
|
|
||
| return True | ||
|
|
||
|
|
||
| def _run_unix_build(pybind_dir: Path, coverage: bool, verbose: bool) -> bool: | ||
| """Run build.sh on macOS/Linux.""" | ||
| build_script = pybind_dir / "build.sh" | ||
| if not build_script.exists(): | ||
| raise FileNotFoundError(f"Build script not found: {build_script}") | ||
|
|
||
| # Make sure the script is executable | ||
| build_script.chmod(0o755) | ||
|
|
||
| cmd = ["bash", str(build_script)] | ||
| if coverage: | ||
| cmd.append("--coverage") | ||
|
|
||
| if verbose: | ||
| print(f"[build_backend] Running: {' '.join(cmd)}") | ||
| print(f"[build_backend] Working directory: {pybind_dir}") | ||
|
|
||
| result = subprocess.run( | ||
| cmd, | ||
| cwd=pybind_dir, | ||
| check=False, | ||
| capture_output=not verbose, | ||
| ) | ||
|
|
||
| if result.returncode != 0: | ||
| if not verbose: | ||
| if result.stdout: | ||
| print(result.stdout.decode(), file=sys.stderr) | ||
| if result.stderr: | ||
| print(result.stderr.decode(), file=sys.stderr) | ||
| raise RuntimeError(f"build.sh failed with exit code {result.returncode}") | ||
|
|
||
| if verbose: | ||
| print("[build_backend] Unix build completed successfully!") | ||
|
|
||
| return True |
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.