repoze.recipe.egg 0.3

脚本生成

demo eggs 定义了一个脚本，但我们没有安装它

>>> ls(sample_buildout, 'bin')
-  buildout

如果您想安装 eggs 提供的脚本，则应使用 scripts 配方

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg:scripts
... eggs = demo<0.3
... find-links = %(server)s
... index = %(server)s/index
... """ % dict(server=link_server))

>>> print system(buildout),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/demo'.

现在我们还可以看到 dmo 脚本定义的脚本

>>> ls(sample_buildout, 'bin')
-  buildout
-  demo

scripts 配方定义了一些附加选项

entry-points

形式为 name=module#attrs 的入口点标识符列表，name 是脚本名称，module 是模块名称，而 attrs 是模块中的（可能带点的）对象名称。此选项在处理未声明入口点的分布时很有用，例如未针对 setuptools 编写的分布。

scripts

控制哪些脚本被生成。值应该是零个或多个标记的列表。每个标记要么是名称，要么是名称后跟一个 '=' 和新名称。仅生成命名的脚本。如果没有给出标记，则禁用脚本生成。如果没有提供此选项，则将生成命名 eggs 定义的脚本。

interpreter

生成一个允许访问具有基于已安装 eggs 设置的路径的 Python 解释器的脚本的名称。

extra-paths

在生成的脚本中包含的额外路径。

initialization

指定一些 Python 初始化代码。这是非常有限的。特别是，请注意，从提供的代码中删除了前导空格。

arguments

以 Python 源的形式指定传递给入口点的参数。

让我们添加一个解释器选项

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg
... eggs = demo<0.3
... find-links = %(server)s
... index = %(server)s/index
... interpreter = py-demo
... """ % dict(server=link_server))

请注意，我们在配方规范中省略了入口点名称。我们之所以能够这样做，是因为 scripts 配方是 repoze.recipe.egg eggs 的默认入口点。

>>> print system(buildout),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/demo'.
Generated interpreter '/sample-buildout/bin/py-demo'.

现在我们还获得了一个py-demo脚本，该脚本可以为我们提供一个带有demo路径及其依赖的eggs的Python提示符。这对于调试和测试非常有用。

>>> ls(sample_buildout, 'bin')
-  buildout
-  demo
-  py-demo

如果我们运行demo脚本，它会打印出一些最小数据

>>> print system(join(sample_buildout, 'bin', 'demo')),
2 2

它打印出的值恰好是已安装模块中定义的值。

我们还可以运行py-demo脚本。这里我们只打印出反映eggs的路径中的位

>>> print system(join(sample_buildout, 'bin', 'py-demo'),
... """import os, sys
... for p in sys.path:
...     if 'demo' in p:
...         print os.path.basename(p)
...
... """).replace('>>> ', '').replace('... ', ''),
... # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
demo-0.2-py2.4.egg
demoneeded-1.2c1-py2.4.egg

egg更新

配方通常获取满足指定条件的最新分布。如果buildout在非最新模式或离线模式，则不会这样做。为了了解它是如何工作的，我们将从demo中移除限制并以非最新模式运行buildout

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg
... find-links = %(server)s
... index = %(server)s/index
... """ % dict(server=link_server))

并运行buildout

>>> print system(buildout+' -N'),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/demo'.

请注意，我们已经移除了eggs选项，eggs默认为部分名称。因为我们移除了eggs选项，所以demo被重新安装。

我们还将以离线模式运行buildout

>>> print system(buildout+' -o'),
Updating demo.

我们没有为demo获取更新

>>> ls(sample_buildout, 'eggs')
-  demo-0.2-py2.3.egg
-  demoneeded-1.2c1-py2.3.egg
-  setuptools-0.6-py2.3.egg
-  zc.buildout-1.0-py2.3.egg

如果我们以默认的在线和最新模式运行buildout，我们将为demo获取更新

>>> print system(buildout),
Updating demo.
Getting distribution for 'demo'.
Got demo 0.4c1.
Generated script '/sample-buildout/bin/demo'.

然后我们将得到一个新的demo egg

>>> ls(sample_buildout, 'eggs')
-  demo-0.2-py2.3.egg
-  demo-0.4c1-py2.3.egg
-  demoneeded-1.2c1-py2.3.egg
-  setuptools-0.6-py2.4.egg
-  zc.buildout-1.0-py2.4.egg

脚本也已更新

>>> print system(join(sample_buildout, 'bin', 'demo')),
4 2

控制脚本生成

您可以使用脚本选项来控制要生成的脚本。例如，要抑制脚本，请使用不带任何参数的脚本选项

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg
... find-links = %(server)s
... index = %(server)s/index
... scripts =
... """ % dict(server=link_server))

