工作区文件

警告

此功能是新的孵化功能的一部分。这意味着它正在开发中，并正在寻找用户测试和反馈。有关更多信息，请参阅孵化部分。

工作区由 conanws.yml 和/或 conanws.py 文件定义，这些文件将定义“根”工作区文件夹。

conanws.yml

工作区最基本的实现是 conanws.yml 文件。它定义了工作区的 packages（可编辑包）。例如，一个定义了 2 个 packages 的工作区 conanws.yml 可以是

conanws.yml

packages:
   - path: dep1
     ref: dep1/0.1
   - path: dep2
     ref: dep2/0.1

此外，它可能没有 ref 字段，并让 Conan 从相应的 path/conanfile.py 读取名称/版本

conanws.yml

packages:
   - path: dep1
   - path: dep2

conanws.py

一个 conanws.yml 可以通过一个更强大的 conanws.py 进行扩展，它遵循与 ConanFile 及其 conandata.yml 相同的关系。如果我们想动态定义 packages，例如根据文件夹中是否存在某些 name.txt 和 version.txt 文件，那么包可以在 conanws.py 中定义为

conanws.py

import os
from conan import Workspace

class MyWorkspace(Workspace):

   def packages(self):
      result = []
      for f in os.listdir(self.folder):
         if os.path.isdir(os.path.join(self.folder, f)):
            with open(os.path.join(self.folder, f, "name.txt")) as fname:
               name = fname.read().strip()
            with open(os.path.join(self.folder, f, "version.txt")) as fversion:
               version = fversion.read().strip()
            result.append({"path": f, "ref": f"{name}/{version}"})
      return result

还可以使用 Workspace.load_conanfile() 助手在 set_name() 和 set_version() 方法中重用 conanfile.py 逻辑

conanws.py

import os
from conan import Workspace

class MyWorkspace(Workspace):
   def packages(self):
      result = []
      for f in os.listdir(self.folder):
         if os.path.isdir(os.path.join(self.folder, f)):
            conanfile = self.load_conanfile(f)
            result.append({"path": f, "ref": f"{conanfile.name}/{conanfile.version}"})
      return result

conanws.py 超级构建选项

用于超级构建工作区文件的 conanws.py 可以通过两种不同的方式管理选项

• 它可以使用正常的 conanfile.py 语法定义自己的 options，这样为超级项目生成的 conan_toolchain.cmake 就可以使用这些输入。

• 它可以使用 workspace_packages_options 收集工作区包的选项，并以任何用户自定义的方式处理它们。

超级项目选项

一个 conanws.py 必须在 ConanFile 类中定义超级构建的选项，并在 generate() 方法中使用这些选项，就像 conanfile.py 文件通常发生的那样，类似于

from conan import ConanFile, Workspace

class MyWs(ConanFile):
   settings = "arch", "build_type"
   options = {"myoption": [1, 2, 3]}

   def generate(self):
      self.output.info(f"Generating with my option {self.options.myoption}!!!!")

class Ws(Workspace):
   def root_conanfile(self):
      return MyWs

然后，可以通过常规语法、配置文件或命令行提供选项

$ conan workspace super-install -of=build -o "*:myoption=1"
> conanws.py base project Conanfile: Generating with my option 1!!!!

请注意，这可能与工作区包中定义的 options 重叠，因为对于超级项目，这些选项将被简单地忽略，并且只有超级项目的选项才会被考虑用于生成 conan_toolchain.cmake。例如，如果希望 conan_toolchain.cmake 在定义类似 -o "*:shared=True" 时正确定义 BUILD_SHARED_LIBS，那么 conanws.py 可以定义一个 shared 选项，因为当工作区包在依赖图中折叠以建模超级项目时，具有 shared 选项信息的工作区包将被丢弃。

包选项

第二种替代方案是收集已折叠的工作区包的 options。请记住，在最终的依赖图中，工作区包不再被表示，因为它们不再是单个包，而是当前超级构建的一部分。访问其选项信息的方式是通过 workspace_packages_options，并且该信息可以在 generate() 方法中使用，以在超级构建项目级别执行任何所需的操作。

因此，假设一个包含 dep/0.1 包的工作区，其中包含标准 shared 选项，定义了以下超级构建 ConanFile

from conan import ConanFile, Workspace

class MyWs(ConanFile):
   def generate(self):
      for pkg, options in self.workspace_packages_options.items():
         for k, v in options.items():
               self.output.info(f"Generating with opt {pkg}:{k}={v}!!!!")

class Ws(Workspace):
   def root_conanfile(self):
      return MyWs

然后，当定义工作区包选项时，工作区 ConanFile 可以收集它们。

$ conan workspace super-install -of=build -o "*:shared=True"
> conanws.py base project Conanfile: Generating with opt dep/0.1:shared=True!!!!!!!!

注意

实际上，工作区创建者有责任决定如何处理这些选项，无论是通过定义自己的选项还是收集工作区包的选项。请注意，不可能将工作区包选项自动映射到超级项目，因为选项是按包定义的。两个不同的包可能具有不同的 shared=True 和 shared=False 值。此外，通常情况下，对生成的工具链文件的影响是自定义的，并在每个包的 generate() 方法中实现。这种影响是程序性的（而不是声明性的），将所有这些影响聚合到一个工具链中将极具挑战性。

另请参阅

阅读工作区教程部分。