class documentation

class twisted.trial._dist.disttrial.DistTrialRunner: (source)

View In Hierarchy

A specialized runner for distributed trial. The runner launches a number of local worker processes which will run tests.

Method __init__ Undocumented
Method writeResults Write test run final outcome to result.
Method createLocalWorkers Create local worker protocol instances and return them.
Method launchWorkerProcesses Spawn processes from a list of process protocols.
Method run Spawn local worker processes and load tests. After that, run them.
Method runUntilFailure Run the tests with local worker processes until they fail.
Instance Variable _workerNumber the number of workers to be spawned.
Instance Variable _stream stream which the reporter will use.
Instance Variable _reporterFactory the reporter class to be used.
Method _makeResult Make reporter factory, and wrap it with a DistReporter.
Instance Variable _workerArguments Undocumented
Instance Variable _tbformat Undocumented
Instance Variable _rterrors Undocumented
Instance Variable _uncleanWarnings Undocumented
Instance Variable _result Undocumented
Instance Variable _workingDirectory Undocumented
Instance Variable _logFile Undocumented
Instance Variable _logFileObserver Undocumented
Instance Variable _logFileObject Undocumented
Instance Variable _logWarnings Undocumented
Method _driveWorker Drive a LocalWorkerAMP instance, iterating the tests and calling run for every one of them.
_workerNumber = (source)
the number of workers to be spawned.
(type: int)
_stream = (source)
stream which the reporter will use.
_reporterFactory = (source)
the reporter class to be used.
def _makeResult(self): (source)

Make reporter factory, and wrap it with a DistReporter.

def __init__(self, reporterFactory, workerNumber, workerArguments, stream=None, tracebackFormat='default', realTimeErrors=False, uncleanWarnings=False, logfile='test.log', workingDirectory='_trial_temp'): (source)

Undocumented

_workerArguments = (source)

Undocumented

_tbformat = (source)

Undocumented

_rterrors = (source)

Undocumented

_uncleanWarnings = (source)

Undocumented

_result = (source)

Undocumented

_workingDirectory = (source)

Undocumented

_logFile = (source)

Undocumented

_logFileObserver = (source)

Undocumented

_logFileObject = (source)

Undocumented

_logWarnings = (source)

Undocumented

(type: bool)
def writeResults(self, result): (source)

Write test run final outcome to result.

ParametersresultA TestResult which will print errors and the summary.
def createLocalWorkers(self, protocols, workingDirectory): (source)

Create local worker protocol instances and return them.

ParametersprotocolsAn iterable of LocalWorkerAMP instances.
workingDirectoryThe base path in which we should run the workers. (type: str)
ReturnsA list of quantity LocalWorker instances.
def launchWorkerProcesses(self, spawner, protocols, arguments): (source)

Spawn processes from a list of process protocols.

ParametersspawnerA IReactorProcess.spawnProcess implementation.
protocolsAn iterable of ProcessProtocol instances.
argumentsExtra arguments passed to the processes.
def _driveWorker(self, worker, result, testCases, cooperate): (source)

Drive a LocalWorkerAMP instance, iterating the tests and calling run for every one of them.

ParametersworkerThe LocalWorkerAMP to drive.
resultThe global DistReporter instance.
testCasesThe global list of tests to iterate.
cooperateThe cooperate function to use, to be customized in tests. (type: function)
ReturnsA Deferred firing when all the tests are finished.
def run(self, suite, reactor=None, cooperate=cooperate, untilFailure=False): (source)

Spawn local worker processes and load tests. After that, run them.

ParameterssuiteA tests suite to be run.
reactorThe reactor to use, to be customized in tests. (type: A provider of twisted.internet.interfaces.IReactorProcess)
cooperateThe cooperate function to use, to be customized in tests. (type: function)
untilFailureIf True, continue to run the tests until they fail. (type: bool.)
ReturnsThe test result. (type: DistReporter)
def runUntilFailure(self, suite): (source)

Run the tests with local worker processes until they fail.

ParameterssuiteA tests suite to be run.
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.