>>> print system(buildout),
Uninstalling demo.
Installing demo.

>>> ls(sample_buildout, 'bin')
-  buildout

您还可以控制脚本使用的名称

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg
... find-links = %(server)s
... index = %(server)s/index
... scripts = demo=foo
... """ % dict(server=link_server))

>>> print system(buildout),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/foo'.

>>> ls(sample_buildout, 'bin')
-  buildout
-  foo

指定额外的脚本路径

如果我们需要在脚本中包含额外的路径，我们可以使用extra-paths选项

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg
... find-links = %(server)s
... index = %(server)s/index
... scripts = demo=foo
... extra-paths =
...    /foo/bar
...    /spam/eggs
... """ % dict(server=link_server))

>>> print system(buildout),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/foo'.

让我们看看生成的脚本

>>> cat(sample_buildout, 'bin', 'foo') # doctest: +NORMALIZE_WHITESPACE
#!/usr/local/bin/python2.4
<BLANKLINE>
import sys
sys.path[0:0] = [
  '/sample-buildout/eggs/demo-0.4c1-py2.4.egg',
  '/sample-buildout/eggs/demoneeded-1.2c1-py2.4.egg',
  '/foo/bar',
  '/spam/eggs',
  ]
<BLANKLINE>
import eggrecipedemo
<BLANKLINE>
if __name__ == '__main__':
    eggrecipedemo.main()

指定初始化代码和参数

有时，我们需要做的不仅仅是调用入口点。我们可以使用初始化和参数选项来指定要包含在生成的脚本中的额外代码

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg
... find-links = %(server)s
... index = %(server)s/index
... scripts = demo=foo
... extra-paths =
...    /foo/bar
...    /spam/eggs
... initialization = a = (1, 2
...                       3, 4)
... arguments = a, 2
... """ % dict(server=link_server))

>>> print system(buildout),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/foo'.

>>> cat(sample_buildout, 'bin', 'foo') # doctest: +NORMALIZE_WHITESPACE
#!/usr/local/bin/python2.4
<BLANKLINE>
import sys
sys.path[0:0] = [
  '/sample-buildout/eggs/demo-0.4c1-py2.4.egg',
  '/sample-buildout/eggs/demoneeded-1.2c1-py2.4.egg',
  '/foo/bar',
  '/spam/eggs',
  ]
<BLANKLINE>
a = (1, 2
3, 4)
<BLANKLINE>
import eggrecipedemo
<BLANKLINE>
if __name__ == '__main__':
    eggrecipedemo.main(a, 2)

在这里，我们看到我们指定的初始化代码在设置路径后被添加。注意，如上所述，前导空白已被删除。同样，我们指定的参数代码在入口点调用（到main）中添加。

指定入口点

可以为显式声明的入口点生成脚本。我们可以使用entry-points选项声明入口点

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
...
... [demo]
... recipe = repoze.recipe.egg
... find-links = %(server)s
... index = %(server)s/index
... extra-paths =
...    /foo/bar
...    /spam/eggs
... entry-points = alt=eggrecipedemo:alt other=foo.bar:a.b.c
... """ % dict(server=link_server))

