zc.metarecipe 0.2.1

简单的元食谱示例

让我们看看一个相当简单的元食谱示例。首先，考虑一个构建数据库部署的Buildout配置

[buildout]
parts = ctl pack

[deployment]
recipe = zc.recipe.deployment
name = ample
user = zope

[ctl]
recipe = zc.recipe.rhrc
deployment = deployment
chkconfig = 345 99 10
parts = main

[main]
recipe = zc.zodbrecipes:server
deployment = deployment
address = 8100
path = /var/databases/ample/main.fs
zeo.conf =
   <zeo>
      address ${:address}
   </zeo>
   %import zc.zlibstorage
   <zlibstorage>
     <filestorage>
        path ${:path}
     </filestorage>
   </zlibstorage>

[pack]
recipe = zc.recipe.deployment:crontab
deployment = deployment
times = 1 2 * * 6
command = ${buildout:bin-directory}/zeopack -d3 -t00 ${main:address}

此构建过程不是构建软件，而是构建配置，用于使用已部署的软件部署数据库配置。然而，对于本文档而言，这些细节并不重要。

我们不需要每次都手动编写上述配置，而是可以编写一个元配方来自动生成它。我们将按照以下方式使用我们的元配方：

[buildout]
parts = ample

[ample]
recipe = com.example.ample:db
path = /var/databases/ample/main.fs

这里的理念是元配方允许我们指定所需的最小信息。元配方通常自动化与应用程序和组织相关的策略和假设。例如，上面的例子假设我们希望在周六打包到3天前。

现在，让我们看看自动完成此任务的元配方：

import zc.metarecipe

class Recipe(zc.metarecipe.Recipe):

    def __init__(self, buildout, name, options):
        super(Recipe, self).__init__(buildout, name, options)

        self.parse('''
            [deployment]
            recipe = zc.recipe.deployment
            name = %s
            user = zope
            ''' % name)

        self['main'] = dict(
            recipe = 'zc.zodbrecipes:server',
            deployment = 'deployment',
            address = 8100,
            path = options['path'],
            **{
              'zeo.conf': '''
                <zeo>
                  address ${:address}
                </zeo>

                %import zc.zlibstorage

                <zlibstorage>
                  <filestorage>
                    path ${:path}
                  </filestorage>
                </zlibstorage>
                '''}
            )

        self.parse('''
            [pack]
            recipe = zc.recipe.deployment:crontab
            deployment = deployment
            times = 1 2 * * 6
            command =
              ${buildout:bin-directory}/zeopack -d3 -t00 ${main:address}

            [ctl]
            recipe = zc.recipe.rhrc
            deployment = deployment
            chkconfig = 345 99 10
            parts = main
            ''')

元配方只是向构建过程中添加组件。它是通过调用继承的 __setitem__ 和 parse 方法来实现的。parse 方法仅接受 ConfigParser 语法中的字符串。当我们想要添加静态或几乎静态的组件数据时，它很有用。当我们对组件数据有非平凡的计算时，setitem 语法很有用。

我们添加组件的顺序很重要。当添加组件时，任何字符串替换和其他依赖关系都会被评估，因此必须先定义引用的组件。这就是为什么，例如，pack 组件是在 main 组件之后添加的原因。

请注意，元配方为其中一个选项提供了一个整数。除了字符串之外，还可以提供整数和 unicode 值。

测试

现在，让我们来测试它。我们将使用 zc.metarecipe.testing 模块提供的模拟构建过程来测试它，而不是实际运行 buildout。

>>> import zc.metarecipe.testing
>>> buildout = zc.metarecipe.testing.Buildout()

>>> _ = Recipe(buildout, 'ample', dict(path='/var/databases/ample/main.fs'))
[deployment]
name = ample
recipe = zc.recipe.deployment
user = zope
[main]
address = 8100
deployment = deployment
path = /var/databases/ample/main.fs
recipe = zc.zodbrecipes:server
zeo.conf = <zeo>
                    address ${:address}
                  </zeo>
<BLANKLINE>
                  %import zc.zlibstorage
<BLANKLINE>
                  <zlibstorage>
                    <filestorage>
                      path ${:path}
                    </filestorage>
                  </zlibstorage>
[ctl]
chkconfig = 345 99 10
deployment = deployment
parts = main
recipe = zc.recipe.rhrc
[pack]
command = ${buildout:bin-directory}/zeopack -d3 -t00 ${main:address}
deployment = deployment
recipe = zc.recipe.deployment:crontab
times = 1 2 * * 6

当我们调用我们的配方时，它将向测试构建过程中添加部分，并将这些部分简单地打印出来，以便我们可以验证是否生成了正确的数据。

就是这样。

变更