ocrolib: avoid print/stderr.write in favor of logging

Author: Robert Sachunsky

ocrd_cis/ocropy/ocrolib/common.py

@@ -24,7 +24,7 @@
 
 from . import default
 from .default import getlocal
-from .toplevel import (checks, ABINARY2, AINT2, AINT3, BOOL, DARKSEG, GRAYSCALE,
+from .toplevel import (checks, LOG, ABINARY2, AINT2, AINT3, BOOL, DARKSEG, GRAYSCALE,
                       LIGHTSEG, LINESEG, PAGESEG)
 from . import chars
 from . import ligatures
@@ -35,7 +35,6 @@
 
 pickle_mode = 2
 
-
 ################################################################
 # text normalization
 ################################################################
@@ -187,7 +186,8 @@ def write_image_gray(fname,image,normalize=0,verbose=0):
     type, its values are clipped to the range [0,1],
     multiplied by 255 and converted to unsigned bytes.  Otherwise,
     the image must be of type unsigned byte."""
-    if verbose: print("# writing", fname)
+    if verbose:
+        LOG.info("# writing '%s'", fname)
     if isfloatarray(image):
         image = array(255*clip(image,0.0,1.0),'B')
     assert image.dtype==dtype('B'),"array has wrong dtype: %s"%image.dtype
@@ -210,7 +210,8 @@ def write_image_binary(fname,image,verbose=0):
     """Write a binary image to disk. This verifies first that the given image
     is, in fact, binary.  The image may be of any type, but must consist of only
     two values."""
-    if verbose: print("# writing", fname)
+    if verbose:
+        LOG.info("# writing '%s'", fname)
     assert image.ndim==2
     image = array(255*(image>midrange(image)),'B')
     im = array2pil(image)
@@ -440,8 +441,8 @@ def load_object(fname,zip=0,nofind=0,verbose=0):
     class names that have changed."""
     if not nofind:
         fname = ocropus_find_file(fname)
-    #if verbose:
-    #    print("# loading object", fname)
+    if verbose:
+        LOG.info("# loading object '%s'", fname)
     if zip==0 and fname.endswith(".gz"):
         zip = 1
     if zip>0:
@@ -720,16 +721,12 @@ def caller():
 
 def die(message,*args):
     """Die with an error message."""
-    message = message%args
-    message = caller()+" FATAL "+message+"\n"
-    sys.stderr.write(message)
+    LOG.critical(caller() + ' ' + message, args)
     sys.exit(1)
 
 def warn(message,*args):
     """Give a warning message."""
-    message = message%args
-    message = caller()+" WARNING "+message+"\n"
-    sys.stderr.write(message)
+    LOG.warning(caller() + ' ' + message, args)
 
 already_warned = {}
 
@@ -738,9 +735,7 @@ def warn_once(message,*args):
     c = caller()
     if c in already_warned: return
     already_warned[c] = 1
-    message = message%args
-    message = c+" WARNING "+message+"\n"
-    sys.stderr.write(message)
+    LOG.warning(c + ' ' + message, args)
 
 def quick_check_page_components(page_bin,dpi):
     """Quickly check whether the components of page_bin are

ocrd_cis/ocropy/ocrolib/lineest.py

@@ -20,7 +20,6 @@ def __init__(self,target_height=48,params=(4,1.0,0.3)):
         self.debug = int(os.getenv("debug_center") or "0")
         self.target_height = target_height
         self.range,self.smoothness,self.extra = params
-        print("# CenterNormalizer")
     def setHeight(self,target_height):
         self.target_height = target_height
     def check(self,line, max_ignore=0.02):

ocrd_cis/ocropy/ocrolib/lstm.py

@@ -33,16 +33,13 @@
 from scipy.ndimage import measurements,filters
 
 from . import common as ocrolib
+from .toplevel import LOG
 from .exceptions import RecognitionError
 from .edist import levenshtein
 from . import utils
 
 initial_range = 0.1
 
-class RangeError(Exception):
-    def __init__(self,s=None):
-        Exception.__init__(self,s)
-
 def prepare_line(line,pad=16):
     """Prepare a line for recognition; this inverts it, transposes
     it, and pads it."""
@@ -216,7 +213,7 @@ def update(self):
             ds.ravel()[:] = self.momentum * ds.ravel()[:] + self.learning_rate * dw.ravel()[:]
             w.ravel()[:] += ds.ravel()[:]
             if self.verbose:
-                print(n, (np.amin(w), np.amax(w)), (np.amin(dw), np.amax(dw)))
+                LOG.info("{} {} {}".format(n, (np.amin(w), np.amax(w)), (np.amin(dw), np.amax(dw))))
 
     def forward(self,xs):
         """Propagate activations forward through the network.
@@ -270,7 +267,7 @@ def info(self):
         vars = sorted("W2".split())
         for v in vars:
             a = np.array(getattr(self,v))
-            print(v, a.shape, np.amin(a), np.amax(a))
+            LOG.info("{} {} {} {}".format(v, a.shape, np.amin(a), np.amax(a)))
     def weights(self):
         yield self.W2,self.DW2,"Logreg"
 
@@ -314,7 +311,7 @@ def info(self):
         vars = sorted("W2".split())
         for v in vars:
             a = np.array(getattr(self,v))
-            print(v, a.shape, np.amin(a), np.amax(a))
+            LOG.info("{} {} {} {}".format(v, a.shape, np.amin(a), np.amax(a)))
     def weights(self):
         yield self.W2,self.DW2,"Softmax"
 
@@ -504,7 +501,7 @@ def info(self):
         vars = sorted(vars)
         for v in vars:
             a = np.array(getattr(self,v))
-            print(v, a.shape, np.amin(a), np.amax(a))
+            LOG.info("{} {} {} {}".format(v, a.shape, np.amin(a), np.amax(a)))
     def preSave(self):
         self.max_n = max(500,len(self.ci))
         self.allocate(1)
@@ -719,7 +716,7 @@ def make_target(cs,nc):
             result[2*i+1,j] = 1.0
         result[-1,0] = 1.0
     except(IndexError):
-        print('\n!!! Uuups, something went wrong !!!\nDid you import a model that was trained on less characters then needed for this operation?')
+        LOG.critical('Cannot index target class. Did you load a model that was trained on less characters then needed for this operation?')
         sys.exit(1)
     return result
 

ocrd_cis/ocropy/ocrolib/psegutils.py

@@ -227,5 +227,6 @@ def rgbshow(r,g,b=None,gn=1,cn=0,ab=0,**kw):
         combo /= max(np.abs(np.amin(combo)),np.abs(np.amax(combo)))
     if ab:
         combo = np.abs(combo)
-    if np.amin(combo)<0: print("warning: values less than zero")
+    if np.amin(combo)<0:
+        LOG.warning("RGB values less than zero")
     plt.imshow(np.clip(combo,0,1),**kw)

ocrd_cis/ocropy/ocrolib/toplevel.py

@@ -4,10 +4,13 @@
 import os
 import sys
 import warnings
+import logging
 
 import numpy as np
 from functools import (reduce, wraps)
 
+LOG = logging.getLogger('ocrolib')
+
 ### printing
 
 def strc(arg,n=10):
@@ -54,15 +57,15 @@ def wrapper(*args,**kw):
         try:
             global _trace1_depth
             _trace1_depth += 1
-            print(" " * _trace1_depth, "ENTER", name, ":", end=' ')
+            message = " " * _trace1_depth + " ENTER %s: " % name
             for k,v in list(zip(argnames,args))+list(kw.items()):
-                print("%s=%s" % (k, strc(v)), end=' ')
-            print()
+                message += "%s=%s " % (k, strc(v))
+            LOG.debug(message)
             result = f(*args,**kw)
-            print(" " * _trace1_depth, "LEAVE", name, ":", strc(result))
+            LOG.debug(" " * _trace1_depth + " LEAVE %s: %s", name, strc(result))
             return result
         except Exception as e:
-            print(" " * _trace1_depth, "ERROR", name, ":", e)
+            LOG.debug(" " * _trace1_depth + " ERROR %s: ", name, exc_info=e)
             raise
         finally:
             _trace1_depth -= 1
@@ -78,13 +81,16 @@ def localtrace(frame, why, arg):
             fname = frame.f_code.co_filename
             lineno = frame.f_lineno
             base = os.path.basename(fname)
-            print("%s(%s): %s" % (base, lineno,
-                                  linecache.getline(fname, lineno)))
+            LOG.debug("%s(%s): %s", base, lineno,
+                      linecache.getline(fname, lineno))
         return localtrace
     @wraps(f)
     def wrapper(*args,**kw):
         sys.settrace(globaltrace)
+        level = LOG.level
+        LOG.setLevel('DEBUG')
         result = f(*args,**kw)
+        LOG.setLevel(level)
         sys.settrace(None)
         return result
     return wrapper
@@ -205,7 +211,7 @@ def argument_checks(*args,**kw):
                     e.var = var
                     raise e
                 except:
-                    print("unknown exception while checking function:", name)
+                    LOG.critical("unknown exception while checking function: '%s'", name)
                     raise
             result = f(*args,**kw)
             checktype(result,kw.get("_",True))