U  W[@sTdZddlmZmZddlmZddlmZGdddejZ GdddejZ dS) z3 Interfaces for Trial. Maintainer: Jonathan Lange )divisionabsolute_importN) Attributec@sBeZdZdZedZddZddZddZ d d Z d d Z d S) ITestCasezU The interface that a test case must implement in order to be used in Trial. z7The exception class that is raised by failed assertionscCsdS)zQ Run the test. Should always do exactly the same thing as run(). Nresultrr6/usr/lib/python3/dist-packages/twisted/trial/itrial.py__call__szITestCase.__call__cCsdS)zJ Return the number of tests in this test case. Usually 1. Nrrrrr countTestCasesszITestCase.countTestCasescCsdS)zk Return a unique identifier for the test, usually the fully-qualified Python name. Nrrrrr id%sz ITestCase.idcCsdS)zj Run the test, storing the results in C{result}. @param result: A L{TestResult}. Nrrrrr run,sz ITestCase.runcCsdS)z9 Return a short description of the test. Nrrrrr shortDescription4szITestCase.shortDescriptionN) __name__ __module__ __qualname____doc__zirZfailureExceptionr r r r rrrrr rsrc@seZdZdZedZedZedZedZ edZ edZ dd Z d d Z d d ZddZddZd.ddZddZddZddZd/ddZd0ddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-ZdS)1 IReporterz6 I report results from a run of a test suite. zIDeprecated in Twisted 8.0. The io-stream that this reporter will write toz'Either 'default', 'brief', or 'verbose'z7Additional string argument passed from the command linezZ A boolean indicating that this reporter would like the test run to stop. z\Deprecated in Twisted 8.0. A value which will occasionally be passed to the L{write} method.zd The number of tests that seem to have been run according to this reporter. cCsdS)z Report the beginning of a run of a single test method. @param method: an object that is adaptable to ITestMethod Nrmethodrrr startTestTszIReporter.startTestcCsdS)z~ Report the status of a single test method @param method: an object that is adaptable to ITestMethod Nrrrrr stopTest\szIReporter.stopTestcCsdS)z Deprecated in Twisted 8.0. Suites which wish to appear in reporter output should call this before running their tests. Nrnamerrr startSuitedszIReporter.startSuitecCsdS)z Deprecated in Twisted 8.0. Called at the end of a suite, if and only if that suite has called C{startSuite}. Nrrrrr endSuitemszIReporter.endSuitecCsdS)z Deprecated in Twisted 8.0. Called when the reactor has been left in a 'dirty' state @param errs: a list of L{twisted.python.failure.Failure}s Nr)Zerrsrrr cleanupErrorsvszIReporter.cleanupErrorsTcCsdS)a Deprecated in Twisted 8.0. Called when an error occurs in a setUp* or tearDown* method @param warn: indicates whether or not the reporter should emit a warning about the error @type warn: Boolean @param printStatus: indicates whether or not the reporter should print the name of the method and the status message appropriate for the type of error @type printStatus: Boolean Nr)ZuserMethwarnZ printStatusrrr upDownErrorszIReporter.upDownErrorcCsdS)z* Record that test passed. Nr)testrrr addSuccessszIReporter.addSuccesscCsdS)aI Record that a test has raised an unexpected exception. @param test: The test that has raised an error. @param error: The error that the test raised. It will either be a three-tuple in the style of C{sys.exc_info()} or a L{Failure} object. Nr)r errorrrr addErrorszIReporter.addErrorcCsdS)aH Record that a test has failed with the given failure. @param test: The test that has failed. @param failure: The failure that the test failed with. It will either be a three-tuple in the style of C{sys.exc_info()} or a L{Failure} object. Nr)r failurerrr addFailureszIReporter.addFailureNcCsdS)a Record that the given test failed, and was expected to do so. In Twisted 15.5 and prior, C{todo} was a mandatory parameter. @type test: L{unittest.TestCase} @param test: The test which this is about. @type error: L{failure.Failure} @param error: The error which this test failed with. @type todo: L{unittest.Todo} @param todo: The reason for the test's TODO status. If L{None}, a generic reason is used. Nr)r r$todorrr addExpectedFailureszIReporter.addExpectedFailurecCsdS)a Record that the given test failed, and was expected to do so. In Twisted 15.5 and prior, C{todo} was a mandatory parameter. @type test: L{unittest.TestCase} @param test: The test which this is about. @type todo: L{unittest.Todo} @param todo: The reason for the test's TODO status. If L{None}, a generic reason is used. Nr)r r&rrr addUnexpectedSuccessszIReporter.addUnexpectedSuccesscCsdS)z Record that a test has been skipped for the given reason. @param test: The test that has been skipped. @param reason: An object that the test case has specified as the reason for skipping the test. Nr)r reasonrrr addSkipszIReporter.addSkipcCsdS)zq Deprecated in Twisted 8.0, use L{done} instead. Present a summary of the test results. Nrrrrr printSummaryszIReporter.printSummarycCsdS)z Deprecated in Twisted 8.0, use L{done} instead. Present the errors that have occurred during the test run. This method will be called after all tests have been run. Nrrrrr printErrorsszIReporter.printErrorscCsdS)z Deprecated in Twisted 8.0, use L{done} instead. Display a string to the user, without appending a new line. Nrstringrrr writeszIReporter.writecCsdS)z~ Deprecated in Twisted 8.0, use L{done} instead. Display a string to the user, appending a new line. Nrr-rrr writelnszIReporter.writelncCsdS)z Return a boolean indicating whether all test results that were reported to this reporter were successful or not. Nrrrrr wasSuccessfulszIReporter.wasSuccessfulcCsdS)a1 Called when the test run is complete. This gives the result object an opportunity to display a summary of information to the user. Once you have called C{done} on an L{IReporter} object, you should assume that the L{IReporter} object is no longer usable. Nrrrrr doneszIReporter.done)TT)N)N)rrrrrrstreamZtbformatargsZ shouldStopZ separatorZtestsRunrrrrrrr!r#r%r'r(r*r+r,r/r0r1r2rrrr r;sF         r) rZ __future__rrZzope.interfaceZ interfacerrZ Interfacerrrrrr s   +