Merge pull request numpy#11169 from pv/import-sanitycheck

charris · web-flow · commit 331106f57305 · 2018-05-27T12:36:57.000-06:00
MAINT: add sanity-checks to be run at import time
diff --git a/numpy/__init__.py b/numpy/__init__.py
@@ -194,3 +194,28 @@ def pkgload(*packages, **options):
     from numpy.testing._private.pytesttester import PytestTester
     test = PytestTester(__name__)
     del PytestTester
+
+
+    def _sanity_check():
+        """
+        Quick sanity checks for common bugs caused by environment.
+        There are some cases e.g. with wrong BLAS ABI that cause wrong
+        results under specific runtime conditions that are not necessarily
+        achieved during test suite runs, and it is useful to catch those early.
+
+        See https://github.com/numpy/numpy/issues/8577 and other
+        similar bug reports.
+
+        """
+        try:
+            x = ones(2, dtype=float32)
+            if not abs(x.dot(x) - 2.0) < 1e-5:
+                raise AssertionError()
+        except AssertionError:
+            msg = ("The current Numpy installation ({!r}) fails to "
+                   "pass simple sanity checks. This can be caused for example "
+                   "by incorrect BLAS library being linked in.")
+            raise RuntimeError(msg.format(__file__))
+
+    _sanity_check()
+    del _sanity_check
