method_logger.MethodLogger Class Reference

Public Member Functions
None	__init__ (self, wrapped_instance, sink=sys.stdout)
def	method_logger (self, met)
def	__getattr__ (self, attr)

Protected Attributes
	_class
	_sink
	_prefix

Detailed Description

This class wraps a instance of an arbitrary class, intercepts all its
method calls and logs them to a file (default: `sys.stdout`).

>>> import method_logger as ml
>>> from StringIO import StringIO
>>> class TestClass(object):
...     def __init__(self):
...         pass
...     def func(*args, **kwargs):
...         pass
...
>>> cl = TestClass()
>>> sink = StringIO()
>>> lg = ml.MethodLogger(cl, sink=sink)
>>> lg.func(3, y=8, foo='bar')
>>> sink.getvalue()
"TestClass.func(3, y=8, foo='bar')\\n"
>>> sink.close()

Definition at line 8 of file method_logger.py.

Constructor & Destructor Documentation

__init__()

None method_logger.MethodLogger.__init__	(		self,
			wrapped_instance,
			sink = sys.stdout
	)

Definition at line 30 of file method_logger.py.

    def __init__(self, wrapped_instance, sink=sys.stdout) -> None:
        self._class = wrapped_instance
        self._sink = sink
        self._prefix = type(wrapped_instance).__name__ + "."
 

Member Function Documentation

__getattr__()

def method_logger.MethodLogger.__getattr__	(		self,
			attr
	)

Definition at line 48 of file method_logger.py.

    def __getattr__(self, attr):
        return self.method_logger(getattr(self._class, attr))

method_logger()

def method_logger.MethodLogger.method_logger	(		self,
			met
	)

Definition at line 35 of file method_logger.py.

    def method_logger(self, met):
        qualified_name = self._prefix + str(met.__name__)
 
        @wraps(met)
        def _logger(*args, **kwargs):
            args_str = ", ".join(repr(arg) for arg in args)
            kwargs_str = ", ".join(str(k) + "=" + repr(v) for (k, v) in kwargs.items())
            all_args_str = args_str + (", " if len(kwargs_str) > 0 else "") + kwargs_str
            print(f"{qualified_name}({all_args_str})", file=self._sink)
            return met.__call__(*args, **kwargs)
 
        return _logger
 

Member Data Documentation

_class

method_logger.MethodLogger._class

protected

Definition at line 31 of file method_logger.py.

_prefix

method_logger.MethodLogger._prefix

protected

Definition at line 33 of file method_logger.py.

_sink

method_logger.MethodLogger._sink

protected

Definition at line 32 of file method_logger.py.

---

The documentation for this class was generated from the following file:

• python/method_logger.py