在CMake命令ModuleNotFoundError中调用pipenv

Question

我正试图使用CMake通过Python脚本生成C/C++源文件，但遇到了一个问题，pipenv似乎没有按预期工作。

我试图在我的Github上创建一个简化版的真实世界示例。

cmake_minimum_required(VERSION 2.8.5)
project(example)
include_directories(${PROJECT_SOURCE_DIR}/src)
find_package(Python3 COMPONENTS Interpreter REQUIRED)
find_program(PipEnv pipenv REQUIRED)
# Create command to compile the generate command
add_custom_command(
OUTPUT
${CMAKE_SOURCE_DIR}/generate.py
COMMAND ${PipEnv} install
COMMENT "Installing pipenv dependencies [${PipEnv} install]"
DEPENDS
${CMAKE_SOURCE_DIR}/generate.py
${CMAKE_SOURCE_DIR}/Pipfile
)
add_custom_target(
generate_version
COMMAND ${PipEnv} run ${Python3_EXECUTABLE} ${CMAKE_SOURCE_DIR}/generate.py -o src/version.h config.json
COMMENT "Generating version header [${PipEnv} run ${CMAKE_SOURCE_DIR}/generate.py -o src/version.h config.json]"
DEPENDS
${CMAKE_SOURCE_DIR}/generate.py
${CMAKE_SOURCE_DIR}/config.json
)
add_subdirectory(src)

我收到的错误是：

[main] Building folder: Python_example 
[build] Starting build
[proc] Executing command: "C:Program FilesCMakebincmake.EXE" --build c:/src/cmake-auto-increment-build-number/Python_example/build --config Debug --target ALL_BUILD -- /maxcpucount:10
[build] CMake is re-running because C:/src/cmake-auto-increment-build-number/Python_example/build/CMakeFiles/generate.stamp is out-of-date.
[build]   the file 'C:/src/cmake-auto-increment-build-number/Python_example/CMakeLists.txt'
[build]   is newer than 'C:/src/cmake-auto-increment-build-number/Python_example/build/CMakeFiles/generate.stamp.depend'
[build]   result='-1'
[build] -- Selecting Windows SDK version 10.0.18362.0 to target Windows 10.0.18363.
[build] -- Configuring done
[build] -- Generating done
[build] -- Build files have been written to: C:/src/cmake-auto-increment-build-number/Python_example/build
[build] Microsoft (R) Build Engine version 16.3.2+e481bbf88 for .NET Framework
[build] Copyright (C) Microsoft Corporation. All rights reserved.
[build] 
[build]   Checking Build System
[build]   Generating version header [C:/Program Files/Python38/Scripts/pipenv.exe run C:/src/cmake-auto-increment-build-number/Python_example/generate.py -o src/version.h config.json]
[build]   Traceback (most recent call last):
[build]     File "C:/src/cmake-auto-increment-build-number/Python_example/generate.py", line 14, in <module>
[build]       from docopt import docopt
[build]   ModuleNotFoundError: No module named 'docopt'
[build] C:Program Files (x86)Microsoft Visual Studio2019CommunityMSBuildMicrosoftVCv160Microsoft.CppCommon.targets(230,5): error MSB6006: "cmd.exe" exited with code 1. [C:srccmake-auto-increment-build-numberPython_examplebuildgenerate_version.vcxproj]
[build] Build finished with exit code 1

我尝试过将add_custom_target()的COMMAND参数更改为${PipEnv} install，但没有效果。我是否需要将其他内容传递给pipenv或CMake命令才能使其正常工作？

Answer 1

这里有几个错误。。。

1. 您的自定义命令输出并依赖于同一个文件，generate.py
   注意：您可以在跟踪中看到一个make错误

2. 默认情况下，add_custom_command将当前源目录作为工作目录，而自定义目标在当前生成目录中运行。
   即两者都在不同的目录中运行->使用了两个不同的pipenv。。。

3. 你应该用pipenv run python而不是pipenv run ${Python3_EXECUTABLE}。。。

4. 这是我的Dockerfile来运行一些测试

# Create a virtual environment with all tools installed
# ref: https://hub.docker.com/_/ubuntu
FROM ubuntu:rolling AS base
LABEL maintainer="[e-mail]"
# Install system build dependencies
ENV PATH=/usr/local/bin:$PATH
RUN apt-get update -qq 
&& apt-get install -yq git wget build-essential 
&& apt-get clean 
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
# Install CMake 3.18.1
RUN wget "https://cmake.org/files/v3.18/cmake-3.18.1-Linux-x86_64.sh" 
&& chmod a+x cmake-3.18.1-Linux-x86_64.sh 
&& ./cmake-3.18.1-Linux-x86_64.sh --prefix=/usr/local/ --skip-license 
&& rm cmake-3.18.1-Linux-x86_64.sh
CMD [ "/usr/bin/bash" ]
# Install Python 3.8
RUN apt-get update -qq 
&& apt-get install -yq python3-dev python3-pip 
&& apt-get clean 
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
# Install pipenv
RUN python3 -m pip install pipenv
FROM base AS devel
WORKDIR /home/sample
COPY . .
FROM devel AS build
RUN cmake -S. -Bbuild
RUN cmake --build build --target all -v

构建：

docker build --target=build --tag so .

播放(即停止一个开发阶段，然后生成一个容器播放(：

docker build --target=devel --tag so .
docker run --rm -it so

所以你修改了CMakeLists.txt

cmake_minimum_required(VERSION 2.8.5)
project(example)
include_directories(${PROJECT_SOURCE_DIR}/src)
find_package(Python3 COMPONENTS Interpreter REQUIRED)
find_program(PipEnv pipenv REQUIRED)
# Create command to compile the generate command
add_custom_command(
OUTPUT Pipfile.lock
COMMAND pwd
COMMAND ${PipEnv} install
COMMENT "Installing pipenv dependencies [${PipEnv} install]"
DEPENDS
Pipfile
WORKING_DIRECTORY
${CMAKE_CURRENT_SOURCE_DIR}
)
add_custom_target(
generate_version
COMMAND pwd
COMMAND ${PipEnv} run python generate.py -o src/version.h config.json
COMMENT "Generating version header [${PipEnv} run ${CMAKE_SOURCE_DIR}/generate.py -o src/version.h config.json]"
DEPENDS
Pipfile.lock
generate.py
config.json
WORKING_DIRECTORY
${CMAKE_CURRENT_SOURCE_DIR}
)
add_subdirectory(src)