Logging As The Caller Module In Python
Solution 1:
Variable logger
being a global, can be accessed from inside do_something()
function like this:
logger = logging.getLogger(__name__)
def do_something():
x = logger
After reading this carefully:
What's the common solution for this type of recipe, when one function is used all over the code base but the loggers should be of those calling the function?
In simple english would be:
How to access global variable
logger
from imported functiondo_something()
?
I conclude that there is no other way! You have to pass logger as an argument for this particular case.
from utils import do_something
logger = logging.getLogger(__name__)
do_something() # logger global is not visible in do_something()
do_something(logger=logger) # the only way
Solution 2:
Passing the logger
as an argument looks fine to me. But if you have many calls to do_something
then passing the same logger in each call is not only too verbose but prone to errors --you might pass the wrong logger by mistake. Also, while you do need to make do_something
aware of the logger, doing it at the point where you are calling it probably does not make sense --you want to do something, not mess with loggers. OOP to the rescue: make do_something
a method of a class and pass the logger when instantiating the class, then you do not need to pass it to the method.
# utils.pyclassUsefulObject:def__init__(self, logger):
self._logger = logger
defdo_something(self):
print('hello')
self._logger.debug('test')
Now in the client module you create an instance of UsefulObject
and you can call .do_something
on it without passing the logger every time.
# one.py
from utils import UsefulObject
logger = logging.getLogger(__name__)
useful_object = UsefulObject(logger) # dothis once
# ...
useful_object.do_something() # dothis many times, do not pass the logger
Solution 3:
If you don't like the existing solutions, here's a magic way to do it:
def do_something():
logger = inspect.currentframe().f_back.f_globals['log']
...
The calling function must then have a global variable called log
.
Post a Comment for "Logging As The Caller Module In Python"