Add Test Coverage for IPython

docs/source/release_notes.rst

@@ -12,6 +12,7 @@ Release Notes
         * Added DecisionTree estimators to API Reference :pr:`1246`
         * Changed class inheritance display to flow vertically :pr:`1248`
     * Testing Changes
+        * Added tests for ``jupyter_check`` to handle IPython :pr:``
 
 
 **v0.14.1 Sep. 29, 2020**

evalml/tests/utils_tests/test_gen_utils.py

@@ -1,5 +1,5 @@
 import inspect
-from unittest.mock import patch
+from unittest.mock import patch, MagicMock
 
 import numpy as np
 import pytest
@@ -13,7 +13,8 @@
     get_importable_subclasses,
     get_random_seed,
     get_random_state,
-    import_or_raise
+    import_or_raise,
+    jupyter_check
 )
 
 
@@ -214,3 +215,28 @@ def test_check_random_state_equality():
     rs_1.set_state(tuple(['MT19937', np.array([1] * 624), 0, 1, 0.1]))
     rs_2.set_state(tuple(['MT19937', np.array([1] * 624), 1, 1, 0.1]))
     assert not check_random_state_equality(rs_1, rs_2)
+
+
+@patch('evalml.utils.gen_utils.import_or_raise')
+def test_jupyter_check_errors(mock_import_or_raise):
+    mock_import_or_raise.side_effect = ImportError
+    assert not jupyter_check()
+
+    mock_import_or_raise.side_effect = Exception
+    assert not jupyter_check()
+
+
+@patch('evalml.utils.gen_utils.import_or_raise')
+@patch('IPython.core.getipython.get_ipython')
+def test_jupyter_check(mock_ipython, mock_import_or_raise):
+    mock_import_or_raise.return_value = MagicMock()
+    mock_ipython.return_value = True
+    mock_import_or_raise.core.getipython.get_ipython().return_value = True
+    assert jupyter_check()
+
+    mock_ipython.return_value = False
+    mock_import_or_raise.core.getipython.get_ipython().return_value = False
+    assert not jupyter_check()
+    mock_import_or_raise.core.getipython.get_ipython().return_value = None
+    mock_ipython.return_value = None
+    assert not jupyter_check()

evalml/utils/gen_utils.py

@@ -233,9 +233,13 @@ def jupyter_check():
         Boolean: True if Ipython, False otherwise
     """
     try:
-        get_ipython()
-        return True
-    except NameError:
+        ipy = import_or_raise("IPython")
+        if (ipy.core.getipython.get_ipython()):
+            return True
+        return False
+    except ImportError:
+        return False
+    except Exception:
         return False
 
 

requirements.txt

@@ -1,6 +1,7 @@
 -r core-requirements.txt
 plotly>=4.2.1
 ipywidgets>=7.5
+ipython>=7.17.0
 xgboost>=0.82
 catboost>=0.20
 lightgbm>=2.3.1