File size: 3,858 Bytes
476455e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | # Copyright Amazon.com, Inc. or its affiliates. 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. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Defines the base entities used in workflow."""
from __future__ import absolute_import
import abc
from enum import EnumMeta
from typing import Any, Dict, List, Union
PrimitiveType = Union[str, int, bool, float, None]
RequestType = Union[Dict[str, Any], List[Dict[str, Any]]]
class Entity(abc.ABC):
"""Base object for workflow entities.
Entities must implement the to_request method.
"""
@abc.abstractmethod
def to_request(self) -> RequestType:
"""Get the request structure for workflow service calls."""
class DefaultEnumMeta(EnumMeta):
"""An EnumMeta which defaults to the first value in the Enum list."""
default = object()
def __call__(cls, *args, value=default, **kwargs):
"""Defaults to the first value in the Enum list."""
if value is DefaultEnumMeta.default:
return next(iter(cls))
return super().__call__(value, *args, **kwargs)
factory = __call__
class Expression(abc.ABC):
"""Base object for expressions.
Expressions must implement the expr property.
"""
@property
@abc.abstractmethod
def expr(self) -> RequestType:
"""Get the expression structure for workflow service calls."""
class PipelineVariable(Expression):
"""Base object for pipeline variables
PipelineVariable subclasses must implement the expr property. Its subclasses include:
:class:`~sagemaker.workflow.parameters.Parameter`,
:class:`~sagemaker.workflow.properties.Properties`,
:class:`~sagemaker.workflow.functions.Join`,
:class:`~sagemaker.workflow.functions.JsonGet`,
:class:`~sagemaker.workflow.execution_variables.ExecutionVariable`.
"""
def __add__(self, other: Union[Expression, PrimitiveType]):
"""Add function for PipelineVariable
Args:
other (Union[Expression, PrimitiveType]): The other object to be concatenated.
Always raise an error since pipeline variables do not support concatenation
"""
raise TypeError("Pipeline variables do not support concatenation.")
def __str__(self):
"""Override built-in String function for PipelineVariable"""
raise TypeError(
"Pipeline variables do not support __str__ operation. "
"Please use `.to_string()` to convert it to string type in execution time"
"or use `.expr` to translate it to Json for display purpose in Python SDK."
)
def __int__(self):
"""Override built-in Integer function for PipelineVariable"""
raise TypeError("Pipeline variables do not support __int__ operation.")
def __float__(self):
"""Override built-in Float function for PipelineVariable"""
raise TypeError("Pipeline variables do not support __float__ operation.")
def to_string(self):
"""Prompt the pipeline to convert the pipeline variable to String in runtime"""
from sagemaker.workflow.functions import Join
return Join(on="", values=[self])
@property
@abc.abstractmethod
def expr(self) -> RequestType:
"""Get the expression structure for workflow service calls."""
@property
@abc.abstractmethod
def _referenced_steps(self) -> List[str]:
"""List of step names that this function depends on."""
|