Developer Details

class flapjack_stack.flapjack_stack.FlapjackStack

A container to hold layers of stack attributes stored in Layer objects

add_layer(obj=None)

This function adds another empty layer (Layer) to the layers list and optionally merges a given object into this layer

Parameters:obj (object) – An object to be merged with this layer

add_layer_from_env()

This function creates a new layer, gets a list of all the current attributes, and attempts to find matching environment variables with the prefix of FJS_. If matches are found it sets those attributes in the new layer.

add_layer_from_file(filename)

This function calls all supported file type handlers which in turn populate a new empty layer (Layer) the provided file’s contents

Parameters:filename (string) – The name of a file to read

add_layer_from_py_file(filename)

This function implements loading a Python file and populating a new empty layer (Layer) with its contents

Parameters:filename (string) – The name of a file to read

add_layer_from_yaml_file(filename)

This function implements loading a YAML file and populating a new empty layer (Layer) with its contents

Parameters:filename (string) – The name of a file to read

get_attributes()

This function through the layers from top to bottom, and creates a list of all the attributes found

Returns:A list of all the attributes names Return type:list

remove_layer()

Removes the top layer (right most) of the layers

Returns:the top layer (right most) of the layers as a Layer Return type:object

class flapjack_stack.flapjack_stack.Layer

A container to hold stack attributes

merge(obj)

This function merge another object’s values with this instance

Parameters:obj (object) – An object to be merged with into this layer