# Copyright 2018-2019 Google LLC
#
# 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 . import _container_op
from . import _pipeline
from ._pipeline_param import ConditionOperator
class OpsGroup(object):
"""Represents a logical group of ops and group of OpsGroups.
This class is the base class for groups of ops, such as ops sharing an exit handler,
a condition branch, or a loop. This class is not supposed to be used by pipeline authors.
It is useful for implementing a compiler.
"""
def __init__(self, group_type: str, name: str=None):
"""Create a new instance of OpsGroup.
Args:
group_type (str): one of 'pipeline', 'exit_handler', 'condition', and 'graph'.
name (str): name of the opsgroup
"""
#TODO: declare the group_type to be strongly typed
self.type = group_type
self.ops = list()
self.groups = list()
self.name = name
self.dependencies = []
# recursive_ref points to the opsgroups with the same name if exists.
self.recursive_ref = None
@staticmethod
def _get_opsgroup_pipeline(group_type, name):
"""retrieves the opsgroup when the pipeline already contains it.
the opsgroup might be already in the pipeline in case of recursive calls.
Args:
group_type (str): one of 'pipeline', 'exit_handler', 'condition', and 'graph'.
name (str): the name before conversion. """
if not _pipeline.Pipeline.get_default_pipeline():
raise ValueError('Default pipeline not defined.')
if name is None:
return None
name_pattern = '^' + (group_type + '-' + name + '-').replace('_', '-') + '[\d]+$'
for ops_group in _pipeline.Pipeline.get_default_pipeline().groups:
import re
if ops_group.type == group_type and re.match(name_pattern ,ops_group.name):
return ops_group
return None
def _make_name_unique(self):
"""Generate a unique opsgroup name in the pipeline"""
if not _pipeline.Pipeline.get_default_pipeline():
raise ValueError('Default pipeline not defined.')
self.name = (self.type + '-' + ('' if self.name is None else self.name + '-') +
str(_pipeline.Pipeline.get_default_pipeline().get_next_group_id()))
self.name = self.name.replace('_', '-')
def __enter__(self):
if not _pipeline.Pipeline.get_default_pipeline():
raise ValueError('Default pipeline not defined.')
self.recursive_ref = self._get_opsgroup_pipeline(self.type, self.name)
if not self.recursive_ref:
self._make_name_unique()
_pipeline.Pipeline.get_default_pipeline().push_ops_group(self)
return self
def __exit__(self, *args):
_pipeline.Pipeline.get_default_pipeline().pop_ops_group()
def after(self, dependency):
"""Specify explicit dependency on another op."""
self.dependencies.append(dependency)
return self
[docs]class ExitHandler(OpsGroup):
"""Represents an exit handler that is invoked upon exiting a group of ops.
Example usage:
```python
exit_op = ContainerOp(...)
with ExitHandler(exit_op):
op1 = ContainerOp(...)
op2 = ContainerOp(...)
```
"""
def __init__(self, exit_op: _container_op.ContainerOp):
"""Create a new instance of ExitHandler.
Args:
exit_op: an operator invoked at exiting a group of ops.
Raises:
ValueError is the exit_op is invalid.
"""
super(ExitHandler, self).__init__('exit_handler')
if exit_op.dependent_names:
raise ValueError('exit_op cannot depend on any other ops.')
self.exit_op = exit_op
[docs]class Condition(OpsGroup):
"""Represents an condition group with a condition.
Example usage:
```python
with Condition(param1=='pizza'):
op1 = ContainerOp(...)
op2 = ContainerOp(...)
```
"""
def __init__(self, condition):
"""Create a new instance of ExitHandler.
Args:
condition (ConditionOperator): the condition.
Raises:
ValueError is the exit_op is invalid.
"""
super(Condition, self).__init__('condition')
self.condition = condition
class Graph(OpsGroup):
"""Graph DAG with inputs, recursive_inputs, and outputs.
This is not used directly by the users but auto generated when the graph_component decoration exists
"""
def __init__(self, name):
super(Graph, self).__init__(group_type='graph', name=name)
self.inputs = []
self.outputs = {}
self.dependencies = []