com.google.template.soy.pysrc.restricted

Class PyFunctionExprBuilder

java.lang.Object

com.google.template.soy.pysrc.restricted.PyFunctionExprBuilder

public final class PyFunctionExprBuilder
extends Object

A class for building code for a function call expression in Python. It builds to a PyExpr so it could be used function call code recursively.

Sample Output: some_func_call(1, "str", foo='bar', foo=nested_call(42))

Constructor Summary

Constructors

Constructor and Description
PyFunctionExprBuilder(String funcName)

Method Summary

Modifier and Type	Method and Description
PyFunctionExprBuilder	addArg(boolean b)
PyFunctionExprBuilder	addArg(double i)
PyFunctionExprBuilder	addArg(int i)
PyFunctionExprBuilder	addArg(long i)
PyFunctionExprBuilder	addArg(PyExpr arg)
PyFunctionExprBuilder	addArg(String str)
PyFunctionExprBuilder	addArgs(List<PyExpr> argList)
PyFunctionExprBuilder	addKwarg(String key, double i)
PyFunctionExprBuilder	addKwarg(String key, int i)
PyFunctionExprBuilder	addKwarg(String key, long i)
PyFunctionExprBuilder	addKwarg(String key, PyExpr argValue)
PyFunctionExprBuilder	addKwarg(String key, String str)
PyExpr	asPyExpr() Use when the output function is unknown in Python runtime.
PyStringExpr	asPyStringExpr() Use when the output function is known to be a String in Python runtime.
String	build() Returns a valid Python function call as a String.
String	getFuncName()
PyFunctionExprBuilder	setUnpackedKwargs(PyExpr mapping) Unpacking keyword arguments will expand a dictionary into a series of keyword arguments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PyFunctionExprBuilder

public PyFunctionExprBuilder(String funcName)

Parameters:

funcName - The name of the function.

Method Detail

addArg

public PyFunctionExprBuilder addArg(PyExpr arg)

addArgs

public PyFunctionExprBuilder addArgs(List<PyExpr> argList)

addArg

public PyFunctionExprBuilder addArg(String str)

addArg

public PyFunctionExprBuilder addArg(boolean b)

addArg

public PyFunctionExprBuilder addArg(int i)

addArg

public PyFunctionExprBuilder addArg(double i)

addArg

public PyFunctionExprBuilder addArg(long i)

getFuncName

public String getFuncName()

addKwarg

public PyFunctionExprBuilder addKwarg(String key,
                                      PyExpr argValue)

addKwarg

public PyFunctionExprBuilder addKwarg(String key,
                                      String str)

addKwarg

public PyFunctionExprBuilder addKwarg(String key,
                                      int i)

addKwarg

public PyFunctionExprBuilder addKwarg(String key,
                                      double i)

addKwarg

public PyFunctionExprBuilder addKwarg(String key,
                                      long i)

setUnpackedKwargs

public PyFunctionExprBuilder setUnpackedKwargs(PyExpr mapping)

Unpacking keyword arguments will expand a dictionary into a series of keyword arguments.

NOTE: Keyword unpacking behavior is only guaranteed for mapping expressions. Non-mapping expressions which attempt to unpack will result in Python runtime errors.

Parameters:

mapping - The mapping expression to unpack.

Returns:

This PyFunctionExprBuilder instance.

build

public String build()

Returns a valid Python function call as a String.

asPyExpr

public PyExpr asPyExpr()

Use when the output function is unknown in Python runtime.

Returns:

A PyExpr represents the function code.

asPyStringExpr

public PyStringExpr asPyStringExpr()

Use when the output function is known to be a String in Python runtime.

Returns:

A PyStringExpr represents the function code.