Merge branch 'macos-python-update' into bump_CI_images

Author: jlatusek

config/python/python_config.py

@@ -14,38 +14,79 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import argparse
 import json
 import os
+import pathlib
 import shutil
 import subprocess
+from typing import Optional
 
 
 class Config:
-    def __init__(self):
-        cipd_install_dir = os.getenv("PW_PYTHON_CIPD_INSTALL_DIR")
-        self.python_exe = os.path.join(cipd_install_dir, "bin", "python3")
-        if not os.path.exists(self.python_exe):
-            self.python_exe = shutil.which("python3")
-            if not self.python_exe:
-                raise FileNotFoundError("Python3 not found")
-
-    def get_version(self):
-        out = subprocess.check_output(
-            [self.python_exe, "-c", "import sys; print(sys.version_info.major, sys.version_info.minor)"], text=True
-        )
-        return out.strip().split(" ")
+    def __init__(self, python_exe: Optional[pathlib.Path] = None):
+        self._paths: Optional[dict] = None
+        self._version: Optional[list] = None
 
+        if python_exe:
+            self.python_exe = python_exe
+        else:
+            cipd_install_dir = os.getenv("PW_PYTHON_CIPD_INSTALL_DIR")
+            if not cipd_install_dir:
+                raise RuntimeError("PW_PYTHON_CIPD_INSTALL_DIR not set")
+            self.python_exe = os.path.join(cipd_install_dir, "bin", "python3")
+            if not os.path.exists(self.python_exe):
+                self.python_exe = shutil.which("python3")
+                if not self.python_exe:
+                    raise FileNotFoundError("Python3 not found")
 
-if __name__ == "__main__":
-    config = Config()
-    version = config.get_version()
+    @property
+    def paths(self) -> dict:
+        if not self._paths:
+            out = subprocess.check_output(
+                [self.python_exe, "-c", "from sysconfig import get_paths; import json; print(json.dumps(get_paths()))"], text=True
+            ).strip()
+            self._paths = json.loads(out)
+        return self._paths
+
+    @property
+    def version(self) -> list[str]:
+        if not self._version:
+            self._version = (
+                subprocess.check_output(
+                    [self.python_exe, "-c", "import sys; print(sys.version_info.major, sys.version_info.minor)"], text=True
+                )
+                .strip()
+                .split(" ")
+            )
+        return self._version
+
+    @property
+    def include(self) -> str:
+        return self.paths["include"]
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(description="Generate Python config")
+    parser.add_argument("--python", type=pathlib.Path, help="Python executable to use", required=False)
+    return parser.parse_args()
+
+
+def main():
+    args = parse_args()
+    config = Config(args.python)
     print(
         json.dumps(
             {
                 "version": {
-                    "major": version[0],
-                    "minor": version[1],
-                }
+                    "major": config.version[0],
+                    "minor": config.version[1],
+                },
+                "include": config.include,
             }
         )
     )
+
+
+if __name__ == "__main__":
+    main()

docs/guides/BUILDING.md

@@ -8,7 +8,7 @@ that generates inputs to [ninja](https://ninja-build.org/).
 
 The build system has been tested on the following Operating Systems:
 
--   macOS 10.15
+-   macOS 13
 -   Debian 11 (64 bit required)
 -   Ubuntu 22.04 LTS
 
@@ -107,7 +107,14 @@ sudo apt-get install libsdl2-dev
 
 ### Installing prerequisites on macOS
 
-On macOS, install Xcode from the Mac App Store.
+On macOS, install Xcode from the Mac App Store. After installing Xcode, install
+python3.11 using brew:
+
+```sh
+    brew install python@3.11
+    python3.11 -m pip install --upgrade setuptools
+    python3.11 -m pip install --upgrade pip
+```
 
 #### UI builds
 

scripts/setup/bootstrap.sh

@@ -14,6 +14,22 @@
 # limitations under the License.
 #
 
+# Installation of python using brew without specifying the version will add the python
+# and python3 executables to the PATH. However, installation of specific version
+# of python on macOS using brew will not add the
+# python/python3 executable to the PATH. To make pigweed use brew installed python
+# on macOS, we need to add `/usr/local/opt/python@$version/libexec/bin/` to the PATH.
+if [ "$(uname)" = "Darwin" ]; then
+    PYTHON_VERSIONS=("3.12" "3.11")
+    for version in "${PYTHON_VERSIONS[@]}"; do
+        _PYTHON_PATH="/usr/local/opt/python@$version/libexec/bin/"
+        if [ -d "$_PYTHON_PATH" ]; then
+            PATH="$_PYTHON_PATH:$PATH"
+            break
+        fi
+    done
+fi
+
 _install_additional_pip_requirements() {
     _SETUP_PLATFORM=$1
     shift

src/pybindings/pycontroller/BUILD.gn

@@ -46,17 +46,10 @@ shared_library("CHIPController") {
 
   # TODO: Update to use GN tools to get actual paths
   include_dirs = [ "${chip_root}/third_party/pybind11/repo/include" ]
-  version = python_config.version
-  if (current_os == "mac") {
-    include_dirs +=
-        [ "${chip_root}/.environment/cipd/packages/python/include/python" +
-          version.major + "." + version.minor ]
-  } else if (current_os == "linux") {
-    include_dirs +=
-        [ "/usr/include/python" + version.major + "." + version.minor ]
-  } else {
+  if (current_os != "mac" && current_os != "linux") {
     assert(false, "OS not supported.")
   }
+  include_dirs += [ python_config.include ]
 
   sources = [
     "ControllerBindings/PyChip_ChipError.cpp",
@@ -92,6 +85,7 @@ shared_library("CHIPController") {
     ]
   }
   if (current_os == "linux") {
+    version = python_config.version
     libs = [ "python" + version.major + "." + version.minor ]
   }
 }