mProcess.dependencyAbs.Dependency Class Reference

[ ABSTRACT CLASS ] - Abstract dependency class. More...

Inheritance diagram for mProcess.dependencyAbs.Dependency:

Public Member Functions
def	__init__ (self, parent=None, data=None, **kwargs)
	Constructor. More...
def	displayAutoIgnoredMessage (self)
	Display auto ignored message. More...
def	reset (self)
	Reset this dependency. More...
def	run (self)
	Run the dependency. More...
def	runFix (self)
	Run fix. More...
def	runAction (self)
	Run action. More...
def	isActionRunnable (self)
	Whether action is runnable for given condition. More...
def	shouldInitialize (self)
	Whether this dependency should be initialized. More...
PROPERTIES
def	data (self)
	Data. More...
def	kwargs (self)
	Keyword arguments. More...
def	name (self)
	Name of the dependency. More...
def	description (self)
	Description about the dependency. More...
def	isActive (self)
	Whether this dependency is active. More...
def	hasFix (self)
	Whether this dependency has fix. More...
def	runFixAutomatically (self)
	Whether auto fix should run automatically. More...
def	hasAction (self)
	Whether this dependency has action. More...
def	isIgnorable (self)
	Whether this dependency is ignorable. More...
def	isIgnored (self)
	Whether this dependency is ignored. More...
def	requiresDescriptionWhenIgnored (self)
	Whether this dependency requires description when ignored. More...
def	failureMessage (self)
	The last failure message that was recorded for this dependency. More...
def	isExecuted (self)
	Whether this dependency is executed. More...
def	isSucceeded (self)
	Whether this dependency succeeded after execution. More...

Static Public Attributes
int	MESSAGE_PADDING = 52
	[ int ] - Message padding.
	signalInfoOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setInfo method.
	signalSuccessOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setSuccess method.
	signalWarningOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setWarning method.
	signalFailureOccurred = QtCore.Signal(str)
	[ Signal ] - Signal emitted by _setFailure method.
	signalResultOccurred = QtCore.Signal(bool)
	[ Signal ] - Signal emitted by _setInfo and _setFailure methods

Detailed Description

[ ABSTRACT CLASS ] - Abstract dependency class.

Constructor & Destructor Documentation

__init__()

def mProcess.dependencyAbs.Dependency.__init__	(		self,
			parent = None,
			data = None,
		**	kwargs
	)

Constructor.

Parameters

parent	[ QObject | None | in ] - Parent.
data	[ mProcess.dataLib.Data | None | in ] - Data.
kwargs	[ dict | None | in ] - Keyword arguments.

Exceptions

N/A

Returns

None - None.

Reimplemented in mMecoRelease.processes.releasePreDep.genericCheckPackageDevelopmentLocationDep.GenericCheckPackageDevelopmentLocation, mMecoRelease.processes.releasePreDep.genericCheckEndOfWeekDep.GenericCheckEndOfWeek, mMecoRelease.processes.releasePreDep.genericCheckPackageVersionForReleasingDep.GenericCheckPackageVersionForReleasing, mMecoRelease.processes.releasePostDep.genericSendNotificationDep.GenericSendNotification, and mMecoRelease.processes.releasePreDep.genericDisplayPackageInfoDep.GenericDisplayPackageInfo.

Member Function Documentation

data()

def mProcess.dependencyAbs.Dependency.data

(

self

)

Data.

Exceptions

N/A

Returns

mProcess.dataLib.Data - Data.

kwargs()

def mProcess.dependencyAbs.Dependency.kwargs

(

self

)

Keyword arguments.

Exceptions

N/A

Returns

dict - Keyword arguments.

name()

def mProcess.dependencyAbs.Dependency.name

(

self

)

Name of the dependency.

Exceptions

N/A

Returns

str - Name.

description()

def mProcess.dependencyAbs.Dependency.description

(

self

)

Description about the dependency.

Exceptions

N/A

Returns

str - Description.

isActive()

def mProcess.dependencyAbs.Dependency.isActive

(

self

)

Whether this dependency is active.

Exceptions

N/A

Returns

bool - Value.

hasFix()

def mProcess.dependencyAbs.Dependency.hasFix

(

self

)

Whether this dependency has fix.

Exceptions

N/A

Returns

bool - Value.

runFixAutomatically()

def mProcess.dependencyAbs.Dependency.runFixAutomatically

(

self

)

Whether auto fix should run automatically.

Exceptions

N/A

Returns

bool - Value.

hasAction()

def mProcess.dependencyAbs.Dependency.hasAction

(

self

)

Whether this dependency has action.

Exceptions

N/A

Returns

bool - Value.

isIgnorable()

def mProcess.dependencyAbs.Dependency.isIgnorable

(

self

)

Whether this dependency is ignorable.

Exceptions

N/A

Returns

bool - Value.

isIgnored()

def mProcess.dependencyAbs.Dependency.isIgnored

(

self

)

Whether this dependency is ignored.

Exceptions

N/A

Returns

bool - Value.

requiresDescriptionWhenIgnored()

def mProcess.dependencyAbs.Dependency.requiresDescriptionWhenIgnored

(

self

)

Whether this dependency requires description when ignored.

Exceptions

N/A

Returns

bool - Value.

failureMessage()

def mProcess.dependencyAbs.Dependency.failureMessage

(

self

)

The last failure message that was recorded for this dependency.

Exceptions

N/A

Returns

str - Message.

isExecuted()

def mProcess.dependencyAbs.Dependency.isExecuted

(

self

)

Whether this dependency is executed.

Exceptions

N/A

Returns

bool - Value.

isSucceeded()

def mProcess.dependencyAbs.Dependency.isSucceeded

(

self

)

Whether this dependency succeeded after execution.

Exceptions

N/A

Returns

bool - Value.

displayAutoIgnoredMessage()

def mProcess.dependencyAbs.Dependency.displayAutoIgnoredMessage

(

self

)

Display auto ignored message.

Ignorable dependencies could be ignored by the container if they fail. In such case, this method will be invoked to notify the user.

Exceptions

N/A

Returns

None - None.

reset()

def mProcess.dependencyAbs.Dependency.reset

(

self

)

Reset this dependency.

Exceptions

N/A

Returns

None - None.

run()

def mProcess.dependencyAbs.Dependency.run

(

self

)

Run the dependency.

Exceptions

mProcess.exceptionLib.DependencyError

- No run method is available for this run mode.

Returns

bool - Result.

runFix()

def mProcess.dependencyAbs.Dependency.runFix

(

self

)

Run fix.

Exceptions

mProcess.exceptionLib.DependencyError

- No run fix method is available for this run mode.

Returns

bool - Result.

runAction()

def mProcess.dependencyAbs.Dependency.runAction

(

self

)

Run action.

Exceptions

NotImplementedError

- If this method is not implemented in child class when _hasAction True.

Returns

None - None.

isActionRunnable()

def mProcess.dependencyAbs.Dependency.isActionRunnable

(

self

)

Whether action is runnable for given condition.

This method is provided so GUI can decide whether to show the run action button.

Exceptions

N/A

Returns

bool - Result.

shouldInitialize()

def mProcess.dependencyAbs.Dependency.shouldInitialize

(

self

)

Whether this dependency should be initialized.

Implement this method to prevent child class instances from being initialized by raising mProcess.exceptionLib.DependencyError exception. Method must return True explicitly otherwise.

Exceptions

N/A

Returns

bool - Result.

---

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

• mProcess/python/mProcess/dependencyAbs.py