twisted.logger.test.test_global.LogBeginnerTests

Tests for LogBeginner.

Method	setUp	Undocumented
Method	test_beginLoggingToAddObservers	Test that `beginLoggingTo()` adds observers.
Method	test_beginLoggingToBufferedEvents	Test that events are buffered until `beginLoggingTo()` is called.
Method	test_defaultBufferLimit	Up to `LogBeginner._DEFAULT_BUFFER_SIZE` log events are buffered for replay by `LogBeginner.beginLoggingTo`.
Method	test_overrideBufferLimit	The size of the `LogBeginner` event buffer can be overridden with the `initialBufferSize` initilizer argument.
Method	test_beginLoggingToTwice	When invoked twice, `LogBeginner.beginLoggingTo` will emit a log message warning the user that they previously began logging, and add the new log observers.
Method	test_criticalLogging	Critical messages will be written as text to the error stream.
Method	test_criticalLoggingStops	Once logging has begun with `beginLoggingTo`, critical messages are no longer written to the output stream.
Method	test_beginLoggingToRedirectStandardIO	`LogBeginner.beginLoggingTo` will re-direct the standard output and error streams by setting the `stdio` and `stderr` attributes on its sys module object.
Method	test_beginLoggingToDontRedirect	`LogBeginner.beginLoggingTo` will leave the existing stdout/stderr in place if it has been told not to replace them.
Method	test_beginLoggingToPreservesEncoding	When `LogBeginner.beginLoggingTo` redirects stdout/stderr streams, the replacement streams will preserve the encoding of the replaced streams, to minimally disrupt any application relying on a specific encoding.
Method	test_warningsModule	`LogBeginner.beginLoggingTo` will redirect the warnings of its warnings module into the logging system.
Method	test_failuresAppendTracebacks	The string resulting from a logged failure contains a traceback.
Method	_bufferLimitTest	Verify that when more than `limit` events are logged to `LogBeginner`, only the last `limit` are replayed by `LogBeginner.beginLoggingTo`.

Inherited from TestCase:

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.Deferred`s. After they complete, do some reactor cleanup.
Method	_wait	Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via 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 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 setUp(self):

Undocumented

def test_beginLoggingToAddObservers(self):

Test that beginLoggingTo() adds observers.

def test_beginLoggingToBufferedEvents(self):

Test that events are buffered until beginLoggingTo() is called.

def _bufferLimitTest(self, limit, beginner):

Verify that when more than limit events are logged to LogBeginner, only the last limit are replayed by LogBeginner.beginLoggingTo.

Parameters	limit	The maximum number of events the log beginner should buffer. (type: `int`)
	beginner	The `LogBeginner` against which to verify. (type: `LogBeginner`)
Returns	`None`
Raises	`self.failureException` if the wrong events are replayed by `beginner`.

def test_defaultBufferLimit(self):

Up to LogBeginner._DEFAULT_BUFFER_SIZE log events are buffered for replay by LogBeginner.beginLoggingTo.

def test_overrideBufferLimit(self):

The size of the LogBeginner event buffer can be overridden with the initialBufferSize initilizer argument.

def test_beginLoggingToTwice(self):

When invoked twice, LogBeginner.beginLoggingTo will emit a log message warning the user that they previously began logging, and add the new log observers.

def test_criticalLogging(self):

Critical messages will be written as text to the error stream.

def test_criticalLoggingStops(self):

Once logging has begun with beginLoggingTo, critical messages are no longer written to the output stream.

def test_beginLoggingToRedirectStandardIO(self):

LogBeginner.beginLoggingTo will re-direct the standard output and error streams by setting the stdio and stderr attributes on its sys module object.

def test_beginLoggingToDontRedirect(self):

LogBeginner.beginLoggingTo will leave the existing stdout/stderr in place if it has been told not to replace them.

def test_beginLoggingToPreservesEncoding(self):

When LogBeginner.beginLoggingTo redirects stdout/stderr streams, the replacement streams will preserve the encoding of the replaced streams, to minimally disrupt any application relying on a specific encoding.

def test_warningsModule(self):

LogBeginner.beginLoggingTo will redirect the warnings of its warnings module into the logging system.

def test_failuresAppendTracebacks(self):

The string resulting from a logged failure contains a traceback.

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

twisted.logger.test.test_global.LogBeginnerTests(unittest.TestCase) class documentation

`twisted.logger.test.test_global.LogBeginnerTests(unittest.TestCase)` class documentation