Great! The main setup is done! Setting up our module-level loggingĪ simple module to test our logger can be done to understand the template better. To make sure we can import our module from the package. If we do that, we’ll also need to include a _init_.py file in the folder and do from. def get_logger( module_name): return logging.getLogger(APP_LOGGER_NAME).getChild(module_name)Īlso, in order to use this module as a package, we can optionally make a folder called logger and put this file inside it. This is done via the logging FileHandler.Īnother function is needed which will make sure our modules can call the logger when needed.
Next, we also make sure to include a file in which we can additonally store all our log messages too. We then assign it to our stream handler in order to write messages to the console.
We will be defining our logger with the predefined DEBUG level and use a Formatter to structure our logging messages. The function we will be calling in our app.py: def setup_applevel_logger( logger_name = APP_LOGGER_NAME, file_name=None): logger = logging.getLogger(logger_name) tLevel(logging.DEBUG) formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") sh = logging.StreamHandler(sys.stdout) sh.setFormatter(formatter) () logger.addHandler(sh) if file_name: fh = logging.FileHandler(file_name) fh.setFormatter(formatter) logger.addHandler(fh) return logger
Time for some code!Ī few imports and our app name: import logging import sys APP_LOGGER_NAME = 'MyAwesomeApp' Let’s define a root logger and use it for initialising our app level logger. We’ll call it logger.Īnd we’re done with this part. Now, let’s create a new module for the app level logging setup. Go ahead and open your project in VSCode (or any editor you prefer). I will be using this project to construct a simple working example of the template I’m talking about. This will be the starting point of our app. Inside it, create a new Python file called app.py. With that in mind, let’s go ahead and initialise a simple project for now, shall we?Ĭreate a folder called ‘ MyAwesomeProject’. Okay, let’s get down to it! 👇 Making a simple Python projectĮxplaining a new concept should always be done at first in simpler terms with little focus diverted towards background information. Like I said, there are a number of good articles out there to learn from. I am assuming you know the basics of logging already. In this article, I will be sharing my personal logging template that you can easily use for any project with multiple modules.
#Continuously read and copy log file python how to#
However, it is nearly impossible to find one that explains how to set up the Python logging library to be used application-wide, and how to properly integrate and share the logging info comfortably in all your project modules.
I started using the Python logging library a couple years ago, and since then, I’ve been consulting countless tutorials and articles online on how to use it effectively and with best possible setup for my projects.Īll of them are good at explaining how to set a logging system for a single Python script. They are the essential component of any small, medium or large project in any programming language, not just Python. The perfect way to debug and follow the execution of an app is through well defined, informative and conveniently structured logs.
0 kommentar(er)
