Make set_term_title() default to no-op, as it can cause problems.

In embedded contexts this can corrupt stdout (e.g. gedit ipython plugin), by
default ipython should be 'safe' to use in all contexts.  The user-facing
terminal app can activate more aggressive configurations as needed.

Added an API call to actually toggle the state, and deprecated the old one
(which could only disable but not enable).

IPython/platutils.py

@@ -1,47 +1,70 b''
 # -*- coding: utf-8 -*-
 """ Proxy module for accessing platform specific utility functions. 
 
 Importing this module should give you the implementations that are correct 
 for your operation system, from platutils_PLATFORMNAME module.
 """
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez <[e-mail]>
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Ville']
-__license__ = Release.license
-
 import os
 import sys
 
 # Import the platform-specific implementations
 if os.name == 'posix':
     import platutils_posix as _platutils
 elif sys.platform == 'win32':
     import platutils_win32 as _platutils
 else:
     import platutils_dummy as _platutils
     import warnings
     warnings.warn("Platutils not available for platform '%s', some features may be missing" %
         os.name)
     del warnings
 
 
 # Functionality that's logically common to all platforms goes here, each
 # platform-specific module only provides the bits that are OS-dependent.
 
-def freeze_term_title():
-    _platutils.ignore_termtitle = True
+# XXX - I'm still not happy with a module global for this, but at least now
+# there is a public, cross-platform way of toggling the term title control on
+# and off.  We should make this a stateful object later on so that each user
+# can have its own instance if needed.
+def toggle_set_term_title(val):
+    """Control whether set_term_title is active or not.
+
+    set_term_title() allows writing to the console titlebar.  In embedded
+    widgets this can cause problems, so this call can be used to toggle it on
+    or off as needed.
+
+    The default state of the module is for the function to be disabled.
+
+    Parameters
+    ----------
+      val : bool
+        If True, set_term_title() actually writes to the terminal (using the
+        appropriate platform-specific module).  If False, it is a no-op.
+    """
+    _platutils.ignore_termtitle = not(val)
 
 
 def set_term_title(title):
     """Set terminal title using the necessary platform-dependent calls."""
 
     if _platutils.ignore_termtitle:
         return
     _platutils.set_term_title(title)
+
+
+#-----------------------------------------------------------------------------
+# Deprecated functions
+#-----------------------------------------------------------------------------
+def freeze_term_title():
+    warnings.warn("This function is deprecated, use toggle_set_term_title()")
+    _platutils.ignore_termtitle = True
+

IPython/platutils_posix.py

@@ -1,36 +1,32 b''
 # -*- coding: utf-8 -*-
 """ Platform specific utility functions, posix version 
 
 Importing this module directly is not portable - rather, import platutils 
 to use these functions in platform agnostic fashion.
 """
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez <[e-mail]>
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Ville']
-__license__ = Release.license
-
 import sys
 import os
 
-ignore_termtitle = False
+ignore_termtitle = True
 
 def _dummy_op(*a, **b):
     """ A no-op function """
 
 def _set_term_title_xterm(title):
     """ Change virtual terminal title in xterm-workalikes """
 
-    sys.stdout.write('\033]%d;%s\007' % (0,title))
+    sys.stdout.write('\033]0;%s\007' % title)
 
 
 if os.environ.get('TERM','') == 'xterm':
     set_term_title = _set_term_title_xterm
 else:
     set_term_title = _dummy_op

IPython/platutils_win32.py

@@ -1,47 +1,44 b''
 # -*- coding: utf-8 -*-
 """ Platform specific utility functions, win32 version
 
 Importing this module directly is not portable - rather, import platutils 
 to use these functions in platform agnostic fashion.
 """
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez <[e-mail]>
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #*****************************************************************************
 
-from IPython import Release
-__author__  = '%s <%s>' % Release.authors['Ville']
-__license__ = Release.license
 
 import os
 
-ignore_termtitle = False
+ignore_termtitle = True
 
 try:
     import ctypes
 
     SetConsoleTitleW = ctypes.windll.kernel32.SetConsoleTitleW
     SetConsoleTitleW.argtypes = [ctypes.c_wchar_p]
     
     def set_term_title(title):
         """Set terminal title using ctypes to access the Win32 APIs."""
         SetConsoleTitleW(title)
 
 except ImportError:
     def set_term_title(title):
         """Set terminal title using the 'title' command."""
         global ignore_termtitle
 
         try:
             # Cannot be on network share when issuing system commands
             curr = os.getcwd()
             os.chdir("C:")
             ret = os.system("title " + title)
         finally:
             os.chdir(curr)
         if ret:
             # non-zero return code signals error, don't try again
             ignore_termtitle = True