Belle II Software light-2406-ragdoll
LogPythonInterface Class Reference

Thin wrapper to expose a usable interface to the logging framework in python. More...

#include <LogPythonInterface.h>

Public Member Functions

 LogPythonInterface ()
 ctor
 
void setLogLevel (LogConfig::ELogLevel level)
 Set the log level.
 
void setAbortLevel (LogConfig::ELogLevel level)
 Set the abort log level.
 
void setDebugLevel (int level)
 Set the debug messaging level.
 
void setLogInfo (LogConfig::ELogLevel level, int info)
 Set the printed log information for the given level.
 
void setPackageLogConfig (const std::string &package, const LogConfig &config)
 Set LogConfig for a given package.
 
void setMaxMessageRepetitions (unsigned repetitions)
 Set maximum number of repetitions before silencing "identical" log messages.
 
LogConfig::ELogLevel getLogLevel ()
 Get the log level.
 
LogConfig::ELogLevel getAbortLevel ()
 Get the abort level.
 
int getDebugLevel ()
 Get the debug level.
 
int getLogInfo (LogConfig::ELogLevel level)
 Get the printed log information for the given level.
 
LogConfiggetPackageLogConfig (const std::string &package)
 Get the LogConfig for the given package.
 
unsigned getMaxMessageRepetitions () const
 Get maximum number of repetitions before silencing "identical" log messages.
 
void addLogFile (const std::string &filename, bool append=false)
 Add a file as output connection.
 
void addLogConsole ()
 Add the console as output connection.
 
void addLogJSON (bool complete)
 Add the console as output connection but print the log messages as json objects so that they can be parsed easily.
 
void addLogUDP (const std::string &hostname, unsigned short port)
 Add a UDP server as an output connection.
 
void addLogConsole (bool color)
 Add the console as output connection.
 
void reset ()
 Reset logging connections.
 
void zeroCounters ()
 Reset logging counters.
 
void enableErrorSummary (bool on)
 Enable/Disable error summary.
 
void setPythonLoggingEnabled (bool enabled) const
 Set flag if logging should be done via python sys.stdout
 
bool getPythonLoggingEnabled () const
 Get flag if logging should be done via python sys.stdout
 
void setEscapeNewlinesEnabled (bool enabled) const
 Set flag if newlines in log messages to console should be replaced by '
'.
 
bool getEscapeNewlinesEnabled () const
 Get flag if newlines in log messages to console should be replaced by '
'`.
 
boost::python::dict getLogStatistics ()
 return dict with log statistics
 

Static Public Member Functions

static boost::python::object logDebug (boost::python::tuple args, const boost::python::dict &kwargs)
 Produce debug message.
 
static boost::python::object logInfo (boost::python::tuple args, const boost::python::dict &kwargs)
 Produce info message.
 
static boost::python::object logResult (boost::python::tuple args, const boost::python::dict &kwargs)
 Produce result message.
 
static boost::python::object logWarning (boost::python::tuple args, const boost::python::dict &kwargs)
 Produce warning message.
 
static boost::python::object logError (boost::python::tuple args, const boost::python::dict &kwargs)
 Produce error message.
 
static boost::python::object logFatal (boost::python::tuple args, const boost::python::dict &kwargs)
 Produce fatal message.
 
static void exposePythonAPI ()
 expose python API
 

Detailed Description

Thin wrapper to expose a usable interface to the logging framework in python.

This class exposes a object called "logging" to the python interface. With this object it is possible to set all properties of the logging system directly in the steering file in a consistent manner This class also exposes the LogConfig class as well as the LogConfig::ELogLevel and LogConfig::ELogInfo enums to make setting of properties more transparent by using the names and not just the values. To set or get the log level, one can simply do:

‍logging.log_level = LogLevel.FATAL print "Logging level set to", logging.log_level

This module also allows to send log messages directly from python to ease consistent error reporting througout the framework

‍B2WARNING("This is a warning message");

For all features, see b2logging.py in the framework/examples folder

Definition at line 44 of file LogPythonInterface.h.

Constructor & Destructor Documentation

◆ LogPythonInterface()

LogPythonInterface ( )
inline

ctor

Definition at line 47 of file LogPythonInterface.h.

47{};

Member Function Documentation

◆ addLogConsole() [1/2]

