TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/PythonBuildStep

PythonBuildStep

fun BuildSteps.python(init: PythonBuildStep.() -> Unit): PythonBuildStep

Example. Adds a simple Python build step which runs a Python script with parameter located in the working directory with automatically detected Python 3 on agent and without any environment.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        python {
          command = file {
            filename = "user_script.py"
            scriptArguments = "%user.param%"
          }
        }
Content copied to clipboard
    }
}

Example. Runs Python tests with arguments with coverage via pytest with custom Python executable path, environment and working directory which is different from the checkout directory. This build step will be executed only if running build status is successful.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        python {
          name = "Run Python tests"
          executionMode = BuildStep.ExecutionMode.RUN_ON_SUCCESS
          workingDir = "python-tests"
          pythonVersion = customPython {
            executable = "/usr/bin/python3"
          }

          // Environment tools are available: venv, virtualenv, pipenv, poetry
          environment = venv {
            requirementsFile = "requirements-tests.txt"
          }

          // Commands are available: file, module, script, unittest, pytest, flake8, pylint
          command = pytest {
            isCoverageEnabled = true
            scriptArguments = "-m slow"
          }
        }
Content copied to clipboard
    }
}

Example. Runs Python script with parameter given directly in the build step. Environment will be created with specified dependencies.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        python {
          name = "Try Python request"

          environment = venv {
            // If requirementsFile is not set it will be "requirements.txt" by default
            requirementsFile = ""
            // Specify extra pip run arguments, e.g. dependencies
            pipArgs = "requests"
          }

          command = script {
            content = """
              import requests
              r = requests.get('https://httpbin.org/basic-auth/user/pass', auth=('user', '%user.password%'))
              print(r.status_code)
            """.trimIndent()
          }
        }
Content copied to clipboard
    }
}

Constructors

PythonBuildStep

fun PythonBuildStep(init: PythonBuildStep.() -> Unit)

PythonBuildStep

fun PythonBuildStep()

Types

Command

sealed class Command : CompoundParam<PythonBuildStep.Command>

Environment

sealed class Environment : CompoundParam<PythonBuildStep.Environment>

ImagePlatform

enum ImagePlatform : Enum<PythonBuildStep.ImagePlatform>

Docker image platforms

PythonVersion

sealed class PythonVersion : CompoundParam<PythonBuildStep.PythonVersion>

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): SingleDelegateProvider<Boolean>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T>

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildStep

Creates an instance of this build step via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

custom

fun custom(init: PythonBuildStep.Command.Custom.() -> Unit = {}): PythonBuildStep.Command.Custom

customPython

fun customPython(init: PythonBuildStep.PythonVersion.CustomPython.() -> Unit = {}): PythonBuildStep.PythonVersion.CustomPython

doubleParameter

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

file

fun file(init: PythonBuildStep.Command.File.() -> Unit = {}): PythonBuildStep.Command.File

findRawParam

fun findRawParam(paramName: String): Parameter?

flake8

fun flake8(init: PythonBuildStep.Command.Flake8.() -> Unit = {}): PythonBuildStep.Command.Flake8

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

module

fun module(init: PythonBuildStep.Command.Module.() -> Unit = {}): PythonBuildStep.Command.Module

none

fun none(): PythonBuildStep.Environment.None

param

fun param(name: String, value: String)

Adds parameter with specified name and value

pipenv

fun pipenv(init: PythonBuildStep.Environment.Pipenv.() -> Unit = {}): PythonBuildStep.Environment.Pipenv

poetry

fun poetry(init: PythonBuildStep.Environment.Poetry.() -> Unit = {}): PythonBuildStep.Environment.Poetry

pylint

fun pylint(init: PythonBuildStep.Command.Pylint.() -> Unit = {}): PythonBuildStep.Command.Pylint

pytest

fun pytest(init: PythonBuildStep.Command.Pytest.() -> Unit = {}): PythonBuildStep.Command.Pytest

python2

fun python2(init: PythonBuildStep.PythonVersion.Python2.() -> Unit = {}): PythonBuildStep.PythonVersion.Python2

python3

fun python3(init: PythonBuildStep.PythonVersion.Python3.() -> Unit = {}): PythonBuildStep.PythonVersion.Python3

removeRawParam

fun removeRawParam(paramName: String)

script

fun script(init: PythonBuildStep.Command.Script.() -> Unit = {}): PythonBuildStep.Command.Script

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

toString

open override fun toString(): String

unittest

fun unittest(init: PythonBuildStep.Command.Unittest.() -> Unit = {}): PythonBuildStep.Command.Unittest

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

venv

fun venv(init: PythonBuildStep.Environment.Venv.() -> Unit = {}): PythonBuildStep.Environment.Venv

virtualenv

fun virtualenv(init: PythonBuildStep.Environment.Virtualenv.() -> Unit = {}): PythonBuildStep.Environment.Virtualenv

Properties

command

var command: PythonBuildStep.Command?

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

dockerImage

var dockerImage: String?

Specifies which Docker image to use for running this build step. I.e. the build step will be run inside specified docker image, using 'docker run' wrapper.

dockerImagePlatform

var dockerImagePlatform: PythonBuildStep.ImagePlatform?

Specifies which Docker image platform will be used to run this build step.

dockerPull

var dockerPull: Boolean?

If enabled, "pull image" command will be run before docker run.

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

environment

var environment: PythonBuildStep.Environment?

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String? = null

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

name

var name: String

Build step name

params