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 客户端执行。

从模块导入

钩子接口应始终放置在 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")

它可以像常规 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 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.")

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

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

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

存储、激活和共享

钩子是存储在 <conan_home>/extensions/hooks 文件夹下的 Python 文件，并且它们的文件名应以 hook_ 开头，并以 .py 扩展名结尾。

钩子的激活是自动完成的，一旦钩子文件存储在钩子文件夹中。如果存储在子文件夹中，它也自动工作。

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

官方钩子

有一些官方维护的钩子在其自己的仓库中，位于 Conan hooks GitHub，但大多数仅与 Conan 1.x 兼容，所以，请先查看 README，以获取哪些钩子与 Conan v2 兼容的信息。