Class PossibleFlowPosition

flows/handler.py:548–593

        
    
class PossibleFlowPosition(object):
    all_positions = {}
    
    """
    A PossibleFlowPosition represents a possible position in a hierachy of 
    flow components. On startup, all FlowComponents (Scaffolds and Actions)
    are inspected to build up a list of all possible positions within all
    avaiable flows. This class represents one such possibility.
    """

    def __init__(self, app_namespace, flow_namespace, flow_components):
        self.app_namespace = app_namespace
        self.flow_namespace = flow_namespace
        self.flow_component_classes = flow_components

        PossibleFlowPosition.all_positions[self.url_name] = self
            
    def create_instance(self, state, state_store, url_args, url_kwargs):
        return FlowPositionInstance(self.app_namespace, self.flow_namespace, self, state,
                                    state_store, url_args, url_kwargs)
    
    def _url_name_from_components(self, components, include_app_namespace=True):
        if self.flow_namespace is None:
            prefix = 'flow_'
        else:
            prefix = 'flow_%s_' % self.flow_namespace
        if self.app_namespace and include_app_namespace:
            prefix = '%s:%s' % (self.app_namespace, prefix)
        return '%s%s' % (prefix, '/'.join([name_for_flow(fc) for fc in components]))
    
    def is_entry_point(self):
        root_tree = self.flow_component_classes[0].get_initial_action_tree()
        my_tree = self.flow_component_classes
        return root_tree == my_tree
    
    @property
    def url_name(self):
        return self.get_url_name(include_app_namespace=True)
    
    def get_url_name(self, include_app_namespace=True):
        return self._url_name_from_components(self.flow_component_classes, include_app_namespace)
    
    
    def __repr__(self):
        classes = ' / '.join( map(str, self.flow_component_classes) )
        return '%s (%s)' % (classes, self.url_name)