>>> print system(buildout),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/demo'.
Generated script '/sample-buildout/bin/alt'.
Generated script '/sample-buildout/bin/other'.

>>> ls(sample_buildout, 'bin')
-  alt
-  buildout
-  demo
-  other

>>> cat(sample_buildout, 'bin', 'other')
#!/usr/local/bin/python2.4
<BLANKLINE>
import sys
sys.path[0:0] = [
  '/sample-buildout/eggs/demo-0.4c1-py2.4.egg',
  '/sample-buildout/eggs/demoneeded-1.2c1-py2.4.egg',
  '/foo/bar',
  '/spam/eggs',
  ]
<BLANKLINE>
import foo.bar
<BLANKLINE>
if __name__ == '__main__':
    foo.bar.a.b.c()

离线模式

如果buildout离线选项设置为“true”，则不会尝试联系索引服务器

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
... offline = true
...
... [demo]
... recipe = repoze.recipe.egg
... index = eek!
... scripts = demo=foo
... """ % dict(server=link_server))

>>> print system(buildout),
Uninstalling demo.
Installing demo.
Generated script '/sample-buildout/bin/foo'.

控制使用哪个Python

以下假设您已安装Python 2.3。

我们可以通过指定一个部分名称来指定要使用的Python，该部分用于从Python可执行文件读取。默认值是由python buildout选项定义的部分。

我们有一个链接服务器

>>> print get(link_server),
<html><body>
<a href="demo-0.1-py2.3.egg">demo-0.1-py2.3.egg</a><br>
<a href="demo-0.2-py2.3.egg">demo-0.2-py2.3.egg</a><br>
<a href="demo-0.3-py2.3.egg">demo-0.3-py2.3.egg</a><br>
<a href="demo-0.4c1-py2.3.egg">demo-0.4c1-py2.3.egg</a><br>
<a href="demoneeded-1.0.zip">demoneeded-1.0.zip</a><br>
<a href="demoneeded-1.1.zip">demoneeded-1.1.zip</a><br>
<a href="demoneeded-1.2c1.zip">demoneeded-1.2c1.zip</a><br>
<a href="extdemo-1.4.zip">extdemo-1.4.zip</a><br>
<a href="index/">index/</a><br>
<a href="other-1.0-py2.3.egg">other-1.0-py2.3.egg</a><br>
</body></html>

我们有一个示例buildout。让我们更新其配置文件以使用Python 2.3安装demo包。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = demo
... eggs-directory = eggs
... index = https://pythonlang.cn/pypi/
...
... [python2.3]
... executable = %(python23)s
...
... [demo]
... recipe = repoze.recipe.egg
... eggs = demo <0.3
... find-links = %(server)s
... python = python2.3
... interpreter = py-demo
... """ % dict(server=link_server, python23=python2_3_executable))

现在，如果我们运行buildout

>>> import os
>>> os.chdir(sample_buildout)
>>> buildout = os.path.join(sample_buildout, 'bin', 'buildout')
>>> print system(buildout),
Installing demo.
Getting distribution for 'demo<0.3'.
Got demo 0.2.
Getting distribution for 'demoneeded'.
Getting distribution for 'setuptools'.
Got setuptools 0.6.
Got demoneeded 1.2c1.
Generated script '/sample-buildout/bin/demo'.
Generated interpreter '/sample-buildout/bin/py-demo'.

我们将为demo和demoneeded获取Python 2.3的eggs

>>> ls(sample_buildout, 'eggs')
-  demo-0.2-py2.3.egg
-  demoneeded-1.2c1-py2.3.egg
d  setuptools-0.6-py2.3.egg
d  setuptools-0.6-py2.4.egg
-  zc.buildout-1.0-py2.4.egg

并且生成的脚本调用Python 2.3

