setup_python

Documentation

Overview

Package setup_python provides a typed wrapper for actions/setup-python.

Index

• type SetupPython
  • func (a SetupPython) Action() string
  • func (a SetupPython) Inputs() map[string]any

Types

type SetupPython

type SetupPython struct {
	// Version range or exact version of Python to use
	PythonVersion string `yaml:"python-version,omitempty"`

	// File containing the Python version to use
	PythonVersionFile string `yaml:"python-version-file,omitempty"`

	// Used to specify a package manager for caching (pip, pipenv, poetry)
	Cache string `yaml:"cache,omitempty"`

	// Target architecture (x86, x64)
	Architecture string `yaml:"architecture,omitempty"`

	// Set this option if you want the action to check for latest available version
	CheckLatest bool `yaml:"check-latest,omitempty"`

	// Used to pull Python distributions
	Token string `yaml:"token,omitempty"`

	// The path to a dependency file (requirements.txt, Pipfile.lock, etc.)
	CacheDependencyPath string `yaml:"cache-dependency-path,omitempty"`

	// Set this option to true to update environment variables
	UpdateEnvironment bool `yaml:"update-environment,omitempty"`

	// Allow pre-release versions of Python to be installed
	AllowPrereleases bool `yaml:"allow-prereleases,omitempty"`
}

SetupPython wraps the actions/setup-python@v5 action. Setup a Python environment and add it to PATH.

func (SetupPython) Action

func (a SetupPython) Action() string

Action returns the action reference.

func (SetupPython) Inputs

func (a SetupPython) Inputs() map[string]any

Inputs returns the action inputs as a map.