twisted.test.test_log.FileObserverTests(LogPublisherTestCaseMixin, unittest.SynchronousTestCase) class documentation

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

Tests for log.FileObserver.

Method test_getTimezoneOffsetWestOfUTC No summary
Method test_getTimezoneOffsetEastOfUTC No summary
Method test_getTimezoneOffsetWithoutDaylightSavingTime No summary
Method test_timeFormatting Test the method of FileLogObserver which turns a timestamp into a human-readable string.
Method test_microsecondTimestampFormatting FileLogObserver.formatTime supports a value of timeFormat which includes "%f", a datetime-only format specifier for microseconds.
Method test_loggingAnObjectWithBroken__str__ Undocumented
Method test_formattingAnObjectWithBroken__str__ Undocumented
Method test_brokenSystem__str__ Undocumented
Method test_formattingAnObjectWithBroken__repr__Indirect Undocumented
Method test_systemWithBroker__repr__Indirect Undocumented
Method test_simpleBrokenFormat Undocumented
Method test_ridiculousFormat Undocumented
Method test_evilFormat__repr__And__str__ Undocumented
Method test_strangeEventDict This kind of eventDict used to fail silently, so test it does.
Method test_printToStderrSetsIsError startLogging()'s overridden sys.stderr should consider everything written to it an error.
Method test_startLogging startLogging() installs FileLogObserver and overrides sys.stdout and sys.stderr.
Method test_startLoggingTwice There are some obscure error conditions that can occur when logging is started twice. See http://twistedmatrix.com/trac/ticket/3289 for more information.
Method test_startLoggingOverridesWarning startLogging() overrides global warnings.showwarning such that warnings go to Twisted log observers.
Method test_emitPrefix FileLogObserver.emit() will add a timestamp and system prefix to its file output.
Method test_emitNewline FileLogObserver.emit() will append a newline to its file output.
Method _getTimezoneOffsetTest Verify that getTimezoneOffset produces the expected offset for a certain timezone both when daylight saving time is in effect and when it is not.
Method _startLoggingCleanup Cleanup after a startLogging() call that mutates the hell out of some global state.

Inherited from LogPublisherTestCaseMixin:

Method setUp No summary
Method tearDown Verify that everything written to the fake file self.out was a str. Also, restore the default string encoding to its previous setting, if it was modified by setUp.

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 _getTimezoneOffsetTest(self, tzname, daylightOffset, standardOffset):

Verify that getTimezoneOffset produces the expected offset for a certain timezone both when daylight saving time is in effect and when it is not.

ParameterstznameThe name of a timezone to exercise. (type: bytes)
daylightOffsetThe number of seconds west of UTC the timezone should be when daylight saving time is in effect. (type: int)
standardOffsetThe number of seconds west of UTC the timezone should be when daylight saving time is not in effect. (type: int)
def test_getTimezoneOffsetWestOfUTC(self):

Attempt to verify that FileLogObserver.getTimezoneOffset returns correct values for the current TZ environment setting for at least some cases. This test method exercises a timezone that is west of UTC (and should produce positive results).

def test_getTimezoneOffsetEastOfUTC(self):

Attempt to verify that FileLogObserver.getTimezoneOffset returns correct values for the current TZ environment setting for at least some cases. This test method exercises a timezone that is east of UTC (and should produce negative results).

def test_getTimezoneOffsetWithoutDaylightSavingTime(self):

Attempt to verify that FileLogObserver.getTimezoneOffset returns correct values for the current TZ environment setting for at least some cases. This test method exercises a timezone that does not use daylight saving time at all (so both summer and winter time test values should have the same offset).

def test_timeFormatting(self):

Test the method of FileLogObserver which turns a timestamp into a human-readable string.

def test_microsecondTimestampFormatting(self):

FileLogObserver.formatTime supports a value of timeFormat which includes "%f", a datetime-only format specifier for microseconds.

def test_loggingAnObjectWithBroken__str__(self):
Undocumented
def test_formattingAnObjectWithBroken__str__(self):
Undocumented
def test_brokenSystem__str__(self):
Undocumented
def test_formattingAnObjectWithBroken__repr__Indirect(self):
Undocumented
def test_systemWithBroker__repr__Indirect(self):
Undocumented
def test_simpleBrokenFormat(self):
Undocumented
def test_ridiculousFormat(self):
Undocumented
def test_evilFormat__repr__And__str__(self):
Undocumented
def test_strangeEventDict(self):

This kind of eventDict used to fail silently, so test it does.

def _startLoggingCleanup(self):

Cleanup after a startLogging() call that mutates the hell out of some global state.

def test_printToStderrSetsIsError(self):

startLogging()'s overridden sys.stderr should consider everything written to it an error.

def test_startLogging(self):

startLogging() installs FileLogObserver and overrides sys.stdout and sys.stderr.

def test_startLoggingTwice(self):

There are some obscure error conditions that can occur when logging is started twice. See http://twistedmatrix.com/trac/ticket/3289 for more information.

def test_startLoggingOverridesWarning(self):

startLogging() overrides global warnings.showwarning such that warnings go to Twisted log observers.

def test_emitPrefix(self):

FileLogObserver.emit() will add a timestamp and system prefix to its file output.

def test_emitNewline(self):

FileLogObserver.emit() will append a newline to its file output.

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