twisted.web.test.test_wsgi.StartResponseTests(WSGITestsMixin, TestCase) class documentation

Part of twisted.web.test.test_wsgi (View In Hierarchy)

Tests for the start_response parameter passed to the application object by WSGIResource.

Method test_status The response status passed to the start_response callable is written as the status of the response to the request.
Method test_statusMustBeNativeString The response status passed to the start_response callable MUST be a native string in Python 2 and Python 3.
Method test_headers The headers passed to the start_response callable are included in the response as are the required Date and Server headers and the necessary connection (hop to hop) header Transfer-Encoding.
Method test_headersMustBeSequence The headers passed to the start_response callable MUST be a sequence.
Method test_headersShouldBePlainList According to PEP-3333, the headers passed to the start_response callable MUST be a plain list:
Method test_headersMustEachBeSequence Each header passed to the start_response callable MUST be a sequence.
Method test_headersShouldEachBeTuple According to PEP-3333, each header passed to the start_response callable should be a tuple:
Method test_headersShouldEachHaveKeyAndValue Each header passed to the start_response callable MUST hold a key and a value, and ONLY a key and a value.
Method test_headerKeyMustBeNativeString Each header key passed to the start_response callable MUST be at native string in Python 2 and Python 3.
Method test_headerValueMustBeNativeString Each header value passed to the start_response callable MUST be at native string in Python 2 and Python 3.
Method test_applicationProvidedContentType If Content-Type is included in the headers passed to the start_response callable, one Content-Type header is included in the response.
Method test_applicationProvidedServerAndDate If either Server or Date is included in the headers passed to the start_response callable, they are disregarded.
Method test_delayedUntilReturn No summary
Method test_delayedUntilContent No summary
Method test_content Content produced by the iterator returned by the application object is written to the request as it is produced.
Method test_multipleStartResponse If the start_response callable is invoked multiple times before a data for the response body is produced, the values from the last call are used.
Method test_startResponseWithException If the start_response callable is invoked with a third positional argument before the status and headers have been written to the response, the status and headers become the newly supplied values.
Method test_startResponseWithExceptionTooLate No summary
Method test_write start_response returns the write callable which can be used to write bytes to the response body without buffering.
Method test_writeAcceptsOnlyByteStrings The write callable returned from start_response only accepts byte strings.
Method _headersTest No summary

Inherited from WSGITestsMixin:

Instance Variable channelFactory A no-argument callable which will be invoked to create a new HTTP channel to associate with request objects.
Method setUp Undocumented
Method lowLevelRender
Method render Undocumented
Method requestFactoryFactory Undocumented
Method getContentFromResponse Undocumented
Method prepareRequest Prepare a Request which, when a request is received, captures the environ and start_response callable passed to a WSGI app.

Inherited from TestCase:

Instance Variable timeout A real number of seconds. If set, the test will raise an error if it takes longer than timeout seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
Method __init__ Construct an asynchronous test case for methodName.
Method assertFailure Fail if deferred does not errback with one of expectedFailures. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
Method __call__ Run the test. Should always do exactly the same thing as run().
Method deferSetUp Undocumented
Method deferTestMethod Undocumented
Method deferTearDown Undocumented
Method deferRunCleanups Run any scheduled cleanups and report errors (if any to the result object.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method getSuppress Undocumented
Method getTimeout No summary
Method _run Run a single method, either a test method or fixture.
Method _ebDeferSetUp Undocumented
Method _cbDeferTestMethod Undocumented
Method _ebDeferTestMethod Undocumented
Method _ebDeferTearDown Undocumented
Method _cbDeferRunCleanups Undocumented
Method _cleanUp Undocumented
Method _classCleanUp Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _deprecateReactor Deprecate iterate, crash and stop on reactor. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
Method _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _runCleanups Run the cleanups added with addCleanup in order.
Method _runFixturesAndTest Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via TestCase):

