[ CLASS ] - Request class used by sStash.stashLib.Stash class. More...

Inheritance diagram for sStash.stashLib.Request:

Public Member Functions
def	__init__ (self)
	Constructor. More...

def	set (self, project=None, developer=None, development=None, stage=None, ignoreMaster=False, ignorePackage=None, ignoreReset=False, last=False, app=None, appExecArgs=None, ignoreAppExec=False, initializeAppPackages=False, logPath=None, scriptPath=None, callbackModulePath=None, packageSettingsModulePath=None, preScript=None, postScript=None, custom=None, displayOnly=False, setOnly=False, ignoreScriptExec=False, outScript=False, outAppExec=False, outPackages=False, outDevelopmentPackages=False, outStagePackages=False, outProjectPackages=False, outMasterPackages=False, outEnv=0, outDevelopmentEnv=0, outStageEnv=0, outProjectEnv=0, outMasterEnv=0, outData=0, outLog=False, outMAC=False, outVersion=False)
	Sets request. More...

def	setByStr (self, flag)
	Sets request by string that contains flags and their values. More...

def	buildForCommandLine (self)
	Build flags as they would be used in command line. More...

def	getFlag (self, flag)
	Get sStash.stashLib.Flag class instance used by this class. More...

def	reset (self)
	Reset values of all flags. More...

Detailed Description

[ CLASS ] - Request class used by sStash.stashLib.Stash class.

Constructor & Destructor Documentation

◆ init()

def sStash.stashLib.Request.__init__ ( self )

Constructor.

Exceptions

N/A

Returns: None - None.

Member Function Documentation

◆ set()

def sStash.stashLib.Request.set	(	self,
		project = `None`,
		developer = `None`,
		development = `None`,
		stage = `None`,
		ignoreMaster = `False`,
		ignorePackage = `None`,
		ignoreReset = `False`,
		last = `False`,
		app = `None`,
		appExecArgs = `None`,
		ignoreAppExec = `False`,
		initializeAppPackages = `False`,
		logPath = `None`,
		scriptPath = `None`,
		callbackModulePath = `None`,
		packageSettingsModulePath = `None`,
		preScript = `None`,
		postScript = `None`,
		custom = `None`,
		displayOnly = `False`,
		setOnly = `False`,
		ignoreScriptExec = `False`,
		outScript = `False`,
		outAppExec = `False`,
		outPackages = `False`,
		outDevelopmentPackages = `False`,
		outStagePackages = `False`,
		outProjectPackages = `False`,
		outMasterPackages = `False`,
		outEnv = `0`,
		outDevelopmentEnv = `0`,
		outStageEnv = `0`,
		outProjectEnv = `0`,
		outMasterEnv = `0`,
		outData = `0`,
		outLog = `False`,
		outMAC = `False`,
		outVersion = `False`
	)

Sets request.

Values accepted by outPackages, outDevelopmentPackages, outStagePackages, outProjectPackages and outMasterPackages arguments are;

Value	Result
0	Not requested
1	Absolute path of the packages with variable names
2	Absolute path of the packages for setting the environment for current platform

Values accepted by outEnv, outDevelopmentEnv, outStageEnv, outProjectEnv and outMasterEnv argument are;

Value	Result
1	Entries
2	Entries as they would be in env script

Values accepted by outData argument are;

Value	Result
0	Not requested
1	All below
2	Request
3	Settings
4	App
5	Solver
6	Builder

Parameters

project	[ str \| None \| in ] - Project name.
developer	[ str \| None \| in ] - Development or stage environment would be initialized for the provided developer (user).
development	[ str \| None \| in ] - Development environment name.
stage	[ str \| None \| in ] - Stage environment name.
ignoreMaster	[ bool \| None \| in ] - Ignore master project environment by not initializing the packages from the project.
ignorePackage	[ str \| None \| in ] - Packages to ignore.
ignoreReset	[ bool \| None \| in ] - Ignore, therefore do not execute environment reset script.
last	[ bool \| None \| in ] - Repeat last environment.
app	[ str \| None \| in ] - App name.
appExecArgs	[ str \| None \| in ] - App executable arguments.
ignoreAppExec	[ bool \| False \| in ] - Ignore application executable.
initializeAppPackages	[ bool \| False \| in ] - Initialize app packages.
logPath	[ str \| None \| in ] - Log path.
scriptPath	[ str \| None \| in ] - Script path.
callbackModulePath	[ str \| None \| in ] - Callback module path.
packageSettingsModulePath	[ str \| None \| in ] - Package settings module path.
preScript	[ str \| None \| in ] - Pre script, delimiter is \|.
postScript	[ str \| None \| in ] - Post script, delimiter is \|.
custom	[ str \| None \| in ] - Custom flags and values.
displayOnly	[ bool \| False \| in ] - Environment script is written only to display the environment but not to set it.
setOnly	[ bool \| False \| in ] - Script is written only to set the environment but not to display it.
ignoreScriptExec	[ bool \| False \| in ] - Ignore script execution.
outScript	[ bool \| False \| in ] - Display absolute path of the environment script.
outAppExec	[ bool \| False \| in ] - Display application executable (if any) as it is stated in the app file.
outPackages	[ bool \| False \| in ] - Return all packages.
outDevelopmentPackages	[ bool \| False \| in ] - Return development packages.
outStagePackages	[ bool \| False \| in ] - Return stage packages.
outProjectPackages	[ bool \| False \| in ] - Return project packages.
outMasterPackages	[ bool \| False \| in ] - Return master project packages.
outEnv	[ int \| 0 \| in ] - Return all environments.
outDevelopmentEnv	[ int \| 0 \| in ] - Return development environment.
outStageEnv	[ int \| 0 \| in ] - Return stage environment.
outProjectEnv	[ int \| 0 \| in ] - Return project environment.
outMasterEnv	[ int \| 0 \| in ] - Return master project environment.
outData	[ int \| 0 \| in ] - Display the data (request, settings) used to resolve the environment.
outLog	[ bool \| False \| in ] - Display log.
outMAC	[ bool \| False \| in ] - Display MAC address.
outVersion	[ bool \| False \| in ] - Display version.

Exceptions

N/A

Returns: None - None.

◆ setByStr()

def sStash.stashLib.Request.setByStr	(	self,
		flag
	)

Sets request by string that contains flags and their values.

Parameters

flag	[ str \| None \| in ] - String that contains flags and their values.

Exceptions

N/A

Returns: None - None.

◆ buildForCommandLine()

def sStash.stashLib.Request.buildForCommandLine ( self )

Build flags as they would be used in command line.

Exceptions

N/A

Returns: str - All flags and their values.

◆ getFlag()

def sStash.stashLib.Request.getFlag	(	self,
		flag
	)

Get sStash.stashLib.Flag class instance used by this class.

Parameters

flag	[ sStash.stashLib.Request.FlagName \| None \| in ] - A member of sStash.stashLib.Request.FlagName enum class.

Exceptions

N/A

Returns: sStash.stashLib.Request.Flag - Flag class.; None - If this class doesn't have requested flag.

◆ reset()

def sStash.stashLib.Request.reset ( self )

Reset values of all flags.

Exceptions

N/A

Returns: None - None.

The documentation for this class was generated from the following file:

sStash/python/sStash/stashLib.py

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ set()

◆ setByStr()

◆ buildForCommandLine()

◆ getFlag()

◆ reset()

◆ init()