void addLogConsole ( )

Add the console as output connection.

Color will be used automatically if supported

Definition at line 111 of file LogPythonInterface.cc.

112{
114}
Implements a log connection to an IO Stream.
Implements a log connection that filters repeated messages.
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void addLogConnection(LogConnectionBase *logConnection)
Adds a log connection object which is used to the send the logging messages.
Definition: LogSystem.cc:38

◆ addLogConsole() [2/2]

void addLogConsole ( bool  color)

Add the console as output connection.

Parameters
colorFlag whether color should be used

Definition at line 116 of file LogPythonInterface.cc.

117{
119}

◆ addLogFile()

void addLogFile ( const std::string &  filename,
bool  append = false 
)

Add a file as output connection.

Parameters
filenameThe text file name
appendFlag whether output should be appended to an existing file

Definition at line 106 of file LogPythonInterface.cc.

107{
109}
Implements a log connection to a text file.

◆ addLogJSON()

void addLogJSON ( bool  complete)

Add the console as output connection but print the log messages as json objects so that they can be parsed easily.

Parameters
completeif true ignore the log info configuration and print all parts of the log message.

Definition at line 96 of file LogPythonInterface.cc.

97{
99}
Implements a log connection to stdout but with messages formatted as json objects to allow easy parsi...

◆ addLogUDP()

void addLogUDP ( const std::string &  hostname,
unsigned short  port 
)

Add a UDP server as an output connection.

Parameters
hostnamethe hostname of the UDP server. Will throw an exception if it can not be resolved.
portthe port to connect to

Definition at line 101 of file LogPythonInterface.cc.

102{
104}
Log Connection to send the log message as JSON to a UDP server.

◆ enableErrorSummary()

void enableErrorSummary ( bool  on)

Enable/Disable error summary.

Definition at line 131 of file LogPythonInterface.cc.

132{
134}
void enableErrorSummary(bool on)
enable/disable error/warning summary after successful execution and B2FATAL.
Definition: LogSystem.h:181

◆ exposePythonAPI()

void exposePythonAPI ( )
static

expose python API

Expose python api.

Definition at line 188 of file LogPythonInterface.cc.

