twisted.python.test.test_constants.FlagsTests

class documentation

class FlagsTests(_FlagsTestsMixin, TestCase, _ConstantsTestsMixin): (source)

View In Hierarchy

Tests for twisted.python.constants.Flags, a base class for containers of related, combinable flag or bitvector-like constants.

Method test_attributeIdentity Repeated access of an attribute associated with a FlagConstant value in a Flags subclass results in the same object.
Method test_attributeIterconstantsIdentity The constants returned from Flags.iterconstants are identical to the constants accessible using attributes.
Method test_initializedOnce Flags._enumerants is initialized once and its value re-used on subsequent access.
Method test_iterconstants Flags.iterconstants returns an iterator over all of the constants defined in the class, in the order they were defined.
Method test_iterconstantsIdentity The constants returned from Flags.iterconstants are identical on each call to that method.
Method test_lookupByName Constants can be looked up by name using Flags.lookupByName.
Method test_lookupByValue Constants can be looked up by their associated value, defined implicitly by the position in which the constant appears in the class definition or explicitly by the argument passed to FlagConstant.
Method test_lookupDuplicateByValue If more than one constant is associated with a particular value, Flags.lookupByValue returns whichever of them is defined first.
Method test_name The name attribute of one of the constants gives that constant's name.
Method test_notInstantiable A subclass of Flags raises TypeError if an attempt is made to instantiate it.
Method test_notLookupMissingByName Names not defined with a FlagConstant instance cannot be looked up using Flags.lookupByName.
Method test_notLookupMissingByValue Flags.lookupByValue raises ValueError when called with a value with which no constant is associated.
Method test_representation The string representation of a constant on a Flags subclass includes the name of the Flags subclass and the name of the constant itself.
Method test_symbolicAttributes Each name associated with a FlagConstant instance in the definition of a Flags subclass is available as an attribute on the resulting class.
Method test_withoutOtherAttributes As usual, names not defined in the class scope of a Flags subclass are not available as attributes on the resulting class.

Inherited from _FlagsTestsMixin:

Method setUp Create a fresh new Flags subclass for each unit test to use. Since Flags is stateful, re-using the same subclass across test methods makes exercising all of the implementation code paths difficult.
Instance Variable FXF A Flags subclass created for each test method.

Inherited from TestCase (via _FlagsTestsMixin):

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
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 deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
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 _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
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 _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
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 _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via _FlagsTestsMixin, TestCase):

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 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 mktemp Create a new path name which can be used for a new file or directory.
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 _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via _FlagsTestsMixin, TestCase, 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.

Inherited from _ConstantsTestsMixin (via _FlagsTestsMixin, TestCase, SynchronousTestCase, _Assertions):

Method _initializedOnceTest Assert that container._enumerants does not change as a side-effect of one of its attributes being accessed.
Method _notInstantiableTest Assert that an attempt to instantiate the constants class raises TypeError.
def test_attributeIdentity(self): (source)

Repeated access of an attribute associated with a FlagConstant value in a Flags subclass results in the same object.

def test_attributeIterconstantsIdentity(self): (source)

The constants returned from Flags.iterconstants are identical to the constants accessible using attributes.

def test_initializedOnce(self): (source)

Flags._enumerants is initialized once and its value re-used on subsequent access.

def test_iterconstants(self): (source)

Flags.iterconstants returns an iterator over all of the constants defined in the class, in the order they were defined.

def test_iterconstantsIdentity(self): (source)

The constants returned from Flags.iterconstants are identical on each call to that method.

def test_lookupByName(self): (source)

Constants can be looked up by name using Flags.lookupByName.

def test_lookupByValue(self): (source)

Constants can be looked up by their associated value, defined implicitly by the position in which the constant appears in the class definition or explicitly by the argument passed to FlagConstant.

def test_lookupDuplicateByValue(self): (source)

If more than one constant is associated with a particular value, Flags.lookupByValue returns whichever of them is defined first.

def test_name(self): (source)

The name attribute of one of the constants gives that constant's name.

def test_notInstantiable(self): (source)

A subclass of Flags raises TypeError if an attempt is made to instantiate it.

def test_notLookupMissingByName(self): (source)

Names not defined with a FlagConstant instance cannot be looked up using Flags.lookupByName.

def test_notLookupMissingByValue(self): (source)

Flags.lookupByValue raises ValueError when called with a value with which no constant is associated.

def test_representation(self): (source)

The string representation of a constant on a Flags subclass includes the name of the Flags subclass and the name of the constant itself.

def test_symbolicAttributes(self): (source)

Each name associated with a FlagConstant instance in the definition of a Flags subclass is available as an attribute on the resulting class.

def test_withoutOtherAttributes(self): (source)

As usual, names not defined in the class scope of a Flags subclass are not available as attributes on the resulting class.