Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst.log.log.logContinued Namespace Reference

Classes

class  LevelTranslator
 
class  Log
 
class  LogHandler
 
class  MDCDict
 
class  UsePythonLogging
 

Functions

 configure (*args)
 
 configure_prop (properties)
 
 configure_pylog_MDC (str level, Optional[type] MDC_class=MDCDict)
 
 getDefaultLogger ()
 
 getLogger (loggername)
 
 MDC (key, value)
 
 MDCRemove (key)
 
 MDCRegisterInit (func)
 
 setLevel (loggername, level)
 
 getLevel (loggername)
 
 getEffectiveLevel (loggername)
 
 isEnabledFor (loggername, level)
 
 log (loggername, level, fmt, *args, **kwargs)
 
 trace (fmt, *args)
 
 debug (fmt, *args)
 
 info (fmt, *args)
 
 warn (fmt, *args)
 
 warning (fmt, *args)
 
 error (fmt, *args)
 
 fatal (fmt, *args)
 
 critical (fmt, *args)
 
 lwpID ()
 
 getLevelName (level)
 
 usePythonLogging ()
 
 doNotUsePythonLogging ()
 

Variables

int TRACE = 5000
 
int DEBUG = 10000
 
int INFO = 20000
 
int WARN = 30000
 
int ERROR = 40000
 
int FATAL = 50000
 
int CRITICAL = FATAL
 
int WARNING = WARN
 

Function Documentation

◆ configure()

lsst.log.log.logContinued.configure ( * args)

Definition at line 204 of file logContinued.py.

204def configure(*args):
205 Log.configure(*args)
206
207

◆ configure_prop()

lsst.log.log.logContinued.configure_prop ( properties)

Definition at line 208 of file logContinued.py.

208def configure_prop(properties):
209 Log.configure_prop(properties)
210
211

◆ configure_pylog_MDC()

lsst.log.log.logContinued.configure_pylog_MDC ( str level,
Optional[type] MDC_class = MDCDict )
Configure log4cxx to send messages to Python logging, with MDC support.

Parameters
----------
level : `str`
    Name of the logging level for root log4cxx logger.
MDC_class : `type`, optional
    Type of dictionary which is added to `logging.LogRecord` as an ``MDC``
    attribute. Any dictionary or ``defaultdict``-like class can be used as
    a type. If `None` the `logging.LogRecord` will not be augmented.

Notes
-----
This method does two things:

- Configures log4cxx with a given logging level and a ``PyLogAppender``
  appender class which forwards all messages to Python `logging`.
- Installs a record factory for Python `logging` that adds ``MDC``
  attribute to every `logging.LogRecord` object (instance of
  ``MDC_class``). This will happen by default but can be disabled
  by setting the ``MDC_class`` parameter to `None`.

Definition at line 212 of file logContinued.py.

212def configure_pylog_MDC(level: str, MDC_class: Optional[type] = MDCDict):
213 """Configure log4cxx to send messages to Python logging, with MDC support.
214
215 Parameters
216 ----------
217 level : `str`
218 Name of the logging level for root log4cxx logger.
219 MDC_class : `type`, optional
220 Type of dictionary which is added to `logging.LogRecord` as an ``MDC``
221 attribute. Any dictionary or ``defaultdict``-like class can be used as
222 a type. If `None` the `logging.LogRecord` will not be augmented.
223
224 Notes
225 -----
226 This method does two things:
227
228 - Configures log4cxx with a given logging level and a ``PyLogAppender``
229 appender class which forwards all messages to Python `logging`.
230 - Installs a record factory for Python `logging` that adds ``MDC``
231 attribute to every `logging.LogRecord` object (instance of
232 ``MDC_class``). This will happen by default but can be disabled
233 by setting the ``MDC_class`` parameter to `None`.
234 """
235 if MDC_class is not None:
236 old_factory = logging.getLogRecordFactory()
237
238 def record_factory(*args, **kwargs):
239 record = old_factory(*args, **kwargs)
240 record.MDC = MDC_class()
241 return record
242
243 logging.setLogRecordFactory(record_factory)
244
245 properties = f"""\
246log4j.rootLogger = {level}, PyLog
247log4j.appender.PyLog = PyLogAppender
248"""
249 configure_prop(properties)
250
251

◆ critical()

lsst.log.log.logContinued.critical ( fmt,
* args )

Definition at line 323 of file logContinued.py.

323def critical(fmt, *args):
324 fatal(fmt, *args)
325
326

◆ debug()

lsst.log.log.logContinued.debug ( fmt,
* args )

Definition at line 299 of file logContinued.py.

299def debug(fmt, *args):
300 Log.getDefaultLogger()._log(DEBUG, False, fmt, *args)
301
302

◆ doNotUsePythonLogging()

lsst.log.log.logContinued.doNotUsePythonLogging ( )

Definition at line 352 of file logContinued.py.

352def doNotUsePythonLogging():
353 Log.doNotUsePythonLogging()
354
355

◆ error()

lsst.log.log.logContinued.error ( fmt,
* args )

Definition at line 315 of file logContinued.py.

315def error(fmt, *args):
316 Log.getDefaultLogger()._log(ERROR, False, fmt, *args)
317
318

◆ fatal()

lsst.log.log.logContinued.fatal ( fmt,
* args )

Definition at line 319 of file logContinued.py.

319def fatal(fmt, *args):
320 Log.getDefaultLogger()._log(FATAL, False, fmt, *args)
321
322

◆ getDefaultLogger()

lsst.log.log.logContinued.getDefaultLogger ( )

Definition at line 252 of file logContinued.py.