189{
190 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
191 namespace bp = boost::python;
192 scope global;
193 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
194
195 //Interface LogLevel enum
196 enum_<LogConfig::ELogLevel>("LogLevel", R"DOCSTRING(Class for all possible log levels
197
198.. attribute:: DEBUG
199
200 The lowest possible severity meant for expert only information and disabled
201 by default. In contrast to all other log levels DEBUG messages have an
202 additional numeric indication of their priority called the ``debug_level`` to
203 allow for different levels of verbosity.
204
205 The agreed values for ``debug_level`` are
206
207 * **0-9** for user code. These numbers are reserved for user analysis code and
208 may not be used by any part of basf2.
209 * **10-19** for analysis package code. The use case is that a user wants to debug
210 problems in analysis jobs with the help of experts.
211
212 * **20-29** for simulation/reconstruction code.
213 * **30-39** for core framework code.
214
215 .. note:: The default maximum debug level which will be shown when
216 running ``basf2 --debug`` without any argument for ``--debug`` is **10**
217
218
219.. attribute:: INFO
220
221 Used for informational messages which are of use for the average user but not
222 very important. Should be used very sparsely, everything which is of no
223 interest to the average user should be a debug message.
224
225.. attribute:: RESULT
226
227 Informational message which don't indicate an error condition but are more
228 important than a mere information. For example the calculated cross section
229 or the output file name.
230
231 .. deprecated:: release-01-00-00
232 use `INFO <basf2.LogLevel.INFO>` messages instead
233
234.. attribute:: WARNING
235
236 For messages which indicate something which is not correct but not fatal to
237 the processing. This should **not** be used to make informational messages
238 more prominent and they should not be ignored by the user but they are not
239 critical.
240
241.. attribute:: ERROR
242
243 For messages which indicate a clear error condition which needs to be
244 recovered. If error messages are produced before event processing is started
245 the processing will be aborted. During processing errors don't lead to a stop
246 of the processing but still indicate a problem.
247
248.. attribute:: FATAL
249
250 For errors so severe that no recovery is possible. Emitting a fatal error
251 will always stop the processing and the `B2FATAL` function is guaranteed to
252 not return.
253)DOCSTRING")
261 ;
262
263 //Interface LogInfo enum
264 enum_<LogConfig::ELogInfo>("LogInfo", R"DOCSTRING(The different fields of a log message.
265
266These fields can be used as a bitmask to configure the appearance of log messages.
267
268.. attribute:: LEVEL
269
270 The severity of the log message, one of `basf2.LogLevel`
271
272.. attribute:: MESSAGE
273
274 The actual log message
275
276.. attribute:: MODULE
277
278 The name of the module active when the message was emitted. Can be empty if
279 no module was active (before/after processing or outside of the normal event
280 loop)
281
282.. attribute:: PACKAGE
283
284 The package the code that emitted the message belongs to. This is empty for
285 messages emitted by python scripts
286
287.. attribute:: FUNCTION
288
289 The function name that emitted the message
290
291.. attribute:: FILE
292
293 The filename containing the code emitting the message
294
295.. attribute:: LINE
296
297 The line number in the file emitting the message
298)DOCSTRING")
299 .value("LEVEL", LogConfig::c_Level)
300 .value("MESSAGE", LogConfig::c_Message)
301 .value("MODULE", LogConfig::c_Module)
302 .value("PACKAGE", LogConfig::c_Package)
303 .value("FUNCTION", LogConfig::c_Function)
304 .value("FILE", LogConfig::c_File)
305 .value("LINE", LogConfig::c_Line)
306 .value("TIMESTAMP", LogConfig::c_Timestamp)
307 ;
308
309 //Interface LogConfig class
310 class_<LogConfig>("LogConfig",
311 R"(Defines logging settings (log levels and items included in each message) for a certain context, e.g. a module or package.
312
313.. seealso:: `logging.package(str) <basf2.LogPythonInterface.package>`)")
314 .def(init<bp::optional<LogConfig::ELogLevel, int> >())
315 .add_property("log_level", &LogConfig::getLogLevel, &LogConfig::setLogLevel, "set or get the current log level")
316 .add_property("debug_level", &LogConfig::getDebugLevel, &LogConfig::setDebugLevel, "set or get the current debug level")
317 .add_property("abort_level", &LogConfig::getAbortLevel, &LogConfig::setAbortLevel,
318 "set or get the severity which causes program abort")
319 .def("set_log_level", &LogConfig::setLogLevel, args("log_level"), R"DOC(
320Set the minimum log level to be shown. Messages with a log level below this value will not be shown at all.
321
322.. warning: Message with a level of `ERROR <LogLevel.ERROR>` or higher will always be shown and cannot be silenced.
323)DOC")
324 .def("set_debug_level", &LogConfig::setDebugLevel, args("debug_level"), R"DOC(
325Set the maximum debug level to be shown. Any messages with log level `DEBUG <LogLevel.DEBUG>` and a larger debug level will not be shown.
326
327.. seealso: the documentation of `DEBUG <LogLevel.DEBUG>` for suitable values
328)DOC")
329 .def("set_abort_level", &LogConfig::setAbortLevel, args("abort_level"), R"DOC(
330Set the severity which causes program abort.
331
332This can be set to a `LogLevel` which will cause the processing to be aborted if
333a message with the given level or higher is encountered. The default is
334`FATAL <LogLevel.FATAL>`. It cannot be set any higher but can be lowered.
335)DOC")
336 .def("set_info", &LogConfig::setLogInfo, args("log_level", "log_info"),
337 "set the bitmask of LogInfo members to show when printing messages for a given log level")
338 .def("get_info", &LogConfig::getLogInfo, args("log_level"),
339 "get the current bitmask of which parts of the log message will be printed for a given log level")
340 ;
341
343
344 //Interface the Interface class :)
345 class_<LogPythonInterface, std::shared_ptr<LogPythonInterface>, boost::noncopyable>("LogPythonInterface", R"(
346Logging configuration (for messages generated from C++ or Python), available as a global `basf2.logging` object in Python. See also `basf2.set_log_level()` and `basf2.set_debug_level()`.
347
348This class exposes a object called `logging <basf2.logging>` to the python interface. With
349this object it is possible to set all properties of the logging system
350directly in the steering file in a consistent manner This class also
351exposes the `LogConfig` class as well as the `LogLevel`
352and `LogInfo` enums to make setting of properties more transparent
353by using the names and not just the values. To set or get the log level,
354one can simply do:
355
356>>> logging.log_level = LogLevel.FATAL
357>>> print("Logging level set to", logging.log_level)
358FATAL
359
360This module also allows to send log messages directly from python to ease
361consistent error reporting throughout the framework
362
363>>> B2WARNING("This is a warning message")
364
365.. seealso::
366
367 For all features, see :download:`b2logging.py </framework/examples/b2logging.py>`)")
368 .add_property("log_level", &LogPythonInterface::getLogLevel, &LogPythonInterface::setLogLevel, R"DOC(
369Attribute for setting/getting the current `log level <basf2.LogLevel>`.
370Messages with a lower level are ignored.
371
372.. warning: Message with a level of `ERROR <LogLevel.ERROR>` or higher will always be shown and cannot be silenced.
373)DOC")
375 "Attribute for getting/setting the debug level. If debug messages are enabled, their level needs to be at least this high to be printed. Defaults to 100.")
377 "Attribute for setting/getting the `log level <basf2.LogLevel>` at which to abort processing. Defaults to `FATAL <LogLevel.FATAL>` but can be set to a lower level in rare cases.")
379Set the maximum amount of times log messages with the same level and message text
380(excluding variables) will be repeated before it is suppressed. Suppressed messages
381will still be counted but not shown for the remainder of the processing.
382
383This affects messages with the same text but different ref:`logging_logvariables`.
384If the same log message is repeated frequently with different variables all of
385these will be suppressed after the given amount of repetitions.
386
387.. versionadded:: release-05-00-00
388)DOC")
389
390 .def("set_package", &LogPythonInterface::setPackageLogConfig, args("package", "config"),
391 "Set `basf2.LogConfig` for given package, see also `package() <basf2.LogPythonInterface.package>`.")
392 .def("package", &LogPythonInterface::getPackageLogConfig, return_value_policy<reference_existing_object>(), args("package"),
393 R"(Get the `LogConfig` for given package to set detailed logging pararameters for this package.
394
395 >>> logging.package('svd').debug_level = 10
396 >>> logging.package('svd').set_info(LogLevel.INFO, LogInfo.LEVEL | LogInfo.MESSAGE | LogInfo.FILE)
397 )")
398 .def("set_info", &LogPythonInterface::setLogInfo, args("log_level", "log_info"),
399 R"DOCSTRING(Set info to print for given log level. Should be an OR combination of `basf2.LogInfo` constants.
400As an example, to show only the level and text for all debug messages one could use
401
402>>> basf2.logging.set_info(basf2.LogLevel.DEBUG, basf2.LogInfo.LEVEL | basf2.LogInfo.MESSAGE)
403
404Parameters:
405 log_level (LogLevel): log level for which to set the display info
406 log_info (int): Bitmask of `basf2.LogInfo` constants.)DOCSTRING")
407 .def("get_info", &LogPythonInterface::getLogInfo, args("log_level"), "Get info to print for given log level.\n\n"
408 "Parameters:\n log_level (basf2.LogLevel): Log level for which to get the display info")
409 .def("add_file", &LogPythonInterface::addLogFile, (bp::arg("filename"), bp::arg("append") = false),
410 R"DOCSTRING(Write log output to given file. (In addition to existing outputs)\n\n"
411
412Parameters:
413 filename (str): Filename to to write log messages into
414 append (bool): If set to True the file will be truncated before writing new messages.)DOCSTRING")
415 .def("add_console", addLogConsole,
416 addLogConsole_overloads(args("enable_color"), "Write log output to console. (In addition to existing outputs). "
417 "If ``enable_color`` is not specified color will be enabled if supported"))
418 .def("add_json", &LogPythonInterface::addLogJSON, (bp::arg("complete_info") = false), R"DOCSTRING(
419Write log output to console, but format log messages as json objects for
420simplified parsing by other tools. Each log message will be printed as a one
421line JSON object.
422
423.. versionadded:: release-03-00-00
424
425Parameters:
426 complete_info (bool): If this is set to True the complete log information is printed regardless of the `LogInfo` setting.
427
428See Also:
429 `add_console()`, `set_info()`
430)DOCSTRING")
431 .def("add_udp", &LogPythonInterface::addLogUDP, (bp::arg("hostname"), bp::arg("port")), R"DOCSTRING(
432 Send the log output as a JSON object to the given hostname and port via UDP.
433
434.. versionadded:: release-04-00-00
435
436Parameters:
437 hostname (str): The hostname to send the message to. If it can not be resolved, an exception will be thrown.
438 port (int): The port on the host to send the message via UDP.
439
440See Also:
441 `add_json()`
442)DOCSTRING")
443 .def("terminal_supports_colors", &terminalSupportsColors, "Returns true if the terminal supports colored output")
444 .staticmethod("terminal_supports_colors")
445 .def("reset", &LogPythonInterface::reset, "Remove all configured logging outputs. "
446 "You can then configure your own via `add_file() <basf2.LogPythonInterface.add_file>` "
447 "or `add_console() <basf2.LogPythonInterface.add_console>`")
448 .def("zero_counters", &LogPythonInterface::zeroCounters, "Reset the per-level message counters.")
449 .def_readonly("log_stats", &LogPythonInterface::getLogStatistics, "Returns dictionary with message counters.")
450 .def("enable_summary", &LogPythonInterface::enableErrorSummary, args("on"),
451 "Enable or disable the error summary printed at the end of processing. "
452 "Expects one argument whether or not the summary should be shown")
453 .add_property("enable_python_logging", &LogPythonInterface::getPythonLoggingEnabled,
455Enable or disable logging via python. If this is set to true than log messages
456will be sent via `sys.stdout`. This is probably slightly slower but is useful
457when running in jupyter notebooks or when trying to redirect stdout in python
458to a buffer. This setting affects all log connections to the
459console.
460
461.. versionadded:: release-03-00-00)DOCSTRING")
462 .add_property("enable_escape_newlines", &LogPythonInterface::getEscapeNewlinesEnabled,
464Enable or disable escaping of newlines in log messages to the console. If this
465is set to true than any newline character in log messages printed to the console
466will be replaced by a "\n" to ensure that every log messages fits exactly on one line.
467
468.. versionadded:: release-04-02-00)DOCSTRING")
469 ;
470
471 //Expose Logging object
472 std::shared_ptr<LogPythonInterface> initguard{new LogPythonInterface()};
473 scope().attr("logging") = initguard;
474
475 //Add all the logging functions. To handle arbitrary keyword arguments we add
476 //them as raw functions. However it seems setting the docstring needs to be
477 //done manually in this case. So create function objects, add to namespace,
478 //set docstring ...
479
480 const std::string common_doc = R"DOCSTRING(
481All additional positional arguments are converted to strings and concatenated
482to the log message. All keyword arguments are added to the function as
483:ref:`logging_logvariables`.)DOCSTRING";
484
485 auto logDebug = raw_function(&LogPythonInterface::logDebug);
486 def("B2DEBUG", logDebug);
487 setattr(logDebug, "__doc__", "B2DEBUG(debugLevel, message, *args, **kwargs)\n\n"
488 "Print a `DEBUG <basf2.LogLevel.DEBUG>` message. "
489 "The first argument is the `debug_level <basf2.LogLevel.DEBUG>`. " +
490 common_doc);
491
492 auto logInfo = raw_function(&LogPythonInterface::logInfo);
493 def("B2INFO", logInfo);
494 setattr(logInfo, "__doc__", "B2INFO(message, *args, **kwargs)\n\n"
495 "Print a `INFO <basf2.LogLevel.INFO>` message. " + common_doc);
496
497 auto logResult = raw_function(&LogPythonInterface::logResult);
498 def("B2RESULT", logResult);
499 setattr(logResult, "__doc__", "B2RESULT(message, *args, **kwargs)\n\n"
500 "Print a `RESULT <basf2.LogLevel.RESULT>` message. " + common_doc
501 + "\n\n.. deprecated:: release-01-00-00\n use `B2INFO()` instead");
502
int getDebugLevel() const
Returns the configured debug messaging level.
Definition: LogConfig.h:105
ELogLevel getLogLevel() const
Returns the configured log level.
Definition: LogConfig.h:91
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98
@ c_Error
Error: for things that went wrong and have to be fixed.
Definition: LogConfig.h:30
@ c_Info
Info: for informational messages, e.g.
Definition: LogConfig.h:27
@ c_Debug
Debug: for code development.
Definition: LogConfig.h:26
@ c_Fatal
Fatal: for situations were the program execution can not be continued.
Definition: LogConfig.h:31
@ c_Warning
Warning: for potential problems that the user should pay attention to.
Definition: LogConfig.h:29
@ c_Result
Result: for informational summary messages, e.g.
Definition: LogConfig.h:28
@ c_Default
Default: use globally configured log level.
Definition: LogConfig.h:32
unsigned int getLogInfo(ELogLevel logLevel) const
Returns the configured log information for the given level.
Definition: LogConfig.h:134
ELogLevel getAbortLevel() const
Returns the configured abort level.
Definition: LogConfig.h:119
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112
@ c_Module
Module in which the message was emitted.
Definition: LogConfig.h:38
@ c_File
Source file in which the message was emitted.
Definition: LogConfig.h:41
@ c_Function
Function in which the message was emitted.
Definition: LogConfig.h:40
@ c_Line
Line in source file in which the message was emitted.
Definition: LogConfig.h:42
@ c_Level
Log level of the message.
Definition: LogConfig.h:36
@ c_Package
Package in which the message was emitted.
Definition: LogConfig.h:39
@ c_Message
Log message text.
Definition: LogConfig.h:37
@ c_Timestamp
Time at which the message was emitted.
Definition: LogConfig.h:43
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127
static const char * logLevelToString(ELogLevel logLevelType)
Converts a log level type to a string.
Definition: LogConfig.cc:42
Thin wrapper to expose a usable interface to the logging framework in python.
bool getEscapeNewlinesEnabled() const
Get flag if newlines in log messages to console should be replaced by ' '`.
void setDebugLevel(int level)
Set the debug messaging level.
void setAbortLevel(LogConfig::ELogLevel level)
Set the abort log level.
int getLogInfo(LogConfig::ELogLevel level)
Get the printed log information for the given level.
boost::python::dict getLogStatistics()
return dict with log statistics
void setPackageLogConfig(const std::string &package, const LogConfig &config)
Set LogConfig for a given package.
void addLogFile(const std::string &filename, bool append=false)
Add a file as output connection.
void setPythonLoggingEnabled(bool enabled) const
Set flag if logging should be done via python sys.stdout
LogConfig::ELogLevel getAbortLevel()
Get the abort level.
bool getPythonLoggingEnabled() const
Get flag if logging should be done via python sys.stdout
void enableErrorSummary(bool on)
Enable/Disable error summary.
void setMaxMessageRepetitions(unsigned repetitions)
Set maximum number of repetitions before silencing "identical" log messages.
static boost::python::object logDebug(boost::python::tuple args, const boost::python::dict &kwargs)
Produce debug message.
void addLogConsole()
Add the console as output connection.
void addLogUDP(const std::string &hostname, unsigned short port)
Add a UDP server as an output connection.
void setLogLevel(LogConfig::ELogLevel level)
Set the log level.
int getDebugLevel()
Get the debug level.
void reset()
Reset logging connections.
static boost::python::object logInfo(boost::python::tuple args, const boost::python::dict &kwargs)
Produce info message.
void addLogJSON(bool complete)
Add the console as output connection but print the log messages as json objects so that they can be p...
void setLogInfo(LogConfig::ELogLevel level, int info)
Set the printed log information for the given level.
unsigned getMaxMessageRepetitions() const
Get maximum number of repetitions before silencing "identical" log messages.
void setEscapeNewlinesEnabled(bool enabled) const
Set flag if newlines in log messages to console should be replaced by ' '.
LogConfig & getPackageLogConfig(const std::string &package)
Get the LogConfig for the given package.
void zeroCounters()
Reset logging counters.
static boost::python::object logResult(boost::python::tuple args, const boost::python::dict &kwargs)
Produce result message.
LogConfig::ELogLevel getLogLevel()
Get the log level.

◆ getAbortLevel()

LogConfig::ELogLevel getAbortLevel ( )

Get the abort level.

Returns
The abort level

Definition at line 71 of file LogPythonInterface.cc.

72{
74}
LogConfig * getLogConfig()
Returns global log system configuration.
Definition: LogSystem.h:78

◆ getDebugLevel()

int getDebugLevel ( )

Get the debug level.

Returns
The debug level

Definition at line 76 of file LogPythonInterface.cc.

77{
79}

◆ getEscapeNewlinesEnabled()

bool getEscapeNewlinesEnabled ( ) const

Get flag if newlines in log messages to console should be replaced by '
'`.

