-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathworkflow.py
More file actions
1793 lines (1516 loc) · 61.4 KB
/
workflow.py
File metadata and controls
1793 lines (1516 loc) · 61.4 KB
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
import hashlib
import importlib
import json
import os
import sys
import typing
from dataclasses import dataclass, fields, is_dataclass
from pathlib import Path
from textwrap import dedent
from typing import (
Any,
Dict,
Generator,
Iterable,
List,
Optional,
Tuple,
Type,
TypeVar,
Union,
get_args,
get_origin,
)
from urllib.parse import urlparse
import click
import snakemake
import snakemake.io
import snakemake.jobs
from flytekit.configuration import SerializationSettings
from flytekit.core import constants as _common_constants
from flytekit.core.base_task import TaskMetadata
from flytekit.core.class_based_resolver import ClassStorageTaskResolver
from flytekit.core.context_manager import FlyteContextManager
from flytekit.core.docstring import Docstring
from flytekit.core.interface import Interface, transform_interface_to_typed_interface
from flytekit.core.node import Node
from flytekit.core.promise import NodeOutput, Promise
from flytekit.core.python_auto_container import (
DefaultTaskResolver,
PythonAutoContainerTask,
)
from flytekit.core.type_engine import TypeEngine, TypeTransformerFailedError
from flytekit.core.workflow import (
WorkflowBase,
WorkflowFailurePolicy,
WorkflowMetadata,
WorkflowMetadataDefaults,
)
from flytekit.exceptions import scopes as exception_scopes
from flytekit.models import interface as interface_models
from flytekit.models import literals as literals_models
from flytekit.models import task as _task_models
from flytekit.models import types as type_models
from flytekit.models.core.types import BlobType
from flytekit.models.literals import Blob, BlobMetadata, Literal, LiteralMap, Scalar
from flytekitplugins.pod.task import (
_PRIMARY_CONTAINER_NAME_FIELD,
Pod,
PodFunctionTask,
_sanitize_resource_name,
)
from kubernetes.client import ApiClient
from kubernetes.client.models import (
V1Container,
V1EnvVar,
V1PodSpec,
V1ResourceRequirements,
V1Toleration,
)
from snakemake.dag import DAG
from snakemake.jobs import GroupJob, Job
from typing_extensions import Annotated, TypeAlias, TypedDict
import latch.types.metadata as metadata
from latch.resources.tasks import _get_large_gpu_pod, _get_small_gpu_pod, custom_task
from latch.types.directory import LatchDir
from latch.types.file import LatchFile
from latch.types.metadata import FileMetadata, SnakemakeFileParameter
from latch_cli.snakemake.config.utils import is_list_type, is_primitive_type, type_repr
from latch_cli.snakemake.utils import reindent
from ..utils import identifier_from_str, identifier_suffix_from_str
SnakemakeInputVal: TypeAlias = snakemake.io._IOFile
# old snakemake did not have encode_target_jobs_cli_args
def jobs_cli_args(
jobs: Iterable[Job],
) -> Generator[str, None, None]:
for x in jobs:
wildcards = ",".join(
f"{key}={value}" for key, value in x.wildcards_dict.items()
)
yield f"{x.rule.name}:{wildcards}"
T = TypeVar("T")
@dataclass
class JobOutputInfo:
jobid: str
output_param_name: str
type_: Union[Type[LatchFile], Type[LatchDir]]
def task_fn_placeholder(): ...
def variable_name_for_file(file: snakemake.io.AnnotatedString):
if file[0] == "/":
return f"a_{identifier_suffix_from_str(file)}"
return f"r_{identifier_suffix_from_str(file)}"
def isdir(var: snakemake.io._IOFile) -> bool:
return var is not None and (os.path.isdir(var) or var.is_directory)
@dataclass
class RemoteFile:
local_path: str
remote_path: str
def snakemake_dag_to_interface(
dag: DAG,
wf_name: str,
docstring: Optional[Docstring] = None,
local_to_remote_path_mapping: Optional[Dict[str, str]] = None,
) -> Tuple[Interface, LiteralMap, List[RemoteFile]]:
outputs: Dict[str, Union[Type[LatchFile], Type[LatchDir]]] = {}
for target in dag.targetjobs:
for desired in target.input:
param = variable_name_for_file(desired)
jobs: List[snakemake.jobs.Job] = dag.file2jobs(desired)
producer_out: snakemake.io._IOFile = next(x for x in jobs[0].output)
if isdir(producer_out):
outputs[param] = LatchDir
else:
outputs[param] = LatchFile
literals: Dict[str, Literal] = {}
inputs: Dict[str, Tuple[Type[LatchFile], None]] = {}
return_files: List[RemoteFile] = []
for job in dag.jobs:
dep_outputs = []
for dep, dep_files in dag.dependencies[job].items():
for o in dep.output:
if o in dep_files:
dep_outputs.append(o)
for o in dep.log:
if o in dep_files:
dep_outputs.append(o)
for x in job.input:
if x not in dep_outputs:
param = variable_name_for_file(x)
if isdir(x):
inputs[param] = (LatchDir, None)
else:
inputs[param] = (LatchFile, None)
remote_path = (
Path("/.snakemake_latch") / "workflows" / wf_name / "inputs" / x
)
use_original_remote_path: bool = (
local_to_remote_path_mapping is not None
and x in local_to_remote_path_mapping
)
if use_original_remote_path:
remote_path = local_to_remote_path_mapping.get(x)
remote_url = (
urlparse(str(remote_path))._replace(scheme="latch").geturl()
)
if not use_original_remote_path:
return_files.append(
RemoteFile(local_path=x, remote_path=remote_url)
)
# it is possible for two different input files to have the same parameter name
# as long as they are defined in different rules. This can lead to name collisions
# because we use a global mapping (across all rules) of param_name -> input_file.
if param in literals and literals[param].scalar.blob.uri != remote_url:
click.secho(
dedent(f"""
Name collision detected for {job.name}. The following two input
parameters have the same name but different remote paths:
{param} -> {remote_url}
{param} -> {literals[param].scalar.blob.uri}
"""),
fg="red",
)
sys.exit(1)
literals[param] = Literal(
scalar=Scalar(
blob=Blob(
metadata=BlobMetadata(
type=BlobType(
format="",
dimensionality=(
BlobType.BlobDimensionality.SINGLE
if not isdir(x)
else BlobType.BlobDimensionality.MULTIPART
),
)
),
uri=remote_url,
),
)
)
meta = metadata.LatchMetadata(
display_name=wf_name,
author=metadata.LatchAuthor(name="Latch Snakemake JIT"),
parameters={k: metadata.LatchParameter(display_name=k) for k in inputs.keys()},
)
return (
Interface(
inputs,
outputs,
docstring=Docstring(f"{wf_name}\n\nSample Description\n\n" + str(meta)),
),
LiteralMap(literals=literals),
return_files,
)
def binding_data_from_python(
expected_literal_type: type_models.LiteralType,
t_value: typing.Any,
t_value_type: Optional[Type] = None,
) -> Optional[literals_models.BindingData]:
if isinstance(t_value, Promise):
if not t_value.is_ready:
return literals_models.BindingData(promise=t_value.ref)
def binding_from_python(
var_name: str,
expected_literal_type: type_models.LiteralType,
t_value: typing.Any,
t_value_type: Type,
) -> literals_models.Binding:
binding_data = binding_data_from_python(
expected_literal_type, t_value, t_value_type
)
return literals_models.Binding(var=var_name, binding=binding_data)
def transform_type(
x: Type, description: Optional[str] = None
) -> interface_models.Variable:
return interface_models.Variable(
type=TypeEngine.to_literal_type(x), description=description
)
def transform_types_in_variable_map(
variable_map: Dict[str, Type],
descriptions: Dict[str, str] = {},
) -> Dict[str, interface_models.Variable]:
res = {}
if variable_map:
for k, v in variable_map.items():
res[k] = transform_type(v, descriptions.get(k, k))
return res
def interface_to_parameters(
interface: Optional[Interface],
) -> interface_models.ParameterMap:
if interface is None or interface.inputs_with_defaults is None:
return interface_models.ParameterMap({})
if interface.docstring is None:
inputs_vars = transform_types_in_variable_map(interface.inputs)
else:
inputs_vars = transform_types_in_variable_map(
interface.inputs, interface.docstring.input_descriptions
)
params: Dict[str, interface_models.Parameter] = {}
for k, v in inputs_vars.items():
val, default = interface.inputs_with_defaults[k]
required = default is None
default_lv = None
ctx = FlyteContextManager.current_context()
if default is not None:
default_lv = TypeEngine.to_literal(
ctx, default, python_type=interface.inputs[k], expected=v.type
)
params[k] = interface_models.Parameter(
var=v, default=default_lv, required=required
)
return interface_models.ParameterMap(params)
class JITRegisterWorkflow(WorkflowBase, ClassStorageTaskResolver):
out_parameter_name = "o0" # must be "o0"
def __init__(
self,
cache_tasks: bool = False,
git_commit_hash: Optional[str] = None,
git_is_dirty: bool = False,
):
self.cache_tasks = cache_tasks
assert metadata._snakemake_metadata is not None
parameter_metadata = metadata._snakemake_metadata.parameters
display_name = metadata._snakemake_metadata.display_name
name = metadata._snakemake_metadata.name
self.file_metadata = metadata._snakemake_metadata.file_metadata
desc = f"Sample Description"
about_page_path = metadata._snakemake_metadata.about_page_content
if about_page_path is not None:
if not (about_page_path.exists() and about_page_path.is_file()):
click.secho(
dedent(f"""
The about page path provided in the metadata is not a valid file:
{about_page_path}
"""),
fg="red",
)
raise click.exceptions.Exit(1)
desc = about_page_path.read_text()
if git_commit_hash is not None:
click.secho(
f"Tagging workflow version with git commit {git_commit_hash}", fg="blue"
)
metadata._snakemake_metadata._non_standard["git_commit_hash"] = (
git_commit_hash
)
metadata._snakemake_metadata._non_standard["git_is_dirty"] = git_is_dirty
docstring = Docstring(
f"{display_name}\n\n{desc}\n\n" + str(metadata._snakemake_metadata)
)
python_interface = Interface(
{k: (v.type, v.default) for k, v in parameter_metadata.items()},
{self.out_parameter_name: bool},
docstring=docstring,
)
self.parameter_metadata = parameter_metadata
if metadata._snakemake_metadata.output_dir is not None:
self.remote_output_url = metadata._snakemake_metadata.output_dir.remote_path
else:
self.remote_output_url = None
workflow_metadata = WorkflowMetadata(
on_failure=WorkflowFailurePolicy.FAIL_IMMEDIATELY
)
name = f"{name}_jit_register"
workflow_metadata_defaults = WorkflowMetadataDefaults(False)
super().__init__(
name=name,
workflow_metadata=workflow_metadata,
workflow_metadata_defaults=workflow_metadata_defaults,
python_interface=python_interface,
)
def get_fn_interface(
self, decorator_name="small_task", fn_name: Optional[str] = None
):
if fn_name is None:
fn_name = self.name
params: List[str] = []
for param, t in self.python_interface.inputs.items():
params.append(
reindent(
rf"""
{param}: {type_repr(t, add_namespace=True)}
""",
1,
).rstrip()
)
params_str = ",\n".join(params)
return reindent(
rf"""
@{decorator_name}
def {fn_name}(
__params__
) -> bool:
""",
0,
).replace("__params__", params_str)
def get_fn_return_stmt(self):
return reindent(
rf"""
return True
""",
1,
)
def _param_path_str(self, param_path: List[Union[str, int]]) -> str:
return "][".join(map(repr, param_path))
def get_file_download_code(
self,
t: Type,
param: str,
path: Path,
download: bool,
config: bool,
param_path: List[Union[str, int]],
) -> str:
code_block = ""
param_name = identifier_from_str(param)
touch_str = f"{param}._create_imposters()"
if download:
touch_str = (
f'print(f"Downloading {param}: {{{param}.remote_path}}");'
f" Path({param}).resolve()"
)
code_block += dedent(rf"""
{param_name}_dst_p = Path("{path}")
{touch_str}
{param_name}_p = Path({param}.path)
print(f" {{file_name_and_size({param_name}_p)}}")
""")
if t is LatchDir:
code_block += f"{param_name}_p.iterdir()\n"
code_block += dedent(rf"""
print(f"Moving {param} to {{{param_name}_dst_p}}")
update_mapping({param_name}_p, {param_name}_dst_p, {param}.remote_path, local_to_remote_path_mapping)
check_exists_and_rename(
{param_name}_p,
{param_name}_dst_p
)
""")
if config:
param_path_str = self._param_path_str(param_path)
code_block += dedent(rf"""
print(f"Saving parameter value {param} = {str(path)}")
overwrite_config[{param_path_str}] = {repr(str(path))}
overwrite_config['_latchfiles'][{param_path_str}] = {param}.remote_path
""")
return code_block
def get_param_code(
self,
t: Type,
param: str,
file_meta: FileMetadata,
param_path: List[Union[str, int]],
) -> str:
if get_origin(t) is Union:
args = get_args(t)
assert len(args) > 0
code_block = f"if {param} is not None:\n"
return code_block + reindent(
self.get_param_code(args[0], param, file_meta, param_path), 1
)
param_meta = self.parameter_metadata.get(param)
# support workflows that use the legacy SnakemakeFileParameter
if isinstance(param_meta, SnakemakeFileParameter):
assert t in (
LatchFile,
LatchDir,
), "SnakemakeFileParameter must have type LatchFile or LatchDir"
code_block = ""
code_block += self.get_file_download_code(
t,
param,
param_meta.path,
param_meta.download,
param_meta.config,
param_path,
)
return code_block
if file_meta is None or file_meta.get(param) is None or is_primitive_type(t):
return dedent(f"""
if {param} is not None:
print(f"Saving parameter value {param} = get_parameter_json_value({param})")
overwrite_config[{self._param_path_str(param_path)}] = get_parameter_json_value({param})
""")
if get_origin(t) is Annotated:
args = get_args(t)
assert len(args) > 0
return self.get_param_code(args[0], param, file_meta, param_path)
meta = file_meta.get(param)
if t in (LatchFile, LatchDir):
return self.get_file_download_code(
t,
param,
meta.path,
meta.download,
meta.config,
param_path,
)
code_blocks: List[str] = []
if is_list_type(t):
args = get_args(t)
if len(args) == 0:
click.secho(
dedent(f"""
Generic Lists are not supported - please specify a subtype, e.g."
List[LatchFile]",
"""),
fg="red",
)
raise click.exceptions.Exit(1)
sub_typ = args[0]
code_blocks.append(
f"overwrite_config[{self._param_path_str(param_path)}] = [None for"
f" _ in range({len(meta)})]\n"
)
for i, m in enumerate(meta):
sub_param = f"{param}[{i}]"
code_blocks.append(
self.get_param_code(
sub_typ,
sub_param,
{sub_param: m},
[*param_path, i],
)
)
else:
assert is_dataclass(t)
code_blocks.append(
f"overwrite_config[{self._param_path_str(param_path)}] = {{}}"
)
for field in fields(t):
sub_param = f"{param}.{field.name}"
code_blocks.append(
self.get_param_code(
field.type,
sub_param,
{sub_param: meta.get(field.name)},
param_path + [field.name],
)
)
return "\n".join(code_blocks)
def get_fn_code(
self,
metadata_path: str,
snakefile_path: str,
image_name: str,
remote_output_url: Optional[str],
):
task_name = f"{self.name}_task"
code_block = self.get_fn_interface(fn_name=task_name)
code_block += reindent(
rf"""
overwrite_config = {{}}
overwrite_config['_latchfiles'] = {{}}
local_to_remote_path_mapping = {{}}
""",
1,
)
for param, t in self.python_interface.inputs.items():
code_block += reindent(
self.get_param_code(t, param, self.file_metadata, [param]) + "\n",
1,
)
code_block += reindent(
rf"""
image_name = "{image_name}"
snakefile = Path("{snakefile_path}")
lp = LatchPersistence()
pkg_root = Path.cwd()
""",
1,
)
code_block += reindent(
r"""
dry_run = os.environ.get("LATCH_SNAKEMAKE_DRY_RUN")
if dry_run is not None:
token = None
version = None
jit_wf_version = "0.0.0-dry"
jit_exec_display_name = "jit-dry-run"
account_id = None
else:
exec_id_hash = hashlib.sha1()
token = os.environ["FLYTE_INTERNAL_EXECUTION_ID"]
exec_id_hash.update(token.encode("utf-8"))
version = exec_id_hash.hexdigest()[:16]
jit_wf_version = os.environ["FLYTE_INTERNAL_TASK_VERSION"]
res = execute(
gql.gql('''
query executionCreatorsByToken($token: String!) {
executionCreatorByToken(token: $token) {
flytedbId
info {
displayName
}
accountInfoByCreatedBy {
id
}
}
}
'''),
{"token": token},
)["executionCreatorByToken"]
jit_exec_display_name = res["info"]["displayName"]
account_id = res["accountInfoByCreatedBy"]["id"]
""",
1,
)
code_block += reindent(
rf"""
print(f"JIT Workflow Version: {{jit_wf_version}}")
print(f"JIT Execution Display Name: {{jit_exec_display_name}}")
wf = extract_snakemake_workflow(
pkg_root,
Path("{metadata_path}"),
snakefile,
jit_wf_version,
jit_exec_display_name,
local_to_remote_path_mapping,
overwrite_config,
{self.cache_tasks},
)
wf_name = wf.name
generate_snakemake_entrypoint(wf, pkg_root, snakefile, {repr(remote_output_url)}, overwrite_config)
entrypoint_remote = f"latch:///.snakemake_latch/workflows/{{wf_name}}/{{jit_wf_version}}/{{jit_exec_display_name}}/entrypoint.py"
lp.upload("latch_entrypoint.py", entrypoint_remote)
print(f"latch_entrypoint.py -> {{entrypoint_remote}}")
""",
1,
)
code_block += reindent(
r"""
if dry_run is None:
headers = {
"Authorization": f"Latch-Execution-Token {token}",
}
temp_dir = tempfile.TemporaryDirectory()
with Path(temp_dir.name).resolve() as td:
serialize_snakemake(wf, td, image_name, config.dkr_repo)
protos = _recursive_list(td)
reg_resp = register_serialized_pkg(protos, None, version, account_id)
_print_reg_resp(reg_resp, image_name)
wf_spec_remote = f"latch:///.snakemake_latch/workflows/{wf_name}/{version}/spec"
spec_dir = Path("spec")
for x_dir in spec_dir.iterdir():
if not x_dir.is_dir():
dst = f"{wf_spec_remote}/{x_dir.name}"
print(f"{x_dir} -> {dst}")
lp.upload(str(x_dir), dst)
print(" done")
continue
for x in x_dir.iterdir():
dst = f"{wf_spec_remote}/{x_dir.name}/{x.name}"
print(f"{x} -> {dst}")
lp.upload(str(x), dst)
print(" done")
class _WorkflowInfoNode(TypedDict):
id: str
nodes: Optional[List[_WorkflowInfoNode]] = None
while True:
time.sleep(1)
print("Getting Workflow Data:", end=" ")
nodes = execute(
gql.gql('''
query workflowQuery($name: String, $ownerId: BigInt, $version: String) {
workflowInfos(condition: { name: $name, ownerId: $ownerId, version: $version}) {
nodes {
id
}
}
}
'''),
{"name": wf_name, "version": version, "ownerId": account_id},
)["workflowInfos"]["nodes"]
if not nodes:
print("Failed. Trying again.")
else:
print("Succeeded.")
break
if len(nodes) > 1:
raise ValueError(
"Invariant violated - more than one workflow identified for unique combination"
" of {wf_name}, {version}, {account_id}"
)
print(nodes)
for file in wf.return_files:
print(f"Uploading {file.local_path} -> {file.remote_path}")
lp.upload(file.local_path, file.remote_path)
wf_id = nodes[0]["id"]
params = gpjson.MessageToDict(wf.literal_map.to_flyte_idl()).get("literals", {})
print(params)
_interface_request = {
"workflow_id": wf_id,
"params": params,
"snakemake_jit": True,
}
response = requests.post(urljoin(config.nucleus_url, "/api/create-execution"), headers=headers, json=_interface_request)
print(response.json())
else:
print("Dry run successful. Exiting.")
""",
1,
)
code_block += self.get_fn_return_stmt()
return code_block
class SnakemakeWorkflow(WorkflowBase, ClassStorageTaskResolver):
def __init__(
self,
dag: DAG,
jit_wf_version: str,
jit_exec_display_name: str,
local_to_remote_path_mapping: Optional[Dict[str, str]] = None,
cache_tasks: bool = False,
):
assert metadata._snakemake_metadata is not None
name = metadata._snakemake_metadata.name
self.jit_wf_version = jit_wf_version
self.jit_exec_display_name = jit_exec_display_name
self.cores = metadata._snakemake_metadata.cores
assert name is not None
python_interface, literal_map, return_files = snakemake_dag_to_interface(
dag,
name,
None,
local_to_remote_path_mapping,
)
self.literal_map = literal_map
self.return_files = return_files
self._input_parameters = None
self._dag = dag
self._cache_tasks = cache_tasks
self._docker_metadata = metadata._snakemake_metadata.docker_metadata
self._use_conda = (
metadata._snakemake_metadata.env_config is not None
and metadata._snakemake_metadata.env_config.use_conda
)
self._use_container = (
metadata._snakemake_metadata.env_config is not None
and metadata._snakemake_metadata.env_config.use_container
)
self._container_args = (
[]
if metadata._snakemake_metadata.env_config is None
else metadata._snakemake_metadata.env_config.container_args
)
self.snakemake_tasks: List[SnakemakeJobTask] = []
workflow_metadata = WorkflowMetadata(
on_failure=WorkflowFailurePolicy.FAIL_IMMEDIATELY
)
workflow_metadata_defaults = WorkflowMetadataDefaults(False)
super().__init__(
name=name,
workflow_metadata=workflow_metadata,
workflow_metadata_defaults=workflow_metadata_defaults,
python_interface=python_interface,
)
def compile(self, **kwargs):
self._input_parameters = interface_to_parameters(self.python_interface)
GLOBAL_START_NODE = Node(
id=_common_constants.GLOBAL_INPUT_NODE_ID,
metadata=None,
bindings=[],
upstream_nodes=[],
flyte_entity=None,
)
node_map: Dict[str, Node] = {}
target_files = [x for job in self._dag.targetjobs for x in job.input]
node_id = 0
for layer in self._dag.toposorted():
for job in layer:
assert isinstance(job, snakemake.jobs.Job)
is_target = False
if job in self._dag.targetjobs:
continue
target_file_for_output_param: Dict[str, str] = {}
target_file_for_input_param: Dict[str, str] = {}
python_outputs: Dict[str, Union[Type[LatchFile], Type[LatchDir]]] = {}
for x in job.output:
assert isinstance(x, SnakemakeInputVal)
if x in target_files:
is_target = True
param = variable_name_for_file(x)
target_file_for_output_param[param] = x
if isdir(x):
python_outputs[param] = LatchDir
else:
python_outputs[param] = LatchFile
for x in job.log:
assert isinstance(x, SnakemakeInputVal)
if x in target_files:
is_target = True
param = variable_name_for_file(x)
target_file_for_output_param[param] = x
if isdir(x):
python_outputs[param] = LatchDir
else:
python_outputs[param] = LatchFile
dep_outputs: Dict[SnakemakeInputVal, JobOutputInfo] = {}
for dep, dep_files in self._dag.dependencies[job].items():
for o in dep.output:
if o in dep_files:
assert isinstance(o, SnakemakeInputVal)
dep_outputs[o] = JobOutputInfo(
jobid=dep.jobid,
output_param_name=variable_name_for_file(o),
type_=LatchDir if isdir(o) else LatchFile,
)
for o in dep.log:
if o in dep_files:
assert isinstance(o, SnakemakeInputVal)
dep_outputs[o] = JobOutputInfo(
jobid=dep.jobid,
output_param_name=variable_name_for_file(o),
type_=LatchDir if isdir(o) else LatchFile,
)
python_inputs: Dict[str, Union[Type[LatchFile], Type[LatchDir]]] = {}
promise_map: Dict[str, JobOutputInfo] = {}
for x in job.input:
param = variable_name_for_file(x)
target_file_for_input_param[param] = x
dep_out = dep_outputs.get(x)
if isdir(x):
python_inputs[param] = LatchDir
else:
python_inputs[param] = LatchFile
if dep_out is not None:
python_inputs[param] = dep_out.type_
promise_map[param] = dep_out
interface = Interface(python_inputs, python_outputs, docstring=None)
task = SnakemakeJobTask(
wf=self,
job=job,
inputs=python_inputs,
outputs=python_outputs,
target_file_for_input_param=target_file_for_input_param,
target_file_for_output_param=target_file_for_output_param,
is_target=is_target,
interface=interface,
)
if getattr(task, "_metadata") is None:
task._metadata = TaskMetadata()
if self._cache_tasks:
task._metadata.cache = True
task._metadata.cache_serialize = True
hash = hashlib.new("sha256")
hash.update(job.properties().encode())
if job.is_script:
hash.update(Path(job.rule.script).read_bytes())
task._metadata.cache_version = hash.hexdigest()
self.snakemake_tasks.append(task)
typed_interface = transform_interface_to_typed_interface(interface)
assert typed_interface is not None
bindings: List[literals_models.Binding] = []
for k in interface.inputs:
var = typed_interface.inputs[k]
if var.description in promise_map:
job_output_info = promise_map[var.description]
promise_to_bind = Promise(
var=k,
val=NodeOutput(
node=node_map[job_output_info.jobid],
var=job_output_info.output_param_name,
),
)
else:
promise_to_bind = Promise(
var=k,
val=NodeOutput(node=GLOBAL_START_NODE, var=k),
)
bindings.append(
binding_from_python(
var_name=k,
expected_literal_type=var.type,
t_value=promise_to_bind,
t_value_type=interface.inputs[k],
)
)
upstream_nodes = []
for x in self._dag.dependencies[job].keys():
if x.jobid in node_map:
upstream_nodes.append(node_map[x.jobid])
node = Node(
id=f"n{node_id}",
metadata=task.construct_node_metadata(),
bindings=sorted(bindings, key=lambda b: b.var),
upstream_nodes=upstream_nodes,
flyte_entity=task,
)
node_map[job.jobid] = node
node_id += 1
bindings: Dict[str, literals_models.Binding] = {}
for target in self._dag.targetjobs:
for out_file in target.input:
out_param_name = variable_name_for_file(out_file)
if out_param_name in bindings:
# rahul: Flyte will error if there are mulitple
# bindings for the same output
continue
upstream_id, upstream_var = self.find_upstream_node_matching_file(