recipe.diff.json package

Submodules

recipe.diff.json.diff_v6 module

Manages the v6 recipe diff schema

class recipe.diff.json.diff_v6.RecipeDiffV6(diff=None, do_validate=False)

Bases: object

Represents a v6 recipe graph diff JSON for the difference between two recipe graphs

get_dict()

Returns the internal dictionary

Returns:The internal dictionary
Return type:dict
recipe.diff.json.diff_v6.convert_diff_to_v6(graph_diff)

Returns the v6 recipe graph diff JSON for the given graph diff

Parameters:graph_diff (recipe.handlers.graph_delta.RecipeGraphDelta) – The recipe graph diff
Returns:The v6 recipe graph diff JSON
Return type:recipe.diff.json.diff_v6.RecipeDiffV6
recipe.diff.json.diff_v6.convert_node_diff_to_v6_json(node_diff)

Returns the v6 diff JSON dict for the given node diff

Parameters:node_diff (recipe.diff.node.NodeDiff) – The node diff
Returns:The v6 diff JSON dict for the node
Return type:dict
recipe.diff.json.diff_v6.convert_recipe_diff_to_v6_json(recipe_diff)

Returns the v6 recipe diff JSON for the given recipe diff

Parameters:recipe_diff (recipe.diff.diff.RecipeDiff) – The recipe diff
Returns:The v6 recipe diff JSON
Return type:recipe.diff.json.diff_v6.RecipeDiffV6

recipe.diff.json.forced_nodes_v6 module

Manages the v6 forced nodes schema

class recipe.diff.json.forced_nodes_v6.ForcedNodesV6(forced_nodes=None, do_validate=False)

Bases: object

Represents a v6 forced nodes JSON for the describing which nodes in a recipe should be forced to be reprocessed

get_dict()

Returns the internal dictionary

Returns:The internal dictionary
Return type:dict
get_forced_nodes()

Returns the forced nodes object

Returns:The forced nodes
Return type:recipe.diff.forced_nodes.ForcedNodes
recipe.diff.json.forced_nodes_v6.convert_forced_nodes_to_v6(forced_nodes)

Returns the v6 forced nodes JSON for the given forced nodes object

Parameters:forced_nodes (recipe.diff.forced_nodes.ForcedNodes) – The forced nodes
Returns:The v6 forced nodes JSON
Return type:recipe.diff.json.forced_nodes_v6.ForcedNodesV6

Module contents