txaio.tx

Attributes

_categories
_default_api
_log_level
_loggers
_observer
_started_logging
_unspecified
add_callbacks
as_future
call_later
cancel
config
create_failure
create_future
create_future_error
create_future_success
failure_format_traceback
failure_message
failure_traceback
gather
is_called
is_future
make_batched_timer
perf_counter_ns
reject
resolve
sleep
time_ns
using_asyncio
using_twisted

Classes

Logger
_LogObserver	Internal helper.
_TxApi

Functions

_no_op(*args, **kwargs)
add_log_categories(categories)
get_global_log_level()
make_logger([level, logger, observer])
set_global_log_level(level)	Set the global log level on all loggers instantiated by txaio.
start_logging([out, level])	Start logging to the file-like object in out. By default, this
with_config([loop])

Module Contents

class Logger(level=None, logger=None, namespace=None, observer=None)

Bases: object

__get__(oself, type=None)

_failure(format=None, *args, **kw)

_log(level, *args, **kwargs)

_log_level_set_explicitly = False

_logger

_set_log_level(level)

_trace(*args, **kw)

emit(level, *args, **kwargs)

set_log_level(level, keep=True)

Set the log level. If keep is True, then it will not change along with global log changes.

class _LogObserver(out)

Bases: object

Internal helper.

An observer which formats events to a given file.

__call__(event)

_acceptable_level(level)

_encode = True

_file

_levels = None

to_tx

class _TxApi(config)

Bases: object

_config

_get_loop()

internal helper

add_callbacks(future, callback, errback)

callback or errback may be None, but at least one must be non-None.

as_future(fun, *args, **kwargs)

call_later(delay, fun, *args, **kwargs)

cancel(future, msg=None)

create_failure(exception=None)

Create a Failure instance.

if exception is None (the default), we MUST be inside an “except” block. This encapsulates the exception into an object that implements IFailedFuture

create_future(result=_unspecified, error=_unspecified, canceller=None)

create_future_error(error=None)

create_future_success(result)

failure_format_traceback(fail)

Parameters:

fail – must be an IFailedFuture

returns a string

failure_message(fail)

Parameters:

fail – must be an IFailedFuture

returns a unicode error-message

failure_traceback(fail)

Parameters:

fail – must be an IFailedFuture

returns a traceback instance

gather(futures, consume_exceptions=True)

is_called(future)

is_future(obj)

make_batched_timer(bucket_seconds, chunk_size=100)

Creates and returns an object implementing txaio.IBatchedTimer.

Parameters:

• bucket_seconds – the number of seconds in each bucket. That is, a value of 5 means that any timeout within a 5 second window will be in the same bucket, and get notified at the same time. This is only accurate to “milliseconds”.

• chunk_size – when “doing” the callbacks in a particular bucket, this controls how many we do at once before yielding to the reactor.

reject(future, error=None)

resolve(future, result=None)

sleep(delay)

Inline sleep for use in co-routines.

Parameters:

delay (float) – Time to sleep in seconds.

_categories

_default_api

_log_level = 'info'

_loggers

_no_op(*args, **kwargs)

_observer = None

_started_logging = False

_unspecified

add_callbacks

add_log_categories(categories)

as_future

call_later

cancel

config

create_failure

create_future

create_future_error

create_future_success

failure_format_traceback

failure_message

failure_traceback

gather

get_global_log_level()

is_called

is_future

make_batched_timer

make_logger(level=None, logger=_Logger, observer=None)

perf_counter_ns

reject

resolve

set_global_log_level(level)

Set the global log level on all loggers instantiated by txaio.

sleep

start_logging(out=_stdout, level='info')

Start logging to the file-like object in out. By default, this is stdout.

time_ns

using_asyncio = False

using_twisted = True

with_config(loop=None)