@@ -69,7 +69,7 @@ def init_logging():
6969 loggingConfig = {"logging_file" : None ,
7070 "logging_level" : logging .WARNING ,
7171 "hide_console" : False ,
72- "custom_levels" : {"ANALYSIS" , 25 }}
72+ "custom_levels" : {"ANALYSIS" : 25 }}
7373
7474 if loggingConfig .get ("custom_levels" , None ) is not None :
7575 for level_name , level_num in loggingConfig .get ("custom_levels" , {}).items ():
@@ -163,6 +163,23 @@ def debug(msg):
163163
164164@_concatArgs
165165def custom_log (msg , logging_level = None ):
166+ """
167+ Logs to a user defined logging level. This will only work for user defined
168+ levels if a builtin logging level is desired please use on of the builtin
169+ logging methods found in this file. To defined logging levels add them to the
170+ configuration file of your project. To add levels here add the map of
171+ `logging_levels` to the top level logging object and have the key be the new
172+ logging level name, and the value be the numerical logging value. To see all
173+ build in logging levels look at the builtin python logger package.
174+
175+
176+ This is decorated to have the same functionality of python's print argument concatenation
177+
178+ Args:
179+ msg: The message to log
180+
181+ logging_level: The user defined logging level.
182+ """
166183 if isinstance (logging_level , str ):
167184 logging_level = logging_level .upper ()
168185
0 commit comments