stdout_replacement.py

#! /usr/bin/env python
# -*- coding: utf-8 -*-



"""
    This file is generated automatically based `stderr_replacement.py` while `debug_tools`
    library/package is being developed.

    If you developing the `debug_tools` library, please do not edit this file, but the file
    `stderr_replacement.py` and run `logger.py` function `create_stdout_handler()` by
    uncommenting it on `all/debug_tools/logger.py` file.
"""
import sys
import logging

import inspect
import traceback

from logging import StreamHandler

try:
    unicode
    _unicode = True
except NameError:
    unicode = str
    _unicode = False


class stdout_replacement(object):
    """
        In case of reloading this module, never recapture the current `sys.stdout`.

        When disabling this with unlock, it will only restore the standard behavior of the `stdout`
        stream. However, the attached logger will cannot be detached never because someone else can
        have a reference to its older version. This is why this is a global singleton which can
        never dies.

        How do I duplicate sys.stdout to a log file in python?
        https://stackoverflow.com/questions/616645/how-do-i-duplicate-sys-stdout-to-a-log-file-in-python

        How to redirect stdout and stdout to logger in Python
        https://stackoverflow.com/questions/19425736/how-to-redirect-stdout-and-stdout-to-logger-in-python

        Set a Read-Only Attribute in Python?
        https://stackoverflow.com/questions/24497316/set-a-read-only-attribute-in-python
    """
    is_active = False

    @classmethod
    def lock(cls, logger):
        """
            Attach this singleton logger to the `sys.stdout` permanently.
        """
        global _stdout_singleton
        global _stdout_default
        global _stdout_default_class_type

        # On Sublime Text, the `sys.__stdout__` is None, because they already replaced `sys.stdout`
        # by some `_LogWriter()` class, then just save the current one over there.
        if not sys.__stdout__:
            sys.__stdout__ = sys.stdout

        try:
            _stdout_default
            _stdout_default_class_type

        except NameError:
            # sys.stdout.write( "Assigning sys.stdout to _stdout_default\n" )
            _stdout_default = sys.stdout

            _stdout_default_class_type = type( _stdout_default )
            # sys.stdout.write( "Assigned  sys.stdout to _stdout_default: %s, %s\n" % ( _stdout_default, _stdout_default_class_type ) )

        # Recreate the sys.stdout logger when it was reset by `unlock()`
        if not cls.is_active:
            cls.is_active = True
            _stdout_write = _stdout_default.write

            logger_call = logger._log_clean
            clean_formatter = logger.clean_formatter

            global _sys_stdout_write
            global _sys_stdout_write_hidden

            if sys.version_info <= (3,2):

                def customEmit(self, record):
                    """
                    Emit a record.
                    https://stackoverflow.com/questions/12699645/how-can-i-suppress-newline-in-python-logging-module

                    If a formatter is specified, it is used to format the record.
                    The record is then written to the stream with a trailing newline.  If
                    exception information is present, it is formatted using
                    traceback.print_exception and appended to the stream.  If the stream
                    has an 'encoding' attribute, it is used to determine how to do the
                    output to the stream.
                    """
                    try:
                        msg = self.format(record)
                        stream = self.stream
                        fs = "%s%s"
                        if not _unicode: #if no unicode support...
                            stream.write(fs % (msg, self.terminator))
                        else:
                            try:
                                if (isinstance(msg, unicode) and
                                    getattr(stream, 'encoding', None)):
                                    ufs = u'%s%s'
                                    try:
                                        stream.write(ufs % (msg, self.terminator))
                                    except UnicodeEncodeError:
                                        #Printing to terminals sometimes fails. For example,
                                        #with an encoding of 'cp1251', the above write will
                                        #work if written to a stream opened or wrapped by
                                        #the codecs module, but fail when writing to a
                                        #terminal even when the codepage is set to cp1251.
                                        #An extra encoding step seems to be needed.
                                        stream.write((ufs % (msg, self.terminator)).encode(stream.encoding))
                                else:
                                    stream.write(fs % (msg, self.terminator))
                            except UnicodeError:
                                stream.write(fs % (msg.encode("UTF-8"), self.terminator))
                        self.flush()
                    except (KeyboardInterrupt, SystemExit):
                        raise
                    except:
                        self.handleError(record)

                logging.StreamHandler.terminator = '\n'
                setattr(StreamHandler, StreamHandler.emit.__name__, customEmit)

            # Always recreate/override the internal write function used by `_sys_stdout_write`
            def _sys_stdout_write_hidden(msg, *args, **kwargs):
                """
                    Suppress newline in Python logging module
                    https://stackoverflow.com/questions/7168790/suppress-newline-in-python-logging-module
                """

                try:
                    file = logger._file
                    _stdout_write( msg, *args, **kwargs )

                    formatter = file.formatter
                    terminator = file.terminator

                    file.formatter = clean_formatter
                    file.terminator = ""

                    kwargs['extra'] = { '_duplicated_from_file': True }
                    logger_call( msg, args, kwargs )

                    file.formatter = formatter
                    file.terminator = terminator

                except Exception:
                    logger.exception( "Could not write to the file: %s(%s)", file, logger )
                    cls.unlock()

            # Only create one `_sys_stdout_write` function pointer ever
            try:
                _sys_stdout_write

            except NameError:

                def _sys_stdout_write(*args, **kwargs):
                    """
                        Hides the actual function pointer. This allow the external function pointer to
                        be cached while the internal written can be exchanged between the standard
                        `sys.stdout.write` and our custom wrapper around it.
                    """
                    _sys_stdout_write_hidden( *args, **kwargs )

        # sys.stdout.write( "_stdout_default: %s\n" % _stdout_default )
        # sys.stdout.write( "_stdout_default.__dict__: %s\n" % dir( _stdout_default ) )
        # sys.stdout.write( "(inspect) _stdout_default.__init__: %s\n" % str( inspect.getfullargspec( _stdout_default.__init__ ) ) )

        try:
            # Only create one singleton instance ever
            # del _stdout_singleton
            _stdout_singleton

        except NameError:

            class stdout_replament_hidden(_stdout_default_class_type):
                """
                    Which special methods bypasses __getattribute__ in Python?
                    https://stackoverflow.com/questions/12872695/which-special-methods-bypasses-getattribute-in-python
                """

                if hasattr( _stdout_default, "__abstractmethods__" ):
                    __abstractmethods__ = _stdout_default.__abstractmethods__

                if hasattr( _stdout_default, "__base__" ):
                    __base__ = _stdout_default.__base__

                if hasattr( _stdout_default, "__bases__" ):
                    __bases__ = _stdout_default.__bases__

                if hasattr( _stdout_default, "__basicsize__" ):
                    __basicsize__ = _stdout_default.__basicsize__

                if hasattr( _stdout_default, "__call__" ):
                    __call__ = _stdout_default.__call__

                if hasattr( _stdout_default, "__class__" ):
                    __class__ = _stdout_default.__class__

                if hasattr( _stdout_default, "__delattr__" ):
                    __delattr__ = _stdout_default.__delattr__

                if hasattr( _stdout_default, "__dict__" ):
                    __dict__ = _stdout_default.__dict__

                if hasattr( _stdout_default, "__dictoffset__" ):
                    __dictoffset__ = _stdout_default.__dictoffset__

                if hasattr( _stdout_default, "__dir__" ):
                    __dir__ = _stdout_default.__dir__

                if hasattr( _stdout_default, "__doc__" ):
                    __doc__ = _stdout_default.__doc__

                if hasattr( _stdout_default, "__eq__" ):
                    __eq__ = _stdout_default.__eq__

                if hasattr( _stdout_default, "__flags__" ):
                    __flags__ = _stdout_default.__flags__

                if hasattr( _stdout_default, "__format__" ):
                    __format__ = _stdout_default.__format__

                if hasattr( _stdout_default, "__ge__" ):
                    __ge__ = _stdout_default.__ge__

                if hasattr( _stdout_default, "__getattribute__" ):
                    __getattribute__ = _stdout_default.__getattribute__

                if hasattr( _stdout_default, "__gt__" ):
                    __gt__ = _stdout_default.__gt__

                if hasattr( _stdout_default, "__hash__" ):
                    __hash__ = _stdout_default.__hash__

                if hasattr( _stdout_default, "__init__" ):
                    __init__ = _stdout_default.__init__

                if hasattr( _stdout_default, "__init_subclass__" ):
                    __init_subclass__ = _stdout_default.__init_subclass__

                if hasattr( _stdout_default, "__instancecheck__" ):
                    __instancecheck__ = _stdout_default.__instancecheck__

                if hasattr( _stdout_default, "__itemsize__" ):
                    __itemsize__ = _stdout_default.__itemsize__

                if hasattr( _stdout_default, "__le__" ):
                    __le__ = _stdout_default.__le__

                if hasattr( _stdout_default, "__lt__" ):
                    __lt__ = _stdout_default.__lt__

                if hasattr( _stdout_default, "__module__" ):
                    __module__ = _stdout_default.__module__

                if hasattr( _stdout_default, "__mro__" ):
                    __mro__ = _stdout_default.__mro__

                if hasattr( _stdout_default, "__name__" ):
                    __name__ = _stdout_default.__name__

                if hasattr( _stdout_default, "__ne__" ):
                    __ne__ = _stdout_default.__ne__

                if hasattr( _stdout_default, "__new__" ):
                    __new__ = _stdout_default.__new__

                if hasattr( _stdout_default, "__prepare__" ):
                    __prepare__ = _stdout_default.__prepare__

                if hasattr( _stdout_default, "__qualname__" ):
                    __qualname__ = _stdout_default.__qualname__

                if hasattr( _stdout_default, "__reduce__" ):
                    __reduce__ = _stdout_default.__reduce__

                if hasattr( _stdout_default, "__reduce_ex__" ):
                    __reduce_ex__ = _stdout_default.__reduce_ex__

                if hasattr( _stdout_default, "__repr__" ):
                    __repr__ = _stdout_default.__repr__

                if hasattr( _stdout_default, "__setattr__" ):
                    __setattr__ = _stdout_default.__setattr__

                if hasattr( _stdout_default, "__sizeof__" ):
                    __sizeof__ = _stdout_default.__sizeof__

                if hasattr( _stdout_default, "__str__" ):
                    __str__ = _stdout_default.__str__

                if hasattr( _stdout_default, "__subclasscheck__" ):
                    __subclasscheck__ = _stdout_default.__subclasscheck__

                if hasattr( _stdout_default, "__subclasses__" ):
                    __subclasses__ = _stdout_default.__subclasses__

                if hasattr( _stdout_default, "__subclasshook__" ):
                    __subclasshook__ = _stdout_default.__subclasshook__

                if hasattr( _stdout_default, "__text_signature__" ):
                    __text_signature__ = _stdout_default.__text_signature__

                if hasattr( _stdout_default, "__weakrefoffset__" ):
                    __weakrefoffset__ = _stdout_default.__weakrefoffset__

                if hasattr( _stdout_default, "mro" ):
                    mro = _stdout_default.mro

                def __init__(self):
                    """
                        Override any super class `type( _stdout_default )` constructor, so we can
                        instantiate any kind of `sys.stdout` replacement object, in case it was
                        already replaced by something else like on Sublime Text with `_LogWriter()`.

                        Assures all attributes were statically replaced just above. This should happen in case
                        some new attribute is added to the python language.

                        This also ignores the only two methods which are not equal, `__init__()` and `__getattribute__()`.
                    """
                    different_methods = ("__init__", "__class__", "__getattribute__")
                    attributes_to_check = set( dir( object ) + dir( type ) )

                    for attribute in attributes_to_check:

                        if attribute not in different_methods \
                                and hasattr( _stdout_default, attribute ):

                            base_class_attribute = super( _stdout_default_class_type, self ).__getattribute__( attribute )
                            target_class_attribute = _stdout_default.__getattribute__( attribute )

                            if base_class_attribute != target_class_attribute:
                                sys.stdout.write( "    The base class attribute `%s` is different from the target class:\n%s\n%s\n\n" % ( attribute, base_class_attribute, target_class_attribute ) )

                def __getattribute__(self, item):
                    # sys.stdout.write( "__getattribute__, item: %s: %s\n" % ( item, _sys_stdout_write ) )

                    if item == 'write':
                        return _sys_stdout_write

                    try:
                        return _stdout_default.__getattribute__( item )

                    except AttributeError:
                        return super( _stdout_default_class_type, _stdout_default ).__getattribute__( item )

            # sys.stdout.write( "_stdout_default: %s\n" % _stdout_default )
            # sys.stdout.write( "inspect.getmro(_stdout_default): %s\n" % str( inspect.getmro( type( _stdout_default ) ) ) )
            # sys.stdout.write( "inspect.getmro(stdout_replacement): %s\n" % str( inspect.getmro( stdout_replament_hidden ) ) )
            # sys.stdout.write( "traceback.format_stack():\n%s\n" % "".join( traceback.format_stack() ) )
            _stdout_singleton = stdout_replament_hidden()

            # sys.stdout.write( "_stdout_singleton: ")
            # sys.stdout.write( "%s\n" % _stdout_singleton )
            sys.stdout = _stdout_singleton

            # sys.stdout.write( "(inspect) signature:   %s\n" % str( inspect.signature( _stdout_singleton.write ) ) )
            # sys.stdout.write( "(inspect) fullargspec: %s\n" % str( inspect.getfullargspec( _stdout_singleton.write ) ) )
            # sys.stdout.write( "(_stdout_singleton 6): %s\n" % _stdout_singleton )

        # sys.stdout.write( "Locking...   _sys_stdout_write_hidden: %s\n" % _sys_stdout_write_hidden )
        return cls

    @classmethod
    def unlock(cls):
        """
            Detach this `stdout` writer from `sys.stdout` and allow the next call to `lock()` create
            a new writer for the stdout.
        """

        if cls.is_active:
            global _sys_stdout_write_hidden
            # sys.stdout.write( "Unlocking... _sys_stdout_write_hidden: %s\n" % _sys_stdout_write_hidden )

            cls.is_active = False
            _sys_stdout_write_hidden = _stdout_default.write