Move some code core.py to new modules

Author: tkf

src/replhelper/__init__.py

@@ -1 +1,2 @@
-from .core import customized_ipython, ipython_options, revise
+from .entrypoints import customized_ipython, ipython_options
+from .core import revise

src/replhelper/convenience.py

@@ -0,0 +1,116 @@
+import functools
+import sys
+import warnings
+
+
+instruction_template = """
+
+Python package "{package}" cannot be imported from Python interpreter
+{python}.
+{additional_message}
+Use your favorite method to install "{need_install}" or run the following
+command in Julia (which *tries* to the right thing):
+
+    IPython.install_dependency("{need_install}")
+
+It prints the installation command to be executed and prompts your
+input (yes/no) before really executing it.
+"""
+
+ipython_dependency_missing = """
+IPython (version: {IPython.__version__}) is importable but {dependency}
+cannot be imported.  It is very strange and I'm not sure what is the
+best instruction here.  Updating IPython could help.
+"""
+
+
+def make_instruction(package, need_install=None, **kwargs):
+    return instruction_template.format(**dict(dict(
+        package=package,
+        need_install=need_install or package.lower(),
+        python=sys.executable,
+        additional_message='',
+    ), **kwargs))
+
+
+def make_dependency_missing_instruction(IPython, dependency):
+    return make_instruction(
+        dependency,
+        need_install='ipython',
+        additional_message=ipython_dependency_missing.format(
+            IPython=IPython,
+            dependency=dependency,
+        ))
+
+
+def package_name(err):
+    try:
+        return err.name
+    except AttributeError:
+        # Python 2 support:
+        prefix = 'No module named '
+        message = str(err)
+        if message.startswith(prefix):
+            return message[len(prefix):].rstrip()
+    raise ValueError('Cannot determine missing package for error {}'
+                     .format(err))
+
+
+def print_instruction_on_import_error(f):
+    @functools.wraps(f)
+    def wrapped(*args, **kwargs):
+        try:
+            return f(*args, **kwargs)
+        except ImportError as err:
+            name = package_name(err)
+            if name in ('IPython', 'julia'):
+                print(make_instruction(name))
+                return
+            if name == 'traitlets':
+                try:
+                    import IPython
+                except ImportError:
+                    print(make_instruction('IPython'))
+                    return
+                print(make_dependency_missing_instruction(IPython, name))
+                return
+            raise
+    return wrapped
+
+
+segfault_warning = """\
+Segmentation fault warning.
+
+You are using IPython version {IPython.__version__} which is known to
+cause segmentation fault with tab completion.  For segfault-free
+IPython, upgrade to version 7 or above (which may still be in
+development stage depending on the time you read this message).
+Note also that IPython releases after 5.x do not support Python 2.
+
+If you need to install development version of IPython and understand
+what would happen to your Python environment by doing so, executing
+the following command in Julia may help:
+
+    IPython.install_dependency("ipython-dev")
+
+It prints the installation command to be executed and prompts your
+input (yes/no) before really executing it.
+"""
+
+segfault_warned = False
+
+
+def maybe_warn_segfault():
+    global segfault_warned
+    import IPython
+    if int(IPython.__version__.split('.', 1)[0]) < 7 and not segfault_warned:
+        warnings.warn(segfault_warning.format(**vars()))
+        segfault_warned = True
+
+
+def with_message(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwds):
+        maybe_warn_segfault()
+        return func(*args, **kwds)
+    return print_instruction_on_import_error(wrapper)

src/replhelper/core.py

@@ -5,7 +5,6 @@
 
 import sys
 import types
-import warnings
 
 try:
     from importlib import reload
@@ -78,80 +77,6 @@ def __dir__(self):
     # well in Python REPLs like IPython.
 
 
