Merge pull request #304 from NaturalHistoryMuseum/feature/303-delay-load-binaries

Feature/303 delay load binaries

Author: quicklizard99

CHANGELOG.md

@@ -2,6 +2,7 @@ This is an overview of major changes. Refer to the git repository for a full log
 
 Version 0.1.30
 -------------
+- Fixed #303 - Improve startup time
 
 Version 0.1.29
 -------------

build.sh

@@ -7,21 +7,29 @@ VERSION=`python inselect.py --version 2>&1 | sed 's/inselect.py //g'`
 echo Building Inselect $VERSION
 
 echo Clean
+rm -rf cover build dist
 find . -name "*pyc" -print0 | xargs -0 rm -rf
 find . -name __pycache__ -print0 | xargs -0 rm -rf
-rm -rf cover
 
 echo Tests
 nosetests --with-coverage --cover-html --cover-inclusive --cover-erase --cover-tests --cover-package=inselect inselect
 
+echo Report startup time and check for non-essential binary imports
+mkdir build
+time python -v inselect.py --quit &> build/startup_log
+for module in cv2 numpy pydmtx scipy sklearn zbar; do
+    if grep -q $module build/startup_log; then
+        echo Non-essential binary $module imported on startup
+        exit 1
+    fi
+done
+
 echo Source build
-rm -rf dist
 ./setup.py sdist
 mv dist/inselect-$VERSION.tar.gz .
 
 if [[ "$OSTYPE" == "darwin"* ]]; then
     # Clean existing build files
-    rm -rf build dist
     pyinstaller --clean inselect.spec
 
     for script in export_metadata ingest read_barcodes save_crops; do

inselect/app.py

@@ -27,6 +27,8 @@ def main(args):
                         help='Use LOCALE; intended for testing purposes only')
     parser.add_argument('-v', '--version', action='version',
                         version='%(prog)s ' + inselect.__version__)
+    parser.add_argument('-q', '--quit', action='store_true',
+                        help='Exit immediately after showing the main window')
     parsed = parser.parse_args(args[1:])
 
     # TODO LH A command-line switch to clear all QSettings
@@ -63,4 +65,7 @@ def main(args):
     if parsed.file:
         window.open_file(parsed.file)
 
-    sys.exit(app.exec_())
+    if parsed.quit:
+        sys.exit(0)
+    else:
+        sys.exit(app.exec_())

inselect/gui/about.py