Definition at line 151 of file LogPythonInterface.cc.

152{
154}
static bool getEscapeNewlinesEnabled()
Check whether we want to escape newlines on console.

◆ getLogInfo()

int getLogInfo ( LogConfig::ELogLevel  level)

Get the printed log information for the given level.

Parameters
levelThe log level
Returns
The log information that should be printed (see LogConfig::ELogInfo)

Definition at line 81 of file LogPythonInterface.cc.

82{
84}

◆ getLogLevel()

LogConfig::ELogLevel getLogLevel ( )

Get the log level.

Returns
The log level

Definition at line 66 of file LogPythonInterface.cc.

67{
69}

◆ getLogStatistics()

dict getLogStatistics ( )

return dict with log statistics

Return dict containing message counters.

Definition at line 157 of file LogPythonInterface.cc.

158{
159 dict returnDict;
160 const LogSystem& logSys = LogSystem::Instance();
161 for (int iLevel = 0; iLevel < LogConfig::c_Default; ++iLevel) {
162 auto logLevel = static_cast<LogConfig::ELogLevel>(iLevel);
163 returnDict[logLevel] = logSys.getMessageCounter(logLevel);
164 }
165 return returnDict;
166}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
int getMessageCounter(LogConfig::ELogLevel logLevel) const
Returns the number of logging calls per log level.
Definition: LogSystem.cc:161

