pg.object_utils.kvlist_str

Accessible via pg.object_utils.kvlist_str.

kvlist_str(kvlist, compact=True, verbose=False, root_indent=0)[source]

Formats a list key/value pairs into a comma delimited string.

Return type:

str

Parameters:
  • kvlist – List of tuples in format of (key, value, default_value or a tuple of default values)

  • compact – If True, format value in kvlist in compact form.

  • verbose – If True, format value in kvlist in verbose.

  • root_indent – The indent should be applied for values in kvlist if they are multi-line.

Returns:

A formatted string from a list of key/value pairs delimited by comma.