mMeco.operators.settingsOpt.SettingsOperator Class Reference

[ CLASS ] - Class to operate on Python modules. More...

Inheritance diagram for mMeco.operators.settingsOpt.SettingsOperator:

Public Member Functions
def	__init__ (self, module=None)
	Constructor. More...
def	__str__ (self)
	String representation. More...
def	masterProjectName (self)
	Property. More...
def	projectNameInUse (self)
	Property. More...
def	reservedPackagesPath (self)
	Property. More...
def	developmentPackagesPath (self)
	Property. More...
def	stagePackagesPath (self)
	Property. More...
def	projectInternalPackagesPath (self)
	Property. More...
def	projectExternalPackagesPath (self)
	Property. More...
def	masterProjectInternalPackagesPath (self)
	Property. More...
def	masterProjectExternalPackagesPath (self)
	Property. More...
def	appFilePath (self)
	Property. More...
def	scriptFilePath (self)
	Property. More...
def	logFilePath (self)
	Property. More...
def	terminalHeaderDisplayColor (self)
	Property. More...
def	terminalDisplayColor (self)
	Property. More...
def	asStr (self)
	Get string representation of the class. More...
def	getTerminalDisplayColorByColorName (self, colorName, envType=None)
	Get terminal display color for given env type. More...
Public Member Functions inherited from mMeco.abstract.operatorAbs.Operator
def	name (self)
	Property. More...
def	allLib (self)
	Property. More...
def	module (self)
	Property. More...
def	set (self, module=None)
	Set Python module. More...
def	initialize (self)
	Initialize the attributes of the Python module. More...

Static Public Attributes
string	MODULE = 'mMecoSettings.settingsLib'
	[ str ] - Default Python module import name.
Static Public Attributes inherited from mMeco.abstract.operatorAbs.Operator
	MODULE = None
	[ str ] - Default Python module import name.

Additional Inherited Members
Static Public Member Functions inherited from mMeco.abstract.operatorAbs.Operator
def	importModule (module)
	Import Python module. More...

Detailed Description

[ CLASS ] - Class to operate on Python modules.

Constructor & Destructor Documentation

__init__()

def mMeco.operators.settingsOpt.SettingsOperator.__init__	(		self,
			module = None
	)

Constructor.

Parameters

module

[ str | None | in ] - Python module import path or Python module file path.

Exceptions

N/A

Returns

None - None.

Reimplemented from mMeco.abstract.operatorAbs.Operator.

Member Function Documentation

__str__()

def mMeco.operators.settingsOpt.SettingsOperator.__str__

(

self

)

String representation.

Exceptions

N/A

Returns

str - String representation.

masterProjectName()

def mMeco.operators.settingsOpt.SettingsOperator.masterProjectName

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

projectNameInUse()

def mMeco.operators.settingsOpt.SettingsOperator.projectNameInUse

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

reservedPackagesPath()

def mMeco.operators.settingsOpt.SettingsOperator.reservedPackagesPath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

developmentPackagesPath()

def mMeco.operators.settingsOpt.SettingsOperator.developmentPackagesPath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

stagePackagesPath()

def mMeco.operators.settingsOpt.SettingsOperator.stagePackagesPath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

projectInternalPackagesPath()

def mMeco.operators.settingsOpt.SettingsOperator.projectInternalPackagesPath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

projectExternalPackagesPath()

def mMeco.operators.settingsOpt.SettingsOperator.projectExternalPackagesPath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

masterProjectInternalPackagesPath()

def mMeco.operators.settingsOpt.SettingsOperator.masterProjectInternalPackagesPath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

masterProjectExternalPackagesPath()

def mMeco.operators.settingsOpt.SettingsOperator.masterProjectExternalPackagesPath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

appFilePath()

def mMeco.operators.settingsOpt.SettingsOperator.appFilePath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

scriptFilePath()

def mMeco.operators.settingsOpt.SettingsOperator.scriptFilePath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

logFilePath()

def mMeco.operators.settingsOpt.SettingsOperator.logFilePath

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

terminalHeaderDisplayColor()

def mMeco.operators.settingsOpt.SettingsOperator.terminalHeaderDisplayColor

(

self

)

Property.

Exceptions

N/A

Returns

list of str - Value.

terminalDisplayColor()

def mMeco.operators.settingsOpt.SettingsOperator.terminalDisplayColor

(

self

)

Property.

Exceptions

N/A

Returns

list of str - Value.

asStr()

def mMeco.operators.settingsOpt.SettingsOperator.asStr

(

self

)

Get string representation of the class.

Exceptions

N/A

Returns

str - Information about the package in human readable form.

getTerminalDisplayColorByColorName()

def mMeco.operators.settingsOpt.SettingsOperator.getTerminalDisplayColorByColorName	(		self,
			colorName,
			envType = None
	)

Get terminal display color for given env type.

Parameters

colorName	[ enum | None | in ] - Color from mMeco.libs.enumLib.ColorName enum class.
envType	[ enum | None | in ] - Env type from mMeco.libs.enumLib.EnvType enum class.

Exceptions

N/A

Returns

str - Value.

---

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

• mMeco/python/mMeco/operators/settingsOpt.py