Skip to content

Script Runner Io

This example shows the use of Pydantic Input/Output to create the input and output parameters and artifacts for a script template.

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

from pydantic import BaseModel

from hera.shared import global_config
from hera.workflows import Artifact, ArtifactLoader, Parameter, Script, Steps, Workflow, script
from hera.workflows.archive import NoneArchiveStrategy
from hera.workflows.io import Input, Output

global_config.set_class_defaults(Script, constructor="runner")
global_config.set_class_defaults(Script, image="my-image-with-deps")


class MyObject(BaseModel):
    a_dict: dict  # not giving a default makes the field a required input for the template
    a_str: str = "a default string"


class MyInput(Input):
    param_int: Annotated[int, Parameter(name="param-input")] = 42
    an_object: Annotated[MyObject, Parameter(name="obj-input")] = MyObject(
        a_dict={"my-key": "a-value"}, a_str="hello world!"
    )
    artifact_int: Annotated[int, Artifact(name="artifact-input", loader=ArtifactLoader.json)]


class MyOutput(Output):
    param_int: Annotated[int, Parameter(name="param-output")]
    artifact_int: Annotated[int, Artifact(name="artifact-output")]


@script()
def writer() -> Annotated[int, Artifact(name="int-artifact", archive=NoneArchiveStrategy())]:
    return 100


@script()
def pydantic_io(
    my_input: MyInput,
) -> MyOutput:
    return MyOutput(exit_code=1, result="Test!", param_int=42, artifact_int=my_input.param_int)


with Workflow(generate_name="pydantic-io-", entrypoint="use-pydantic-io") as w:
    with Steps(name="use-pydantic-io"):
        write_step = writer()
        pydantic_io(
            arguments=[
                write_step.get_artifact("int-artifact").with_name("artifact-input"),
                {
                    "param_int": 101,
                    "an_object": MyObject(a_dict={"my-new-key": "my-new-value"}),
                },
            ]
        )

 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
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: pydantic-io-
spec:
  entrypoint: use-pydantic-io
  templates:
  - name: use-pydantic-io
    steps:
    - - name: writer
        template: writer
    - - name: pydantic-io
        template: pydantic-io
        arguments:
          artifacts:
          - name: artifact-input
            from: '{{steps.writer.outputs.artifacts.int-artifact}}'
          parameters:
          - name: param_int
            value: '101'
          - name: an_object
            value: '{"a_dict": {"my-new-key": "my-new-value"}, "a_str": "a default
              string"}'
  - name: writer
    outputs:
      artifacts:
      - name: int-artifact
        path: /tmp/hera-outputs/artifacts/int-artifact
        archive:
          none: {}
    script:
      image: my-image-with-deps
      source: '{{inputs.parameters}}'
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.scripts.script_runner_io:writer
      command:
      - python
      env:
      - name: hera__outputs_directory
        value: /tmp/hera-outputs
  - name: pydantic-io
    inputs:
      artifacts:
      - name: artifact-input
        path: /tmp/hera-inputs/artifacts/artifact-input
      parameters:
      - name: param-input
        default: '42'
      - name: obj-input
        default: '{"a_dict": {"my-key": "a-value"}, "a_str": "hello world!"}'
    outputs:
      artifacts:
      - name: artifact-output
        path: /tmp/hera-outputs/artifacts/artifact-output
      parameters:
      - name: param-output
        valueFrom:
          path: /tmp/hera-outputs/parameters/param-output
    script:
      image: my-image-with-deps
      source: '{{inputs.parameters}}'
      args:
      - -m
      - hera.workflows.runner
      - -e
      - examples.workflows.scripts.script_runner_io:pydantic_io
      command:
      - python
      env:
      - name: hera__outputs_directory
        value: /tmp/hera-outputs

Comments