Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.setup-python.v6.SetupPython

With1.3.0

Properties
Methods

class With

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

`python-version`: String?Source

Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset.
link

`python-version-file`: String?Source

File containing the Python version to use. Example: .python-version
link

cache: ("pip"|"pipenv"|"poetry")?Source

Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry.
link

architecture: ("x64"|"x86")?Source

The target architecture (x86, x64, arm64) of the Python or PyPy interpreter.
link

`check-latest`: Boolean?Source

Set this option if you want the action to check for the latest available version that satisfies the version spec.

Default if unspecified: false
link

token: String?Source

The token used to authenticate when fetching Python distributions from https://github.com/actions/python-versions. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.

Default if unspecified: "${{ github.server_url == 'https://github.com' && github.token || '' }}"
link

hidden

`cache-dependency-path-list`: Listing<String>?Source

Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies.
link

`cache-dependency-path`: String?Source

Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies.

To set as a Listing, use cache-dependency-path-list.
link

`update-environment`: Boolean?Source

Set this option if you want the action to update environment variables.

Default if unspecified: true
link

`allow-prereleases`: Boolean?Source

When 'true', a version range passed to 'python-version' input will match prerelease versions if no GA versions are found. Only 'x.y' version range is supported for CPython.

Default if unspecified: false
link

freethreaded: Boolean?Source

When 'true', use the freethreaded version of Python.

Default if unspecified: false
link

`pip-version`: String?Source

Used to specify the version of pip to install with the Python. Supported format: major.minor.
link

hidden

`pip-install-list`: Listing<String>?Source

Used to specify the packages to install with pip after setting up Python. Can be a requirements file or package names.
link

`pip-install`: String?Source

Used to specify the packages to install with pip after setting up Python. Can be a requirements file or package names.

To set as a Listing, use pip-install-list.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.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

Any.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

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

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

function

Typed.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

Typed.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

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.