twisted.scripts.trial : API documentation

Variable	TBFORMAT_MAP	Undocumented
Function	loadLocalVariables	Accepts a filename and attempts to load the Emacs variable declarations from that file, simulating what Emacs does.
Function	getTestModules	Undocumented
Function	isTestFile	Returns true if 'filename' looks like a file containing unit tests. False otherwise. Doesn't care whether filename exists.
Class	Options	Options to the trial command line tool.
Function	run	Undocumented
Function	_parseLocalVariables	Accepts a single line in Emacs local variable declaration format and returns a dict of all the variables {name: value}. Raises ValueError if 'line' is in the wrong format.
Function	_reporterAction	Undocumented
Function	_maybeFindSourceLine	Try to find the source line of the given test thing.
Variable	_runOrders	Undocumented
Function	_checkKnownRunOrder	Check that the given order is a known test running order.
Class	_BasicOptions	Basic options shared between trial and its local workers.
Function	_initialDebugSetup	Undocumented
Function	_getSuite	Undocumented
Function	_getLoader	Undocumented
Function	_wrappedPdb	Wrap an instance of `pdb.Pdb` with readline support and load any .rcs.
Class	_DebuggerNotFound	A debugger import failed.
Function	_makeRunner	Return a trial runner class set up with the parameters extracted from `config`.

TBFORMAT_MAP = (source)

Undocumented

(type: dict[str, str])

def _parseLocalVariables(line): (source)

Accepts a single line in Emacs local variable declaration format and returns a dict of all the variables {name: value}. Raises ValueError if 'line' is in the wrong format.

See http://www.gnu.org/software/emacs/manual/html_node/File-Variables.html

def loadLocalVariables(filename): (source)

Accepts a filename and attempts to load the Emacs variable declarations from that file, simulating what Emacs does.

See http://www.gnu.org/software/emacs/manual/html_node/File-Variables.html

def getTestModules(filename): (source)

Undocumented

def isTestFile(filename): (source)

Returns true if 'filename' looks like a file containing unit tests. False otherwise. Doesn't care whether filename exists.

def _reporterAction(): (source)

Undocumented

def _maybeFindSourceLine(testThing): (source)

Try to find the source line of the given test thing.

Parameters	testThing	the test item to attempt to inspect (type: an `TestCase`, test method, or module, though only the former two have a chance to succeed)
Returns	the starting source line, or -1 if one couldn't be found (type: int)

_runOrders = (source)

Undocumented

def _checkKnownRunOrder(order): (source)

Check that the given order is a known test running order.

Does nothing else, since looking up the appropriate callable to sort the tests should be done when it actually will be used, as the default argument will not be coerced by this function.

Parameters	order	one of the known orders in `_runOrders`
Returns	the order unmodified

def _initialDebugSetup(config): (source)

Undocumented

def _getSuite(config): (source)

Undocumented

def _getLoader(config): (source)

Undocumented

def _wrappedPdb(): (source)

Wrap an instance of pdb.Pdb with readline support and load any .rcs.

def _makeRunner(config): (source)

Return a trial runner class set up with the parameters extracted from config.

Returns A trial runner instance. (type: runner.TrialRunner or DistTrialRunner depending on the configuration.)

def run(): (source)

Undocumented