twisted.test.test_modules.BasicTests(TwistedModulesTestCase) class documentation

Part of twisted.test.test_modules (View In Hierarchy)
No class docstring
Method test_namespacedPackages Duplicate packages are not yielded when iterating over namespace packages.
Method test_unimportablePackageGetItem No summary
Method test_unimportablePackageWalkModules No summary
Method test_nonexistentPaths Verify that modules.walkModules ignores entries in sys.path which do not exist in the filesystem.
Method test_nonDirectoryPaths Verify that modules.walkModules ignores entries in sys.path which refer to regular files in the filesystem.
Method test_twistedShowsUp Scrounge around in the top-level module namespace and make sure that Twisted shows up, and that the module thusly obtained is the same as the module that we find when we look for it explicitly by name.
Method test_dottedNames Verify that the walkModules APIs will give us back subpackages, not just subpackages.
Method test_onlyTopModules Verify that the iterModules API will only return top-level modules and packages, not submodules or subpackages.
Method test_loadPackagesAndModules Verify that we can locate and load packages, modules, submodules, and subpackages.
Method test_pathEntriesOnPath Verify that path entries discovered via module loading are, in fact, on sys.path somewhere.
Method test_alwaysPreferPy Verify that .py files will always be preferred to .pyc files, regardless of directory listing order.
Method test_packageMissingPath A package can delete its __path__ for some reasons, modules.PythonPath should be able to deal with it.

Inherited from TwistedModulesTestCase:

Method findByIteration You don't ever actually want to do this, so it's not in the public API, but sometimes we want to compare the result of an iterative call with a lookup call and make sure they're the same for test purposes.

Inherited from TwistedModulesMixin (via TwistedModulesTestCase):

Method replaceSysPath Replace sys.path, for the duration of the test, with the given value.
Method replaceSysModules Replace sys.modules, for the duration of the test, with the given value.
Method pathEntryWithOnePackage Generate a FilePath with one package, named pkgname, on it, and return the FilePath of the path entry.

Inherited from TestCase (via TwistedModulesTestCase):

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 TwistedModulesTestCase, 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 TwistedModulesTestCase, 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_namespacedPackages(self):

Duplicate packages are not yielded when iterating over namespace packages.

def test_unimportablePackageGetItem(self):

If a package has been explicitly forbidden from importing by setting a None key in sys.modules under its name, modules.PythonPath.__getitem__ should still be able to retrieve an unloaded modules.PythonModule for that package.

def test_unimportablePackageWalkModules(self):

If a package has been explicitly forbidden from importing by setting a None key in sys.modules under its name, modules.walkModules should still be able to retrieve an unloaded modules.PythonModule for that package.

def test_nonexistentPaths(self):

Verify that modules.walkModules ignores entries in sys.path which do not exist in the filesystem.

def test_nonDirectoryPaths(self):

Verify that modules.walkModules ignores entries in sys.path which refer to regular files in the filesystem.

def test_twistedShowsUp(self):

Scrounge around in the top-level module namespace and make sure that Twisted shows up, and that the module thusly obtained is the same as the module that we find when we look for it explicitly by name.

def test_dottedNames(self):

Verify that the walkModules APIs will give us back subpackages, not just subpackages.

def test_onlyTopModules(self):

Verify that the iterModules API will only return top-level modules and packages, not submodules or subpackages.

def test_loadPackagesAndModules(self):

Verify that we can locate and load packages, modules, submodules, and subpackages.

def test_pathEntriesOnPath(self):

Verify that path entries discovered via module loading are, in fact, on sys.path somewhere.

def test_alwaysPreferPy(self):

Verify that .py files will always be preferred to .pyc files, regardless of directory listing order.

def test_packageMissingPath(self):

A package can delete its __path__ for some reasons, modules.PythonPath should be able to deal with it.

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