Hooks

Conan hooks 功能旨在扩展 Conan 的功能，以便在包创建过程的不同阶段（例如构建前和构建后）执行某些正交操作，例如质量检查。

Hook 结构

Hook 是一个 Python 函数，它将在 Conan 工作流的特定点执行，以自定义客户端行为，而无需修改客户端源代码或配方文件。

这是一个简单的 hook 示例

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.")

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

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

从模块导入

hook 接口应始终放置在 Python 文件中，该文件的名称应以 hook_ 开头，并以 .py 作为扩展名。它还应存储在 <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")

您可以通过导入模块来在 hook 中使用它，就像普通的 Python 代码一样。

hook_printer.py

 from custom_module.custom import my_printer

 def pre_export(conanfile):
     my_printer(conanfile)

Hook 接口

这里可以看到所有可用的 hook 函数的完整示例。

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 packge_id() method.")

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

所有 hook 方法都只填充有相同的单个对象：

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

存储、激活和共享

Hooks 是存储在 <conan_home>/extensions/hooks 文件夹下的 Python 文件，**其文件名应以 hook_ 开头，以 .py 结尾**。

一旦 hook 文件被存储在 hook 文件夹中，hook 就会自动激活。如果存储在子文件夹中，也会自动工作。

要禁用 hook，应将其文件从 hook 文件夹中删除。没有配置可以禁用 hook 但保留文件在 hook 文件夹中。

官方 Hooks

在 Conan hooks GitHub 的独立仓库中，有一些官方维护的 hooks，但它们大部分只与 Conan 1.x 兼容，因此请务必先检查 README 以获取有关哪些 hooks 与 Conan v2 兼容的信息。