Pkldoc > schema.kdeps.com/core

org.kdeps.pkl.Python0.3.8

Overview
Properties
Methods
Classes

open module org.kdeps.pkl.Python extends org.kdeps.pkl.Utils

Abstractions for Python script execution within KDEPS

Module URI:: package://schema.kdeps.com/core@0.3.8#/deps/pkl/Python.pkl
Pkl version:: 0.28.2 or higher
Source code:: Python.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

Resources: Mapping<String, ResourcePython>?Source

A mapping of resource actionIDs to their associated ResourcePython objects.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

isBase64(str: String?): unknown (org.kdeps.pkl.Utils)
link

function

resource(actionID: String?): ResourcePython Source

Retrieves the ResourcePython associated with the given actionID.

If the resource is not found, returns a new ResourcePython object with default values.

actionID: The actionID of the resource to retrieve. ResourcePython: The ResourcePython object associated with the resource actionID.
link

function

stderr(actionID: String?): String Source

Retrieves the standard error output associated with the resource actionID.

actionID: The actionID of the resource to retrieve the stderr for. str: The standard error output of the Python script.
link

function

stdout(actionID: String?): String Source

Retrieves the standard output associated with the resource actionID.

actionID: The actionID of the resource to retrieve the stdout for. str: The standard output of the Python script, or the stderr if stdout is empty.
link

function

exitCode(actionID: String?): Int Source

Retrieves the exit code associated with the resource actionID.

actionID: The actionID of the resource to retrieve the exit code for. int: The exit code of the Python script.
link

function

file(actionID: String?): String Source

Retrieves the file path containing the script output associated with the specified resource actionID.

actionID: The actionID of the resource to retrieve the file for. Returns the decoded content if the file is Base64-encoded; otherwise, returns the file content as-is.
link

function

itemValues(actionID: String?): Listing<String>Source

Retrieves the item iteration results for the resource actionID.

actionID: The actionID of the resource to retrieve the item values.
link

function

env(actionID: String?, envName: String?): String Source

Retrieves the environment variable envName associated with the resource actionID.

actionID: The actionID of the resource to retrieve the environment variable for. envName: The name of the environment variable to retrieve. str: The value of the environment variable, or an empty string if not found.

Classes

link

class

ResourcePython Source

Class representing a Python execution resource, which includes the script to be executed, environment variables, and execution details such as outputs and exit codes.