PluginsPythonTasksScripts

Python​Python

yaml
type: "io.kestra.core.tasks.scripts.Python"

Execute a Python script

This task is deprecated, please use the io.kestra.plugin.scripts.python.Script or io.kestra.plugin.scripts.python.Commands task instead.

With the Python task, you can execute a full Python script. The task will create a fresh virtualenv for every tasks and allows to install some Python package define in requirements property.

By convention, you need to define at least a main.py files in inputFiles that will be the script used. But you are also able to add as many script as you need in inputFiles.

You can also add a pip.conf in inputFiles to customize the pip download of dependencies (like a private registry).

You can send outputs & metrics from your python script that can be used by others tasks. In order to help, we inject a python package directly on the working dir.Here is an example usage:

python
from kestra import Kestra
Kestra.outputs({'test': 'value', 'int': 2, 'bool': True, 'float': 3.65})
Kestra.counter('count', 1, {'tag1': 'i', 'tag2': 'win'})
Kestra.timer('timer1', lambda: time.sleep(1), {'tag1': 'i', 'tag2': 'lost'})
Kestra.timer('timer2', 2.12, {'tag1': 'i', 'tag2': 'destroy'})

Examples

Execute a python script.

yaml
id: python_flow
namespace: company.team

tasks:
  - id: python
    type: io.kestra.core.tasks.scripts.Python
    inputFiles:
      data.json: |
        {"status": "OK"}
      main.py: |
        from kestra import Kestra
        import json
        import requests
        import sys
        result = json.loads(open(sys.argv[1]).read())
        print(f"python script {result['status']}")
        response = requests.get('http://google.com')
        print(response.status_code)
        Kestra.outputs({'status': response.status_code, 'text': response.text})
      pip.conf: |
        # some specific pip repository configuration
    args:
      - data.json
    requirements:
      - requests

Execute a python script with an input file from Kestra's local storage created by a previous task.

yaml
id: python_flow
namespace: company.team

tasks:
  - id: python
    type: io.kestra.core.tasks.scripts.Python
    inputFiles:
      data.csv: {{outputs.previousTaskId.uri}}
      main.py: |
        with open('data.csv', 'r') as f:
          print(f.read())

Properties

commands

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: [ "./bin/python main.py" ]
  • Min items: 1

The commands to run

Default command will be launched with ./bin/python main.py

exitOnFailed

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Exit if any non-true value is returned.

This tells bash that it should exit the script if any statement returns a non-true return value. Setting this to true helps catch cases where a command fails and the script continues to run anyway.

interpreter

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: /bin/sh
  • Min length: 1

Interpreter to use when launching the process.

pythonPath

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: python
  • Min length: 1

The python interpreter to use

Set the python interpreter path to use

runner

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: PROCESS
  • Possible Values:
    • PROCESS
    • DOCKER

The task runner.

warningOnStdErr

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Whether to set the execution state to WARNING if any stdErr is emitted.

args

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Python command args

Arguments list to pass to main python script

dockerOptions

Docker options when using the DOCKER runner.

env

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

One or more additional environment variable(s) to add to the task run.

files

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Deprecated The list of files that will be uploaded to Kestra's internal storage.

Use outputFiles instead.

inputFiles

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Input files are extra files that will be available in the script's working directory.

Define the files as a map of a file name being the key, and the value being the file's content. Alternatively, configure the files as a JSON string with the same key/value structure as the map. In both cases, you can either specify the file's content inline, or reference a file from Kestra's internal storage by its URI, e.g. a file from an input, output of a previous task, or a Namespace File.

interpreterArgs

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌
  • Default: [ "-c" ]

Interpreter arguments to be used.

outputDirs

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

List of output directories that will be uploaded to Kestra's internal storage.

List of keys that will generate temporary directories. This property can be used with a special variable named outputDirs.key. If you add a file with "myDir", you can use the special var echo 1 >> {[ outputDirs.myDir }}/file1.txt and echo 2 >> {[ outputDirs.myDir }}/file2.txt, and both the files will be uploaded to Kestra's internal storage. You can reference them in other tasks using .

outputFiles

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Output file list that will be uploaded to Kestra's internal storage.

List of keys that will generate temporary files. This property can be used with a special variable named outputFiles.key. If you add a file with "first", you can use the special var echo 1 >> {[ outputFiles.first }}, and on other tasks, you can reference it using .

outputsFiles

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Deprecated Output files.

Use outputFiles instead.

requirements

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Requirements are python dependencies to add to the python execution process

Python dependencies list to setup in the virtualenv, in the same format than requirements.txt

virtualEnv

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: true

Create a virtual env

When a virtual env is created, we will install the requirements needed. Disabled it if all the requirements is already on the file system. If you disabled the virtual env creation, the requirements will be ignored.

Outputs

exitCode

  • Type: integer
  • Required: ✔️
  • Default: 0

files

  • Type: object
  • SubType: string
  • Required: ❌

outputFiles

  • Type: object
  • SubType: string
  • Required: ❌

stdErrLineCount

  • Type: integer
  • Required: ❌
  • Default: 0

stdOutLineCount

  • Type: integer
  • Required: ❌
  • Default: 0

vars

  • Type: object
  • Required: ❌

Definitions

io.kestra.plugin.scripts.runner.docker.Cpu

  • cpus
    • Type: integer
    • Dynamic: ❌
    • Required: ❌

io.kestra.plugin.scripts.runner.docker.Memory

  • kernelMemory
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • memory
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • memoryReservation
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • memorySwap
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • memorySwappiness
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • oomKillDisable
    • Type: boolean
    • Dynamic: ❌
    • Required: ❌

io.kestra.plugin.scripts.exec.scripts.models.DockerOptions

  • image
    • Type: string
    • Dynamic: ✔️
    • Required: ✔️
    • Min length: 1
  • config
    • Type:
      • string
      • object
    • Dynamic: ✔️
    • Required: ❌
  • cpu
    • Type: Cpu
    • Dynamic: ❌
    • Required: ❌
  • credentials
  • deviceRequests
  • entryPoint
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required: ❌
  • extraHosts
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required: ❌
  • host
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • memory
    • Type: Memory
    • Dynamic: ❌
    • Required: ❌
  • networkMode
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • privileged
    • Type: boolean
    • Dynamic: ✔️
    • Required: ❌
  • pullPolicy
    • Type: string
    • Dynamic: ❌
    • Required: ❌
    • Default: ALWAYS
    • Possible Values:
      • IF_NOT_PRESENT
      • ALWAYS
      • NEVER
  • shmSize
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • user
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • volumes
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required: ❌

io.kestra.plugin.scripts.runner.docker.Credentials

  • auth
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • identityToken
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • password
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • registry
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • registryToken
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • username
    • Type: string
    • Dynamic: ✔️
    • Required: ❌

io.kestra.plugin.scripts.runner.docker.DeviceRequest

  • capabilities
    • Type: array
    • SubType: array
    • Dynamic: ❌
    • Required: ❌
  • count
    • Type: integer
    • Dynamic: ❌
    • Required: ❌
  • deviceIds
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required: ❌
  • driver
    • Type: string
    • Dynamic: ✔️
    • Required: ❌
  • options
    • Type: object
    • SubType: string
    • Dynamic: ❌
    • Required: ❌