LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
log.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2008-2016 AURA/LSST.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <https://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#include "pybind11/pybind11.h"
24
25#include "lsst/log/Log.h"
26
27namespace py = pybind11;
28
29namespace lsst {
30namespace log {
31
32// Wrapper for Python callable object to make sure that we have GIL
33// when we call Python. Note that we are leaking Python callable,
34// as C++ callables may be (and actually are in our particular case)
35// outliving Python interpreter and attempt to delete Python object
36// will result in crash.
37//
38// See DM-9708
40public:
41 callable_wrapper(PyObject* callable) : _callable(callable) { Py_XINCREF(_callable); }
42 void operator()() {
43 // make sure we own GIL before doing Python call
44 auto state = PyGILState_Ensure();
45 PyObject_CallObject(_callable, nullptr);
46 PyGILState_Release(state);
47 }
48
49private:
50 PyObject* _callable;
51};
52
54 py::class_<Log> cls(mod, "Log");
55
56 /* Constructors */
57 cls.def(py::init<>());
58
59 /* Members */
60 cls.attr("TRACE") = py::int_(5000);
61 cls.attr("DEBUG") = py::int_(10000);
62 cls.attr("INFO") = py::int_(20000);
63 cls.attr("WARN") = py::int_(30000);
64 cls.attr("ERROR") = py::int_(40000);
65 cls.attr("FATAL") = py::int_(50000);
66
67 cls.def("isDebugEnabled", &Log::isDebugEnabled);
68 cls.def("isErrorEnabled", &Log::isErrorEnabled);
69 cls.def("isFatalEnabled", &Log::isFatalEnabled);
70 cls.def("isInfoEnabled", &Log::isInfoEnabled);
71 cls.def("isTraceEnabled", &Log::isTraceEnabled);
72 cls.def("isWarnEnabled", &Log::isWarnEnabled);
73 cls.def("getName", &Log::getName);
74 cls.def("setLevel", &Log::setLevel);
75 cls.def("getLevel", &Log::getLevel);
76 cls.def("getEffectiveLevel", &Log::getEffectiveLevel);
77 cls.def("isEnabledFor", &Log::isEnabledFor);
78 cls.def("getChild", &Log::getChild);
79 cls.def("logMsg", [](Log& log, int level, std::string const& filename, std::string const& funcname,
80 unsigned int lineno, std::string const& msg) {
81 log.logMsg(log4cxx::Level::toLevel(level),
82 log4cxx::spi::LocationInfo(filename.c_str(), funcname.c_str(), lineno), msg.c_str());
83 });
84 cls.def("lwpID", [](Log const& log) -> unsigned { return lsst::log::lwpID(); });
85
86 cls.def_static("getDefaultLogger", Log::getDefaultLogger);
87 cls.def_static("configure", (void (*)())Log::configure);
88 cls.def_static("configure", (void (*)(std::string const&))Log::configure);
89 cls.def_static("configure_prop", Log::configure_prop);
90 cls.def_static("getLogger", (Log(*)(Log const&))Log::getLogger);
91 cls.def_static("getLogger", (Log(*)(std::string const&))Log::getLogger);
92 cls.def_static("MDC", Log::MDC);
93 cls.def_static("MDCRemove", Log::MDCRemove);
94 cls.def_static("MDCRegisterInit", [](py::function func) {
95 auto handle = func.release(); // will leak as described in callable_wrapper
97 });
98}
99
100} // log
101} // lsst
LSST DM logging module built on log4cxx.
T c_str(T... args)
This static class includes a variety of methods for interacting with the the logging module.
Definition: Log.h:724
bool isErrorEnabled() const
Check whether the logger is enabled for the ERROR Level.
Definition: Log.h:739
static Log getDefaultLogger()
Return default logger instance, same as default constructor.
Definition: Log.h:766
static Log getLogger(Log const &logger)
Definition: Log.h:772
static void MDCRemove(std::string const &key)
Remove the value associated with KEY within the MDC.
Definition: Log.cc:288
int getLevel() const
Retrieve the logging threshold.
Definition: Log.cc:318
bool isEnabledFor(int level) const
Return whether the logging threshold of the logger is less than or equal to LEVEL.
Definition: Log.cc:345
bool isTraceEnabled() const
Check whether the logger is enabled for the TRACE Level.
Definition: Log.h:751
Log getChild(std::string const &suffix) const
Return a logger which is a descendant to this logger.
Definition: Log.cc:366
static void configure_prop(std::string const &properties)
Configures log4cxx using a string containing the list of properties, equivalent to configuring from a...
Definition: Log.cc:220
bool isInfoEnabled() const
Check whether the logger is enabled for the INFO Level.
Definition: Log.h:747
void setLevel(int level)
Set the logging threshold to LEVEL.
Definition: Log.cc:311
bool isWarnEnabled() const
Check whether the logger is enabled for the WARN Level.
Definition: Log.h:755
bool isDebugEnabled() const
Check whether the logger is enabled for the DEBUG Level.
Definition: Log.h:735
bool isFatalEnabled() const
Check whether the logger is enabled for the FATAL Level.
Definition: Log.h:743
static void configure()
Explicitly configures log4cxx and initializes logging system.
Definition: Log.cc:177
static std::string MDC(std::string const &key, std::string const &value)
Places a KEY/VALUE pair in the Mapped Diagnostic Context (MDC) for the current thread.
Definition: Log.cc:274
static int MDCRegisterInit(std::function< void()> function)
Definition: Log.cc:292
std::string getName() const
Get the logger name associated with the Log object.
Definition: Log.cc:240
int getEffectiveLevel() const
Retrieve the effective logging threshold.
Definition: Log.cc:330
callable_wrapper(PyObject *callable)
Definition: log.cc:41
PYBIND11_MODULE(log, mod)
Definition: log.cc:53
unsigned lwpID()
Function which returns LWP ID on platforms which support it.
Definition: Log.cc:425
A base class for image defects.