class documentation

class UnicodeHeadersTests(TestCase): (source)

View In Hierarchy

Tests for Headers, using str arguments for methods.

Method test_addRawHeader Headers.addRawHeader adds a new value for a given header.
Method test_copy Headers.copy creates a new independent copy of an existing Headers instance, allowing future modifications without impacts between the copies.
Method test_getAllRawHeaders Headers.getAllRawHeaders returns an iterable of (k, v) pairs, where k is the canonicalized representation of the header name, and v is a sequence of values.
Method test_getRawHeaders Headers.getRawHeaders returns the values which have been set for a given header.
Method test_getRawHeadersDefaultValue Headers.getRawHeaders returns the specified default value when no header is found.
Method test_getRawHeadersNoDefault Headers.getRawHeaders returns None if the header is not found and no default is specified.
Method test_getRawHeadersWithDefaultMatchingValue If the object passed as the value list to Headers.setRawHeaders is later passed as a default to Headers.getRawHeaders, the result nevertheless contains decoded values.
Method test_hasHeaderFalse Headers.hasHeader returns False when the given header is not found.
Method test_hasHeaderTrue Check that Headers.hasHeader returns True when the given header is found.
Method test_headersComparison A Headers instance compares equal to itself and to another Headers instance with the same values.
Method test_initializer The header values passed to Headers.__init__ can be retrieved via Headers.getRawHeaders. If a bytes argument is given, it returns bytes values, and if a str argument is given, it returns str values. Both are the same header value, just encoded or decoded.
Method test_nameEncoding Passing str to any function that takes a header name will encode said header name as ISO-8859-1.
Method test_nameNotEncodable Passing str to any function that takes a header name will encode said header name as ISO-8859-1, and if it cannot be encoded, it will raise a UnicodeDecodeError.
Method test_otherComparison An instance of Headers does not compare equal to other unrelated objects.
Method test_rawHeadersTypeChecking Headers.setRawHeaders requires values to be of type sequence
Method test_rawHeadersValueEncoding Passing str to Headers.setRawHeaders will encode the name as ISO-8859-1 and values as UTF-8.
Method test_removeHeader Check that Headers.removeHeader removes the given header.
Method test_removeHeaderDoesntExist Headers.removeHeader is a no-operation when the specified header is not found.
Method test_repr The repr of a Headers instance shows the names and values of all the headers it contains. This shows only reprs of bytes values, as undecodable headers may cause an exception.
Method test_sanitizeLinearWhitespace Linear whitespace in header names or values is replaced with a single space.
Method test_setRawHeaders Headers.setRawHeaders sets the header values for the given header name to the sequence of strings, encoded.
Method test_subclassRepr The repr of an instance of a subclass of Headers uses the name of the subclass instead of the string "Headers".

Inherited from TestCase:

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
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 deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
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 _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
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 _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
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 _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via TestCase):

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
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 flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
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 shortDescription Undocumented
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 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.
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.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

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 assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
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 assertNoResult Assert that deferred does not have a result at this point.
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 assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
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 assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
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 fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def test_addRawHeader(self): (source)

Headers.addRawHeader adds a new value for a given header.

def test_copy(self): (source)

Headers.copy creates a new independent copy of an existing Headers instance, allowing future modifications without impacts between the copies.

def test_getAllRawHeaders(self): (source)

Headers.getAllRawHeaders returns an iterable of (k, v) pairs, where k is the canonicalized representation of the header name, and v is a sequence of values.

def test_getRawHeaders(self): (source)

Headers.getRawHeaders returns the values which have been set for a given header.

def test_getRawHeadersDefaultValue(self): (source)

Headers.getRawHeaders returns the specified default value when no header is found.

def test_getRawHeadersNoDefault(self): (source)

Headers.getRawHeaders returns None if the header is not found and no default is specified.

def test_getRawHeadersWithDefaultMatchingValue(self): (source)

If the object passed as the value list to Headers.setRawHeaders is later passed as a default to Headers.getRawHeaders, the result nevertheless contains decoded values.

def test_hasHeaderFalse(self): (source)

Headers.hasHeader returns False when the given header is not found.

def test_hasHeaderTrue(self): (source)

Check that Headers.hasHeader returns True when the given header is found.

def test_headersComparison(self): (source)

A Headers instance compares equal to itself and to another Headers instance with the same values.

def test_initializer(self): (source)

The header values passed to Headers.__init__ can be retrieved via Headers.getRawHeaders. If a bytes argument is given, it returns bytes values, and if a str argument is given, it returns str values. Both are the same header value, just encoded or decoded.

def test_nameEncoding(self): (source)

Passing str to any function that takes a header name will encode said header name as ISO-8859-1.

def test_nameNotEncodable(self): (source)

Passing str to any function that takes a header name will encode said header name as ISO-8859-1, and if it cannot be encoded, it will raise a UnicodeDecodeError.

def test_otherComparison(self): (source)

An instance of Headers does not compare equal to other unrelated objects.

def test_rawHeadersTypeChecking(self): (source)

Headers.setRawHeaders requires values to be of type sequence

def test_rawHeadersValueEncoding(self): (source)

Passing str to Headers.setRawHeaders will encode the name as ISO-8859-1 and values as UTF-8.

def test_removeHeader(self): (source)

Check that Headers.removeHeader removes the given header.

def test_removeHeaderDoesntExist(self): (source)

Headers.removeHeader is a no-operation when the specified header is not found.

def test_repr(self): (source)

The repr of a Headers instance shows the names and values of all the headers it contains. This shows only reprs of bytes values, as undecodable headers may cause an exception.

def test_sanitizeLinearWhitespace(self): (source)

Linear whitespace in header names or values is replaced with a single space.

def test_setRawHeaders(self): (source)

Headers.setRawHeaders sets the header values for the given header name to the sequence of strings, encoded.

def test_subclassRepr(self): (source)

The repr of an instance of a subclass of Headers uses the name of the subclass instead of the string "Headers".