Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

hopla.utils.format_attributes

hopla.utils.format_attributes(cls, attrs=None)[source]

Automatically format class attributes.

Parameters:
cls: object

an input class.

attrs: list of str, default None

the attributes to add in the final description.

Returns:
repr: str

the class representation.