class documentation

Tests for IFilePath implementations.

Method setUp Undocumented
Method subdir Undocumented
Method subfile Undocumented
Method test_childrenNonexistentError Verify that children raises the appropriate exception for non-existent directories.
Method test_childrenNotDirectoryError Verify that listdir raises the appropriate exception for attempting to list a file rather than a directory.
Method test_dictionaryKeys Verify that path instances are usable as dictionary keys.
Method test_dictionaryKeyWithString Verify that path instances are usable as dictionary keys which do not clash with their string counterparts.
Method test_invalidSubdir Verify that a subdirectory that doesn't exist is reported as such.
Method test_multipleChildSegments fp.descendant([a, b, c]) returns the same FilePath as is returned by fp.child(a).child(b).child(c).
Method test_newTimesAreFloats Verify that all times returned from the various new time functions are ints (and hopefully therefore 'high precision').
Method test_oldTimesAreInts Verify that all times returned from the various time functions are integers, for compatibility.
Method test_parents FilePath.parents() should return an iterator of every ancestor of the FilePath in question.
Method test_segmentsFromNegative Verify that segmentsFrom notices when the ancestor isn't an ancestor.
Method test_segmentsFromPositive Verify that the segments between two paths are correctly identified.
Method test_validFiles Make sure that we can read existent non-empty files.
Method test_validSubdir Verify that a valid subdirectory will show up as a directory, but not as a file, not as a symlink, and be listable.
Method test_verifyObject Instances of the path type being tested provide IFilePath.
Method test_walk Verify that walking the path gives the same result as the known file hierarchy.
Class Variable f1content Undocumented
Class Variable f2content Undocumented
Instance Variable all Undocumented
Instance Variable cmn Undocumented
Instance Variable now Undocumented
Instance Variable path Undocumented
Instance Variable root Undocumented
Method _mkpath Undocumented

Inherited from BytesTestCase:

Method mktemp Return a temporary path, encoded as bytes.

Inherited from SynchronousTestCase (via BytesTestCase):

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

Inherited from _Assertions (via BytesTestCase, 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 subdir(self, *dirname): (source)

Undocumented

def subfile(self, *dirname): (source)

Undocumented

def test_childrenNonexistentError(self): (source)

Verify that children raises the appropriate exception for non-existent directories.

def test_childrenNotDirectoryError(self): (source)

Verify that listdir raises the appropriate exception for attempting to list a file rather than a directory.

def test_dictionaryKeys(self): (source)

Verify that path instances are usable as dictionary keys.

def test_dictionaryKeyWithString(self): (source)

Verify that path instances are usable as dictionary keys which do not clash with their string counterparts.

def test_invalidSubdir(self): (source)

Verify that a subdirectory that doesn't exist is reported as such.

def test_multipleChildSegments(self): (source)

fp.descendant([a, b, c]) returns the same FilePath as is returned by fp.child(a).child(b).child(c).

def test_newTimesAreFloats(self): (source)

Verify that all times returned from the various new time functions are ints (and hopefully therefore 'high precision').

def test_oldTimesAreInts(self): (source)

Verify that all times returned from the various time functions are integers, for compatibility.

def test_parents(self): (source)

FilePath.parents() should return an iterator of every ancestor of the FilePath in question.

def test_segmentsFromNegative(self): (source)

Verify that segmentsFrom notices when the ancestor isn't an ancestor.

def test_segmentsFromPositive(self): (source)

Verify that the segments between two paths are correctly identified.

def test_validFiles(self): (source)

Make sure that we can read existent non-empty files.

def test_validSubdir(self): (source)

Verify that a valid subdirectory will show up as a directory, but not as a file, not as a symlink, and be listable.

def test_verifyObject(self): (source)

Instances of the path type being tested provide IFilePath.

def test_walk(self): (source)

Verify that walking the path gives the same result as the known file hierarchy.

f1content: bytes = (source)

Undocumented

f2content: bytes = (source)

Undocumented

Undocumented

Undocumented

def _mkpath(self, *p): (source)

Undocumented