Beginning to transition all paths, files, dirs over to unicode.

In preparation for getting ready for Python 3, all filename, paths
and dirs should be representated as unicode strings internally.
I have begun to make this transition in the main applications
(ipython/ipcontroller/ipengine/ipcluster).

IPython/config/default/ipcluster_config.py

@@ -93,12 +93,12 b' c = get_config()'
 # c.WinHPCTask.is_rerunnable = True
 
 # c.IPControllerTask.task_name = 'IPController'
-# c.IPControllerTask.controller_cmd = ['ipcontroller.exe']
+# c.IPControllerTask.controller_cmd = [u'ipcontroller.exe']
 # c.IPControllerTask.controller_args = ['--log-to-file', '--log-level', '40']
 # c.IPControllerTask.environment_variables = {}
 
 # c.IPEngineTask.task_name = 'IPController'
-# c.IPEngineTask.engine_cmd = ['ipengine.exe']
+# c.IPEngineTask.engine_cmd = [u'ipengine.exe']
 # c.IPEngineTask.engine_args = ['--log-to-file', '--log-level', '40']
 # c.IPEngineTask.environment_variables = {}
 

IPython/config/default/ipcontroller_config.py

@@ -101,7 +101,7 b' c = get_config()'
 # are more for developers who want to change the behavior of the controller
 # at a fundamental level.
 
-# c.FCClientServiceFactory.cert_file = 'ipcontroller-client.pem'
+# c.FCClientServiceFactory.cert_file = u'ipcontroller-client.pem'
 
 # default_client_interfaces = Config()
 # default_client_interfaces.Task.interface_chain = [
@@ -109,24 +109,24 b' c = get_config()'
 #     'IPython.kernel.taskfc.IFCTaskController'
 # ]
 # 
-# default_client_interfaces.Task.furl_file = 'ipcontroller-tc.furl'
+# default_client_interfaces.Task.furl_file = u'ipcontroller-tc.furl'
 # 
 # default_client_interfaces.MultiEngine.interface_chain = [
 #     'IPython.kernel.multiengine.IMultiEngine',
 #     'IPython.kernel.multienginefc.IFCSynchronousMultiEngine'
 # ]
 # 
-# default_client_interfaces.MultiEngine.furl_file = 'ipcontroller-mec.furl'
+# default_client_interfaces.MultiEngine.furl_file = u'ipcontroller-mec.furl'
 # 
 # c.FCEngineServiceFactory.interfaces = default_client_interfaces
 
-# c.FCEngineServiceFactory.cert_file = 'ipcontroller-engine.pem'
+# c.FCEngineServiceFactory.cert_file = u'ipcontroller-engine.pem'
 
 # default_engine_interfaces = Config()
 # default_engine_interfaces.Default.interface_chain = [
 #     'IPython.kernel.enginefc.IFCControllerBase'
 # ]
 # 
-# default_engine_interfaces.Default.furl_file = 'ipcontroller-engine.furl'
+# default_engine_interfaces.Default.furl_file = u'ipcontroller-engine.furl'
 # 
 # c.FCEngineServiceFactory.interfaces = default_engine_interfaces

IPython/config/default/ipengine_config.py

@@ -32,7 +32,7 b' c = get_config()'
 # By default, the engine will look for the controller's FURL file in its own
 # cluster directory. Sometimes, the FURL file will be elsewhere and this 
 # attribute can be set to the full path of the FURL file.
-# c.Global.furl_file = ''
+# c.Global.furl_file = u''
 
 #-----------------------------------------------------------------------------
 # MPI configuration
@@ -76,7 +76,7 b' c = get_config()'
 
 # c.Global.shell_class = 'IPython.kernel.core.interpreter.Interpreter'
 
-# c.Global.furl_file_name = 'ipcontroller-engine.furl'
+# c.Global.furl_file_name = u'ipcontroller-engine.furl'
 
 
 

IPython/config/default/ipython_config.py

@@ -71,9 +71,9 b' c = get_config()'
 
 # c.InteractiveShell.logstart = True
 
-# c.InteractiveShell.logfile = 'ipython_log.py'
+# c.InteractiveShell.logfile = u'ipython_log.py'
 
-# c.InteractiveShell.logappend = 'mylog.py'
+# c.InteractiveShell.logappend = u'mylog.py'
 
 # c.InteractiveShell.object_info_string_level = 0
 

IPython/core/application.py

