twisted.web.test.test_flatten.SerializationTests

Tests for flattening various things.

Method	test_nestedTags	Test that nested tags flatten correctly.
Method	test_serializeString	Test that strings will be flattened and escaped correctly.
Method	test_serializeSelfClosingTags	The serialized form of a self-closing tag is `'<tagName />'`.
Method	test_serializeAttribute	The serialized form of attribute a with value b is `'a="b"'`.
Method	test_serializedMultipleAttributes	Multiple attributes are separated by a single space in their serialized form.
Method	checkAttributeSanitization	Common implementation of `test_serializedAttributeWithSanitization` and `test_serializedDeferredAttributeWithSanitization`, `test_serializedAttributeWithTransparentTag`.
Method	test_serializedAttributeWithSanitization	Attribute values containing `"<"`, `">"`, `"&"`, or `'"'` have `"<"`, `">"`, `"&"`, or `"""` substituted for those bytes in the serialized output.
Method	test_serializedDeferredAttributeWithSanitization	Like `test_serializedAttributeWithSanitization`, but when the contents of the attribute are in a `Deferred`.
Method	test_serializedAttributeWithSlotWithSanitization	Like `test_serializedAttributeWithSanitization` but with a slot.
Method	test_serializedAttributeWithTransparentTag	Attribute values which are supplied via the value of a `t:transparent` tag have the same substitution rules to them as values supplied directly.
Method	test_serializedAttributeWithTransparentTagWithRenderer	Like `test_serializedAttributeWithTransparentTag`, but when the attribute is rendered by a renderer on an element.
Method	test_serializedAttributeWithRenderable	Like `test_serializedAttributeWithTransparentTag`, but when the attribute is a provider of `IRenderable` rather than a transparent tag.
Method	checkTagAttributeSerialization	Common implementation of `test_serializedAttributeWithTag` and `test_serializedAttributeWithDeferredTag`.
Method	test_serializedAttributeWithTag	`Tag` objects which are serialized within the context of an attribute are serialized such that the text content of the attribute may be parsed to retrieve the tag.
Method	test_serializedAttributeWithDeferredTag	Like `test_serializedAttributeWithTag`, but when the `Tag` is in a `Deferred`.
Method	test_serializedAttributeWithTagWithAttribute	Similar to `test_serializedAttributeWithTag`, but for the additional complexity where the tag which is the attribute value itself has an attribute value which contains bytes which require substitution.
Method	test_serializeComment	Test that comments are correctly flattened and escaped.
Method	test_commentEscaping	The data in a `Comment` is escaped and mangled in the flattened output so that the result is a legal SGML and XML comment.
Method	test_serializeCDATA	Test that CDATA is correctly flattened and escaped.
Method	test_serializeUnicode	Test that unicode is encoded correctly in the appropriate places, and raises an error when it occurs in inappropriate place.
Method	test_serializeCharRef	A character reference is flattened to a string using the &#NNNN; syntax.
Method	test_serializeDeferred	Test that a deferred is substituted with the current value in the callback chain when flattened.
Method	test_serializeSameDeferredTwice	Test that the same deferred can be flattened twice.
Method	test_serializeCoroutine	Test that a coroutine returning a value is substituted with the that value when flattened.
Method	test_serializeCoroutineWithAwait	Test that a coroutine returning an awaited deferred value is substituted with that value when flattened.
Method	test_serializeIRenderable	Test that flattening respects all of the IRenderable interface.
Method	test_serializeSlots	Test that flattening a slot will use the slot value from the tag.
Method	test_serializeDeferredSlots	Test that a slot with a deferred as its value will be flattened using the value from the deferred.
Method	test_unknownTypeRaises	Test that flattening an unknown type of thing raises an exception.

Inherited from FlattenTestCase:

Method	assertFlattensTo	Assert that a root element, when flattened, is equal to a string.
Method	assertFlattensImmediately	Assert that a root element, when flattened, is equal to a string, and performs no asynchronus Deferred anything.
Method	assertFlatteningRaises	Assert flattening a root element raises a particular exception.