>>> import sys
>>> if sys.platform == 'win32':
...    script_name = 'demo-script.py'
... else:
...    script_name = 'demo'
>>> f = open(os.path.join(sample_buildout, 'bin', script_name))
>>> f.readline().strip() == '#!' + python2_3_executable
True
>>> print f.read(), # doctest: +NORMALIZE_WHITESPACE
<BLANKLINE>
import sys
sys.path[0:0] = [
  '/sample-buildout/eggs/demo-0.2-py2.3.egg',
  '/sample-buildout/eggs/demoneeded-1.2c1-py2.3.egg',
  ]
<BLANKLINE>
import eggrecipedemo
<BLANKLINE>
if __name__ == '__main__':
    eggrecipedemo.main()

>>> if sys.platform == 'win32':
...     f = open(os.path.join(sample_buildout, 'bin', 'py-demo-script.py'))
... else:
...     f = open(os.path.join(sample_buildout, 'bin', 'py-demo'))
>>> f.readline().strip() == '#!' + python2_3_executable
True
>>> print f.read(), # doctest: +NORMALIZE_WHITESPACE
import sys
<BLANKLINE>
sys.path[0:0] = [
  '/sample-buildout/eggs/demo-0.2-py2.3.egg',
  '/sample-buildout/eggs/demoneeded-1.2c1-py2.3.egg',
  ]
<BLANKLINE>
_interactive = True
if len(sys.argv) > 1:
    import getopt
    _options, _args = getopt.getopt(sys.argv[1:], 'ic:')
    _interactive = False
    for (_opt, _val) in _options:
        if _opt == '-i':
            _interactive = True
        elif _opt == '-c':
            exec _val
<BLANKLINE>
    if _args:
        sys.argv[:] = _args
        execfile(sys.argv[0])
<BLANKLINE>
if _interactive:
    import code
    code.interact(banner="", local=globals())

>>> f.close()

更新

自定义配方通常会检查符合给定规范的新源分布。这可以通过使用buildout non-newest和offline模式来抑制。我们将为extdemo生成一个新的源分布

>>> update_extdemo()

如果我们以non-newest或offline模式运行buildout

>>> print system(buildout+' -N'),
Develop: '/sample-buildout/demo'
Updating extdemo.
Updating demo.

>>> print system(buildout+' -o'),
Develop: '/sample-buildout/demo'
Updating extdemo.
Updating demo.

我们不会收到更新。

>>> ls(sample_buildout, 'develop-eggs')
-  demo.egg-link
d  extdemo-1.4-py2.4-unix-i686.egg
-  repoze.recipe.egg.egg-link

但如果我们以默认的在线和最新模式运行buildout，我们就会

>>> print system(buildout),
Develop: '/sample-buildout/demo'
Updating extdemo.
zip_safe flag not set; analyzing archive contents...
Updating demo.
Generated script '/sample-buildout/bin/demo'.

>>> ls(sample_buildout, 'develop-eggs')
-  demo.egg-link
d  extdemo-1.4-py2.4-linux-i686.egg
d  extdemo-1.5-py2.4-linux-i686.egg
-  repoze.recipe.egg.egg-link

控制使用的版本

我们可以使用egg选项指定特定版本

>>> write('buildout.cfg',
... """
... [buildout]
... develop = demo
... parts = extdemo demo
...
... [extdemo]
... recipe = repoze.recipe.egg:custom
... egg = extdemo ==1.4
... find-links = %(server)s
... index = %(server)s/index
... include-dirs = include
...
... [demo]
... recipe = repoze.recipe.egg
... eggs = demo
...        extdemo ==1.4
... entry-points = demo=demo:main
... """ % dict(server=link_server))

>>> print system(buildout+' -D'),
Develop: '/sample-buildout/demo'
Uninstalling demo.
Uninstalling extdemo.
Installing extdemo.
zip_safe flag not set; analyzing archive contents...
Installing demo.
Generated script '/sample-buildout/bin/demo'.

>>> ls(sample_buildout, 'develop-eggs')
-  demo.egg-link
d  extdemo-1.4-py2.4-linux-i686.egg
-  repoze.recipe.egg.egg-link