twisted.trial.runner module documentation

Part of twisted.trial View Source

A miscellany of code used to run Trial tests.

Maintainer: Jonathan Lange

Function isPackage Given an object return True if the object looks like a package
Function isPackageDirectory Is the directory at path 'dirname' a Python package directory? Returns the name of the __init__ file (it may have a weird extension) if dirname is a package directory. Otherwise, returns False
Function samefile A hacky implementation of os.path.samefile. Used by filenameToModule when the platform doesn't provide os.path.samefile. Do not use this.
Function filenameToModule Given a filename, do whatever possible to return a module object matching that file.
Class DestructiveTestSuite A test suite which remove the tests once run, to minimize memory usage.
Class LoggedSuite Any errors logged in this suite will be reported to the TestResult object.
Class TrialSuite Suite to wrap around every single test in a trial run. Used internally by Trial to set up things necessary for Trial tests to work, regardless of what context they are run in.
Function name
Function isTestCase
Class TestHolder Placeholder for a TestCase inside a reporter. As far as a TestResult is concerned, this looks exactly like a unit test.
Class ErrorHolder No summary
Class TestLoader I find tests inside function, modules, files -- whatever -- then return them wrapped inside a Test (either a TestSuite or a TestCase).
Class Py3TestLoader A test loader finds tests from the functions, modules, and files that is asked to and loads them into a TestSuite or TestCase.
Class TrialRunner A specialised runner that the trial front end uses.
Function _importFromFile Undocumented
Function _resolveDirectory Undocumented
Function _getMethodNameInClass Find the attribute name on the method's class which refers to the method.
Function _qualNameWalker Given a Python qualified name, this function yields a 2-tuple of the most specific qualified name first, followed by the next-most-specific qualified name, and so on, paired with the remainder of the qualified name.
def isPackage(module): (source)

Given an object return True if the object looks like a package

def isPackageDirectory(dirname): (source)

Is the directory at path 'dirname' a Python package directory? Returns the name of the __init__ file (it may have a weird extension) if dirname is a package directory. Otherwise, returns False

def samefile(filename1, filename2): (source)

A hacky implementation of os.path.samefile. Used by filenameToModule when the platform doesn't provide os.path.samefile. Do not use this.

def filenameToModule(fn): (source)

Given a filename, do whatever possible to return a module object matching that file.

If the file in question is a module in Python path, properly import and return that module. Otherwise, load the source manually.

ParametersfnA filename.
ReturnsA module object.
RaisesValueErrorIf fn does not exist.
def _importFromFile(fn, moduleName=None): (source)
Undocumented
def _resolveDirectory(fn): (source)
Undocumented
def _getMethodNameInClass(method): (source)

Find the attribute name on the method's class which refers to the method.

For some methods, notably decorators which have not had __name__ set correctly:

getattr(method.im_class, method.__name__) != method

def name(thing): (source)
Parametersthingan object from modules (instance of PythonModule, PythonAttribute), a TestCase subclass, or an instance of a TestCase.
def isTestCase(obj): (source)
ReturnsTrue if obj is a class that contains test cases, False otherwise. Used to find all the tests in a module.
def _qualNameWalker(qualName): (source)

Given a Python qualified name, this function yields a 2-tuple of the most specific qualified name first, followed by the next-most-specific qualified name, and so on, paired with the remainder of the qualified name.

ParametersqualNameA Python qualified name. (type: str)
API Documentation for Twisted, generated by pydoctor at 2018-07-14 04:53:34.