coolest.template.classes.base

coolest.template.classes.base#

Classes#

APIBaseObject

Abstract class on which all COOLEST template classes are based.

Functions#

get_class_names(instance)

filter_dict(dictionary[, exclude_keys])

Module Contents#

get_class_names(instance)[source]#
filter_dict(dictionary, exclude_keys=None)[source]#
class APIBaseObject[source]#

Abstract class on which all COOLEST template classes are based. This handles the filtering of attributes and automatic documentation attributes.

to_JSON(indent=2, exclude_keys=None)[source]#

Returns a JSON representation of self, filtering out specific attributes based on their name.

Parameters:

  • indent (int, optional) – Indentation to be used in the JSON representation, by default 2

  • exclude_keys (list, optional) – List of attribute names to be excluded from the JSON representation (see standard submodule for examples), by default None

Contents