@@ -2,21 +2,24 @@
 """
 import platform
 
-import cv2
 import humanize
-import numpy as np
 import psutil
 import PySide
 import PySide.QtCore
 
 from PySide import QtGui
 from PySide.QtGui import QMessageBox
 
+# Warning: lazy load of cv2 and numpy via local imports
+
 
 def _environment():
     """Returns a formatted string containing version numbers of important
     dependencies
     """
+    import cv2
+    import numpy as np
+
     # Bit depth of interpreter
     python_bit_depth = platform.architecture()[0]
     if '32bit' == python_bit_depth:

inselect/gui/plugins/barcode.py

@@ -9,14 +9,9 @@
 from .barcode_dialog import BarcodeDialog
 from .barcode_settings import load_engine
 
-try:
-    from gouda.strategies.roi.roi import roi
-    from gouda.strategies.resize import resize
+import inselect.lib.utils
 
-    import inselect.lib.utils
-    import gouda.util
-except ImportError:
-    roi = resize = None
+# Warning: lazy load of gouda via local imports
 
 
 class BarcodePlugin(Plugin):
@@ -27,7 +22,10 @@ class BarcodePlugin(Plugin):
 
     def __init__(self, document, parent):
         super(BarcodePlugin, self).__init__()
-        if not roi and not resize:
+        try:
+            import gouda.strategies.roi.roi     # noqa
+            import gouda.strategies.resize      # noqa
+        except ImportError:
             raise InselectError('Barcode decoding is not available')
         else:
             self.document = document
@@ -52,6 +50,7 @@ def __call__(self, progress):
 
         engine = load_engine()
 
+        import gouda.util
         gouda.util.DEBUG_PRINT = inselect.lib.utils.DEBUG_PRINT
 
         progress('Loading full-res image')
@@ -75,6 +74,8 @@ def __call__(self, progress):
         debug_print('BarcodePlugin.__call__ exiting. [{0}] boxes'.format(len(items)))
 
     def _decode_barcodes(self, engine, crop, progress):
+        from gouda.strategies.roi.roi import roi
+        from gouda.strategies.resize import resize
         for strategy in (resize, roi):
             # TODO LH Must be able to cancel within call to strategy
             progress()

inselect/gui/plugins/barcode_settings.py

@@ -3,28 +3,37 @@
 from inselect.lib.inselect_error import InselectError
 from inselect.lib.utils import debug_print
 
-try:
-    import gouda
-    from gouda.engines import InliteEngine, LibDMTXEngine, ZbarEngine
-    from gouda.strategies.roi.roi import roi
-    from gouda.strategies.resize import resize
-except ImportError:
-    gouda = InliteEngine = LibDMTXEngine = ZbarEngine = roi = resize = None
+# Warning: lazy load of gouda via local imports
 
 
 def inlite_available():
     "Returns True if the Inlite engine is available"
-    return InliteEngine is not None and InliteEngine.available()
+    try:
+        from gouda.engines import InliteEngine
+    except ImportError:
+        return False
+    else:
+        return InliteEngine.available()
 
 
 def libdmtx_available():
     "Returns True if the libdmtx engine is available"
-    return LibDMTXEngine is not None and LibDMTXEngine.available()
+    try:
+        from gouda.engines import LibDMTXEngine
+    except ImportError:
+        return False
+    else:
+        return LibDMTXEngine.available()
 
 
 def zbar_available():
     "Returns True if the zbar engine is available"
-    return ZbarEngine is not None and ZbarEngine.available()
+    try:
+        from gouda.engines import ZbarEngine
+    except ImportError:
+        return False
+    else:
+        return ZbarEngine.available()
 
 
 def current_settings():
@@ -57,7 +66,11 @@ def update_settings(new_settings):
 def load_engine():
     """Returns an instance of the user's choice of barcode reading engine
     """
-    if gouda:
+    try:
+        from gouda.engines import InliteEngine, LibDMTXEngine, ZbarEngine
+    except ImportError:
+        raise InselectError('Barcode decoding is not available')
+    else:
         settings = current_settings()
         engine = settings['engine']
         if 'libdmtx' == engine:
@@ -68,5 +81,3 @@ def load_engine():
             return InliteEngine(settings['inlite-format'])
         else:
             raise ValueError('Unrecognised barcode reader [{0}]'.format(engine))
-    else:
-        raise InselectError('Barcode decoding is not available')

inselect/gui/utils.py

@@ -5,18 +5,20 @@
 from io import BytesIO
 from itertools import groupby
 
-import cv2
-import numpy as np
-
 from PySide.QtGui import (QImage, QItemSelection, QItemSelectionModel,
                           QMessageBox, QWidget)
 
 from copy_box import copy_details_box
 
+# Warning: lazy load of cv2 and numpy via local imports
+
 
 def qimage_of_bgr(bgr):
     """ A QImage representation of a BGR numpy array
     """
+    import cv2
+    import numpy as np
+
     bgr = cv2.cvtColor(bgr.astype('uint8'), cv2.COLOR_BGR2RGB)
     bgr = np.ascontiguousarray(bgr)
     qt_image = QImage(bgr.data,

inselect/lib/document.py

@@ -7,13 +7,13 @@
 from itertools import chain
 from pathlib import Path
 
-import cv2
-
 from .image import InselectImage
 from .inselect_error import InselectError
 from .utils import debug_print, user_name
 from .rect import Rect
 
+# Warning: lazy load of cv2 via local imports
+
 
 class InselectDocument(object):
     """An Inselect document.
@@ -309,6 +309,9 @@ def save_crops_from_image(self, image, crop_paths, progress=None):
 
     def _create_and_load_thumbnail(self, width):
         "Create thumbnail image"
+        # TODO LH Delegate job of creating thumbnail to InselectImage class
+        import cv2
+
         p = self.thumbnail_path_of_scanned(self._scanned.path)
 
         msg = u'Creating [{0}] with width of [{1}] pixels'

inselect/lib/image.py

@@ -3,15 +3,14 @@
 from itertools import izip, count, chain, repeat
 from pathlib import Path
 
-import cv2
-import numpy as np
-
 from PIL import Image
 
 from inselect.lib.inselect_error import InselectError
 from inselect.lib.utils import debug_print
 from inselect.lib.rect import Rect
 
