twisted.web.test.test_webclient.WebClientTests(unittest.TestCase) class documentation

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

Known subclasses: twisted.web.test.test_webclient.WebClientSSLTests

No class docstring
Method setUp Undocumented
Method tearDown Undocumented
Method getURL Undocumented
Method testPayload Undocumented
Method test_getPageBrokenDownload If the connection is closed before the number of bytes indicated by Content-Length have been received, the Deferred returned by getPage fails with PartialDownloadError.
Method test_downloadPageBrokenDownload If the connection is closed before the number of bytes indicated by Content-Length have been received, the Deferred returned by downloadPage fails with PartialDownloadError.
Method test_downloadPageLogsFileCloseError If there is an exception closing the file being written to after the connection is prematurely closed, that exception is logged.
Method testHostHeader Undocumented
Method test_getPage client.getPage returns a Deferred which is called back with the body of the response if the default method GET is used.
Method test_getPageHEAD client.getPage returns a Deferred which is called back with the empty string if the method is HEAD and there is a successful response code.
Method test_getPageNotQuiteHEAD If the request method is a different casing of HEAD (ie, not all capitalized) then it is not a HEAD request and the response body is returned.
Method test_timeoutNotTriggering When a non-zero timeout is passed to getPage and the page is retrieved before the timeout period elapses, the Deferred is called back with the contents of the page.
Method test_timeoutTriggering When a non-zero timeout is passed to getPage and that many seconds elapse before the server responds to the request. the Deferred is errbacked with a error.TimeoutError.
Method testDownloadPage Undocumented
Method testDownloadPageError1 Undocumented
Method testDownloadPageError2 Undocumented
Method testDownloadPageError3 Undocumented
Method testServerError Undocumented
Method testDownloadServerError Undocumented
Method testFactoryInfo Undocumented
Method test_followRedirect By default, client.getPage follows redirects and returns the content of the target resource.
Method test_noFollowRedirect If followRedirect is passed a false value, client.getPage does not follow redirects and returns a Deferred which fails with error.PageRedirect when it encounters one.
Method test_infiniteRedirection When more than redirectLimit HTTP redirects are encountered, the page request fails with InfiniteRedirection.
Method test_isolatedFollowRedirect client.HTTPPagerGetter instances each obey the followRedirect value passed to the client.getPage call which created them.
Method test_afterFoundGet Enabling unsafe redirection behaviour overwrites the method of redirected POST requests with GET.
Method test_downloadAfterFoundGet Passing True for afterFoundGet to client.downloadPage invokes the same kind of redirect handling as passing that argument to client.getPage invokes.
Method test_afterFoundGetMakesOneRequest When afterFoundGet is True, client.getPage only issues one request to the server when following the redirect. This is a regression test, see #4760.
Method test_downloadTimeout No summary
Method test_downloadTimeoutsWorkWithoutReading No summary
Method test_downloadHeaders After client.HTTPDownloader.deferred fires, the client.HTTPDownloader instance's status and response_headers attributes are populated with the values from the response.
Method test_downloadCookies The cookies dict passed to the client.HTTPDownloader initializer is used to populate the Cookie header included in the request sent to the server.
Method test_downloadRedirectLimit When more than redirectLimit HTTP redirects are encountered, the page request fails with InfiniteRedirection.
Method test_setURL client.HTTPClientFactory.setURL alters the scheme, host, port and path for absolute URLs.
Method test_setURLRemovesFragment client.HTTPClientFactory.setURL removes the fragment identifier from the path component.
Method test_setURLRelativePath client.HTTPClientFactory.setURL alters the path in a relative URL.
Method _listen Undocumented
Method _cbDownloadPageTest Undocumented
Method _cleanupDownloadPageError3 Undocumented
Method _downloadTest Undocumented
Method _cbFactoryInfo Undocumented
Method _cbCheckLocation Undocumented

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 _listen(self, site):
overridden in twisted.web.test.test_webclient.WebClientSSLTests
Undocumented
def setUp(self):
Undocumented
def tearDown(self):
Undocumented
def getURL(self, path):
overridden in twisted.web.test.test_webclient.WebClientSSLTests
Undocumented
def testPayload(self):
Undocumented
def test_getPageBrokenDownload(self):

