"""
Utility functions to log output of PyUnity.
This will be imported as ``pyunity.Logger``.
"""
__all__ = ["ResetStream", "LogException", "LogSpecial",
"SetStream", "Log", "LogLine", "Save", "Level", "Special"]
import os
import sys
import platform
import traceback
import re
import atexit
from time import strftime, time
[docs]def get_tmp():
if os.getenv("ANDROID_DATA") == "/data" and os.getenv("ANDROID_ROOT") == "/system":
pattern = re.compile(r"/data/(data|user/\d+)/(.+)/files")
for path in sys.path:
if pattern.match(path):
result = path.split("/files")[0]
break
else:
raise OSError("Cannot find path to android app folder")
folder = os.path.join(result, "files", "pyunity", "logs")
elif platform.platform().startswith("Windows"):
folder = os.path.join(os.environ["appdata"], "PyUnity", "Logs")
else:
folder = os.path.join("/tmp", "pyunity", "logs")
return folder
folder = get_tmp()
if not os.path.isdir(folder):
os.makedirs(folder, exist_ok=True)
stream = sys.stdout
timestamp = strftime("%Y-%m-%d %H-%M-%S")
start = time()
with open(os.path.join(folder, "latest.log"), "w+") as f:
f.write("Timestamp |(O)utput / (I)nfo / (D)ebug / (E)rror / (W)arning| Message\n")
f.write(strftime("%Y-%m-%d %H:%M:%S") + " |I| Started logger\n")
[docs]class Level:
"""
Represents a level or severity to log. You
should never instantiate this directly, instead
use one of `Logging.OUTPUT`, `Logging.INFO`,
`Logging.DEBUG`, `Logging.ERROR` or
`Logging.WARN`.
"""
def __init__(self, abbr, name):
self.abbr = abbr
self.name = name
OUTPUT = Level("O", "")
INFO = Level("I", None)
DEBUG = Level("D", "")
ERROR = Level("E", "")
WARN = Level("W", "Warning: ")
[docs]class Special:
"""
Class to represent a special line to log.
You should never instantiate this class,
instead use one of `Logger.RUNNING_TIME`.
"""
def __init__(self, func):
self.func = func
RUNNING_TIME = Special(lambda: f"Time taken: {time() - start}")
[docs]def Log(*message):
"""
Logs a message with level OUTPUT.
"""
LogLine(OUTPUT, *message)
[docs]def LogLine(level, *message, silent=False):
"""
Logs a line in `latest.log` found in these two locations:
Windows: ``%appdata%\\PyUnity\\Logs\\latest.log``
Other: ``/tmp/pyunity/logs/latest.log``
Parameters
----------
level : Level
Level or severity of log.
"""
msg = (level.name if level.name is not None else "") + \
" ".join(map(lambda a: str(a).rstrip(), message))
if os.environ["PYUNITY_DEBUG_MODE"] != "0":
if level.name is not None and not silent:
if level == ERROR:
sys.stderr.write(msg + "\n")
else:
stream.write(msg + "\n")
time = strftime("%Y-%m-%d %H:%M:%S")
with open(os.path.join(folder, "latest.log"), "a") as f:
f.write(f"{time} |{level.abbr}| {msg}\n")
return time, msg
[docs]def LogException(e):
"""
Log an exception.
Parameters
----------
e : Exception
Exception to log
"""
exception = traceback.format_exception(type(e), e, e.__traceback__)
for line in exception:
for line2 in line.split("\n"):
if line2:
LogLine(ERROR, line2)
[docs]def LogSpecial(level, type):
"""
Log a line of level `level` with a
special line that is generated at
runtime.
Parameters
----------
level : Level
Level of log
type : Special
The special line to log
"""
LogLine(level, type.func())
[docs]@atexit.register
def Save():
"""
Saves a new log file with a timestamp
of initializing PyUnity for the first time.
"""
LogLine(INFO, "Saving new log at",
os.path.join(folder, timestamp + ".log"))
with open(os.path.join(folder, "latest.log")) as f:
with open(os.path.join(folder, timestamp + ".log"), "w+") as f2:
f2.write(f.read())
[docs]def SetStream(s):
global stream
stream = s
stream.write(f"Changed stream to {s}")
LogLine(INFO, f"Changed stream to {s}")
[docs]def ResetStream():
global stream
stream = sys.stdout
stream.write("Changed stream back to stdout")
LogLine(INFO, "Changed stream back to stdout")