Inherited from TestCase (via FlattenTestCase):

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.Deferred`s. After they complete, do some reactor cleanup.
Method	_wait	Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via FlattenTestCase, 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 FlattenTestCase, 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.

Inherited from XMLAssertionMixin:

Method

assertXMLEqual

Verify that two strings represent the same XML document.

def test_nestedTags(self):

Test that nested tags flatten correctly.

def test_serializeString(self):

Test that strings will be flattened and escaped correctly.

def test_serializeSelfClosingTags(self):

The serialized form of a self-closing tag is '<tagName />'.

def test_serializeAttribute(self):

The serialized form of attribute a with value b is 'a="b"'.

def test_serializedMultipleAttributes(self):

Multiple attributes are separated by a single space in their serialized form.

def checkAttributeSanitization(self, wrapData, wrapTag):

Common implementation of test_serializedAttributeWithSanitization and test_serializedDeferredAttributeWithSanitization, test_serializedAttributeWithTransparentTag.

Parameters	wrapData	A 1-argument callable that wraps around the attribute's value so other tests can customize it.
	wrapData	callable taking `bytes` and returning something flattenable
	wrapTag	A 1-argument callable that wraps around the outer tag so other tests can customize it. (type: callable taking `Tag` and returning `Tag`.)

def test_serializedAttributeWithSanitization(self):

Attribute values containing "<", ">", "&", or '"' have "<", ">", "&", or """ substituted for those bytes in the serialized output.

def test_serializedDeferredAttributeWithSanitization(self):

Like test_serializedAttributeWithSanitization, but when the contents of the attribute are in a Deferred.

def test_serializedAttributeWithSlotWithSanitization(self):

Like test_serializedAttributeWithSanitization but with a slot.

def test_serializedAttributeWithTransparentTag(self):

Attribute values which are supplied via the value of a t:transparent tag have the same substitution rules to them as values supplied directly.

def test_serializedAttributeWithTransparentTagWithRenderer(self):

Like test_serializedAttributeWithTransparentTag, but when the attribute is rendered by a renderer on an element.

def test_serializedAttributeWithRenderable(self):

Like test_serializedAttributeWithTransparentTag, but when the attribute is a provider of IRenderable rather than a transparent tag.

def checkTagAttributeSerialization(self, wrapTag):

Common implementation of test_serializedAttributeWithTag and test_serializedAttributeWithDeferredTag.

Parameters	wrapTag	A 1-argument callable that wraps around the attribute's value so other tests can customize it.
	wrapTag	callable taking `Tag` and returning something flattenable

def test_serializedAttributeWithTag(self):

Tag objects which are serialized within the context of an attribute are serialized such that the text content of the attribute may be parsed to retrieve the tag.

def test_serializedAttributeWithDeferredTag(self):

Like test_serializedAttributeWithTag, but when the Tag is in a Deferred.

def test_serializedAttributeWithTagWithAttribute(self):

Similar to test_serializedAttributeWithTag, but for the additional complexity where the tag which is the attribute value itself has an attribute value which contains bytes which require substitution.

def test_serializeComment(self):

Test that comments are correctly flattened and escaped.

def test_commentEscaping(self):

The data in a Comment is escaped and mangled in the flattened output so that the result is a legal SGML and XML comment.

SGML comment syntax is complicated and hard to use. This rule is more restrictive, and more compatible:

Comments start with  and never contain -- or >.

Also by XML syntax, a comment may not end with '-'.

See Also http://www.w3.org/TR/REC-xml/#sec-comments

def test_serializeCDATA(self):

Test that CDATA is correctly flattened and escaped.

def test_serializeUnicode(self):

Test that unicode is encoded correctly in the appropriate places, and raises an error when it occurs in inappropriate place.

def test_serializeCharRef(self):

A character reference is flattened to a string using the &#NNNN; syntax.

def test_serializeDeferred(self):

Test that a deferred is substituted with the current value in the callback chain when flattened.

def test_serializeSameDeferredTwice(self):

Test that the same deferred can be flattened twice.

def test_serializeCoroutine(self):

Test that a coroutine returning a value is substituted with the that value when flattened.

def test_serializeCoroutineWithAwait(self):

Test that a coroutine returning an awaited deferred value is substituted with that value when flattened.

def test_serializeIRenderable(self):

Test that flattening respects all of the IRenderable interface.

def test_serializeSlots(self):

Test that flattening a slot will use the slot value from the tag.

def test_serializeDeferredSlots(self):

Test that a slot with a deferred as its value will be flattened using the value from the deferred.

def test_unknownTypeRaises(self):

Test that flattening an unknown type of thing raises an exception.

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

twisted.web.test.test_flatten.SerializationTests(FlattenTestCase, XMLAssertionMixin) class documentation

`twisted.web.test.test_flatten.SerializationTests(FlattenTestCase, XMLAssertionMixin)` class documentation