-
Notifications
You must be signed in to change notification settings - Fork 248
/
promise.py
1236 lines (1014 loc) · 48.9 KB
/
promise.py
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import collections
import inspect
from copy import deepcopy
from enum import Enum
from typing import Any, Coroutine, Dict, List, Optional, Set, Tuple, Union, cast
from google.protobuf import struct_pb2 as _struct
from typing_extensions import Protocol, get_args
from flytekit.core import constants as _common_constants
from flytekit.core import context_manager as _flyte_context
from flytekit.core import interface as flyte_interface
from flytekit.core import type_engine
from flytekit.core.context_manager import (
BranchEvalMode,
ExecutionParameters,
ExecutionState,
FlyteContext,
FlyteContextManager,
OutputMetadataTracker,
)
from flytekit.core.interface import Interface
from flytekit.core.node import Node
from flytekit.core.type_engine import DictTransformer, ListTransformer, TypeEngine, TypeTransformerFailedError
from flytekit.exceptions import user as _user_exceptions
from flytekit.exceptions.user import FlytePromiseAttributeResolveException
from flytekit.loggers import logger
from flytekit.models import interface as _interface_models
from flytekit.models import literals as _literals_models
from flytekit.models import types as _type_models
from flytekit.models import types as type_models
from flytekit.models.core import workflow as _workflow_model
from flytekit.models.literals import Primitive
from flytekit.models.types import SimpleType
def translate_inputs_to_literals(
ctx: FlyteContext,
incoming_values: Dict[str, Any],
flyte_interface_types: Dict[str, _interface_models.Variable],
native_types: Dict[str, type],
) -> Dict[str, _literals_models.Literal]:
"""
The point of this function is to extract out Literals from a collection of either Python native values (which would
be converted into Flyte literals) or Promises (the literals in which would just get extracted).
When calling a task inside a workflow, a user might do something like this.
def my_wf(in1: int) -> int:
a = task_1(in1=in1)
b = task_2(in1=5, in2=a)
return b
If this is the case, when task_2 is called in local workflow execution, we'll need to translate the Python native
literal 5 to a Flyte literal.
More interesting is this:
def my_wf(in1: int, in2: int) -> int:
a = task_1(in1=in1)
b = task_2(in1=5, in2=[a, in2])
return b
Here, in task_2, during execution we'd have a list of Promises. We have to make sure to give task2 a Flyte
LiteralCollection (Flyte's name for list), not a Python list of Flyte literals.
This helper function is used both when sorting out inputs to a task, as well as outputs of a function.
:param ctx: Context needed in case a non-primitive literal needs to be translated to a Flyte literal (like a file)
:param incoming_values: This is a map of your task's input or wf's output kwargs basically
:param flyte_interface_types: One side of an :py:class:`flytekit.models.interface.TypedInterface` basically.
:param native_types: Map to native Python type.
"""
if incoming_values is None:
raise ValueError("Incoming values cannot be None, must be a dict")
result = {} # So as to not overwrite the input_kwargs
for k, v in incoming_values.items():
if k not in flyte_interface_types:
raise ValueError(f"Received unexpected keyword argument {k}")
var = flyte_interface_types[k]
t = native_types[k]
try:
if type(v) is Promise:
v = resolve_attr_path_in_promise(v)
result[k] = TypeEngine.to_literal(ctx, v, t, var.type)
except TypeTransformerFailedError as exc:
raise TypeTransformerFailedError(f"Failed argument '{k}': {exc}") from exc
return result
def resolve_attr_path_in_promise(p: Promise) -> Promise:
"""
resolve_attr_path_in_promise resolves the attribute path in a promise and returns a new promise with the resolved value
This is for local execution only. The remote execution will be resolved in flytepropeller.
"""
curr_val = p.val
used = 0
for attr in p.attr_path:
# If current value is Flyte literal collection (list) or map (dictionary), use [] to resolve
if (
type(curr_val.value) is _literals_models.LiteralMap
or type(curr_val.value) is _literals_models.LiteralCollection
):
if type(attr) == str and attr not in curr_val.value.literals:
raise FlytePromiseAttributeResolveException(
f"Failed to resolve attribute path {p.attr_path} in promise {p},"
f" attribute {attr} not found in {curr_val.value.literals.keys()}"
)
if type(attr) == int and attr >= len(curr_val.value.literals):
raise FlytePromiseAttributeResolveException(
f"Failed to resolve attribute path {p.attr_path} in promise {p},"
f" index {attr} out of range {len(curr_val.value.literals)}"
)
curr_val = curr_val.value.literals[attr]
used += 1
# Scalar is always the leaf. There can't be a collection or map in a scalar.
if type(curr_val.value) is _literals_models.Scalar:
break
# If the current value is a dataclass, resolve the dataclass with the remaining path
if type(curr_val.value) is _literals_models.Scalar and type(curr_val.value.value) is _struct.Struct:
st = curr_val.value.value
new_st = resolve_attr_path_in_pb_struct(st, attr_path=p.attr_path[used:])
literal_type = TypeEngine.to_literal_type(type(new_st))
# Reconstruct the resolved result to flyte literal (because the resolved result might not be struct)
curr_val = TypeEngine.to_literal(FlyteContextManager.current_context(), new_st, type(new_st), literal_type)
p._val = curr_val
return p
def resolve_attr_path_in_pb_struct(st: _struct.Struct, attr_path: List[Union[str, int]]) -> _struct.Struct:
curr_val = st
for attr in attr_path:
if attr not in curr_val:
raise FlytePromiseAttributeResolveException(
f"Failed to resolve attribute path {attr_path} in struct {curr_val}, attribute {attr} not found"
)
curr_val = curr_val[attr]
return curr_val
def get_primitive_val(prim: Primitive) -> Any:
for value in [
prim.integer,
prim.float_value,
prim.string_value,
prim.boolean,
prim.datetime,
prim.duration,
]:
if value is not None:
return value
class ConjunctionOps(Enum):
AND = "and"
OR = "or"
class ComparisonOps(Enum):
EQ = "=="
NE = "!="
GT = ">"
GE = ">="
LT = "<"
LE = "<="
_comparators = {
ComparisonOps.EQ: lambda x, y: x == y,
ComparisonOps.NE: lambda x, y: x != y,
ComparisonOps.GT: lambda x, y: x > y,
ComparisonOps.GE: lambda x, y: x >= y,
ComparisonOps.LT: lambda x, y: x < y,
ComparisonOps.LE: lambda x, y: x <= y,
}
class ComparisonExpression(object):
"""
ComparisonExpression refers to an expression of the form (lhs operator rhs), where lhs and rhs are operands
and operator can be any comparison expression like <, >, <=, >=, ==, !=
"""
def __init__(self, lhs: Union["Promise", Any], op: ComparisonOps, rhs: Union["Promise", Any]):
self._op = op
self._lhs = None
self._rhs = None
if isinstance(lhs, Promise):
self._lhs = lhs
if lhs.is_ready:
if lhs.val.scalar is None or lhs.val.scalar.primitive is None:
union = lhs.val.scalar.union
if union and union.value.scalar:
if union.value.scalar.primitive or union.value.scalar.none_type:
self._lhs = union.value
else:
raise ValueError("Only primitive values can be used in comparison")
else:
raise ValueError("Only primitive values can be used in comparison")
if isinstance(rhs, Promise):
self._rhs = rhs
if rhs.is_ready:
if rhs.val.scalar is None or rhs.val.scalar.primitive is None:
union = rhs.val.scalar.union
if union and union.value.scalar:
if union.value.scalar.primitive or union.value.scalar.none_type:
self._rhs = union.value
else:
raise ValueError("Only primitive values can be used in comparison")
else:
raise ValueError("Only primitive values can be used in comparison")
if self._lhs is None:
self._lhs = type_engine.TypeEngine.to_literal(FlyteContextManager.current_context(), lhs, type(lhs), None)
if self._rhs is None:
self._rhs = type_engine.TypeEngine.to_literal(FlyteContextManager.current_context(), rhs, type(rhs), None)
@property
def rhs(self) -> Union["Promise", _literals_models.Literal]:
return self._rhs
@property
def lhs(self) -> Union["Promise", _literals_models.Literal]:
return self._lhs
@property
def op(self) -> ComparisonOps:
return self._op
def eval(self) -> bool:
if isinstance(self.lhs, Promise):
lhs = self.lhs.eval()
elif self.lhs.scalar.none_type:
lhs = None
else:
lhs = get_primitive_val(self.lhs.scalar.primitive)
if isinstance(self.rhs, Promise):
rhs = self.rhs.eval()
elif self.rhs.scalar.none_type:
rhs = None
else:
rhs = get_primitive_val(self.rhs.scalar.primitive)
return _comparators[self.op](lhs, rhs)
def __and__(self, other):
return ConjunctionExpression(lhs=self, op=ConjunctionOps.AND, rhs=other)
def __or__(self, other):
return ConjunctionExpression(lhs=self, op=ConjunctionOps.OR, rhs=other)
def __bool__(self):
raise ValueError(
"Cannot perform truth value testing,"
" This is a limitation in python. For Logical `and\\or` use `&\\|` (bitwise) instead."
f" Expr {self}"
)
def __repr__(self):
return f"Comp({self._lhs} {self._op.value} {self._rhs})"
def __str__(self):
return self.__repr__()
class ConjunctionExpression(object):
"""
A Conjunction Expression is an expression of the form either (A and B) or (A or B).
where A, B are two expressions (comparison or conjunctions) and (and, or) are logical truth operators.
A conjunctionExpression evaluates to True or False depending on the logical operator and the truth values of
each of the expressions A & B
"""
def __init__(
self,
lhs: Union[ComparisonExpression, "ConjunctionExpression"],
op: ConjunctionOps,
rhs: Union[ComparisonExpression, "ConjunctionExpression"],
):
self._lhs = lhs
self._rhs = rhs
self._op = op
@property
def rhs(self) -> Union[ComparisonExpression, "ConjunctionExpression"]:
return self._rhs
@property
def lhs(self) -> Union[ComparisonExpression, "ConjunctionExpression"]:
return self._lhs
@property
def op(self) -> ConjunctionOps:
return self._op
def eval(self) -> bool:
l_eval = self.lhs.eval()
if self.op == ConjunctionOps.AND and l_eval is False:
return False
if self.op == ConjunctionOps.OR and l_eval is True:
return True
r_eval = self.rhs.eval()
if self.op == ConjunctionOps.AND:
return l_eval and r_eval
return l_eval or r_eval
def __and__(self, other: Union[ComparisonExpression, "ConjunctionExpression"]):
return ConjunctionExpression(lhs=self, op=ConjunctionOps.AND, rhs=other)
def __or__(self, other: Union[ComparisonExpression, "ConjunctionExpression"]):
return ConjunctionExpression(lhs=self, op=ConjunctionOps.OR, rhs=other)
def __bool__(self):
raise ValueError(
"Cannot perform truth value testing,"
" This is a limitation in python. For Logical `and\\or` use `&\\|` (bitwise) instead. Refer to: PEP-335"
)
def __repr__(self):
return f"( {self._lhs} {self._op} {self._rhs} )"
def __str__(self):
return self.__repr__()
# TODO: The NodeOutput object, which this Promise wraps, has an sdk_type. Since we're no longer using sdk types,
# we should consider adding a literal type to this object as well for downstream checking when Bindings are created.
class Promise(object):
"""
This object is a wrapper and exists for three main reasons. Let's assume we're dealing with a task like ::
@task
def t1() -> (int, str): ...
#. Handling the duality between compilation and local execution - when the task function is run in a local execution
mode inside a workflow function, a Python integer and string are produced. When the task is being compiled as
part of the workflow, the task call creates a Node instead, and the task returns two Promise objects that
point to that Node.
#. One needs to be able to call ::
x = t1().with_overrides(...)
If the task returns an integer or a ``(int, str)`` tuple like ``t1`` above, calling ``with_overrides`` on the
result would throw an error. This Promise object adds that.
#. Assorted handling for conditionals.
"""
# TODO: Currently, NodeOutput we're creating is the slimmer core package Node class, but since only the
# id is used, it's okay for now. Let's clean all this up though.
def __init__(self, var: str, val: Union[NodeOutput, _literals_models.Literal]):
self._var = var
self._promise_ready = True
self._val = val
self._ref = None
self._attr_path: List[Union[str, int]] = []
if val and isinstance(val, NodeOutput):
self._ref = val
self._promise_ready = False
self._val = None
def __hash__(self):
return hash(id(self))
def __rshift__(self, other: Union[Promise, VoidPromise]):
if not self.is_ready and other.ref:
self.ref.node.runs_before(other.ref.node)
return other
def with_var(self, new_var: str) -> Promise:
if self.is_ready:
return Promise(var=new_var, val=self.val)
return Promise(var=new_var, val=self.ref)
@property
def is_ready(self) -> bool:
"""
Returns if the Promise is READY (is not a reference and the val is actually ready)
Usage ::
p = Promise(...)
...
if p.is_ready():
print(p.val)
else:
print(p.ref)
"""
return self._promise_ready
@property
def val(self) -> _literals_models.Literal:
"""
If the promise is ready then this holds the actual evaluate value in Flyte's type system
"""
return self._val
@property
def ref(self) -> NodeOutput:
"""
If the promise is NOT READY / Incomplete, then it maps to the origin node that owns the promise
"""
return self._ref # type: ignore
@property
def var(self) -> str:
"""
Name of the variable bound with this promise
"""
return self._var
@property
def attr_path(self) -> List[Union[str, int]]:
"""
The attribute path the promise will be resolved with.
:rtype: List[Union[str, int]]
"""
return self._attr_path
def eval(self) -> Any:
if not self._promise_ready or self._val is None:
raise ValueError("Cannot Eval with incomplete promises")
if self.val.scalar is None or self.val.scalar.primitive is None:
raise ValueError("Eval can be invoked for primitive types only")
return get_primitive_val(self.val.scalar.primitive)
def is_(self, v: bool) -> ComparisonExpression:
return ComparisonExpression(self, ComparisonOps.EQ, v)
def is_false(self) -> ComparisonExpression:
return self.is_(False)
def is_true(self) -> ComparisonExpression:
return self.is_(True)
def is_none(self) -> ComparisonExpression:
return ComparisonExpression(self, ComparisonOps.EQ, None)
def __eq__(self, other) -> ComparisonExpression: # type: ignore
return ComparisonExpression(self, ComparisonOps.EQ, other)
def __ne__(self, other) -> ComparisonExpression: # type: ignore
return ComparisonExpression(self, ComparisonOps.NE, other)
def __gt__(self, other) -> ComparisonExpression:
return ComparisonExpression(self, ComparisonOps.GT, other)
def __ge__(self, other) -> ComparisonExpression:
return ComparisonExpression(self, ComparisonOps.GE, other)
def __lt__(self, other) -> ComparisonExpression:
return ComparisonExpression(self, ComparisonOps.LT, other)
def __le__(self, other) -> ComparisonExpression:
return ComparisonExpression(self, ComparisonOps.LE, other)
def __bool__(self):
raise ValueError(
"Flytekit does not support Unary expressions or performing truth value testing,"
" This is a limitation in python. For Logical `and\\or` use `&\\|` (bitwise) instead"
)
def __and__(self, other):
raise ValueError("Cannot perform Logical AND of Promise with other")
def __or__(self, other):
raise ValueError("Cannot perform Logical OR of Promise with other")
def with_overrides(self, *args, **kwargs):
if not self.is_ready:
# TODO, this should be forwarded, but right now this results in failure and we want to test this behavior
self.ref.node.with_overrides(*args, **kwargs)
return self
def __repr__(self):
if self._promise_ready:
return f"Resolved({self._var}={self._val})"
return f"Promise(node:{self.ref.node_id}.{self._var}.{self.attr_path})"
def __str__(self):
return str(self.__repr__())
def deepcopy(self) -> Promise:
new_promise = Promise(var=self.var, val=self.val)
new_promise._promise_ready = self._promise_ready
new_promise._ref = self._ref
new_promise._attr_path = deepcopy(self._attr_path)
return new_promise
def __getitem__(self, key) -> Promise:
"""
When we use [] to access the attribute on the promise, for example
```
@workflow
def wf():
o = t1()
t2(x=o["a"][0])
```
The attribute keys are appended on the promise and a new promise is returned with the updated attribute path.
We don't modify the original promise because it might be used in other places as well.
"""
return self._append_attr(key)
def __iter__(self):
"""
Flyte/kit (as of https://github.com/flyteorg/flyte/issues/3864) supports indexing into a list of promises.
But it still doesn't make sense to
"""
raise ValueError(
"Promise objects are not iterable - can't range() over a promise."
" But you can use [index] or the still stabilizing @eager"
)
def __getattr__(self, key) -> Promise:
"""
When we use . to access the attribute on the promise, for example
```
@workflow
def wf():
o = t1()
t2(o.a.b)
```
The attribute keys are appended on the promise and a new promise is returned with the updated attribute path.
We don't modify the original promise because it might be used in other places as well.
"""
return self._append_attr(key)
def _append_attr(self, key) -> Promise:
new_promise = self.deepcopy()
# The attr_path on the promise is for local_execute
new_promise._attr_path.append(key)
if new_promise.ref is not None:
# The attr_path on the ref node is for remote execute
new_promise._ref = new_promise.ref.with_attr(key)
return new_promise
def create_native_named_tuple(
ctx: FlyteContext,
promises: Union[Tuple[Promise], Promise, VoidPromise, None],
entity_interface: Interface,
) -> Optional[Tuple]:
"""
Creates and returns a Named tuple with all variables that match the expected named outputs. this makes
it possible to run things locally and expect a more native behavior, i.e. address elements of a named tuple
by name.
"""
if entity_interface is None:
raise ValueError("Interface of the entity is required to generate named outputs")
if promises is None:
return None
if isinstance(promises, Promise):
k, v = [(k, v) for k, v in entity_interface.outputs.items()][0] # get output native type
# only show the name of output key if it's user-defined (by default Flyte names these as "o<n>")
key = k if k != "o0" else 0
try:
return TypeEngine.to_python_value(ctx, promises.val, v)
except Exception as e:
raise TypeError(
f"Failed to convert output in position {key} of value {promises.val}, expected type {v}."
) from e
if len(cast(Tuple[Promise], promises)) == 0:
return None
named_tuple_name = "DefaultNamedTupleOutput"
if entity_interface.output_tuple_name:
named_tuple_name = entity_interface.output_tuple_name
outputs = {}
for i, p in enumerate(cast(Tuple[Promise], promises)):
if not isinstance(p, Promise):
raise AssertionError(
"Workflow outputs can only be promises that are returned by tasks. Found a value of"
f"type {type(p)}. Workflows cannot return local variables or constants."
)
t = entity_interface.outputs[p.var]
try:
outputs[p.var] = TypeEngine.to_python_value(ctx, p.val, t)
except Exception as e:
# only show the name of output key if it's user-defined (by default Flyte names these as "o<n>")
key = p.var if p.var != f"o{i}" else i
raise TypeError(f"Failed to convert output in position {key} of value {p.val}, expected type {t}.") from e
# Should this class be part of the Interface?
nt = collections.namedtuple(named_tuple_name, list(outputs.keys())) # type: ignore
return nt(**outputs)
# To create a class that is a named tuple, we might have to create namedtuplemeta and manipulate the tuple
def create_task_output(
promises: Optional[Union[List[Promise], Promise]],
entity_interface: Optional[Interface] = None,
) -> Optional[Union[Tuple[Promise], Promise]]:
# TODO: Add VoidPromise here to simplify things at call site. Consider returning for [] below as well instead of
# raising an exception.
if promises is None:
return None
if isinstance(promises, Promise):
return promises
if len(promises) == 0:
raise Exception(
"This function should not be called with an empty list. It should have been handled with a"
"VoidPromise at this function's call-site."
)
if len(promises) == 1:
if not entity_interface:
return promises[0]
# See transform_function_to_interface for more information, we're using the existence of a name as a proxy
# for the user having specified a one-element typing.NamedTuple, which means we should _not_ extract it. We
# should still return a tuple but it should be one of ours.
if not entity_interface.output_tuple_name:
return promises[0]
# More than one promise, let us wrap it into a tuple
# Start with just the var names in the promises
variables = [p.var for p in promises]
# These should be OrderedDicts so it should be safe to iterate over the keys.
if entity_interface:
variables = [k for k in entity_interface.outputs.keys()]
named_tuple_name = "DefaultNamedTupleOutput"
if entity_interface and entity_interface.output_tuple_name:
named_tuple_name = entity_interface.output_tuple_name
# Should this class be part of the Interface?
class Output(collections.namedtuple(named_tuple_name, variables)): # type: ignore
def with_overrides(self, *args, **kwargs):
val = self.__getattribute__(self._fields[0])
val.with_overrides(*args, **kwargs)
return self
def runs_before(self, other: Any):
"""
This function is just here to allow local workflow execution to run. See the corresponding function in
flytekit.core.node.Node for more information. Local workflow execution in the manual ``create_node``
paradigm is already determined by the order in which the nodes were created.
"""
# TODO: If possible, add a check and raise an Exception if create_node was not called in the correct order.
return self
def __rshift__(self, other: Any):
# See comment for runs_before
return other
return Output(*promises) # type: ignore
def binding_data_from_python_std(
ctx: _flyte_context.FlyteContext,
expected_literal_type: _type_models.LiteralType,
t_value: Any,
t_value_type: type,
nodes: List[Node],
) -> _literals_models.BindingData:
# This handles the case where the given value is the output of another task
if isinstance(t_value, Promise):
if not t_value.is_ready:
nodes.append(t_value.ref.node) # keeps track of upstream nodes
return _literals_models.BindingData(promise=t_value.ref)
elif isinstance(t_value, VoidPromise):
raise AssertionError(
f"Cannot pass output from task {t_value.task_name} that produces no outputs to a downstream task"
)
elif t_value is not None and expected_literal_type.union_type is not None:
for i in range(len(expected_literal_type.union_type.variants)):
try:
lt_type = expected_literal_type.union_type.variants[i]
python_type = get_args(t_value_type)[i] if t_value_type else None
return binding_data_from_python_std(ctx, lt_type, t_value, python_type, nodes)
except Exception:
logger.debug(
f"failed to bind data {t_value} with literal type {expected_literal_type.union_type.variants[i]}."
)
raise AssertionError(
f"Failed to bind data {t_value} with literal type {expected_literal_type.union_type.variants}."
)
elif isinstance(t_value, list):
sub_type: Optional[type] = ListTransformer.get_sub_type_or_none(t_value_type)
collection = _literals_models.BindingDataCollection(
bindings=[
binding_data_from_python_std(ctx, expected_literal_type.collection_type, t, sub_type or type(t), nodes)
for t in t_value
]
)
return _literals_models.BindingData(collection=collection)
elif isinstance(t_value, dict):
if (
expected_literal_type.map_value_type is None
and expected_literal_type.simple != _type_models.SimpleType.STRUCT
):
raise AssertionError(
f"this should be a Dictionary type and it is not: {type(t_value)} vs {expected_literal_type}"
)
if expected_literal_type.simple == _type_models.SimpleType.STRUCT:
lit = TypeEngine.to_literal(ctx, t_value, type(t_value), expected_literal_type)
return _literals_models.BindingData(scalar=lit.scalar)
else:
_, v_type = DictTransformer.get_dict_types(t_value_type)
m = _literals_models.BindingDataMap(
bindings={
k: binding_data_from_python_std(
ctx, expected_literal_type.map_value_type, v, v_type or type(v), nodes
)
for k, v in t_value.items()
}
)
return _literals_models.BindingData(map=m)
elif isinstance(t_value, tuple):
raise AssertionError(
"Tuples are not a supported type for individual values in Flyte - got a tuple -"
f" {t_value}. If using named tuple in an inner task, please, de-reference the"
"actual attribute that you want to use. For example, in NamedTuple('OP', x=int) then"
"return v.x, instead of v, even if this has a single element"
)
# This is the scalar case - e.g. my_task(in1=5)
scalar = TypeEngine.to_literal(ctx, t_value, t_value_type or type(t_value), expected_literal_type).scalar
return _literals_models.BindingData(scalar=scalar)
def binding_from_python_std(
ctx: _flyte_context.FlyteContext,
var_name: str,
expected_literal_type: _type_models.LiteralType,
t_value: Any,
t_value_type: type,
) -> Tuple[_literals_models.Binding, List[Node]]:
nodes: List[Node] = []
binding_data = binding_data_from_python_std(ctx, expected_literal_type, t_value, t_value_type, nodes)
return _literals_models.Binding(var=var_name, binding=binding_data), nodes
def to_binding(p: Promise) -> _literals_models.Binding:
return _literals_models.Binding(var=p.var, binding=_literals_models.BindingData(promise=p.ref))
class VoidPromise(object):
"""
This object is returned for tasks that do not return any outputs (declared interface is empty)
VoidPromise cannot be interacted with and does not allow comparisons or any operations
"""
def __init__(self, task_name: str, ref: Optional[NodeOutput] = None):
self._task_name = task_name
self._ref = ref
def runs_before(self, *args, **kwargs):
"""
This is a placeholder and should do nothing. It is only here to enable local execution of workflows
where a task returns nothing.
"""
@property
def ref(self) -> Optional[NodeOutput]:
return self._ref
def __rshift__(self, other: Union[Promise, VoidPromise]):
if self.ref and other.ref:
self.ref.node.runs_before(other.ref.node)
return other
def with_overrides(self, *args, **kwargs):
if self.ref:
self.ref.node.with_overrides(*args, **kwargs)
return self
@property
def task_name(self):
return self._task_name
def __eq__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __and__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __or__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __le__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __ge__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __gt__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __lt__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __add__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __cmp__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __bool__(self):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __mod__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __xor__(self, other):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __str__(self):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
def __repr__(self):
raise AssertionError(f"Task {self._task_name} returns nothing, NoneType return cannot be used")
class NodeOutput(type_models.OutputReference):
def __init__(self, node: Node, var: str, attr_path: Optional[List[Union[str, int]]] = None):
"""
:param node:
:param var: The name of the variable this NodeOutput references
"""
if attr_path is None:
attr_path = []
self._node = node
super(NodeOutput, self).__init__(self._node.id, var, attr_path)
@property
def node_id(self):
"""
Override the underlying node_id property to refer to the Node's id. This is to make sure that overriding
node IDs from with_overrides gets serialized correctly.
:rtype: Text
"""
return self.node.id
@property
def node(self) -> Node:
"""Return Node object."""
return self._node
def __repr__(self) -> str:
s = f"Node({self.node if self.node.id is not None else None}:{self.var})"
return s
def deepcopy(self) -> NodeOutput:
return NodeOutput(node=self.node, var=self.var, attr_path=deepcopy(self._attr_path))
def with_attr(self, key) -> NodeOutput:
new_node_output = self.deepcopy()
new_node_output._attr_path.append(key)
return new_node_output
class SupportsNodeCreation(Protocol):
@property
def name(self) -> str:
...
@property
def python_interface(self) -> flyte_interface.Interface:
...
def construct_node_metadata(self) -> _workflow_model.NodeMetadata:
...
class HasFlyteInterface(Protocol):
@property
def name(self) -> str:
...
@property
def interface(self) -> _interface_models.TypedInterface:
...
def construct_node_metadata(self) -> _workflow_model.NodeMetadata:
...
def extract_obj_name(name: str) -> str:
"""
Generates a shortened name, without the module information. Useful for node-names etc. Only extracts the final
object information often separated by `.` in the python fully qualified notation
"""
if name is None:
return ""
if "." in name:
return name.split(".")[-1]
return name
def create_and_link_node_from_remote(
ctx: FlyteContext,
entity: HasFlyteInterface,
_inputs_not_allowed: Optional[Set[str]] = None,
_ignorable_inputs: Optional[Set[str]] = None,
**kwargs,
) -> Optional[Union[Tuple[Promise], Promise, VoidPromise]]:
"""
This method is used to generate a node with bindings especially when using remote entities, like FlyteWorkflow,
FlyteTask and FlyteLaunchplan.
This method is kept separate from the similar named method `create_and_link_node` as remote entities have to be
handled differently. The major difference arises from the fact that the remote entities do not have a python
interface, so all comparisons need to happen using the Literals.
:param ctx: FlyteContext
:param entity: RemoteEntity
:param _inputs_not_allowed: Set of all variable names that should not be provided when using this entity.
Useful for Launchplans with `fixed` inputs
:param _ignorable_inputs: Set of all variable names that are optional, but if provided will be overridden. Useful
for launchplans with `default` inputs
:param kwargs: Dict[str, Any] default inputs passed from the user to this entity. Can be promises.
:return: Optional[Union[Tuple[Promise], Promise, VoidPromise]]
"""
if ctx.compilation_state is None:
raise _user_exceptions.FlyteAssertion("Cannot create node when not compiling...")
used_inputs = set()
bindings = []
typed_interface = entity.interface
if _inputs_not_allowed:
inputs_not_allowed_specified = _inputs_not_allowed.intersection(kwargs.keys())
if inputs_not_allowed_specified:
raise _user_exceptions.FlyteAssertion(
f"Fixed inputs cannot be specified. Please remove the following inputs - {inputs_not_allowed_specified}"
)
nodes = []
for k in sorted(typed_interface.inputs):
var = typed_interface.inputs[k]
if k not in kwargs:
if (_ignorable_inputs and k in _ignorable_inputs) or (_inputs_not_allowed and k in _inputs_not_allowed):
continue
# TODO to improve the error message, should we show python equivalent types for var.type?
raise _user_exceptions.FlyteAssertion("Missing input `{}` type `{}`".format(k, var.type))
v = kwargs[k]
# This check ensures that tuples are not passed into a function, as tuples are not supported by Flyte
# Usually a Tuple will indicate that multiple outputs from a previous task were accidentally passed
# into the function.
if isinstance(v, tuple):
raise AssertionError(
f"Variable({k}) for function({entity.name}) cannot receive a multi-valued tuple {v}."
f" Check if the predecessor function returning more than one value?"
)
try:
b, n = binding_from_python_std(
ctx,
var_name=k,
expected_literal_type=var.type,
t_value=v,
t_value_type=type(v), # since we don't have the python type available
)
bindings.append(b)
nodes.extend(n)
used_inputs.add(k)
except Exception as e:
raise AssertionError(f"Failed to Bind variable {k} for function {entity.name}.") from e
extra_inputs = used_inputs ^ set(kwargs.keys())
if len(extra_inputs) > 0:
raise _user_exceptions.FlyteAssertion(
f"Too many inputs for [{entity.name}] Expected inputs: {typed_interface.inputs.keys()} "
f"- extra inputs: {extra_inputs}"
)