Skip to content

Script Annotations Inputs

 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
from typing import Dict

try:
    from typing import Annotated  # type: ignore
except ImportError:
    from typing_extensions import Annotated  # type: ignore

from hera.shared import global_config
from hera.workflows import Artifact, ArtifactLoader, Parameter, Steps, Workflow, script

global_config.experimental_features["script_annotations"] = True


@script(constructor="runner")
def output_dict_artifact(
    a_number: Annotated[int, Parameter(name="a_number")],
) -> Annotated[Dict[str, int], Artifact(name="a_dict")]:
    return {"your-value": a_number}


@script(constructor="runner")
def echo_all(
    an_int: Annotated[int, Parameter(description="an_int parameter", default=1)],
    a_bool: Annotated[bool, Parameter(description="a_bool parameter", default=True)],
    a_string: Annotated[str, Parameter(description="a_string parameter", default="a")],
    # note that this artifact is loaded from /tmp/file into an_artifact as a string
    an_artifact: Annotated[str, Artifact(name="my-artifact", path="/tmp/file", loader=ArtifactLoader.file)],
    # note that this automatically uses the path /tmp/hera/inputs/artifacts/my-artifact-no-path
    an_artifact_no_path: Annotated[str, Artifact(name="my-artifact-no-path", loader=ArtifactLoader.file)],
):
    print(an_int)
    print(a_bool)
    print(a_string)
    print(an_artifact)
    print(an_artifact_no_path)


with Workflow(generate_name="test-input-annotations-", entrypoint="my-steps") as w:
    with Steps(name="my-steps") as s:
        out = output_dict_artifact(arguments={"a_number": 3})
        echo_all(
            arguments=[
                Parameter(name="an_int", value=1),
                Parameter(name="a_bool", value=True),
                Parameter(name="a_string", value="a"),
                out.get_artifact("a_dict").with_name("my-artifact"),
                out.get_artifact("a_dict").with_name("my-artifact-no-path"),
            ]
        )

 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
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: test-input-annotations-
spec:
  entrypoint: my-steps
  templates:
  - name: my-steps
    steps:
    - - arguments:
          parameters:
          - name: a_number
            value: '3'
        name: output-dict-artifact
        template: output-dict-artifact
    - - arguments:
          artifacts:
          - from: '{{steps.output-dict-artifact.outputs.artifacts.a_dict}}'
            name: my-artifact
          - from: '{{steps.output-dict-artifact.outputs.artifacts.a_dict}}'
            name: my-artifact-no-path
          parameters:
          - name: an_int
            value: '1'
          - name: a_bool
            value: 'true'
          - name: a_string
            value: a
        name: echo-all
        template: echo-all
  - inputs:
      parameters:
      - name: a_number
    name: output-dict-artifact
    outputs:
      artifacts:
      - name: a_dict
        path: /tmp/hera-outputs/artifacts/a_dict
    script:
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.experimental.script_annotations_inputs:output_dict_artifact
      command:
      - python
      env:
      - name: hera__script_annotations
        value: ''
      - name: hera__outputs_directory
        value: /tmp/hera-outputs
      image: python:3.8
      source: '{{inputs.parameters}}'
  - inputs:
      artifacts:
      - name: my-artifact
        path: /tmp/file
      - name: my-artifact-no-path
        path: /tmp/hera-inputs/artifacts/my-artifact-no-path
      parameters:
      - default: '1'
        description: an_int parameter
        name: an_int
      - default: 'true'
        description: a_bool parameter
        name: a_bool
      - default: a
        description: a_string parameter
        name: a_string
    name: echo-all
    script:
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.experimental.script_annotations_inputs:echo_all
      command:
      - python
      env:
      - name: hera__script_annotations
        value: ''
      image: python:3.8
      source: '{{inputs.parameters}}'

Comments