z3c.recipe.filetemplate 2.2.0

path-repr的演示

假设我们想在bin目录中创建一个自定义Python脚本。它将从buildout根目录下的data目录中的一个文件中打印一些信息。这是模板。

>>> write(sample_buildout, 'template', 'bin', 'dosomething.py.in', '''\
... #!${buildout:executable}
... ${python-relative-path-setup}
... f = open(${buildout:directory/data/info.csv|path-repr})
... print f.read()
... ''')
>>> os.chmod(
...     os.path.join(
...         sample_buildout, 'template', 'bin', 'dosomething.py.in'),
...     0711)

如果我们将此模板与relative-paths设置为false进行评估，结果不应该令人惊讶。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = message
...
... [message]
... recipe = z3c.recipe.filetemplate
... source-directory = template
... """)

>>> print system(buildout)
Uninstalling message.
Installing message.

>>> cat(sample_buildout, 'bin', 'dosomething.py') # doctest: +ELLIPSIS
#!...
<BLANKLINE>
f = open('/.../sample-buildout/data/info.csv')
print f.read()

${python-relative-path-setup}评估为空字符串。路径是绝对的和带引号的。

如果我们使用relative-paths设置为true来评估它，结果将大得多。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = message
... relative-paths = true
...
... [message]
... recipe = z3c.recipe.filetemplate
... source-directory = template
... """)

>>> print system(buildout)
Uninstalling message.
Installing message.

>>> cat(sample_buildout, 'bin', 'dosomething.py') # doctest: +ELLIPSIS
#!...
import os, imp
# Get path to this file.
if __name__ == '__main__':
    _z3c_recipe_filetemplate_filename = __file__
else:
    # If this is an imported module, we want the location of the .py
    # file, not the .pyc, because the .py file may have been symlinked.
    _z3c_recipe_filetemplate_filename = imp.find_module(__name__)[1]
# Get the full, non-symbolic-link directory for this file.
_z3c_recipe_filetemplate_base = os.path.dirname(
    os.path.abspath(os.path.realpath(_z3c_recipe_filetemplate_filename)))
# Ascend to buildout root.
_z3c_recipe_filetemplate_base = os.path.dirname(
    _z3c_recipe_filetemplate_base)
def _z3c_recipe_filetemplate_path_repr(path):
    "Return absolute version of buildout-relative path."
    return os.path.join(_z3c_recipe_filetemplate_base, path)
<BLANKLINE>
f = open(_z3c_recipe_filetemplate_path_repr('data/info.csv'))
print f.read()

这是一段相当多的代码。您可能会想知道为什么我们不直接使用‘..’来表示父目录。原因是我们希望我们的脚本可以从文件系统的任何地方使用。如果我们使用‘..’来构建相对于生成的文件的路径，那么这些路径将只能从某些目录中工作。

这就是路径表示法的原理。如果您想在 buildout 中支持相对路径，这会非常有用。现在让我们来看看 shell-path 过滤器。

演示 shell-path

也许您想编写一些 shell 脚本。shell-path 过滤器可以帮助您相对容易地支持 buildout 的相对路径。

目前，shell-path 过滤器只支持 POSIX，如前所述。

用法与 path-repr 过滤器非常相似。在使用它之前，您需要包含 ${shell-relative-path-setup}，就像在使用 path-repr 之前包含 ${python-relative-path-setup} 一样。

假设我们想在 bin 目录中创建一个自定义 shell 脚本。它将从 buildout 根目录下的 data 目录中的文件打印一些信息。以下是模板。

>>> write(sample_buildout, 'template', 'bin', 'dosomething.sh.in', '''\
... #!/bin/sh
... ${shell-relative-path-setup}
... cat ${buildout:directory/data/info.csv|shell-path}
... ''')
>>> os.chmod(
...     os.path.join(
...         sample_buildout, 'template', 'bin', 'dosomething.sh.in'),
...     0711)

如果 relative-paths 设置为 false（默认值），则结果很简单。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = message
...
... [message]
... recipe = z3c.recipe.filetemplate
... source-directory = template
... """)

>>> print system(buildout)
Uninstalling message.
Installing message.

>>> cat(sample_buildout, 'bin', 'dosomething.sh') # doctest: +ELLIPSIS
#!/bin/sh
<BLANKLINE>
cat /.../sample-buildout/data/info.csv

${shell-relative-path-setup} 评估为空字符串。路径是绝对的。

现在让我们看看当 relative-paths 设置为 true 时的较大代码。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = message
... relative-paths = true
...
... [message]
... recipe = z3c.recipe.filetemplate
... source-directory = template
... """)

