From bcc42e2201c7172848185e5675a7b79e3d28aa0f Mon Sep 17 00:00:00 2001
From: Barry Warsaw
Date: Tue, 13 Mar 2012 21:09:33 -0700
Subject: Move the interact module to a better sub-package location.

---
 src/mailman/utilities/interact.py | 86 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 src/mailman/utilities/interact.py

(limited to 'src/mailman/utilities/interact.py')

diff --git a/src/mailman/utilities/interact.py b/src/mailman/utilities/interact.py
new file mode 100644
index 000000000..dd6bac9f0
--- /dev/null
+++ b/src/mailman/utilities/interact.py
@@ -0,0 +1,86 @@
+# Copyright (C) 2006-2012 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Provide an interactive prompt, mimicking the Python interpreter."""
+
+from __future__ import unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'interact',
+    ]
+
+
+import os
+import sys
+import code
+
+DEFAULT_BANNER = ''
+
+
+
+def interact(upframe=True, banner=DEFAULT_BANNER, overrides=None):
+    """Start an interactive interpreter prompt.
+
+    :param upframe: Whether or not to populate the interpreter's globals with
+        the locals from the frame that called this function.
+    :type upfframe: bool
+    :param banner: The banner to print before the interpreter starts.
+    :type banner: string
+    :param overrides: Additional interpreter globals to add.
+    :type overrides: dict
+    """
+    # The interactive prompt's namespace.
+    namespace = dict()
+    # Populate the console's with the locals of the frame that called this
+    # function (i.e. one up from here).
+    if upframe:
+        frame = sys._getframe(1)
+        namespace.update(frame.f_globals)
+        namespace.update(frame.f_locals)
+    if overrides is not None:
+        namespace.update(overrides)
+    interp = code.InteractiveConsole(namespace)
+    # Try to import the readline module, but don't worry if it's unavailable.
+    try:
+        import readline
+    except ImportError:
+        pass
+    # Mimic the real interactive interpreter's loading of any $PYTHONSTARTUP
+    # file.  Note that if the startup file is not prepared to be exec'd more
+    # than once, this could cause a problem.
+    startup = os.environ.get('PYTHONSTARTUP')
+    if startup:
+        try:
+            execfile(startup, namespace)
+        except:
+            pass
+    # We don't want the funky console object in parentheses in the banner.
+    if banner == DEFAULT_BANNER:
+        banner = '''\
+Python %s on %s
+Type "help", "copyright", "credits" or "license" for more information.''' % (
+            sys.version, sys.platform)
+    elif not banner:
+        banner = None
+    interp.interact(banner)
+    # When an exception occurs in the InteractiveConsole, the various
+    # sys.exc_* attributes get set so that error handling works the same way
+    # there as it does in the built-in interpreter.  Be anal about clearing
+    # any exception information before we're done.
+    sys.exc_clear()
+    sys.last_type = sys.last_value = sys.last_traceback = None
-- 
cgit v1.2.3-70-g09d2