Hooks¶

Conan 的钩子功能旨在扩展 Conan 的功能，以便在软件包创建过程的不同阶段执行某些正交操作，例如一些质量检查，例如预构建和后构建。

钩子结构¶

钩子是一个 Python 函数，将在 Conan 工作流程的某些点执行，以自定义客户端行为，而无需修改客户端源代码或配方源代码。

这是一个简单的钩子示例

hook_example.py¶

 from conan.tools.files import load

 def pre_export(conanfile):
     for field in ["url", "license", "description"]:
         field_value = getattr(conanfile, field, None)
         if not field_value:
             conanfile.output.error(f"[REQUIRED ATTRIBUTES] Conanfile doesn't have '{field}'.
                                       It is recommended to add it as attribute.")

此钩子在导出配方之前检查配方内容。基本上，pre_export() 函数检查 conanfile 对象的属性，以查看是否存在 URL、许可证和描述，如果缺少，则通过 conanfile.output 向用户发出警告。这在将配方导出到本地缓存之前完成。

可以执行任何类型的 Python 脚本。您可以创建全局函数并在不同的钩子函数中调用它们，从相对模块导入并警告、报错，甚至引发异常以中止 Conan 客户端执行。

从模块导入¶

钩子接口应始终放置在以 hook_ 开头且以 .py 结尾的 Python 文件中。它还应存储在 <conan_home>/extensions/hooks 文件夹中。但是，如果您在系统中安装了它们，或者它们与 Conan 一起安装，则可以使用已导入模块中的功能

hook_example.py¶

 import requests
 from conan.tools.files import replace_in_file

 def post_package(conanfile):
     if not os.path.isdir(os.path.join(conanfile.package_folder, "licenses")):
         response = requests.get('https://api.github.com/repos/company/repository/contents/LICENSE')

您还可以从相对模块导入功能

hooks
├── custom_module
│   ├── custom.py
│   └── __init__.py
└── hook_printer.py

在我的 custom_module 的 custom.py 中，有

custom.py¶

 def my_printer(conanfile):
     conanfile.output.info("my_printer(): CUSTOM MODULE")

并且可以像常规 Python 一样导入模块来在钩子中使用它

hook_printer.py¶

 from custom_module.custom import my_printer

 def pre_export(conanfile):
     my_printer(conanfile)

钩子接口¶

您可以在这里看到所有可用钩子函数的完整示例

hook_full.py¶

 def pre_export(conanfile):
     conanfile.output.info("Running before to execute export() method.")

 def post_export(conanfile):
     conanfile.output.info("Running after of executing export() method.")

 def pre_validate(conanfile):
     conanfile.output.info("Running before executing the validate() method.")

 def post_validate(conanfile):
     conanfile.output.info("Running after executing the validate() method.")

 def pre_source(conanfile):
     conanfile.output.info("Running before to execute source() method.")

 def post_source(conanfile):
     conanfile.output.info("Running after of executing source() method.")

 def pre_generate(conanfile):
     conanfile.output.info("Running before to execute generate() method.")

 def post_generate(conanfile):
     conanfile.output.info("Running after of executing generate() method.")

 def pre_build(conanfile):
     conanfile.output.info("Running before to execute build() method.")

 def post_build(conanfile):
     conanfile.output.info("Running after of executing build() method.")

 def post_build_fail(conanfile):
     conanfile.output.info("Running after failed execution of build() method.")

 def pre_package(conanfile):
     conanfile.output.info("Running before to execute package() method.")

 def post_package(conanfile):
     conanfile.output.info("Running after of executing package() method.")

 def pre_package_info(conanfile):
     conanfile.output.info("Running before to execute package_info() method.")

 def post_package_info(conanfile):
     conanfile.output.info("Running after of executing package_info() method.")

 # Note that pre_package_id() hook doesn't exist yet, so far there hasn't been
 # a use case
 def post_package_id(conanfile):
     conanfile.output.info("Running after executing package_id() method.")

钩子的函数旨在对它们的执行进行自我描述。例如，pre_package() 函数在执行配方的 package() 方法之前调用。

所有钩子方法都只填充了同一个对象

conanfile：它是一个从接收 Conan 命令的配方中加载的常规 ConanFile 对象。它具有其正常的属性和动态对象，例如 build_folder、package_folder、output、dependencies、options…

官方钩子¶

在 Conan hooks GitHub 中有官方维护的钩子，但大多数仅与 Conan 1.x 兼容，因此请首先检查 README 以获取有关哪些钩子与 Conan v2 兼容的信息。