Instance Variable failureException An exception class, defaulting to FailTest. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable skip None or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the TestResult supports skipping).
Instance Variable todo None, a string or a tuple of (errors, reason) where errors is either an exception class or an iterable of exception classes, and reason is a string. See Todo or makeTodo for more information.
Instance Variable suppress None or a list of tuples of (args, kwargs) to be passed to warnings.filterwarnings. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also util.suppress.
Method __eq__ No summary
Method __ne__ Undocumented
Method __hash__ Undocumented
Method shortDescription Undocumented
Method getSkip No summary
Method getTodo No summary
Method runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method run Run the test case, storing the results in result.
Method patch Monkey patch an object for the duration of the test.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method callDeprecated Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method mktemp Create a new path name which can be used for a new file or directory.
Method _getSuppress No summary
Method _getSkipReason Return the reason to use for skipping a test method.
Method _installObserver Undocumented
Method _removeObserver Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method assertFalse Fail the test if condition evaluates to True.
Method assertTrue Fail the test if condition evaluates to False.
Method assertRaises Fail the test unless calling the function f with the given args and kwargs raises exception. The failure will report the traceback and call stack of the unexpected exception.
Method assertEqual Fail the test if first and second are not equal.
Method assertIs Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNotEqual Fail the test if first == second.
Method assertIn Fail the test if containee is not found in container.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotAlmostEqual Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertAlmostEqual Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertApproximates Fail if first - second > tolerance
Method assertSubstring Fail if substring does not exist within astring.
Method assertNotSubstring Fail if astring contains substring.
Method assertWarns Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method successResultOf Return the current success result of deferred or raise self.failureException.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertRegex Fail the test if a regexp search of text fails.
def test_status(self):

The response status passed to the start_response callable is written as the status of the response to the request.

def test_statusMustBeNativeString(self):

The response status passed to the start_response callable MUST be a native string in Python 2 and Python 3.

def _headersTest(self, appHeaders, expectedHeaders):

Verify that if the response headers given by appHeaders are passed to the start_response callable, then the response header lines given by expectedHeaders plus Server and Date header lines are included in the response.

def test_headers(self):

The headers passed to the start_response callable are included in the response as are the required Date and Server headers and the necessary connection (hop to hop) header Transfer-Encoding.

def test_headersMustBeSequence(self):

The headers passed to the start_response callable MUST be a sequence.

def test_headersShouldBePlainList(self): 
According to PEP-3333, the headers passed to the I{start_response}
callable MUST be a plain list:

  The response_headers argument ... must be a Python list; i.e.
  type(response_headers) is ListType

However, for bug-compatibility, any sequence is accepted. In both
Python 2 and Python 3, only a warning is issued when a sequence other
than a list is encountered.
def test_headersMustEachBeSequence(self):

Each header passed to the start_response callable MUST be a sequence.

def test_headersShouldEachBeTuple(self): 
According to PEP-3333, each header passed to the I{start_response}
callable should be a tuple:

  The response_headers argument is a list of (header_name,
  header_value) tuples

However, for bug-compatibility, any 2 element sequence is also
accepted. In both Python 2 and Python 3, only a warning is issued when
a sequence other than a tuple is encountered.
def test_headersShouldEachHaveKeyAndValue(self):

Each header passed to the start_response callable MUST hold a key and a value, and ONLY a key and a value.

def test_headerKeyMustBeNativeString(self):

Each header key passed to the start_response callable MUST be at native string in Python 2 and Python 3.

def test_headerValueMustBeNativeString(self):

Each header value passed to the start_response callable MUST be at native string in Python 2 and Python 3.

def test_applicationProvidedContentType(self):

If Content-Type is included in the headers passed to the start_response callable, one Content-Type header is included in the response.

def test_applicationProvidedServerAndDate(self):

If either Server or Date is included in the headers passed to the start_response callable, they are disregarded.

def test_delayedUntilReturn(self):

Nothing is written in response to a request when the start_response callable is invoked. If the iterator returned by the application object produces only empty strings, the response is written after the last element is produced.

def test_delayedUntilContent(self):

Nothing is written in response to a request when the start_response callable is invoked. Once a non-empty string has been produced by the iterator returned by the application object, the response status and headers are written.

def test_content(self):

Content produced by the iterator returned by the application object is written to the request as it is produced.

def test_multipleStartResponse(self):

If the start_response callable is invoked multiple times before a data for the response body is produced, the values from the last call are used.

def test_startResponseWithException(self):

If the start_response callable is invoked with a third positional argument before the status and headers have been written to the response, the status and headers become the newly supplied values.

def test_startResponseWithExceptionTooLate(self):

If the start_response callable is invoked with a third positional argument after the status and headers have been written to the response, the supplied exc_info values are re-raised to the application.

def test_write(self):

start_response returns the write callable which can be used to write bytes to the response body without buffering.

def test_writeAcceptsOnlyByteStrings(self):

The write callable returned from start_response only accepts byte strings.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.