twisted.python.test.test_url.TestURL(SynchronousTestCase) class documentation

Part of twisted.python.test.test_url (View In Hierarchy)

Tests for URL.

Method assertUnicoded The given URL's components should be unicode.
Method assertURL The given URL should have the given components.
Method test_initDefaults URL should have appropriate default values.
Method test_init URL should accept unicode parameters.
Method test_initPercent URL should accept (and not interpret) percent characters.
Method test_repr URL.__repr__ will display the canonical form of the URL, wrapped in a URL.fromText invocation, so that it is eval-able but still easy to read.
Method test_fromText Round-tripping URL.fromText with str results in an equivalent URL.
Method test_roundtrip URL.asText should invert URL.fromText.
Method test_equality Two URLs decoded using URL.fromText will be equal (==) if they decoded same URL string, and unequal (!=) if they decoded different strings.
Method test_fragmentEquality An URL created with the empty string for a fragment compares equal to an URL created with an unspecified fragment.
Method test_child URL.child appends a new path segment, but does not affect the query or fragment.
Method test_multiChild URL.child receives multiple segments as *args and appends each in turn.
Method test_childInitRoot URL.child of a URL without a path produces a URL with a single path segment.
Method test_sibling URL.sibling of a URL replaces the last path segment, but does not affect the query or fragment.
Method test_click URL.click interprets the given string as a relative URI-reference and returns a new URL interpreting self as the base absolute URI.
Method test_clickRFC3986 URL.click should correctly resolve the examples in RFC 3986.
Method test_clickSchemeRelPath URL.click should not accept schemes with relative paths.
Method test_cloneUnchanged Verify that URL.replace doesn't change any of the arguments it is passed.
Method test_clickCollapse URL.click collapses . and .. according to RFC 3986 section 5.2.4.
Method test_queryAdd URL.add adds query parameters.
Method test_querySet URL.set replaces query parameters by name.
Method test_queryRemove URL.remove removes all instances of a query parameter.
Method test_empty An empty URL should serialize as the empty string.
Method test_justQueryText An URL with query text should serialize as just query text.
Method test_identicalEqual URL compares equal to itself.
Method test_similarEqual URLs with equivalent components should compare equal.
Method test_differentNotEqual URLs that refer to different resources are both unequal (!=) and also not equal (not ==).
Method test_otherTypesNotEqual URL is not equal (==) to other types.
Method test_identicalNotUnequal Identical URLs are not unequal (!=) to each other.
Method test_similarNotUnequal Structurally similar URLs are not unequal (!=) to each other.
Method test_differentUnequal Structurally different URLs are unequal (!=) to each other.
Method test_otherTypesUnequal URL is unequal (!=) to other types.
Method test_asURI URL.asURI produces an URI which converts any URI unicode encoding into pure US-ASCII and returns a new URL.
Method test_asIRI URL.asIRI decodes any percent-encoded text in the URI, making it more suitable for reading by humans, and returns a new URL.
Method test_badUTF8AsIRI Bad UTF-8 in a path segment, query parameter, or fragment results in that portion of the URI remaining percent-encoded in the IRI.
Method test_alreadyIRIAsIRI A URL composed of non-ASCII text will result in non-ASCII text.
Method test_alreadyURIAsURI A URL composed of encoded text will remain encoded.
Method test_userinfo URL.fromText will parse the userinfo portion of the URI separately from the host and port.
Method test_portText URL.fromText parses custom port numbers as integers.
Method test_mailto No summary
Method test_queryIterable When a URL is created with a query argument, the query argument is converted into an N-tuple of 2-tuples.
Method test_pathIterable When a URL is created with a path argument, the path is converted into a tuple.
Method test_invalidArguments Passing an argument of the wrong type to any of the constructor arguments of URL will raise a descriptive TypeError.
Method test_technicallyTextIsIterableBut Technically, str (or unicode, as appropriate) is iterable, but URL(path="foo") resulting in URL.fromText("f/o/o") is never what you want.

Inherited from SynchronousTestCase:

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 __init__ Undocumented
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 addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
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 _run Run a single method, either a test method or fixture.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _installObserver Undocumented
Method _removeObserver Undocumented

