flowrep package

Subpackages

• flowrep.api package
  • Submodules
    • flowrep.api.schemas module
    • flowrep.api.tools module
  • Module contents
• flowrep.compiler package
  • Submodules
    • flowrep.compiler.annotate module
      • render_annotation()
      • render_default()
    • flowrep.compiler.flow_control module
      • emit_flow_control()
      • emit_flow_control_body()
    • flowrep.compiler.function module
      • Emitter
      • FunctionBuilder
      • NameAllocator
      • build_signature()
      • emit_nested_workflow_node()
      • emit_workflow_function()
      • referenced_top_level_bindings()
    • flowrep.compiler.source module
      • RenderedSource
      • flowrep2python()
    • flowrep.compiler.statements module
      • emit_body()
      • emit_workflow_body()
      • flow_control_input_requirements()
      • label_base()
      • node_call_path()
      • render_call()
    • flowrep.compiler.sugar module
      • attribute_name()
      • is_attribute_syntax()
      • is_std_getattr()
      • is_std_getitem()
  • Module contents
• flowrep.converters package
  • Submodules
    • flowrep.converters.python_workflow_definition module
      • flowrep2pwd()
      • pwd2flowrep()
  • Module contents
• flowrep.parsers package
  • Submodules
    • flowrep.parsers.atomic_parser module
      • atomic()
      • get_labeled_recipe()
      • parse_atomic()
    • flowrep.parsers.attribute_parser module
      • AttributeHandler
    • flowrep.parsers.case_helpers module
      • WalkedBranch
      • parse_case()
      • walk_branch()
      • wire_inputs()
      • wire_outputs()
    • flowrep.parsers.chain_parser module
      • LinkHandler
      • chain_root()
      • dependency_symbols()
      • generate_port_name()
      • hoist_call_arguments()
      • inject_chain()
      • is_data_access()
      • reject_method_call()
      • reject_unbound_access()
    • flowrep.parsers.constant_parser module
      • ConstantParseError
      • inject_constant()
      • make_constant()
      • try_parse_constant()
    • flowrep.parsers.dataclass_parser module
      • dataclass()
      • dataclass_fields_to_outputs()
    • flowrep.parsers.for_parser module
      • AccumulatorMap
      • parse_for_node()
    • flowrep.parsers.if_parser module
      • parse_if_node()
    • flowrep.parsers.item_parser module
      • ItemHandler
    • 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
      • FlowControlBindings
      • SignatureInfo
      • SourceCodeUnavailableError
      • apply_label_decorator()
      • consume_call_arguments()
      • get_ast_function_node()
      • get_available_source_code()
      • get_function_definition()
      • get_source_code()
      • reject_input_alias_outputs()
      • 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
• flowrep.prospective package
  • Submodules
    • flowrep.prospective.atomic_recipe module
      • AtomicRecipe
    • flowrep.prospective.constant_recipe module
      • ConstantRecipe
      • is_jsonable()
    • flowrep.prospective.for_recipe module
      • ForEachRecipe
    • flowrep.prospective.helper_models module
      • ConditionalCase
      • ExceptionCase
      • LabeledRecipe
    • flowrep.prospective.if_recipe module
      • IfRecipe
    • flowrep.prospective.try_recipe module
      • TryRecipe
    • flowrep.prospective.union_types module
    • flowrep.prospective.while_recipe module
      • WhileRecipe
    • flowrep.prospective.workflow_recipe module
      • WorkflowRecipe
  • Module contents
• flowrep.retrospective package
  • Submodules
    • flowrep.retrospective.datastructures module
      • AtomicData
      • CompositeData
      • ConstantData
      • DagData
      • FlowControlData
      • ForEachData
      • IfData
      • InputDataPort
      • NodeData
      • NotData
      • OutputDataPort
      • TryData
      • WhileData
      • recipe2data()
    • flowrep.retrospective.storage module
      • LexicalBagBrowser
      • list_lexical_paths()
      • load_from_bag()
      • validate_bag()
    • flowrep.retrospective.storage_widget module
      • LexicalBagTree
    • flowrep.retrospective.viewer module
      • view()
  • 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.CONSTANT
    • 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()
  • ensure_class_signature_from_init()
  • 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.std module
  • abs()
  • add()
  • and_()
  • call()
  • concat()
  • contains()
  • countOf()
  • delitem()
  • eq()
  • floordiv()
  • ge()
  • get_attr()
  • getitem()
  • gt()
  • iadd()
  • iand()
  • iconcat()
  • identity()
  • ifloordiv()
  • ilshift()
  • imatmul()
  • imod()
  • imul()
  • index()
  • indexOf()
  • inv()
  • invert()
  • ior()
  • ipow()
  • irshift()
  • is_()
  • is_not()
  • isub()
  • itruediv()
  • ixor()
  • le()
  • length_hint()
  • lshift()
  • lt()
  • matmul()
  • mod()
  • mul()
  • ne()
  • neg()
  • not_()
  • or_()
  • pos()
  • pow()
  • rshift()
  • setitem()
  • sub()
  • truediv()
  • truth()
  • xor()
• 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
  • topological_sort()
  • 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.