+# Warning: lazy load of cv2 and numpy via local imports
+
 
 class InselectImage(object):
     """Simple representation of an inselect image
@@ -54,6 +53,7 @@ def array(self):
         """Lazy-load np.array of the colour image array, with channels stored in
         order B G R
         """
+        import cv2
         if self._array is None:
             self.assert_is_file()
             p = str(self._path)
@@ -86,6 +86,8 @@ def crops(self, normalised, rotation=None):
         Rotation should be None, an int or an iterable. If not None, crops will
         be rotated by that many clockwise degrees.
         """
+        import cv2
+        import numpy as np
 
         if not rotation:
             rotation = repeat(0)
@@ -139,6 +141,7 @@ def save_crops(self, normalised, paths, rotation=None, progress=None):
         """
         # TODO Copy EXIF tags?
         # TODO Make read-only?
+        import cv2
         self.assert_is_file()
         for index, crop, path in izip(count(), self.crops(normalised, rotation), paths):
             if progress:

inselect/lib/segment.py

@@ -1,11 +1,10 @@
 from random import randint
 
-import cv2
-
-import numpy as np
-
 from .utils import debug_print
 
+# Warning: lazy load of cv2 and numpy via local imports
+
+# TODO LH Decide on use of skimage's watershed
 # Breaks pyinstaller build
 # from skimage.morphology import watershed
 USE_OPENCV_WATERSHED = True
@@ -31,6 +30,8 @@ def _right_sized(contour, image, container_filter=True, size_filter=True):
     result : boolean
         Object is of correct sizing.
     """
+    import cv2
+
     image_size = image.shape
     x, y, w, h = cv2.boundingRect(contour)
     area = image_size[0] * image_size[1]
@@ -80,6 +81,8 @@ def _process_contours(image, contours, hierarchy, callback, index=0,
     size_filter : boolean
         Filters large objects.
     """
+    import cv2
+
     result = []
     while index >= 0:
         callback()
@@ -101,6 +104,8 @@ def _process_contours(image, contours, hierarchy, callback, index=0,
 # alternate process, may be useful if we abandon hierarchical contours later
 def _process_contours_iterate(image, contours, hierarchy, index=0,
                               size_filter=True):
+    import cv2
+
     result = []
     for contour in contours:
         if right_sized(contour, image.shape, size_filter=size_filter):
@@ -124,6 +129,9 @@ def remove_lines(image):
     mask : (M, N) array
         Mask of image without lines.
     """
+    import cv2
+    import numpy as np
+
     gray = cv2.cvtColor(image, cv2.cv.CV_BGR2GRAY)
     v_edges = cv2.Sobel(gray, cv2.CV_32F, 1, 0, None, 1)
     h_edges = cv2.Sobel(gray, cv2.CV_32F, 0, 1, None, 1)
@@ -184,6 +192,9 @@ def segment_edges(image, window=None, threshold=12, lab_based=True,
     (rects, display) : list, (M, N, 3) array
         Region results and visualization image.
     """
+    import cv2
+    import numpy as np
+
     if not callback:
         def swallow(*args, **kwargs):
             pass
@@ -291,6 +302,9 @@ def swallow(*args, **kwargs):
 
 
 def segment_intensity(image, window=None):
+    import cv2
+    import numpy as np
+
     if window:
         subimage = np.array(image)
         x, y, w, h = window
@@ -334,6 +348,9 @@ def segment_grabcut(image, window=None, seeds=[]):
     (rects, display) : list, (M, N, 3) array
         Region results and visualization image.
     """
+    import cv2
+    import numpy as np
+
     if window:
         subimage = np.array(image)
         x, y, w, h = window
@@ -419,6 +436,9 @@ def segment_watershed(image, window=None):
     (rects, display) : list, (M, N, 3) array
         Region results and visualization image.
     """
+    import cv2
+    import numpy as np
+
     if window:
         subimage = np.array(image)
         x, y, w, h = window
@@ -458,6 +478,9 @@ def segment_watershed(image, window=None):
 
 
 if __name__ == "__main__":
+    import cv2
+    import numpy as np
+
     image = cv2.imread("../../data/drawer.jpg")
     scaled = 1.0
     image = cv2.resize(image, (int(image.shape[1] * scaled),