conan create¶
$ conan create -h
usage: conan create [-h] [-v [V]] [-cc CORE_CONF] [-f FORMAT] [--name NAME]
[--version VERSION] [--user USER] [--channel CHANNEL]
[-l LOCKFILE] [--lockfile-partial]
[--lockfile-out LOCKFILE_OUT] [--lockfile-clean]
[--lockfile-overrides LOCKFILE_OVERRIDES] [-b BUILD]
[-r REMOTE | -nr] [-u [UPDATE]] [-pr PROFILE]
[-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST]
[-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD]
[-o:h OPTIONS_HOST] [-o:a OPTIONS_ALL] [-s SETTINGS]
[-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST]
[-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD]
[-c:h CONF_HOST] [-c:a CONF_ALL] [--build-require]
[-tf TEST_FOLDER] [-tm] [-bt BUILD_TEST]
path
Create a package.
positional arguments:
path Path to a folder containing a recipe (conanfile.py)
options:
-h, --help show this help message and exit
-v [V] Level of detail of the output. Valid options from less
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
-cc CORE_CONF, --core-conf CORE_CONF
Define core configuration, overwriting global.conf
values. E.g.: -cc core:non_interactive=True
-f FORMAT, --format FORMAT
Select the output format: json
--name NAME Provide a package name if not specified in conanfile
--version VERSION Provide a package version if not specified in
conanfile
--user USER Provide a user if not specified in conanfile
--channel CHANNEL Provide a channel if not specified in conanfile
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile. Use --lockfile="" to avoid
automatic use of existing 'conan.lock' file
--lockfile-partial Do not raise an error if some dependency is not found
in lockfile
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
--lockfile-clean Remove unused entries from the lockfile
--lockfile-overrides LOCKFILE_OVERRIDES
Overwrite lockfile overrides
-b BUILD, --build BUILD
Optional, specify which packages to build from source.
Combining multiple '--build' options on one command
line is allowed. Possible values: --build="*" Force
build from source for all packages. --build=never
Disallow build for all packages, use binary packages
or fail if a binary package is not found, it cannot be
combined with other '--build' options. --build=missing
Build packages from source whose binary package is not
found. --build=cascade Build packages from source that
have at least one dependency being built from source.
--build=[pattern] Build packages from source whose
package reference matches the pattern. The pattern
uses 'fnmatch' style wildcards. --build=~[pattern]
Excluded packages, which will not be built from the
source, whose package reference matches the pattern.
The pattern uses 'fnmatch' style wildcards.
--build=missing:[pattern] Build from source if a
compatible binary does not exist, only for packages
matching pattern.
-r REMOTE, --remote REMOTE
Look in the specified remote or remotes server
-nr, --no-remote Do not use remote, resolve exclusively in the cache
-u [UPDATE], --update [UPDATE]
Will install newer versions and/or revisions in the
local cache for the given reference name, or all
references in the graph if no argument is supplied.
When using version ranges, it will install the latest
version that satisfies the range. It will update to
the latest revision for the resolved version range.
-pr PROFILE, --profile PROFILE
Apply the specified profile. By default, or if
specifying -pr:h (--profile:host), it applies to the
host context. Use -pr:b (--profile:build) to specify
the build context, or -pr:a (--profile:all) to specify
both contexts at once
-pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD
-pr:h PROFILE_HOST, --profile:host PROFILE_HOST
-pr:a PROFILE_ALL, --profile:all PROFILE_ALL
-o OPTIONS, --options OPTIONS
Apply the specified options. By default, or if
specifying -o:h (--options:host), it applies to the
host context. Use -o:b (--options:build) to specify
the build context, or -o:a (--options:all) to specify
both contexts at once. Example:
-o="pkg/*:with_qt=True"
-o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD
-o:h OPTIONS_HOST, --options:host OPTIONS_HOST
-o:a OPTIONS_ALL, --options:all OPTIONS_ALL
-s SETTINGS, --settings SETTINGS
Apply the specified settings. By default, or if
specifying -s:h (--settings:host), it applies to the
host context. Use -s:b (--settings:build) to specify
the build context, or -s:a (--settings:all) to specify
both contexts at once. Example: -s="compiler=gcc"
-s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD
-s:h SETTINGS_HOST, --settings:host SETTINGS_HOST
-s:a SETTINGS_ALL, --settings:all SETTINGS_ALL
-c CONF, --conf CONF Apply the specified conf. By default, or if specifying
-c:h (--conf:host), it applies to the host context.
Use -c:b (--conf:build) to specify the build context,
or -c:a (--conf:all) to specify both contexts at once.
Example:
-c="tools.cmake.cmaketoolchain:generator=Xcode"
-c:b CONF_BUILD, --conf:build CONF_BUILD
-c:h CONF_HOST, --conf:host CONF_HOST
-c:a CONF_ALL, --conf:all CONF_ALL
--build-require Whether the package being created is a build-require
(to be used as tool_requires() by other packages)
-tf TEST_FOLDER, --test-folder TEST_FOLDER
Alternative test folder name. By default it is
"test_package". Use "" to skip the test stage
-tm, --test-missing Run the test_package checks only if the package is
built from source but not if it already existed (using
--build=missing)
-bt BUILD_TEST, --build-test BUILD_TEST
Same as '--build' but only for the test_package
requires. By default if not specified it will take the
'--build' value if specified
conan create 命令根据 path 中指定的配方创建包。
此命令将首先**导出**配方到本地缓存，然后构建并创建包。如果找到 test_package 文件夹（您可以使用 -tf 参数或 test_package_folder 配方属性更改文件夹名称），则该命令将运行使用者项目以确保包已正确创建。查看测试 Conan 包部分，了解有关如何测试 Conan 包的更多信息。
提示
有时您想**跳过/禁用测试阶段**。在这种情况下，您可以通过将空值作为 -tf 参数传递来跳过/禁用测试包阶段。
$ conan create . --test-folder=""
您可能还想执行 conan create . --build=missing，以便如果服务器中已存在二进制文件，则不会构建包。如果您还想在二进制文件已存在时避免 test_package 步骤，则可以应用 conan create . --build=missing --test-missing，它只会在从源代码构建二进制文件时启动测试包。
使用带构建需求的 conan create¶
--build-require 参数允许使用“构建”上下文的配置和设置创建包，就像它是 build_require 一样。此功能允许以与稍后使用它们的方式一致的方式创建包。
$ conan create . --name=cmake --version=3.23.1 --build-require
Conan create 输出¶
conan create ... --format=json 创建一个包含完整依赖关系图信息的 json 输出。此 json 与 conan graph info 创建的 json 相同（请参阅图形信息 json 格式），并包含有关二进制文件的扩展信息，例如更完整的 cpp_info 字段。此生成的 json 是正在创建的包配方的依赖关系图，不包括所有 test_package 和 test_package/conanfile.py 的其他可能的依赖关系。这些依赖关系仅存在于 test_package 功能中，因此不是“主要”产品或包的一部分。如果您有兴趣捕获包含 test_package 的依赖关系图（在大多数情况下可能没有必要），那么您可以通过单独运行 conan test 命令来实现。
使用 --lockfile-out 参数创建的锁定文件也是如此。锁定文件将仅包含创建的包及其传递依赖项版本，但不会包含 test_package 或 test_package/conanfile.py 的传递依赖项。可以使用 conan test 命令捕获包含这些内容的锁定文件（尽管同样，这可能不是真正必要的）。
注意
最佳实践
通常，应避免 test_package/conanfile.py 具有除被测包之外的其他依赖项。 test_package 功能应作为一项简单的检查，以确保包已正确创建。向 test_package 添加额外的依赖项可能表明检查并不简单，或者其功能被误用。如果出于任何原因，您的 test_package 具有其他依赖项，您可以使用 --build-test 参数控制它们的构建。
方法执行顺序¶
conan create 按以下顺序执行方法 conanfile.py
- 将配方导出到缓存
init()set_name()set_version()export()export_sources()
- 计算依赖关系图
ìnit()config_options()configure()requirements()build_requirements()
- 计算必要的包
validate_build()validate()package_id()layout()system_requirements()
- 安装包
source()build_id()generate()build()package()package_info()
如果包不是从源代码构建的，则不会调用“安装包”步骤中的步骤 generate()、build()、package()。
之后，如果您在项目中有一个名为 test_package 的文件夹，或者您使用 --test-folder 标志调用 conan create 命令，则该命令将按以下顺序调用文件夹内 conanfile.py 文件的方法。
- 启动 test_package
(测试包)
init()(测试包)
set_name()(测试包)
set_version()
- 计算依赖关系图
(测试包)
config_options()(测试包)
configure()(测试包)
requirements()(测试包)
build_requirements()ìnit()config_options()configure()requirements()build_requirements()
- 计算必要的包
validate_build()validate()package_id()layout()(测试包)
validate_build()(测试包)
validate()(测试包)
package_id()(测试包)
layout()system_requirements()(测试包)
system_requirements()
- 安装包
build_id()generate()build()package_info()
- 测试包
(测试包)
build()(测试包)
test()
带 (测试包) 的函数属于 test_package 文件夹中的 conanfile.py。如果项目已安装，则会跳过“安装包”步骤中的步骤 build_id()、generate()、build()。通常，它应该像之前“安装包”步骤中安装的那样安装。
另请参阅
在专用教程中阅读有关创建包的更多信息。
阅读有关测试 Conan 包的更多信息。