flowrep package

Subpackages

• flowrep.api package
  • Submodules
    • flowrep.api.schemas module
    • flowrep.api.tools module
  • Module contents
• flowrep.converters package
  • Submodules
    • flowrep.converters.python_workflow_definition module
      • flowrep2pwd()
      • pwd2flowrep()
  • Module contents
• flowrep.nodes package
  • Submodules
    • flowrep.nodes.atomic_recipe module
      • AtomicRecipe
      • UnpackMode
    • flowrep.nodes.for_recipe module
      • ForEachRecipe
    • flowrep.nodes.helper_models module
      • ConditionalCase
      • ExceptionCase
      • LabeledRecipe
    • flowrep.nodes.if_recipe module
      • IfRecipe
    • flowrep.nodes.try_recipe module
      • TryRecipe
    • flowrep.nodes.union_types module
    • flowrep.nodes.while_recipe module
      • WhileRecipe
    • flowrep.nodes.workflow_recipe module
      • WorkflowRecipe
  • Module contents
• flowrep.parsers package
  • Submodules
    • flowrep.parsers.atomic_parser module
      • atomic()
      • get_labeled_recipe()
      • parse_atomic()
    • flowrep.parsers.case_helpers module
      • WalkedBranch
      • parse_case()
      • walk_branch()
      • wire_inputs()
      • wire_outputs()
    • flowrep.parsers.for_parser module
      • AccumulatorMap
      • parse_for_node()
    • flowrep.parsers.if_parser module
      • parse_if_node()
    • flowrep.parsers.label_helpers module
      • OutputMeta
      • default_output_label()
      • extract_label_from_annotated()
      • get_annotated_output_labels()
      • index_label()
      • merge_labels()
      • unique_suffix()
    • flowrep.parsers.object_scope module
      • ScopeProxy
      • get_scope()
      • resolve_attribute_to_object()
      • resolve_symbol_to_object()
    • flowrep.parsers.parser_helpers module
      • SignatureInfo
      • SourceCodeUnavailableError
      • consume_call_arguments()
      • ensure_function()
      • get_ast_function_node()
      • get_available_source_code()
      • get_function_definition()
      • get_source_code()
      • parser2decorator()
      • resolve_symbols_to_strings()
    • flowrep.parsers.parser_protocol module
      • BodyWalker
    • flowrep.parsers.symbol_scope module
      • SymbolConsumption
      • SymbolProduction
      • SymbolScope
    • flowrep.parsers.try_parser module
      • parse_try_node()
    • flowrep.parsers.while_parser module
      • parse_while_node()
    • flowrep.parsers.workflow_parser module
      • WorkflowParser
      • is_append_call()
      • parse_workflow()
      • skip_docstring()
      • workflow()
  • Module contents

Submodules

• flowrep.base_models module
  • IOTypes
    • IOTypes.INPUTS
    • IOTypes.OUTPUTS
  • NodeRecipe
    • NodeRecipe.description
    • NodeRecipe.inputs
    • NodeRecipe.inputs_with_defaults
    • NodeRecipe.model_config
    • NodeRecipe.outputs
    • NodeRecipe.type
    • NodeRecipe.validate_internal_data_completeness()
  • PythonReference
    • PythonReference.info
    • PythonReference.inputs_with_defaults
    • PythonReference.model_config
    • PythonReference.restricted_input_kinds
  • RecipeElementType
    • RecipeElementType.ATOMIC
    • RecipeElementType.FOR_EACH
    • RecipeElementType.IF
    • RecipeElementType.TRY
    • RecipeElementType.WHILE
    • RecipeElementType.WORKFLOW
  • RestrictedParamKind
    • RestrictedParamKind.KEYWORD_ONLY
    • RestrictedParamKind.POSITIONAL_ONLY
    • RestrictedParamKind.VAR_KEYWORD
    • RestrictedParamKind.VAR_POSITIONAL
    • RestrictedParamKind.from_param_kind()
  • is_valid_label()
  • validate_unique()
• flowrep.edge_models module
  • HandleModel
    • HandleModel.delimiter
    • HandleModel.deserialize()
    • HandleModel.model_config
    • HandleModel.node
    • HandleModel.port
    • HandleModel.serialize()
  • InputSource
    • InputSource.model_config
    • InputSource.node
    • InputSource.port
  • OutputTarget
    • OutputTarget.model_config
    • OutputTarget.node
    • OutputTarget.port
  • SourceHandle
    • SourceHandle.model_config
    • SourceHandle.node
    • SourceHandle.port
  • TargetHandle
    • TargetHandle.model_config
    • TargetHandle.node
    • TargetHandle.port
• flowrep.retrospective module
  • AtomicData
    • AtomicData.from_recipe()
    • AtomicData.function
  • CompositeData
    • CompositeData.edges
    • CompositeData.input_edges
    • CompositeData.nodes
    • CompositeData.output_edges
  • DagData
    • DagData.from_recipe()
  • FlowControlData
    • FlowControlData.from_recipe()
  • ForEachData
  • IfData
  • InputDataPort
    • InputDataPort.default
    • InputDataPort.get_data()
  • NodeData
    • NodeData.from_recipe()
    • NodeData.input_ports
    • NodeData.output_ports
    • NodeData.recipe
  • NotData
  • OutputDataPort
  • TryData
  • WhileData
  • recipe2data()
• flowrep.storage module
  • LexicalBagBrowser
    • LexicalBagBrowser.browse()
    • LexicalBagBrowser.list_paths()
    • LexicalBagBrowser.load()
    • LexicalBagBrowser.widget()
  • list_lexical_paths()
  • load_from_bag()
  • validate_bag()
• flowrep.storage_widget module
  • LexicalBagTree
    • LexicalBagTree.load_selected()
• flowrep.subgraph_validation module
  • DynamicSubgraphDynamicOutput
    • DynamicSubgraphDynamicOutput.prospective_output_edges
  • DynamicSubgraphOwner
    • DynamicSubgraphOwner.input_edges
    • DynamicSubgraphOwner.inputs
    • DynamicSubgraphOwner.outputs
    • DynamicSubgraphOwner.prospective_nodes
  • DynamicSubgraphStaticOutput
    • DynamicSubgraphStaticOutput.output_edges
  • RecipeProtocol
    • RecipeProtocol.inputs
    • RecipeProtocol.inputs_with_defaults
    • RecipeProtocol.outputs
    • RecipeProtocol.validate_internal_data_completeness()
  • StaticSubgraphOwner
    • StaticSubgraphOwner.edges
    • StaticSubgraphOwner.input_edges
    • StaticSubgraphOwner.inputs
    • StaticSubgraphOwner.nodes
    • StaticSubgraphOwner.output_edges
    • StaticSubgraphOwner.outputs
  • validate_acyclic_edges()
  • validate_input_edge_sources()
  • validate_input_edge_targets()
  • validate_nodes_are_fully_sourced()
  • validate_output_edge_sources()
  • validate_output_edge_targets()
  • validate_prospective_sources_list()
  • validate_sibling_edges()
• flowrep.wfms module
  • run_recipe()

Module contents

Use decorators (@atomic and @workflow) to attach a recipe as a .flowrep_recipe attribute onto a function at definition time, and parsers (parse_atomic, parse_workflow) to return a recipe from an existing function object.