◆ getMaxMessageRepetitions()

unsigned getMaxMessageRepetitions ( ) const

Get maximum number of repetitions before silencing "identical" log messages.

Identity only checks for log level and message content (excluding variables)

Definition at line 91 of file LogPythonInterface.cc.

92{
94}
unsigned getMaxMessageRepetitions() const
Get maximum number of repetitions before silencing "identical" log messages.
Definition: LogSystem.h:160

◆ getPackageLogConfig()

LogConfig & getPackageLogConfig ( const std::string &  package)

Get the LogConfig for the given package.

Parameters
packageThe package name
Returns
The log configuration object

Definition at line 86 of file LogPythonInterface.cc.

87{
89}
LogConfig & getPackageLogConfig(const std::string &package)
Get the log configuration for the package with the given name.
Definition: LogSystem.h:96

◆ getPythonLoggingEnabled()

bool getPythonLoggingEnabled ( ) const

Get flag if logging should be done via python sys.stdout

Definition at line 141 of file LogPythonInterface.cc.

142{
144}
static bool getPythonLoggingEnabled()
Check whether console logging via python is enabled.

◆ logDebug()

boost::python::object logDebug ( boost::python::tuple  args,
const boost::python::dict &  kwargs 
)
static

Produce debug message.

Parameters
argspositional arguments, concatenated to form message
kwargskeyword arguments to be converted to log variables

