Files
deb-python-taskflow/taskflow/patterns/linear_flow.py
Joshua Harlow a570aead53 Adjust the exception hierachy
Group the exceptions into the following groups
  * Storage
  * Jobs
  * Execution
  * Other (wrapped failure here)

This grouping makes it easier to understand where
one type of exception should be used vs using another
type of exception.

Backwards incompatible changes:
  * StorageError -> StorageFailure
  * AlreadyExists -> Duplicate
  * WrappedFailure now inherits from Exception
    and not directly from TaskFlowException since it
    wraps arbitrary other exceptions and is not
    specific to taskflow.

Cleanups:
  * JobNotFound -> NotFound
  * EmptyFlow -> Empty
  * JobAlreadyExists -> AlreadyExists
  * InvariantViolation (X)
  * ConnectionFailure (X)

Change-Id: I0e1e81b513fbbc7adb8bfaa1244993e345ab70d3
2014-03-24 20:42:30 -07:00

100 lines
3.4 KiB
Python

# -*- coding: utf-8 -*-
# Copyright (C) 2012 Yahoo! Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from taskflow import exceptions
from taskflow import flow
_LINK_METADATA = {'invariant': True}
class Flow(flow.Flow):
"""Linear Flow pattern.
A linear (potentially nested) flow of *tasks/flows* that can be
applied in order as one unit and rolled back as one unit using
the reverse order that the *tasks/flows* have been applied in.
NOTE(imelnikov): Tasks/flows contained in this linear flow must not
depend on outputs (provided names/values) of tasks/flows that follow it.
"""
def __init__(self, name, retry=None):
super(Flow, self).__init__(name, retry)
self._children = []
def add(self, *items):
"""Adds a given task/tasks/flow/flows to this flow."""
if not items:
return self
# NOTE(imelnikov): we add item to the end of flow, so it should
# not provide anything previous items of the flow require.
requires = self.requires
provides = self.provides
for item in items:
requires |= item.requires
out_of_order = requires & item.provides
if out_of_order:
raise exceptions.DependencyFailure(
"%(item)s provides %(oo)s that are required "
"by previous item(s) of linear flow %(flow)s"
% dict(item=item.name, flow=self.name,
oo=sorted(out_of_order)))
same_provides = provides & item.provides
if same_provides:
raise exceptions.DependencyFailure(
"%(item)s provides %(value)s but is already being"
" provided by %(flow)s and duplicate producers"
" are disallowed"
% dict(item=item.name, flow=self.name,
value=sorted(same_provides)))
provides |= item.provides
self._children.extend(items)
return self
def __len__(self):
return len(self._children)
def __iter__(self):
for child in self._children:
yield child
def iter_links(self):
for src, dst in zip(self._children[:-1],
self._children[1:]):
yield (src, dst, _LINK_METADATA.copy())
@property
def provides(self):
provides = set()
provides.update(self._retry_provides)
for subflow in self._children:
provides.update(subflow.provides)
return provides
@property
def requires(self):
requires = set()
provides = set()
requires.update(self._retry_requires)
provides.update(self._retry_provides)
for subflow in self._children:
requires.update(subflow.requires - provides)
provides.update(subflow.provides)
return requires