@@ -52,12 +52,12 b' class BaseAppArgParseConfigLoader(ArgParseConfigLoader):'
 
     def _add_other_arguments(self):
         self.parser.add_argument('--ipython-dir', 
-            dest='Global.ipython_dir',type=str,
+            dest='Global.ipython_dir',type=unicode,
             help='Set to override default location of Global.ipython_dir.',
             default=NoConfigDefault,
             metavar='Global.ipython_dir')
         self.parser.add_argument('-p', '--profile',
-            dest='Global.profile',type=str,
+            dest='Global.profile',type=unicode,
             help='The string name of the ipython profile to be used.',
             default=NoConfigDefault,
             metavar='Global.profile')
@@ -67,7 +67,7 b' class BaseAppArgParseConfigLoader(ArgParseConfigLoader):'
             default=NoConfigDefault,
             metavar='Global.log_level')
         self.parser.add_argument('--config-file',
-            dest='Global.config_file',type=str,
+            dest='Global.config_file',type=unicode,
             help='Set the config file name to override default.',
             default=NoConfigDefault,
             metavar='Global.config_file')
@@ -80,9 +80,9 b' class ApplicationError(Exception):'
 class Application(object):
     """Load a config, construct components and set them running."""
 
-    name = 'ipython'
+    name = u'ipython'
     description = 'IPython: an enhanced interactive Python shell.'
-    config_file_name = 'ipython_config.py'
+    config_file_name = u'ipython_config.py'
     default_log_level = logging.WARN
 
     def __init__(self):
@@ -242,7 +242,7 b' class Application(object):'
         try:
             self.profile_name = self.command_line_config.Global.profile
             name_parts = self.config_file_name.split('.')
-            name_parts.insert(1, '_' + self.profile_name + '.')
+            name_parts.insert(1, u'_' + self.profile_name + u'.')
             self.config_file_name = ''.join(name_parts)
         except AttributeError:
             pass
@@ -280,7 +280,7 b' class Application(object):'
             self.file_config = Config()
         except:
             self.log.warn("Error loading config file: %s" % \
-                           self.config_file_name, exc_info=True)
+                          self.config_file_name, exc_info=True)
             self.file_config = Config()
 
     def set_file_config_log_level(self):

IPython/core/ipapp.py

@@ -164,20 +164,20 b' cl_args = ('
         help="Start logging to the default file (./ipython_log.py).")
     ),
     (('--logfile','-lf'), dict(
-        type=str, dest='InteractiveShell.logfile', default=NoConfigDefault,
+        type=unicode, dest='InteractiveShell.logfile', default=NoConfigDefault,
         help="Start logging to logfile.",
         metavar='InteractiveShell.logfile')
     ),
     (('--log-append','-la'), dict(
-        type=str, dest='InteractiveShell.logappend', default=NoConfigDefault,
-        help="Start logging to logappend in append mode.",
+        type=unicode, dest='InteractiveShell.logappend', default=NoConfigDefault,
+        help="Start logging to the give file in append mode.",
         metavar='InteractiveShell.logfile')
     ),
     (('--pdb',), dict(
         action='store_true', dest='InteractiveShell.pdb', default=NoConfigDefault,
         help="Enable auto calling the pdb debugger after every exception.")
     ),