-instruction_template = """
-
-Python package "{package}" cannot be imported from Python interpreter
-{python}.
-{additional_message}
-Use your favorite method to install "{need_install}" or run the following
-command in Julia (which *tries* to the right thing):
-
-    IPython.install_dependency("{need_install}")
-
-It prints the installation command to be executed and prompts your
-input (yes/no) before really executing it.
-"""
-
-ipython_dependency_missing = """
-IPython (version: {IPython.__version__}) is importable but {dependency}
-cannot be imported.  It is very strange and I'm not sure what is the
-best instruction here.  Updating IPython could help.
-"""
-
-
-def make_instruction(package, need_install=None, **kwargs):
-    return instruction_template.format(**dict(dict(
-        package=package,
-        need_install=need_install or package.lower(),
-        python=sys.executable,
-        additional_message='',
-    ), **kwargs))
-
-
-def make_dependency_missing_instruction(IPython, dependency):
-    return make_instruction(
-        dependency,
-        need_install='ipython',
-        additional_message=ipython_dependency_missing.format(
-            IPython=IPython,
-            dependency=dependency,
-        ))
-
-
-def package_name(err):
-    try:
-        return err.name
-    except AttributeError:
-        # Python 2 support:
-        prefix = 'No module named '
-        message = str(err)
-        if message.startswith(prefix):
-            return message[len(prefix):].rstrip()
-    raise ValueError('Cannot determine missing package for error {}'
-                     .format(err))
-
-
-def print_instruction_on_import_error(f):
-    def wrapped(*args, **kwargs):
-        try:
-            return f(*args, **kwargs)
-        except ImportError as err:
-            name = package_name(err)
-            if name in ('IPython', 'julia'):
-                print(make_instruction(name))
-                return
-            if name == 'traitlets':
-                try:
-                    import IPython
-                except ImportError:
-                    print(make_instruction('IPython'))
-                    return
-                print(make_dependency_missing_instruction(IPython, name))
-                return
-            raise
-    return wrapped
-
-
 def get_api(main):
     if main is None:
         return None
@@ -175,60 +100,6 @@ def get_main(**kwargs):
     return _Main
 
 
-def ipython_options(**kwargs):
-    global _Main
-    from traitlets.config import Config
-
-    _Main = Main = JuliaNameSpace(JuliaAPI(**kwargs))
-    user_ns = dict(
-        Main=Main,
-    )
-
-    c = Config()
-    c.TerminalIPythonApp.display_banner = False
-    c.TerminalInteractiveShell.confirm_exit = False
-
-    from . import ipyext
-    c.InteractiveShellApp.extensions = [
-        ipyext.__name__,
-    ]
-
-    return dict(user_ns=user_ns, config=c)
-
-
-segfault_warning = """\
-Segmentation fault warning.
-
-You are using IPython version {IPython.__version__} which is known to
-cause segmentation fault with tab completion.  For segfault-free
-IPython, upgrade to version 7 or above (which may still be in
-development stage depending on the time you read this message).
-Note also that IPython releases after 5.x do not support Python 2.
-
-If you need to install development version of IPython and understand
-what would happen to your Python environment by doing so, executing
-the following command in Julia may help:
-
-    IPython.install_dependency("ipython-dev")
-
-It prints the installation command to be executed and prompts your
-input (yes/no) before really executing it.
-"""
-
-segfault_warned = False
-
-
-@print_instruction_on_import_error
-def customized_ipython(**kwargs):
-    global segfault_warned
-    import IPython
-    print()
-    if int(IPython.__version__.split('.', 1)[0]) < 7 and not segfault_warned:
-        warnings.warn(segfault_warning.format(**vars()))
-        segfault_warned = True
-    IPython.start_ipython(**ipython_options(**kwargs))
-
-
 def revise():
     """Ad-hoc hot reload."""
 

src/replhelper/entrypoints.py

@@ -0,0 +1,29 @@
+from .convenience import with_message
+from .core import get_main
+
+
+def ipython_options(**kwargs):
+    from traitlets.config import Config
+
+    user_ns = dict(
+        Main=get_main(**kwargs),
+    )
+
+    c = Config()
+    c.TerminalIPythonApp.display_banner = False
+    c.TerminalIPythonApp.matplotlib = None  # don't close figures
+    c.TerminalInteractiveShell.confirm_exit = False
+
+    from . import ipyext
+    c.InteractiveShellApp.extensions = [
+        ipyext.__name__,
+    ]
+
+    return dict(user_ns=user_ns, config=c)
+
+
+@with_message
+def customized_ipython(**kwargs):
+    import IPython
+    print()
+    IPython.start_ipython(**ipython_options(**kwargs))

src/replhelper/tests/test_core.py src/replhelper/tests/test_convenience.pysrc/replhelper/tests/test_core.py renamed to src/replhelper/tests/test_convenience.py

@@ -1,6 +1,6 @@
 import pytest
 
-from ..core import print_instruction_on_import_error, package_name, \
+from ..convenience import print_instruction_on_import_error, package_name, \
     make_instruction, make_dependency_missing_instruction