If the connection is closed before the number of bytes indicated by Content-Length have been received, the Deferred returned by getPage fails with PartialDownloadError.

def test_downloadPageBrokenDownload(self):

If the connection is closed before the number of bytes indicated by Content-Length have been received, the Deferred returned by downloadPage fails with PartialDownloadError.

def test_downloadPageLogsFileCloseError(self):

If there is an exception closing the file being written to after the connection is prematurely closed, that exception is logged.

def testHostHeader(self):
Undocumented
def test_getPage(self):

client.getPage returns a Deferred which is called back with the body of the response if the default method GET is used.

def test_getPageHEAD(self):

client.getPage returns a Deferred which is called back with the empty string if the method is HEAD and there is a successful response code.

def test_getPageNotQuiteHEAD(self):

If the request method is a different casing of HEAD (ie, not all capitalized) then it is not a HEAD request and the response body is returned.

def test_timeoutNotTriggering(self):

When a non-zero timeout is passed to getPage and the page is retrieved before the timeout period elapses, the Deferred is called back with the contents of the page.

def test_timeoutTriggering(self):

When a non-zero timeout is passed to getPage and that many seconds elapse before the server responds to the request. the Deferred is errbacked with a error.TimeoutError.

def testDownloadPage(self):
Undocumented
def _cbDownloadPageTest(self, ignored, data, name):
Undocumented
def testDownloadPageError1(self):
Undocumented
def testDownloadPageError2(self):
Undocumented
def testDownloadPageError3(self):
Undocumented
def _cleanupDownloadPageError3(self, ignored):
Undocumented
def _downloadTest(self, method):
Undocumented
def testServerError(self):
Undocumented
def testDownloadServerError(self):
Undocumented
def testFactoryInfo(self):
overridden in twisted.web.test.test_webclient.WebClientSSLTests
Undocumented
def _cbFactoryInfo(self, ignoredResult, factory):
Undocumented
def test_followRedirect(self):

By default, client.getPage follows redirects and returns the content of the target resource.

def test_noFollowRedirect(self):

If followRedirect is passed a false value, client.getPage does not follow redirects and returns a Deferred which fails with error.PageRedirect when it encounters one.

def _cbCheckLocation(self, exc):
Undocumented
def test_infiniteRedirection(self):

When more than redirectLimit HTTP redirects are encountered, the page request fails with InfiniteRedirection.

def test_isolatedFollowRedirect(self):

client.HTTPPagerGetter instances each obey the followRedirect value passed to the client.getPage call which created them.

def test_afterFoundGet(self):

Enabling unsafe redirection behaviour overwrites the method of redirected POST requests with GET.

def test_downloadAfterFoundGet(self):

Passing True for afterFoundGet to client.downloadPage invokes the same kind of redirect handling as passing that argument to client.getPage invokes.

def test_afterFoundGetMakesOneRequest(self):

When afterFoundGet is True, client.getPage only issues one request to the server when following the redirect. This is a regression test, see #4760.

def test_downloadTimeout(self):

If the timeout indicated by the timeout parameter to client.HTTPDownloader.__init__ elapses without the complete response being received, the defer.Deferred returned by client.downloadPage fires with a Failure wrapping a defer.TimeoutError.

def test_downloadTimeoutsWorkWithoutReading(self):

If the timeout indicated by the timeout parameter to client.HTTPDownloader.__init__ elapses without the complete response being received, the defer.Deferred returned by client.downloadPage fires with a Failure wrapping a defer.TimeoutError, even if the remote peer isn't reading data from the socket.

def test_downloadHeaders(self):

After client.HTTPDownloader.deferred fires, the client.HTTPDownloader instance's status and response_headers attributes are populated with the values from the response.

def test_downloadCookies(self):

The cookies dict passed to the client.HTTPDownloader initializer is used to populate the Cookie header included in the request sent to the server.

def test_downloadRedirectLimit(self):

When more than redirectLimit HTTP redirects are encountered, the page request fails with InfiniteRedirection.

def test_setURL(self):

client.HTTPClientFactory.setURL alters the scheme, host, port and path for absolute URLs.

def test_setURLRemovesFragment(self):

client.HTTPClientFactory.setURL removes the fragment identifier from the path component.

def test_setURLRelativePath(self):

client.HTTPClientFactory.setURL alters the path in a relative URL.

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