Method format

st2client/st2client/formatters/table.py:219–264

(cls, subject, *args, **kwargs)

class PropertyValueTable(formatters.Formatter):
    @classmethod
    def format(cls, subject, *args, **kwargs):
        attributes = kwargs.get("attributes", None)
        attribute_display_order = kwargs.get(
            "attribute_display_order", DEFAULT_ATTRIBUTE_DISPLAY_ORDER
        )
        attribute_transform_functions = kwargs.get("attribute_transform_functions", {})

        if not attributes or "all" in attributes:
            attributes = sorted(
                [attr for attr in subject.__dict__ if not attr.startswith("_")]
            )

        for attr in attribute_display_order[::-1]:
            if attr in attributes:
                attributes.remove(attr)
                attributes = [attr] + attributes
        table = PrettyTable()
        table.field_names = ["Property", "Value"]
        table.max_width["Property"] = 20
        table.max_width["Value"] = 60
        table.padding_width = 1
        table.align = "l"
        table.valign = "t"

        for attribute in attributes:
            if "." in attribute:
                field_names = attribute.split(".")
                value = cls._get_attribute_value(subject, field_names.pop(0))
                for name in field_names:
                    value = cls._get_attribute_value(value, name)
                    if type(value) is str:
                        break
            else:
                value = cls._get_attribute_value(subject, attribute)

            transform_function = attribute_transform_functions.get(
                attribute, lambda value: value
            )
            value = transform_function(value=value)

            if type(value) is dict or type(value) is list:
                value = json.dumps(value, indent=4)

            value = strutil.strip_carriage_returns(strutil.unescape(value))
            table.add_row([attribute, value])
        return table

    @staticmethod
    def _get_attribute_value(subject, attribute):