twisted.test.test_paths.SetContentTests(BytesTestCase) class documentation

Part of twisted.test.test_paths (View In Hierarchy)

Tests for FilePath.setContent.

Method test_write Contents of the file referred to by a FilePath can be written using FilePath.setContent.
Method test_fileClosing If writing to the underlying file raises an exception, FilePath.setContent raises that exception after closing the file.
Method test_nameCollision FilePath.setContent will use a different temporary filename on each invocation, so that multiple processes, threads, or reentrant invocations will not collide with each other.
Method test_defaultExtension FilePath.setContent creates temporary files with the extension .new if no alternate extension value is given.
Method test_customExtension FilePath.setContent creates temporary files with a user-supplied extension so that if it is somehow interrupted while writing them the file that it leaves behind will be identifiable.
Method _assertOneOpened Assert that the TrackingFilePath fp was used to open one sibling with the given extension.

Inherited from BytesTestCase:

Method mktemp Return a temporary path, encoded as bytes.

Inherited from SynchronousTestCase (via BytesTestCase):

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 _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 BytesTestCase, 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_write(self):

Contents of the file referred to by a FilePath can be written using FilePath.setContent.

def test_fileClosing(self):

If writing to the underlying file raises an exception, FilePath.setContent raises that exception after closing the file.

def test_nameCollision(self):

FilePath.setContent will use a different temporary filename on each invocation, so that multiple processes, threads, or reentrant invocations will not collide with each other.

def _assertOneOpened(self, fp, extension):

Assert that the TrackingFilePath fp was used to open one sibling with the given extension.

ParametersfpA TrackingFilePath which should have been used to open file at a sibling path. (type: TrackingFilePath)
extensionThe extension the sibling path is expected to have had. (type: bytes)
Raisesself.failureException is raised if the extension of the opened file is incorrect or if not exactly one file was opened using fp.
def test_defaultExtension(self):

FilePath.setContent creates temporary files with the extension .new if no alternate extension value is given.

def test_customExtension(self):

FilePath.setContent creates temporary files with a user-supplied extension so that if it is somehow interrupted while writing them the file that it leaves behind will be identifiable.

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