-    (('--nopdb',), dict(
+    (('--no-pdb',), dict(
         action='store_false', dest='InteractiveShell.pdb', default=NoConfigDefault,
         help="Disable auto calling the pdb debugger after every exception.")
     ),
@@ -293,11 +293,11 b' class IPythonAppCLConfigLoader(BaseAppArgParseConfigLoader):'
     arguments = cl_args
 
 
-default_config_file_name = 'ipython_config.py'
+default_config_file_name = u'ipython_config.py'
 
 
 class IPythonApp(Application):
-    name = 'ipython'
+    name = u'ipython'
     description = 'IPython: an enhanced interactive Python shell.'
     config_file_name = default_config_file_name
 
@@ -475,9 +475,9 b' class IPythonApp(Application):'
             self.shell.showtraceback()
 
     def _exec_file(self, fname):
-        full_filename = filefind(fname, ['.', self.ipython_dir])
+        full_filename = filefind(fname, [u'.', self.ipython_dir])
         if os.path.isfile(full_filename):
-            if full_filename.endswith('.py'):
+            if full_filename.endswith(u'.py'):
                 self.log.info("Running file in user namespace: %s" % full_filename)
                 self.shell.safe_execfile(full_filename, self.shell.user_ns)
             elif full_filename.endswith('.ipy'):

IPython/kernel/clusterdir.py

@@ -139,8 +139,8 b' class ClusterDir(Component):'
 
     def copy_all_config_files(self, path=None, overwrite=False):
         """Copy all config files into the active cluster directory."""
-        for f in ['ipcontroller_config.py', 'ipengine_config.py',
-                  'ipcluster_config.py']:
+        for f in [u'ipcontroller_config.py', u'ipengine_config.py',
+                  u'ipcluster_config.py']:
             self.copy_config_file(f, path=path, overwrite=overwrite)
 
     @classmethod
@@ -156,7 +156,7 b' class ClusterDir(Component):'
         return ClusterDir(cluster_dir)
 
     @classmethod
-    def create_cluster_dir_by_profile(cls, path, profile='default'):
+    def create_cluster_dir_by_profile(cls, path, profile=u'default'):
         """Create a cluster dir by profile name and path.
 
         Parameters
@@ -169,11 +169,11 b' class ClusterDir(Component):'
         """
         if not os.path.isdir(path):
             raise ClusterDirError('Directory not found: %s' % path)
-        cluster_dir = os.path.join(path, 'cluster_' + profile)
+        cluster_dir = os.path.join(path, u'cluster_' + profile)
         return ClusterDir(cluster_dir)
 
     @classmethod
-    def find_cluster_dir_by_profile(cls, ipython_dir, profile='default'):
+    def find_cluster_dir_by_profile(cls, ipython_dir, profile=u'default'):
         """Find an existing cluster dir by profile name, return its ClusterDir.
 
         This searches through a sequence of paths for a cluster dir.  If it
@@ -193,7 +193,7 b' class ClusterDir(Component):'
             The name of the profile.  The name of the cluster directory
             will be "cluster_<profile>".
         """
-        dirname = 'cluster_' + profile
+        dirname = u'cluster_' + profile
         cluster_dir_paths = os.environ.get('IPCLUSTER_DIR_PATH','')
         if cluster_dir_paths:
             cluster_dir_paths = cluster_dir_paths.split(':')
@@ -230,13 +230,13 b' class AppWithClusterDirArgParseConfigLoader(ArgParseConfigLoader):'
 
     def _add_other_arguments(self):
         self.parser.add_argument('--ipython-dir', 
-            dest='Global.ipython_dir',type=str,
+            dest='Global.ipython_dir',type=unicode,
             help='Set to override default location of Global.ipython_dir.',
             default=NoConfigDefault,
             metavar='Global.ipython_dir'
         )
         self.parser.add_argument('-p', '--profile',
-            dest='Global.profile',type=str,
+            dest='Global.profile',type=unicode,
             help='The string name of the profile to be used. This determines '
             'the name of the cluster dir as: cluster_<profile>. The default profile '
             'is named "default".  The cluster directory is resolve this way '
@@ -251,7 +251,7 b' class AppWithClusterDirArgParseConfigLoader(ArgParseConfigLoader):'
             metavar="Global.log_level"
         )
         self.parser.add_argument('--cluster-dir',
-            dest='Global.cluster_dir',type=str,
+            dest='Global.cluster_dir',type=unicode,
             help='Set the cluster dir. This overrides the logic used by the '
             '--profile option.',
             default=NoConfigDefault,
@@ -291,8 +291,8 b' class ApplicationWithClusterDir(Application):'
 
     def create_default_config(self):
         super(ApplicationWithClusterDir, self).create_default_config()
-        self.default_config.Global.profile = 'default'
-        self.default_config.Global.cluster_dir = ''
+        self.default_config.Global.profile = u'default'
+        self.default_config.Global.cluster_dir = u''
         self.default_config.Global.log_to_file = False
         self.default_config.Global.clean_logs = False
 
@@ -404,11 +404,11 b' class ApplicationWithClusterDir(Application):'
         if self.master_config.Global.clean_logs:
             log_dir = self.master_config.Global.log_dir
             for f in os.listdir(log_dir):
-                if f.startswith(self.name + '-') and f.endswith('.log'):
+                if f.startswith(self.name + u'-') and f.endswith('.log'):
                     os.remove(os.path.join(log_dir, f))
         # Start logging to the new log file
         if self.master_config.Global.log_to_file:
-            log_filename = self.name + '-' + str(os.getpid()) + '.log'
+            log_filename = self.name + u'-' + str(os.getpid()) + u'.log'
             logfile = os.path.join(self.log_dir, log_filename)
             open_log_file = open(logfile, 'w')
         else:
@@ -421,7 +421,7 b' class ApplicationWithClusterDir(Application):'
         This must be called after pre_construct, which sets `self.pid_dir`.
         This raises :exc:`PIDFileError` if the pid file exists already.
         """
-        pid_file = os.path.join(self.pid_dir, self.name + '.pid')
+        pid_file = os.path.join(self.pid_dir, self.name + u'.pid')
         if os.path.isfile(pid_file):
             pid = self.get_pid_from_file()
             if not overwrite:
@@ -439,7 +439,7 b' class ApplicationWithClusterDir(Application):'
         This should be called at shutdown by registering a callback with
         :func:`reactor.addSystemEventTrigger`.
         """
-        pid_file = os.path.join(self.pid_dir, self.name + '.pid')
+        pid_file = os.path.join(self.pid_dir, self.name + u'.pid')
         if os.path.isfile(pid_file):
             try:
                 self.log.info("Removing pid file: %s" % pid_file)
@@ -453,7 +453,7 b' class ApplicationWithClusterDir(Application):'
 
         If the  pid file doesn't exist a :exc:`PIDFileError` is raised.
         """
-        pid_file = os.path.join(self.pid_dir, self.name + '.pid')
+        pid_file = os.path.join(self.pid_dir, self.name + u'.pid')
         if os.path.isfile(pid_file):
             with open(pid_file, 'r') as f:
                 pid = int(f.read().strip())

IPython/kernel/ipclusterapp.py

@@ -58,7 +58,7 b' class IPClusterCLLoader(ArgParseConfigLoader):'
         # This has all the common options that all subcommands use
         parent_parser1 = argparse.ArgumentParser(add_help=False)
         parent_parser1.add_argument('--ipython-dir', 
-            dest='Global.ipython_dir',type=str,
+            dest='Global.ipython_dir',type=unicode,
             help='Set to override default location of Global.ipython_dir.',
             default=NoConfigDefault,
             metavar='Global.ipython_dir')
@@ -71,7 +71,7 b' class IPClusterCLLoader(ArgParseConfigLoader):'
         # This has all the common options that other subcommands use
         parent_parser2 = argparse.ArgumentParser(add_help=False)
         parent_parser2.add_argument('-p','--profile',
-            dest='Global.profile',type=str,
+            dest='Global.profile',type=unicode,
             default=NoConfigDefault,
             help='The string name of the profile to be used. This determines '
             'the name of the cluster dir as: cluster_<profile>. The default profile '
@@ -80,7 +80,7 b' class IPClusterCLLoader(ArgParseConfigLoader):'
             default=NoConfigDefault,
             metavar='Global.profile')
         parent_parser2.add_argument('--cluster-dir',
-            dest='Global.cluster_dir',type=str,
+            dest='Global.cluster_dir',type=unicode,
             default=NoConfigDefault,
             help='Set the cluster dir. This overrides the logic used by the '
             '--profile option.',
@@ -165,12 +165,12 b' class IPClusterCLLoader(ArgParseConfigLoader):'
         )
 
 
-default_config_file_name = 'ipcluster_config.py'
+default_config_file_name = u'ipcluster_config.py'
 
 
 class IPClusterApp(ApplicationWithClusterDir):
 
-    name = 'ipcluster'
+    name = u'ipcluster'
     description = 'Start an IPython cluster (controller and engines).'
     config_file_name = default_config_file_name
     default_log_level = logging.INFO
@@ -278,7 +278,6 b' class IPClusterApp(ApplicationWithClusterDir):'
 
         # Setup signals
         signal.signal(signal.SIGINT, self.stop_launchers)
-        # signal.signal(signal.SIGKILL, self.stop_launchers)
 
         # Setup the observing of stopping
         d1 = self.controller_launcher.observe_stop()

IPython/kernel/ipcontrollerapp.py

@@ -59,7 +59,7 b' default_client_interfaces.MultiEngine.interface_chain = ['
     'IPython.kernel.multienginefc.IFCSynchronousMultiEngine'
 ]
 
-default_client_interfaces.MultiEngine.furl_file = 'ipcontroller-mec.furl'
+default_client_interfaces.MultiEngine.furl_file = u'ipcontroller-mec.furl'
 
 # Make this a dict we can pass to Config.__init__ for the default
 default_client_interfaces = dict(copy.deepcopy(default_client_interfaces.items()))
@@ -72,7 +72,7 b' default_engine_interfaces.Default.interface_chain = ['
     'IPython.kernel.enginefc.IFCControllerBase'
 ]
 
-default_engine_interfaces.Default.furl_file = 'ipcontroller-engine.furl'
+default_engine_interfaces.Default.furl_file = u'ipcontroller-engine.furl'
 
 # Make this a dict we can pass to Config.__init__ for the default
 default_engine_interfaces = dict(copy.deepcopy(default_engine_interfaces.items()))
@@ -86,7 +86,7 b' default_engine_interfaces = dict(copy.deepcopy(default_engine_interfaces.items()'
 class FCClientServiceFactory(FCServiceFactory):
     """A Foolscap implementation of the client services."""
 
-    cert_file = Str('ipcontroller-client.pem', config=True)
+    cert_file = Unicode(u'ipcontroller-client.pem', config=True)
     interfaces = Instance(klass=Config, kw=default_client_interfaces,
                           allow_none=False, config=True)
 
@@ -94,7 +94,7 b' class FCClientServiceFactory(FCServiceFactory):'
 class FCEngineServiceFactory(FCServiceFactory):
     """A Foolscap implementation of the engine services."""
 
-    cert_file = Str('ipcontroller-engine.pem', config=True)
+    cert_file = Unicode(u'ipcontroller-engine.pem', config=True)
     interfaces = Instance(klass=dict, kw=default_engine_interfaces,
                           allow_none=False, config=True)
 
@@ -176,12 +176,12 b' class IPControllerAppCLConfigLoader(AppWithClusterDirArgParseConfigLoader):'
     arguments = cl_args
 
 
-default_config_file_name = 'ipcontroller_config.py'
+default_config_file_name = u'ipcontroller_config.py'
 
 
 class IPControllerApp(ApplicationWithClusterDir):
 
-    name = 'ipcontroller'
+    name = u'ipcontroller'
     description = 'Start the IPython controller for parallel computing.'
     config_file_name = default_config_file_name
     auto_create_cluster_dir = True

IPython/kernel/ipengineapp.py

@@ -44,7 +44,7 b' from IPython.kernel.engineconnector import EngineConnector'
 cl_args = (
     # Controller config
     (('--furl-file',), dict(
-        type=str, dest='Global.furl_file', default=NoConfigDefault,
+        type=unicode, dest='Global.furl_file', default=NoConfigDefault,
         help='The full location of the file containing the FURL of the '
         'controller. If this is not given, the FURL file must be in the '
         'security directory of the cluster directory.  This location is '
@@ -84,12 +84,12 b' mpi.size = 0'
 """
 
 
-default_config_file_name = 'ipengine_config.py'
+default_config_file_name = u'ipengine_config.py'
 
 
 class IPEngineApp(ApplicationWithClusterDir):
 
-    name = 'ipengine'
+    name = u'ipengine'
     description = 'Start the IPython engine for parallel computing.'
     config_file_name = default_config_file_name
     auto_create_cluster_dir = True
@@ -108,10 +108,10 b' class IPEngineApp(ApplicationWithClusterDir):'
         # Configuration related to the controller
         # This must match the filename (path not included) that the controller
         # used for the FURL file.
-        self.default_config.Global.furl_file_name = 'ipcontroller-engine.furl'
+        self.default_config.Global.furl_file_name = u'ipcontroller-engine.furl'
         # If given, this is the actual location of the controller's FURL file.
         # If not, this is computed using the profile, app_dir and furl_file_name
-        self.default_config.Global.furl_file = ''
+        self.default_config.Global.furl_file = u''
 
         # The max number of connection attemps and the initial delay between
         # those attemps.

IPython/kernel/launcher.py

@@ -244,8 +244,8 b' class LocalProcessLauncher(BaseLauncher):'
             self.start_deferred = defer.Deferred()
             self.process_transport = reactor.spawnProcess(
                 self.process_protocol,
-                str(self.args[0]),
-                [str(a) for a in self.args],
+                str(self.args[0]),  # twisted expects these to be str, not unicode
+                [str(a) for a in self.args],  # str expected, not unicode
                 env=os.environ
             )
             return self.start_deferred