sPythonUtils.packageEnvLib Namespace Reference

[ MODULE ] - Package environment module. More...

Functions
def	setEnvironment (envType, packageRoot, projectName, developerName, developmentEnvName, stageEnvName, platformName, appPath, custom)
	Set custom environment. More...

Detailed Description

[ MODULE ] - Package environment module.

Function Documentation

setEnvironment()

def sPythonUtils.packageEnvLib.setEnvironment	(		envType,
			packageRoot,
			projectName,
			developerName,
			developmentEnvName,
			stageEnvName,
			platformName,
			appPath,
			custom
	)

Set custom environment.

Return object must be a None instance if this package shouldn't be initialized.

Return object must be an empty list instance if this package should be initialized without any custom package based environment.

Return object must be a list instance that contains dict instances with the following keys if package should be initialized with custom package based environment.

Key	Data Type	Description
envType	str	Provided envType argument value must be set for this key.
entryType	str	Either one of the following values: single, multi, command, script.
variable	str	Name of the environment variable.
value	str	Value of the environment variable.

Warning

If either command or script is provided for entryType, None must be provided for variable key.

Parameters

envType	[ str | None | in ] - Environment type, either one of the following: development, stage, project, masterProject.
packageRoot	[ str | None | in ] - Root path of this package.
projectName	[ str | None | in ] - Project name.
developerName	[ str | None | in ] - Developer name, if applicable.
developmentEnvName	[ str | None | in ] - Development environment name, if applicable.
stageEnvName	[ str | None | in ] - Stage environment name, if applicable.
platformName	[ str | None | in ] - Platform name, either one of the following: Linux, Darwin, Windows.
appPath	[ str | None | in ] - Absolute path of app file if its provided, otherwise empty string passed will be passed.
custom	[ str | None | in ] - Custom values passed to executable by –custom flag.

Exceptions

N/A

Returns

list of dict - Custom environment, package should be initialized.

list (empty) - No custom environment, package should be initialized.

None - Return None if this package should not be initialized.