🚀 New! Kestra raises $3 million to grow Learn more

pluginsplugin-script-pythontasksio.kestra.core.tasks.scripts.python

​Python

Python Python- 🔒 Deprecated

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"
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"
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 {{args}}

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 script runner — by default, Kestra runs all scripts in DOCKER.

warningOnStdErr

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

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

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

🔒 Deprecated

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

The list of files that will be uploaded to internal storage,

use outputFiles property 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 args used

outputDirs

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

List of output directories that will be uploaded to internal storage

List of keys that will generate temporary directories. On the command, just can use with special variable named outputDirs.key. If you add a files with ["myDir"], you can use the special vars echo 1 >> {[ outputDirs.myDir }}/file1.txt and echo 2 >> {[ outputDirs.myDir }}/file2.txt and both files will be uploaded to internal storage. Then you can used them on others tasks using null

outputFiles

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

Output file list that will be uploaded to internal storage

List of key that will generate temporary files. On the command, just can use with special variable named outputFiles.key. If you add a files with ["first"], you can use the special vars echo 1 >> {[ outputFiles.first }} and you used on others tasks using null

outputsFiles

🔒 Deprecated

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

Deprecated Output file

use outputFiles

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
  • Default: 0

The exit code of the whole execution

files

🔒 Deprecated

  • Type: object
  • SubType: string

Deprecated output files

use outputFiles

outputFiles

  • Type: object
  • SubType: string

The output files uri in Kestra internal storage

stdErrLineCount

  • Type: integer
  • Default: 0

The standard error line count

stdOutLineCount

  • Type: integer
  • Default: 0

The standard output line count

vars

  • Type: object

The value extract from output of the commands

Definitions

DeviceRequest

capabilities

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

A list of capabilities; an OR list of AND lists of capabilities.

count

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

A request for devices to be sent to device drivers

deviceIds

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

A request for devices to be sent to device drivers

driver

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

A request for devices to be sent to device drivers

options

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

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

Credentials

auth

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

The registry auth.

The auth field is a base64-encoded authentication string of username:password or a token.

identityToken

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

The identity token.

password

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

The registry password.

registry

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

The registry url.

if not defined, the registry will be extracted from the image name.

registryToken

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

The registry token.

username

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

The registry username.

Memory

kernelMemory

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

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4m. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See --kernel-memory details.

memory

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

The maximum amount of memory resources the container can use.

That is, you must set the value to at least 6 megabytes.

memoryReservation

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

Allows you to specify a soft limit smaller than --memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

memorySwap

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

The amount of memory this container is allowed to swap to disk

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap is the amount of combined memory and swap that can be used, while memory is only the amount of physical memory that can be used.

memorySwappiness

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

The amount of memory this container is allowed to swap to disk

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100, to tune this percentage.

oomKillDisable

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.

DockerOptions

image

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

Docker image to use

config

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

Docker config file

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json

cpu

  • Type: Cpu
  • Dynamic: ❌
  • Required: ❌

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

credentials

Credentials for a private container registry.

deviceRequests

A list of device requests to be sent to device drivers

entryPoint

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

Docker entrypoint to use

extraHosts

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

Extra hostname mappings to the container network interface configuration

host

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

Docker api uri

memory

  • Type: Memory
  • Dynamic: ❌
  • Required: ❌

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

networkMode

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

Docker network mode to use e.g. host, none, etc.

pullPolicy

  • Type: object
  • Dynamic: ❓
  • Required: ❌

shmSize

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

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted the system uses 64MB.

user

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

User within the container

volumes

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

List of volumes to mount

Must be a valid mount expression as string, example : /home/user:/app

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true

Cpu

cpus

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

The maximum amount of CPU resources a container can use.

For instance, if the host machine has two CPUs and you set cpus:"1.5", the container is guaranteed at most one and a half of the CPUs