>>> print system(buildout)
Uninstalling message.
Installing message.

>>> cat(sample_buildout, 'bin', 'dosomething.sh') # doctest: +ELLIPSIS
#!/bin/sh
# Get full, non-symbolic-link path to this file.
Z3C_RECIPE_FILETEMPLATE_FILENAME=`\
    readlink -f "$0" 2>/dev/null || \
    realpath "$0" 2>/dev/null || \
    type -P "$0" 2>/dev/null`
# Get directory of file.
Z3C_RECIPE_FILETEMPLATE_BASE=`dirname ${Z3C_RECIPE_FILETEMPLATE_FILENAME}`
# Ascend to buildout root.
Z3C_RECIPE_FILETEMPLATE_BASE=`dirname ${Z3C_RECIPE_FILETEMPLATE_BASE}`
<BLANKLINE>
cat "$Z3C_RECIPE_FILETEMPLATE_BASE"/data/info.csv

与 Python 代码一样，我们不只用‘..’来表示父目录，因为我们想让我们的脚本可以从文件系统的任何地方使用。

获取任意依赖路径

您可以在配方中指定 eggs 和 extra-paths。该机制与 zc.recipe.egg 提供的机制相同，因此有关 find-links 和 index 等相关选项也是可用的。

如果您这样做，将计算依赖项的路径。它们将以列表的形式在解释选项的命名空间中可用，作为 paths。此外，在模板的选项中还将提供三个预定义选项。

如果 paths 是路径，shell_path 是 shell-path 过滤器，path_repr 是 path-repr 过滤器，则预定义选项大致定义如下

os-paths（用于 shell 脚本）

(os.pathsep).join(shell_path(path) for path in paths)

string-paths（用于 Python 脚本）

',\n '.join(path_repr(path) for path in paths)

space-paths（用于 shell 脚本）

' '.join(shell_path(path) for path in paths)

因此，如果您想支持 relative-paths 选项，则应在模板的顶部相应地包含 ${shell-relative-path-setup}（用于 os-paths 和 space-paths）或 ${python-relative-path-setup}（用于 string-paths）。

让我们考虑一个简单的示例。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = message
...
... [message]
... recipe = z3c.recipe.filetemplate
... files = helloworld.txt
... eggs = demo<0.3
...
... find-links = %(server)s
... index = %(server)s/index
... """ % dict(server=link_server))

relative-paths 选项为 false，这是默认值。

>>> write(sample_buildout, 'helloworld.txt.in',
... """
... Hello!  Here are the paths for the ${eggs} eggs.
... OS paths:
... ${os-paths}
... ---
... String paths:
... ${string-paths}
... ---
... Space paths:
... ${space-paths}
... """)

>>> print system(buildout)
Getting distribution for 'demo<0.3'.
Got demo 0.2.
Getting distribution for 'demoneeded'.
Got demoneeded 1.2c1.
Uninstalling message.
Installing message.

>>> cat(sample_buildout, 'helloworld.txt') # doctest:+ELLIPSIS
Hello!  Here are the paths for the demo<0.3 eggs.
OS paths:
/.../eggs/demo-0.2...egg:/.../eggs/demoneeded-1.2c1...egg
---
String paths:
'/.../eggs/demo-0.2...egg',
'/.../eggs/demoneeded-1.2c1...egg'
---
Space paths:
/.../eggs/demo-0.2...egg /.../eggs/demoneeded-1.2c1...egg

您还可以指定 extra-paths，它将位于 egg 路径的末尾。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = message
...
... [message]
... recipe = z3c.recipe.filetemplate
... files = helloworld.txt
... eggs = demo<0.3
... extra-paths = ${buildout:directory}/foo
...
... find-links = %(server)s
... index = %(server)s/index
... """ % dict(server=link_server))

>>> print system(buildout)
Uninstalling message.
Installing message.

>>> cat(sample_buildout, 'helloworld.txt') # doctest:+ELLIPSIS
Hello!  Here are the paths for the demo<0.3 eggs.
OS paths:
/...demo...:/...demoneeded...:/.../sample-buildout/foo
---
String paths:
'/...demo...',
'/...demoneeded...',
'/.../sample-buildout/foo'
---
Space paths:
/...demo... /...demoneeded... .../sample-buildout/foo

为了强调 relative-paths 选项的影响，让我们看看当我们设置 relative-paths 为 True 时会发生什么。

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = message
... relative-paths = true
...
... [message]
... recipe = z3c.recipe.filetemplate
... files = helloworld.txt
... eggs = demo<0.3
... extra-paths = ${buildout:directory}/foo
...
... find-links = %(server)s
... index = %(server)s/index
... """ % dict(server=link_server))

>>> print system(buildout)
Uninstalling message.
Installing message.

>>> cat(sample_buildout, 'helloworld.txt') # doctest:+ELLIPSIS
Hello!  Here are the paths for the demo<0.3 eggs.
OS paths:
"$Z3C_RECIPE_FILETEMPLATE_BASE"/eggs/demo-0.2-py...egg:"$Z3C_RECIPE_FILETEMPLATE_BASE"/eggs/demoneeded-1.2c1-py...egg:"$Z3C_RECIPE_FILETEMPLATE_BASE"/foo
---
String paths:
_z3c_recipe_filetemplate_path_repr('eggs/demo-0.2-py...egg'),
_z3c_recipe_filetemplate_path_repr('eggs/demoneeded-1.2c1-py...egg'),
_z3c_recipe_filetemplate_path_repr('foo')
---
Space paths:
"$Z3C_RECIPE_FILETEMPLATE_BASE"/eggs/demo-0.2-py...egg "$Z3C_RECIPE_FILETEMPLATE_BASE"/eggs/demoneeded-1.2c1-py...egg "$Z3C_RECIPE_FILETEMPLATE_BASE"/foo

请记住，除非您在模板的顶部相应地包含 ${shell-relative-path-setup}（用于 os-paths 和 space-paths）或 ${python-relative-path-setup}（用于 string-paths），否则您的脚本实际上是不会工作的。

[buildout]
parts = scripts message
relative-paths = true

[scripts]
recipe = z3c.recipe.scripts
eggs = demo<0.3

[message]
recipe = z3c.recipe.filetemplate
files = helloworld.py

功能

• 添加对使用exclude-directories选项排除source-directory的一些子目录的支持。[Bruno Binet]

修复

• 在测试额外中添加了对未声明但必需的测试依赖项zope.testing。

• 添加了对z3c.recipe.scripts的测试依赖项，因为它需要较新的zc.buildout版本。

• 使用python的doctest模块而不是已弃用的zope.testing.doctest。

功能

• 通过允许路径后缀的扩展语法启用跨平台路径。例如：如果${buildout:directory}在POSIX系统上解析为/sample_buildout，而在Windows中为C:\sample_buildout，则${buildout:directory/foo.txt}将分别解析为/sample_buildout/foo.txt和C:\sample_buildout\foo.txt。

• 通过管道语法添加过滤器，类似于UNIX管道或Django模板过滤器。简单示例：如果${name}解析为harry，则${name|upper}解析为HARRY。简单的字符串过滤器是upper、lower、title和capitalize，就像Python字符串方法一样。也请参阅下一项。

• 添加了对buildout相对路径选项的支持。Shell脚本应在执行具有buildout生成的路径的命令之前包含${shell-relative-path-setup}。Python脚本应类似地使用${python-relative-path-setup}。当使用buildout相对路径选项时，${os-paths}（shell）、${space-paths}（shell）和${string-paths}（Python）将具有相对路径。${path-repr}过滤器用于Python脚本中的单个绝对路径到相对路径的转换，而shell-path过滤器用于shell脚本。路径后缀可以与这些过滤器结合使用，因此，如果buildout的相对路径选项为true，${buildout:directory/foo.txt|path-repr}将生成到foo.txt的buildout相对、平台适当的路径。请注意，对于shell脚本，目前不支持Windows。

• 在模板中支持使用 $${...} 来转义 ${...}，这在 UNIX shell 脚本中特别有用。

修复

• 使测试更不易受到时间错误的影响。

更改

• ${os-paths} 和 ${space-paths} 不再过滤出 .zip 路径。

• ${string-paths} 中的条目现在由换行符分隔。每个条目都缩进到标记初始放置的级别。