252def getDefaultLogger():
253 return Log.getDefaultLogger()
254
255

◆ getEffectiveLevel()

lsst.log.log.logContinued.getEffectiveLevel ( loggername)

Definition at line 280 of file logContinued.py.

280def getEffectiveLevel(loggername):
281 return Log.getLogger(loggername).getEffectiveLevel()
282
283

◆ getLevel()

lsst.log.log.logContinued.getLevel ( loggername)

Definition at line 276 of file logContinued.py.

276def getLevel(loggername):
277 return Log.getLogger(loggername).getLevel()
278
279

◆ getLevelName()

lsst.log.log.logContinued.getLevelName ( level)
Return the name associated with this logging level.

Returns "Level %d" if no name can be found.

Definition at line 331 of file logContinued.py.

331def getLevelName(level):
332 """Return the name associated with this logging level.
333
334 Returns "Level %d" if no name can be found.
335 """
336 names = ("DEBUG", "TRACE", "WARNING", "FATAL", "INFO", "ERROR")
337 for name in names:
338 test_level = getattr(Log, name)
339 if test_level == level:
340 return name
341 return f"Level {level}"
342
343
344# This will cause a warning in Sphinx documentation due to confusion between
345# UsePythonLogging and usePythonLogging.
346# https://github.com/astropy/sphinx-automodapi/issues/73 (but note that this
347# does not seem to be Mac-only).

◆ getLogger()

lsst.log.log.logContinued.getLogger ( loggername)

Definition at line 256 of file logContinued.py.

256def getLogger(loggername):
257 return Log.getLogger(loggername)
258
259

◆ info()

lsst.log.log.logContinued.info ( fmt,
* args )

Definition at line 303 of file logContinued.py.

303def info(fmt, *args):
304 Log.getDefaultLogger()._log(INFO, False, fmt, *args)
305
306

◆ isEnabledFor()

lsst.log.log.logContinued.isEnabledFor ( loggername,
level )

Definition at line 284 of file logContinued.py.

284def isEnabledFor(loggername, level):
285 return Log.getLogger(loggername).isEnabledFor(level)
286
287
288# This will cause a warning in Sphinx documentation due to confusion between
289# Log and log. https://github.com/astropy/sphinx-automodapi/issues/73 (but
290# note that this does not seem to be Mac-only).

◆ log()

lsst.log.log.logContinued.log ( loggername,
level,
fmt,
* args,
** kwargs )

Definition at line 291 of file logContinued.py.

291def log(loggername, level, fmt, *args, **kwargs):
292 Log.getLogger(loggername)._log(level, False, fmt, *args)
293
294

◆ lwpID()

lsst.log.log.logContinued.lwpID ( )

Definition at line 327 of file logContinued.py.

327def lwpID():
328 return Log.lwpID
329
330

◆ MDC()

lsst.log.log.logContinued.MDC ( key,
value )

Definition at line 260 of file logContinued.py.

260def MDC(key, value):
261 return Log.MDC(key, str(value))
262
263

◆ MDCRegisterInit()

lsst.log.log.logContinued.MDCRegisterInit ( func)

Definition at line 268 of file logContinued.py.

268def MDCRegisterInit(func):
269 Log.MDCRegisterInit(func)
270
271

◆ MDCRemove()

lsst.log.log.logContinued.MDCRemove ( key)

Definition at line 264 of file logContinued.py.

264def MDCRemove(key):
265 Log.MDCRemove(key)
266
267

◆ setLevel()

lsst.log.log.logContinued.setLevel ( loggername,
level )

Definition at line 272 of file logContinued.py.

272def setLevel(loggername, level):
273 Log.getLogger(loggername).setLevel(level)
274
275

◆ trace()

lsst.log.log.logContinued.trace ( fmt,
* args )

Definition at line 295 of file logContinued.py.

295def trace(fmt, *args):
296 Log.getDefaultLogger()._log(TRACE, False, fmt, *args)
297
298

◆ usePythonLogging()

lsst.log.log.logContinued.usePythonLogging ( )

Definition at line 348 of file logContinued.py.

348def usePythonLogging():
349 Log.usePythonLogging()
350
351

◆ warn()

lsst.log.log.logContinued.warn ( fmt,
* args )

Definition at line 307 of file logContinued.py.

307def warn(fmt, *args):
308 Log.getDefaultLogger()._log(WARN, False, fmt, *args)
309
310

◆ warning()

lsst.log.log.logContinued.warning ( fmt,
* args )

Definition at line 311 of file logContinued.py.

311def warning(fmt, *args):
312 warn(fmt, *args)
313
314

Variable Documentation

◆ CRITICAL

int lsst.log.log.logContinued.CRITICAL = FATAL

Definition at line 51 of file logContinued.py.

◆ DEBUG

int lsst.log.log.logContinued.DEBUG = 10000

Definition at line 44 of file logContinued.py.

◆ ERROR

int lsst.log.log.logContinued.ERROR = 40000

Definition at line 47 of file logContinued.py.

◆ FATAL

int lsst.log.log.logContinued.FATAL = 50000

Definition at line 48 of file logContinued.py.

◆ INFO

int lsst.log.log.logContinued.INFO = 20000

Definition at line 45 of file logContinued.py.

◆ TRACE

int lsst.log.log.logContinued.TRACE = 5000

Definition at line 43 of file logContinued.py.

◆ WARN

int lsst.log.log.logContinued.WARN = 30000

Definition at line 46 of file logContinued.py.

◆ WARNING

int lsst.log.log.logContinued.WARNING = WARN

Definition at line 52 of file logContinued.py.