Context manager for redirecting Autodesk Maya's logging to given file path, to use as `with` statement.

redirect_log.py

from contextlib import contextmanager
from pathlib import Path


@contextmanager
def redirect_log(logfile_path):
    # type: (Text) -> Generator[None, None, None]
    """Function: Context manager for redirecting maya's log to given path, to use as `with` statement.

        Scenario: giving None to logfile_path
            then: do nothing

        Scenario: given existing path
            then: redirect to path before, do main job then re-redirect to original

        Scenario: given non-existing path
            then: touch file, redirect to path before, do main job then re-redirect to original
    """
    import maya.cmds as cmds

    if not logfile_path:
        yield
        return

    logfile = Path(logfile_path)
    logfile.touch()

    is_original_redirected = cmds.scriptEditorInfo(q=True, writeHistory=True)
    original_log = cmds.scriptEditorInfo(q=True, historyFilename=True)

    try:
        cmds.scriptEditorInfo(historyFilename=logfile.as_posix(), writeHistory=True)
        yield

    finally:
        cmds.scriptEditorInfo(writeHistory=False)
        if is_original_redirected:
            cmds.scriptEditorInfo(writeHistory=True)
        if original_log:
            cmds.scriptEditorInfo(historyFilename=original_log)