Definition at line 577 of file LogPythonInterface.cc.

◆ logError()

boost::python::object logError ( boost::python::tuple  args,
const boost::python::dict &  kwargs 
)
static

Produce error message.

Parameters
argspositional arguments, concatenated to form message
kwargskeyword arguments to be converted to log variables

Definition at line 609 of file LogPythonInterface.cc.

611{
612#ifndef LOG_NO_B2RESULT
613 dispatchMessage(LogConfig::c_Result, std::move(args), kwargs);

◆ logFatal()

boost::python::object logFatal ( boost::python::tuple  args,
const boost::python::dict &  kwargs 
)
static

Produce fatal message.

Parameters
argspositional arguments, concatenated to form message
kwargskeyword arguments to be converted to log variables

Definition at line 615 of file LogPythonInterface.cc.

619{
620#ifndef LOG_NO_B2WARNING

◆ logInfo()

boost::python::object logInfo ( boost::python::tuple  args,
const boost::python::dict &  kwargs 
)
static

Produce info message.

Parameters
argspositional arguments, concatenated to form message
kwargskeyword arguments to be converted to log variables

Definition at line 585 of file LogPythonInterface.cc.

◆ logResult()

boost::python::object logResult ( boost::python::tuple  args,
const boost::python::dict &  kwargs 
)
static

Produce result message.

Parameters
argspositional arguments, concatenated to form message
kwargskeyword arguments to be converted to log variables

Definition at line 593 of file LogPythonInterface.cc.

595{
596#ifndef LOG_NO_B2DEBUG
597 dispatchMessage(LogConfig::c_Debug, std::move(args), kwargs);
598#endif
599 return boost::python::object();

◆ logWarning()

boost::python::object logWarning ( boost::python::tuple  args,
const boost::python::dict &  kwargs 
)
static

Produce warning message.

Parameters
argspositional arguments, concatenated to form message
kwargskeyword arguments to be converted to log variables

Definition at line 601 of file LogPythonInterface.cc.

603{
604#ifndef LOG_NO_B2INFO
605 dispatchMessage(LogConfig::c_Info, std::move(args), kwargs);
606#endif
607 return boost::python::object();

◆ reset()

void reset ( )

Reset logging connections.

Definition at line 121 of file LogPythonInterface.cc.

122{
124}
void resetLogConnections()
Removes all log connections.
Definition: LogSystem.cc:44

◆ setAbortLevel()

void setAbortLevel ( LogConfig::ELogLevel  level)

Set the abort log level.

Parameters
levelThe abort log level

Definition at line 41 of file LogPythonInterface.cc.

◆ setDebugLevel()

void setDebugLevel ( int  level)

Set the debug messaging level.

Parameters
levelThe debug level

Definition at line 46 of file LogPythonInterface.cc.

◆ setEscapeNewlinesEnabled()

void setEscapeNewlinesEnabled ( bool  enabled) const

Set flag if newlines in log messages to console should be replaced by '
'.

Definition at line 146 of file LogPythonInterface.cc.

147{
149}
static void setEscapeNewlinesEnabled(bool enabled)
Set whether we want to escape newlines on console.

◆ setLogInfo()

void setLogInfo ( LogConfig::ELogLevel  level,
int  info 
)

Set the printed log information for the given level.

Parameters
levelThe log level
infoThe log information that should be printed

Definition at line 51 of file LogPythonInterface.cc.

52{
54}

◆ setLogLevel()

void setLogLevel ( LogConfig::ELogLevel  level)

Set the log level.

Parameters
levelThe log level

Definition at line 32 of file LogPythonInterface.cc.

33{
35 if (overrideLevel != LogConfig::c_Default)
36 level = overrideLevel;
37
39}
static Environment & Instance()
Static method to get a reference to the Environment instance.
Definition: Environment.cc:28
int getLogLevelOverride() const
Get log level override.
Definition: Environment.h:238

◆ setMaxMessageRepetitions()

void setMaxMessageRepetitions ( unsigned  repetitions)

Set maximum number of repetitions before silencing "identical" log messages.

Identity only checks for log level and message content (excluding variables)

Definition at line 61 of file LogPythonInterface.cc.

62{
64}
void setMaxMessageRepetitions(unsigned repetitions)
Set maximum number of repetitions before silencing "identical" log messages.
Definition: LogSystem.h:167

◆ setPackageLogConfig()

void setPackageLogConfig ( const std::string &  package,
const LogConfig config 
)

Set LogConfig for a given package.

Parameters
packageThe package name
configThe log configuration object

Definition at line 56 of file LogPythonInterface.cc.

57{
59}
void addPackageLogConfig(const std::string &package, const LogConfig &logConfig)
Add the per package log configuration.
Definition: LogSystem.h:87

◆ setPythonLoggingEnabled()

void setPythonLoggingEnabled ( bool  enabled) const

Set flag if logging should be done via python sys.stdout

Definition at line 136 of file LogPythonInterface.cc.

137{
139}
static void setPythonLoggingEnabled(bool enabled)
Set whether console logging via pyhthon is enabled.

◆ zeroCounters()

void zeroCounters ( )

Reset logging counters.

Definition at line 126 of file LogPythonInterface.cc.

127{
129}
void resetMessageCounter()
Resets the message counter and error log by setting all message counts to 0.
Definition: LogSystem.cc:150

The documentation for this class was generated from the following files: