heat.engine.function module

class heat.engine.function.Function(stack, fn_name, args)

基类: object

模板函数的抽象基类。

all_dep_attrs()

返回引用的所有属性的资源、属性名称对。

返回一个迭代器，该迭代器遍历此函数引用的所有属性的资源名称、属性名称元组。

特殊值 heat.engine.attributes.ALL_ATTRIBUTES 可用于指示需要资源的全部属性。

默认情况下，这将调用 dep_attrs() 方法，但子类可以覆盖以提供更高效的实现。

dep_attrs(resource_name)

返回指定资源中引用的属性。

返回一个迭代器，该迭代器遍历此函数引用的指定资源的任何属性。

特殊值 heat.engine.attributes.ALL_ATTRIBUTES 可用于指示需要资源的全部属性。

dependencies(path)

abstract result()

返回函数解析的结果。

函数子类必须覆盖此方法以计算其结果。

property stack

validate()

在不解析函数的情况下验证参数。

函数子类必须覆盖此方法以验证其参数。

class heat.engine.function.Invalid(stack, fn_name, args)

基类: Function

用于检查条件函数并强制失败的函数。

此函数用于强制条件定义中不支持的函数的失败。

result()

返回函数解析的结果。

函数子类必须覆盖此方法以计算其结果。

class heat.engine.function.Macro(stack, fn_name, raw_args, parse_func, template)

基类: Function

模板宏的抽象基类。

宏与函数不同，因为它控制模板的解析方式。 因此，它在语法树本身上运行，而不是在解析后的输出上运行。

all_dep_attrs()

返回引用的所有属性的资源、属性名称对。

返回一个迭代器，该迭代器遍历此函数引用的所有属性的资源名称、属性名称元组。

特殊值 heat.engine.attributes.ALL_ATTRIBUTES 可用于指示需要资源的全部属性。

默认情况下，这将调用 dep_attrs() 方法，但子类可以覆盖以提供更高效的实现。

dep_attrs(resource_name)

返回指定资源中引用的属性。

返回一个迭代器，该迭代器遍历此函数引用的指定资源的任何属性。

特殊值 heat.engine.attributes.ALL_ATTRIBUTES 可用于指示需要资源的全部属性。

dependencies(path)

abstract parse_args(parse_func)

使用提供的解析函数解析宏。

宏子类应覆盖此方法以控制参数的解析。

result()

返回宏内容的解析结果。

property template

validate()

在不解析结果的情况下验证参数。

heat.engine.function.all_dep_attrs(snippet)

迭代模板片段中引用的资源、属性名称对。

片段应已解析为在适当的位置插入 Function 对象。

返回值:

迭代模板片段中引用的所有属性的资源名称、属性名称元组。

heat.engine.function.dep_attrs(snippet, resource_name)

迭代模板片段中资源的依赖属性。

片段应已解析为在适当的位置插入 Function 对象。

返回值:

迭代模板片段中指定资源的属性。

heat.engine.function.dependencies(snippet, path='')

返回模板片段中资源依赖项的迭代器。

片段应已解析为在适当的位置插入 Function 对象。

heat.engine.function.resolve(snippet, nullable=False)

heat.engine.function.validate(snippet, path=None)