Skip to content

Commit 8749d96

Browse files
committed
Add convenience function to set up SciJava logging
1 parent dc2051e commit 8749d96

2 files changed

Lines changed: 29 additions & 1 deletion

File tree

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
<groupId>ch.unibas.biozentrum.imcf</groupId>
1313
<artifactId>python-imcflibs</artifactId>
14-
<version>0.4.1-SNAPSHOT</version>
14+
<version>0.5.0-SNAPSHOT</version>
1515

1616
<name>python-imcflibs</name>
1717
<description>

src/imcflibs/imagej/sjlog.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
"""Helper functions to set up the scijava logger from Python."""
2+
3+
import sjlogging # pylint: disable-msg=import-error
4+
from .prefs import debug_mode
5+
6+
7+
def scijava_logger(log_service):
8+
"""Prepare logger and set the level according to stored ImageJ preferences.
9+
10+
Parameters
11+
----------
12+
log_service : org.scijava.log.LogService
13+
The LogService instance, usually retrieved in a SciJava script by using
14+
the script parameters annotation '#@ LogService logs' or equivalent.
15+
16+
Returns
17+
-------
18+
logger : logging.Logger
19+
The Python logger object connected to SciJava's LogService.
20+
"""
21+
logger = sjlogging.setup_logger(log_service)
22+
log_level = "INFO"
23+
if debug_mode():
24+
# issue a message with level "warn" to bring up the console window:
25+
logger.warn("Enabling debug logging.")
26+
log_level = "DEBUG"
27+
sjlogging.set_loglevel(log_level)
28+
return logger

0 commit comments

Comments
 (0)