Inherited from _Assertions (via 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 assertUnicoded(self, u):

The given URL's components should be unicode.

ParametersuThe URL to test.
def assertURL(self, u, scheme, host, path, query, fragment, port, userinfo=u''):

The given URL should have the given components.

ParametersuThe actual URL to examine.
schemeThe expected scheme.
hostThe expected host.
pathThe expected path.
queryThe expected query.
fragmentThe expected fragment.
portThe expected port.
userinfoThe expected userinfo.
def test_initDefaults(self):

URL should have appropriate default values.

def test_init(self):

URL should accept unicode parameters.

def test_initPercent(self):

URL should accept (and not interpret) percent characters.

def test_repr(self):

URL.__repr__ will display the canonical form of the URL, wrapped in a URL.fromText invocation, so that it is eval-able but still easy to read.

def test_fromText(self):

Round-tripping URL.fromText with str results in an equivalent URL.

def test_roundtrip(self):

URL.asText should invert URL.fromText.

def test_equality(self):

Two URLs decoded using URL.fromText will be equal (==) if they decoded same URL string, and unequal (!=) if they decoded different strings.

def test_fragmentEquality(self):

An URL created with the empty string for a fragment compares equal to an URL created with an unspecified fragment.

def test_child(self):

URL.child appends a new path segment, but does not affect the query or fragment.

def test_multiChild(self):

URL.child receives multiple segments as *args and appends each in turn.

def test_childInitRoot(self):

URL.child of a URL without a path produces a URL with a single path segment.

def test_sibling(self):

URL.sibling of a URL replaces the last path segment, but does not affect the query or fragment.

def test_click(self):

URL.click interprets the given string as a relative URI-reference and returns a new URL interpreting self as the base absolute URI.

def test_clickRFC3986(self):

URL.click should correctly resolve the examples in RFC 3986.

def test_clickSchemeRelPath(self):

URL.click should not accept schemes with relative paths.

def test_cloneUnchanged(self):

Verify that URL.replace doesn't change any of the arguments it is passed.

def test_clickCollapse(self):

URL.click collapses . and .. according to RFC 3986 section

def test_queryAdd(self):

URL.add adds query parameters.

def test_querySet(self):

URL.set replaces query parameters by name.

def test_queryRemove(self):

URL.remove removes all instances of a query parameter.

def test_empty(self):

An empty URL should serialize as the empty string.

def test_justQueryText(self):

An URL with query text should serialize as just query text.

def test_identicalEqual(self):

URL compares equal to itself.

def test_similarEqual(self):

URLs with equivalent components should compare equal.

def test_differentNotEqual(self):

URLs that refer to different resources are both unequal (!=) and also not equal (not ==).

def test_otherTypesNotEqual(self):

URL is not equal (==) to other types.

def test_identicalNotUnequal(self):

Identical URLs are not unequal (!=) to each other.

def test_similarNotUnequal(self):

Structurally similar URLs are not unequal (!=) to each other.

def test_differentUnequal(self):

Structurally different URLs are unequal (!=) to each other.

def test_otherTypesUnequal(self):

URL is unequal (!=) to other types.

def test_asURI(self):

URL.asURI produces an URI which converts any URI unicode encoding into pure US-ASCII and returns a new URL.

def test_asIRI(self):

URL.asIRI decodes any percent-encoded text in the URI, making it more suitable for reading by humans, and returns a new URL.

def test_badUTF8AsIRI(self):

Bad UTF-8 in a path segment, query parameter, or fragment results in that portion of the URI remaining percent-encoded in the IRI.

def test_alreadyIRIAsIRI(self):

A URL composed of non-ASCII text will result in non-ASCII text.

def test_alreadyURIAsURI(self):

A URL composed of encoded text will remain encoded.

def test_userinfo(self):

URL.fromText will parse the userinfo portion of the URI separately from the host and port.

def test_portText(self):

URL.fromText parses custom port numbers as integers.

def test_mailto(self):

Although URL instances are mainly for dealing with HTTP, other schemes (such as mailto:) should work as well. For example, URL.fromText/URL.asText round-trips cleanly for a mailto: URL representing an email address.

def test_queryIterable(self):

When a URL is created with a query argument, the query argument is converted into an N-tuple of 2-tuples.

def test_pathIterable(self):

When a URL is created with a path argument, the path is converted into a tuple.

def test_invalidArguments(self):

Passing an argument of the wrong type to any of the constructor arguments of URL will raise a descriptive TypeError.

URL typechecks very aggressively to ensure that its constitutent parts are all properly immutable and to prevent confusing errors when bad data crops up in a method call long after the code that called the constructor is off the stack.

def test_technicallyTextIsIterableBut(self):

Technically, str (or unicode, as appropriate) is iterable, but URL(path="foo") resulting in URL.fromText("f/o/o") is never what you want.

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