Create a proper Python project for the Python scripts #470
There are no files selected for viewing
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
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
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
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 |
|---|---|---|
|
|
@@ -4,32 +4,64 @@ | |
| # CMake script to find the Python interpreter and either install or find | ||
| # Mbed's dependencies. | ||
|
|
||
| include(CheckPythonPackage) | ||
|
|
||
| option(MBED_CREATE_PYTHON_VENV "If true, Mbed OS will create its own virtual environment (venv) and install its Python packages there. This removes the need to manually install Python packages." TRUE) | ||
|
|
||
| get_filename_component(MBED_CE_TOOLS_BASE_DIR "${CMAKE_CURRENT_LIST_DIR}/.." ABSOLUTE) | ||
|
|
||
| if(MBED_CREATE_PYTHON_VENV) | ||
| # Use the venv. | ||
|
|
||
| # Note: venv is stored in the source directory as it can be shared between all the build directories | ||
| # (not target specific) | ||
| set(MBED_VENV_LOCATION ${MBED_SOURCE_DIR}/venv) | ||
| set(VENV_STAMP_FILE ${MBED_VENV_LOCATION}/mbed-venv.stamp) | ||
| set(MBED_PYPROJECT_TOML_LOCATION "${MBED_CE_TOOLS_BASE_DIR}/pyproject.toml") | ||
|
|
||
| # Make it so modifying pyproject.toml will trigger a reconfigure | ||
| set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${MBED_PYPROJECT_TOML_LOCATION}) | ||
|
|
||
| # Find Python3 (this will get the one in the venv if we already found it) | ||
| set(ENV{VIRTUAL_ENV} ${MBED_VENV_LOCATION}) | ||
| set(Python3_FIND_VIRTUALENV FIRST) | ||
| find_package(Python3 COMPONENTS Interpreter) | ||
| include(CheckPythonPackage) | ||
|
|
||
| set(NEED_TO_CREATE_VENV FALSE) | ||
| set(NEED_TO_INSTALL_PACKAGES FALSE) | ||
|
|
||
| # Special situation: if we have a cached interpreter location in the venv dir, but Python could be found, | ||
| # this means that the venv was deleted or symlinks to a missing python install location. | ||
| # So, use the system python and recreate it. | ||
| if("${Python3_EXECUTABLE}" MATCHES "${MBED_VENV_LOCATION}" AND NOT Python3_FOUND) | ||
|
There was a problem hiding this comment. I have noticed two scenarios here that seemed to cause problems over the last year or so:
I attempt to handle both those cases here. I have confirmed that #2 is fixed now, but I have not found a reliable way to reproduce situation #1 yet, so I sort of threw everything at it in the hope that we can make FindPython temporarily revert back to the system python. |
||
| message(STATUS "Python venv deleted or unusable. Recreating using system Python...") | ||
|
|
||
| # Launch a new search for Python3 | ||
| unset(Python3_EXECUTABLE) | ||
| unset(_Python3_EXECUTABLE CACHE) | ||
| unset(_Python3_INTERPRETER_PROPERTIES CACHE) | ||
| unset(_Python3_INTERPRETER_SIGNATURE CACHE) | ||
| set (Python3_FIND_VIRTUALENV STANDARD) | ||
| unset(ENV{VIRTUAL_ENV}) | ||
| find_package(Python3 REQUIRED COMPONENTS Interpreter) | ||
|
|
||
| # Reset venv configuration as above | ||
| set(Python3_FIND_VIRTUALENV FIRST) | ||
| set(ENV{VIRTUAL_ENV} ${MBED_VENV_LOCATION}) | ||
|
|
||
| set(NEED_TO_CREATE_VENV TRUE) | ||
| set(NEED_TO_INSTALL_PACKAGES TRUE) | ||
| elseif(NOT EXISTS "${VENV_STAMP_FILE}") | ||
| set(NEED_TO_CREATE_VENV TRUE) | ||
| set(NEED_TO_INSTALL_PACKAGES TRUE) | ||
| elseif(NOT ("${Python3_EXECUTABLE}" MATCHES "${MBED_VENV_LOCATION}")) | ||
| # Alternately if we think we have the venv but FindPython didn't use it, that likely means it's | ||
| # missing or corrupted and we need to recreate it | ||
| message(STATUS "Python venv deleted or unusable. Recreating using system Python...") | ||
| set(NEED_TO_CREATE_VENV TRUE) | ||
| set(NEED_TO_INSTALL_PACKAGES TRUE) | ||
| elseif("${MBED_PYPROJECT_TOML_LOCATION}" IS_NEWER_THAN "${VENV_STAMP_FILE}") | ||
| set(NEED_TO_INSTALL_PACKAGES TRUE) | ||
| endif() | ||
|
|
||
|
|
@@ -47,7 +79,8 @@ if(MBED_CREATE_PYTHON_VENV) | |
| unset(_Python3_EXECUTABLE CACHE) | ||
| unset(_Python3_INTERPRETER_PROPERTIES CACHE) | ||
| unset(_Python3_INTERPRETER_SIGNATURE CACHE) | ||
|
|
||
| ## Launch a new search for Python3 in the venv | ||
| find_package (Python3 REQUIRED COMPONENTS Interpreter) | ||
| endif() | ||
|
|
||
|
|
@@ -59,41 +92,80 @@ if(MBED_CREATE_PYTHON_VENV) | |
| COMMAND_ERROR_IS_FATAL ANY | ||
| ) | ||
| execute_process( | ||
| COMMAND ${Python3_EXECUTABLE} -m pip install -e ${MBED_CE_TOOLS_BASE_DIR} | ||
| COMMAND_ERROR_IS_FATAL ANY | ||
| ) | ||
|
|
||
| message(STATUS "Mbed: venv created successfully") | ||
| file(TOUCH ${VENV_STAMP_FILE}) | ||
| endif() | ||
|
|
||
| # When using the venv, scripts will always be installed to the directory where Python itself is installed | ||
| # (venv\Scripts on Windows, venv/bin on Linux/Mac) | ||
| get_filename_component(PYTHON3_INTERP_DIR ${Python3_EXECUTABLE} DIRECTORY) | ||
| set(PYTHON_SCRIPT_LOC_HINTS ${PYTHON3_INTERP_DIR}) | ||
|
|
||
| else() | ||
|
|
||
| find_package(Python3 REQUIRED COMPONENTS Interpreter) | ||
|
|
||
| # The cmsis_mcu_descr module was written from scratch by Mbed CE. | ||
| # So, this check will ensure that the user has installed the Mbed CE version of mbed_tools | ||
| # and not the PyPI version (which we cannot update because it's owned by ARM) | ||
| check_python_package(mbed_tools.cli.cmsis_mcu_descr HAVE_MBED_CE_TOOLS) | ||
|
|
||
| if(NOT HAVE_MBED_CE_TOOLS) | ||
| message(FATAL_ERROR "Did not detect the Mbed CE Python tools installed into the python interpreter ${Python3_EXECUTABLE}. Install them with a command like: ${Python3_EXECUTABLE} -m pip install -e ${MBED_CE_TOOLS_BASE_DIR}") | ||
| endif() | ||
|
|
||
| # For now, don't supply any hints and assume that the script install dir is correctly on PATH | ||
| set(PYTHON_SCRIPT_LOC_HINTS) | ||
| endif() | ||
|
|
||
| # Find scripts provided by the Python package | ||
| find_program(mbed_tools | ||
| NAMES mbed-tools | ||
| HINTS ${PYTHON_SCRIPT_LOC_HINTS} | ||
| DOC "Path to mbed-tools Python script." | ||
| REQUIRED) | ||
|
|
||
| find_program(mbedhtrun | ||
| NAMES mbedhtrun | ||
| HINTS ${PYTHON_SCRIPT_LOC_HINTS} | ||
| DOC "Path to mbedhtrun Python script." | ||
| REQUIRED) | ||
|
|
||
| find_program(memap | ||
| NAMES memap | ||
| HINTS ${PYTHON_SCRIPT_LOC_HINTS} | ||
| DOC "Path to memap Python script." | ||
| REQUIRED) | ||
|
|
||
| # | ||
| # Utility function to check for a Python package with the given import name. | ||
| # If the package is not found and the Mbed venv is in use, | ||
| # then the package will be installed by passing PACKAGE_INSTALL_CONSTRAINT to Pip. | ||
| # If the install fails or the venv is not being used, FOUND_VAR will be set to false. | ||
| # | ||
| function(mbed_check_or_install_python_package FOUND_VAR PACKAGE_IMPORT_NAME PACKAGE_INSTALL_CONSTRAINT) | ||
| check_python_package(${PACKAGE_IMPORT_NAME} ${FOUND_VAR}) | ||
|
|
||
| if(NOT ${FOUND_VAR}) | ||
| # If we are using the Mbed venv, we can install the package automatically. | ||
| if(MBED_CREATE_PYTHON_VENV) | ||
| message(STATUS "Mbed: Installing ${PACKAGE_INSTALL_CONSTRAINT} into Mbed's Python virtualenv") | ||
| execute_process( | ||
| COMMAND ${Python3_EXECUTABLE} -m pip install ${PACKAGE_INSTALL_CONSTRAINT} | ||
| RESULT_VARIABLE PIP_INSTALL_RESULT | ||
| ) | ||
| if(NOT PIP_INSTALL_RESULT EQUAL 0) | ||
| message(WARNING "Installation of ${PACKAGE_INSTALL_CONSTRAINT} via pip failed.") | ||
| else() | ||
| # Redo the check to confirm it's installed | ||
| check_python_package(${PACKAGE_IMPORT_NAME} ${FOUND_VAR}) | ||
| endif() | ||
| else() | ||
| message(WARNING "Mbed: ${PACKAGE_IMPORT_NAME} cannot be installed because the Mbed virtualenv is not being used. Please install ${PACKAGE_INSTALL_CONSTRAINT} into Mbed's Python interpeter manually.") | ||
| endif() | ||
| endif() | ||
| endfunction(mbed_check_or_install_python_package) | ||
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
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.