python

package

v1.516.0 Latest Latest Go to latest Published: Jul 16, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SAP/jenkins-library

Links

Documentation ¶

Index ¶

Constants
Variables
func BuildWithPyProjectToml(executeFn func(executable string, params ...string) error, virtualEnv string, ...) error
func BuildWithSetupPy(executeFn func(executable string, params ...string) error, virtualEnv string, ...) error
func CreateBOM(executeFn func(executable string, params ...string) error, ...) error
func CreateVirtualEnvironment(executeFn func(executable string, params ...string) error, ...) (func(), error)
func InstallBuild(executeFn func(executable string, params ...string) error, virtualEnv string) error
func InstallCycloneDX(executeFn func(executable string, params ...string) error, virtualEnv string, ...) error
func InstallPip(executeFn func(executable string, params ...string) error, virtualEnv string) error
func InstallProjectDependencies(executeFn func(executable string, params ...string) error, virtualEnv string) error
func InstallRequirements(executeFn func(executable string, params ...string) error, virtualEnv string, ...) error
func InstallTestDependencies(executeFn func(executable string, params ...string) error, virtualEnv string) error
func InstallTwine(executeFn func(executable string, params ...string) error, virtualEnv string) error
func InstallWheel(executeFn func(executable string, params ...string) error, virtualEnv string) error
func PublishPackage(executeFn func(executable string, params ...string) error, virtualEnv string, ...) error
func RunTests(executeFn func(executable string, params ...string) error, virtualEnv string, ...) error

Constants ¶

View Source

const (
	JUnitReportFile    = "TEST-python.xml"
	CoverageReportFile = "cobertura-coverage.xml"
)

View Source

const (
	BOMFilename = "bom-pip.xml"
)

Variables ¶

View Source

var (
	PipInstallFlags = []string{"install", "--upgrade", "--root-user-action=ignore"}
)

Functions ¶

func BuildWithPyProjectToml ¶ added in v1.472.0

func BuildWithPyProjectToml(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
	pythonArgs []string,
	moduleArgs []string,
) error

func BuildWithSetupPy ¶

func BuildWithSetupPy(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
	pythonArgs []string,
	setupArgs []string,
) error

func CreateBOM ¶

func CreateBOM(
	executeFn func(executable string, params ...string) error,
	existsFn func(path string) (bool, error),
	readFileFn func(path string) ([]byte, error),
	virtualEnv string,
	requirementsFile string,
	cycloneDxVersion string,
	cycloneDxSchemaVersion string,
) error

func CreateVirtualEnvironment ¶

func CreateVirtualEnvironment(
	executeFn func(executable string, params ...string) error,
	removeFn func(executable string) error,
	virtualEnv string,
) (func(), error)

func InstallBuild ¶ added in v1.472.0

func InstallBuild(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
) error

func InstallCycloneDX ¶

func InstallCycloneDX(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
	cycloneDXVersion string,
) error

func InstallPip ¶ added in v1.472.0

func InstallPip(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
) error

func InstallProjectDependencies ¶ added in v1.472.0

func InstallProjectDependencies(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
) error

func InstallRequirements ¶

func InstallRequirements(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
	requirementsFile string,
) error

func InstallTestDependencies ¶ added in v1.511.0

func InstallTestDependencies(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
) error

func InstallTwine ¶

func InstallTwine(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
) error

func InstallWheel ¶

func InstallWheel(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
) error

func PublishPackage ¶

func PublishPackage(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
	repository string,
	username string,
	password string,
) error

func RunTests ¶ added in v1.511.0

func RunTests(
	executeFn func(executable string, params ...string) error,
	virtualEnv string,
	testOptions []string,
) error

RunTests runs pytest inside virtualEnv with the given extra testOptions. executeFn must propagate *exec.ExitError transparently (via %w) so that the exit-code-5 "no tests collected" branch can unwrap it with errors.As.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL