support patches in pip package

Author: thorsten-klein

MANIFEST.in

@@ -1,3 +1,4 @@
 include src/west/west-commands-schema.yml
 include src/west/manifest-schema.yml
 include src/west/py.typed
+recursive-include patches *.patch

build_backend.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+
+import subprocess
+
+from pathlib import Path
+from setuptools.build_meta import build_wheel as actual_build_wheel
+from setuptools.build_meta import prepare_metadata_for_build_wheel as actual_prepare_metadata_for_build_wheel
+
+def apply_patches():
+    print("Info: Function apply_patches()")
+    patch_dir = Path(__file__).parent / "patches"
+    for patch in sorted(patch_dir.glob("*.patch")):
+        print(f"Applying patch: {patch.name}")
+        #subprocess.check_call(["patch", "-p1", "-i", str(patch)])
+        subprocess.check_call(["git", "am", str(patch)])
+
+def prepare_metadata_for_build_wheel(*args, **kwargs):
+    print("Info: Function prepare_metadata_for_build_wheel()")
+    apply_patches()
+    return actual_prepare_metadata_for_build_wheel(*args, **kwargs)
+
+def build_wheel(*args, **kwargs):
+    print("Info: Function build_wheel()")
+    apply_patches()
+    return actual_build_wheel(*args, **kwargs)

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = ["setuptools>=77.0.3"]
-build-backend = "setuptools.build_meta"
+build-backend = "build_backend"
 
 [project]
 name = "west"

scripts/create-patches.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+GIT_ROOT=$(git rev-parse --show-toplevel)
+PATCH_DIR="$GIT_ROOT/patches"
+
+# original remote
+REMOTE_NAME="original"
+REMOTE_BRANCH="main"
+
+# create patch files for each commit from FORK_BRANCH not in REMOTE_BRANCH
+mkdir -p "$PATCH_DIR"
+git format-patch "$REMOTE_NAME/$REMOTE_BRANCH" -o "$PATCH_DIR"
+
+echo "Done!"

scripts/create-wheel.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+GIT_ROOT=$(git rev-parse --show-toplevel)
+PATCH_DIR="$GIT_ROOT/patches"
+
+cd $GIT_ROOT
+PYTHONPATH="." python3 -m build --wheel

scripts/merge_upstream.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# original remote
+REMOTE_NAME="original"
+REMOTE_BRANCH="main"
+
+# fork details
+FORK_NAME="fork"
+FORK_BRANCH="main-with-patches"
+
+# fetch fork and original remote
+git fetch fork
+git fetch original
+
+# checkout FORK_BRANCH from fork
+git checkout -B "$FORK_BRANCH" "fork/$FORK_BRANCH" || \
+git checkout -b "$FORK_BRANCH" "original/$REMOTE_BRANCH"
+
+# merge REMOTE_BRANCH into FORK_BRANCH to keep a linear history
+git merge "original/$REMOTE_BRANCH" || (
+    echo "Merge encountered conflicts. Please resolve them and run 'git merge --continue' or abort"
+)
+
+echo "Done!"

scripts/rebase_fork.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# original remote
+ORIGINAL_URL="https://github.com/zephyrproject-rtos/west.git"
+REMOTE_BRANCH="main"
+
+# fork details
+FORK_URL="https://github.com/thorsten-klein/west.git"
+FORK_BRANCH="main-with-patches"
+
+# add remote "fork" if not already exists
+if ! git remote | grep -q "^fork$"; then
+    git remote add fork "$FORK_URL"
+fi
+
+# add remote original if not already exists
+if ! git remote | grep -q "^original$"; then
+    git remote add original "$ORIGINAL_URL"
+fi
+
+# fetch fork and original remote
+git fetch fork
+git fetch original
+
+# checkout FORK_BRANCH from fork
+git checkout -B "$FORK_BRANCH" "fork/$FORK_BRANCH" || \
+git checkout -b "$FORK_BRANCH" "original/$REMOTE_BRANCH"
+
+# rebase FORK_BRANCH onto REMOTE_BRANCH
+git rebase "original/$REMOTE_BRANCH" || (
+    echo "Rebase encountered conflicts. Please resolve them and run 'git rebase --continue' or abort"
+)
+
+echo "Done!"