mMeco.libs.entryLib.EnvEntryContainer Class Reference

[ CLASS ] - Env envEntry container. More...

Inheritance diagram for mMeco.libs.entryLib.EnvEntryContainer:

Public Member Functions
def	__init__ (self, containerType=mMeco.libs.enumLib.EnvEntryContainerType.kPackage, path=None, packageName=None, version=None)
	Constructor. More...
def	__str__ (self)
	String representation. More...
def	type (self)
	Property. More...
def	path (self)
	Property. More...
def	packageName (self)
	Property. More...
def	version (self)
	Property. More...
def	entries (self)
	Property. More...
def	asStr (self)
	Get string representation of the class. More...
def	displayEntries (self)
	Display entries. More...
def	getPackageRootPath (self)
	Get root path of the package (if applicable) that represented by this instance. More...
def	addCommand (self, command)
	Add command. More...
def	addScript (self, scriptPath)
	Add script. More...
def	addSingle (self, variable, value)
	Add single env variable. More...
def	addMulti (self, variable, value)
	Add multi env variable. More...
def	sort (self)
	Sort entries. More...

Detailed Description

[ CLASS ] - Env envEntry container.

Class to contain mMeco.libs.entryLib.EnvEntry class instances.

Constructor & Destructor Documentation

__init__()

def mMeco.libs.entryLib.EnvEntryContainer.__init__	(		self,
			containerType = mMeco.libs.enumLib.EnvEntryContainerType.kPackage,
			path = None,
			packageName = None,
			version = None
	)

Constructor.

Parameters

containerType	[ enum | None | in ] - Env envEntry container type from mMeco.libs.enumLib.EnvEntryContainerType enum class.
path	[ str | None | in ] - Path of the package.
packageName	[ str | None | in ] - Name of the package.
version	[ str | None | in ] - Version of the package.

Exceptions

N/A

Returns

None - None.

Member Function Documentation

__str__()

def mMeco.libs.entryLib.EnvEntryContainer.__str__

(

self

)

String representation.

Exceptions

N/A

Returns

str - String representation.

type()

def mMeco.libs.entryLib.EnvEntryContainer.type

(

self

)

Property.

Exceptions

N/A

Returns

mMeco.libs.enumLib.EnvEntryContainerType - Value.

path()

def mMeco.libs.entryLib.EnvEntryContainer.path

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

packageName()

def mMeco.libs.entryLib.EnvEntryContainer.packageName

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

version()

def mMeco.libs.entryLib.EnvEntryContainer.version

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

entries()

def mMeco.libs.entryLib.EnvEntryContainer.entries

(

self

)

Property.

Exceptions

N/A

Returns

str - Value.

asStr()

def mMeco.libs.entryLib.EnvEntryContainer.asStr

(

self

)

Get string representation of the class.

Exceptions

N/A

Returns

str - Information about the package in human readable form.

displayEntries()

def mMeco.libs.entryLib.EnvEntryContainer.displayEntries

(

self

)

Display entries.

Exceptions

N/A

Returns

None - None.

getPackageRootPath()

def mMeco.libs.entryLib.EnvEntryContainer.getPackageRootPath

(

self

)

Get root path of the package (if applicable) that represented by this instance.

Exceptions

N/A

Returns

str - Root path of the package.

None - If this instance doesn't represent a package.

addCommand()

def mMeco.libs.entryLib.EnvEntryContainer.addCommand	(		self,
			command
	)

Add command.

Parameters

command

[ str | None | in ] - Command.

Exceptions

N/A

Returns

None - None.

addScript()

def mMeco.libs.entryLib.EnvEntryContainer.addScript	(		self,
			scriptPath
	)

Add script.

Parameters

scriptPath

[ str | None | in ] - Absolute path of a script.

Exceptions

N/A

Returns

None - None.

addSingle()

def mMeco.libs.entryLib.EnvEntryContainer.addSingle	(		self,
			variable,
			value
	)

Add single env variable.

Parameters

variable	[ str | None | in ] - Name.
value	[ str | None | in ] - Value.

Exceptions

N/A

Returns

None - None.

addMulti()

def mMeco.libs.entryLib.EnvEntryContainer.addMulti	(		self,
			variable,
			value
	)

Add multi env variable.

Parameters

variable	[ str | None | in ] - Name.
value	[ str | None | in ] - Value.

Exceptions

N/A

Returns

None - None.

sort()

def mMeco.libs.entryLib.EnvEntryContainer.sort

(

self

)

Sort entries.

Exceptions

N/A

Returns

None - None.

---

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

• mMeco/python/mMeco/libs/entryLib.py