runfile/debugfile in evaluated strings: replaced backslashes by slashes in paths

to avoid unicode decoding errors in Python 3 (or in Python 2 when future
'unicode_literals' has been imported).

Update Issue 1438
Status: Fixed

This change may have side effects. I strongly recommend further testing of
running/debugging scripts in current intepreter (Python *and* IPython consoles)
with filenames having "\U" characters for example.

Author: PierreRaybaut

spyderlib/interpreter.py

@@ -20,6 +20,7 @@
 # Local imports:
 from spyderlib.utils.dochelpers import isdefined
 from spyderlib.utils import encoding
+from spyderlib.utils.misc import remove_backslashes
 
 # Force Python to search modules in the current directory first:
 sys.path.insert(0, '')
@@ -173,7 +174,7 @@ def run_command(self, cmd, new_prompt=True):
         # run command
         elif run_match:
             filename = guess_filename(run_match.groups()[0])
-            cmd = 'runfile(r"%s", args=None)' % filename
+            cmd = "runfile('%s', args=None)" % remove_backslashes(filename)
         # !cd system command
         elif cd_match:
             cmd = 'import os; os.chdir(r"%s")' % cd_match.groups()[0].strip()

spyderlib/plugins/console.py

@@ -24,7 +24,7 @@
 # Local imports
 from spyderlib.baseconfig import _
 from spyderlib.config import CONF
-from spyderlib.utils.misc import get_error_match
+from spyderlib.utils.misc import get_error_match, remove_backslashes
 from spyderlib.utils.qthelpers import (get_icon, create_action, add_actions,
                                        mimedata2url, DialogManager)
 from spyderlib.utils.environ import EnvDialog
@@ -222,12 +222,13 @@ def run_script(self, filename=None, silent=False, set_focus=False,
                    os.getcwdu(), _("Python scripts")+" (*.py ; *.pyw ; *.ipy)")
             self.shell.interpreter.redirect_stds()
             if filename:
-                os.chdir( os.path.dirname(filename) )
-                filename = os.path.basename(filename)
+                os.chdir( osp.dirname(filename) )
+                filename = osp.basename(filename)
             else:
                 return
-        command = "runfile(%s, args=%s)" % (repr(osp.abspath(filename)),
-                                            repr(args))
+        filename = osp.abspath(filename)
+        rbs = remove_backslashes
+        command = "runfile('%s', args='%s')" % (rbs(filename), rbs(args))
         if set_focus:
             self.shell.setFocus()
         if self.dockwidget and not self.ismaximized:

spyderlib/plugins/externalconsole.py

@@ -30,8 +30,7 @@
 from spyderlib.config import CONF
 from spyderlib.utils import programs
 from spyderlib.utils.misc import (get_error_match, get_python_executable,
-                                  remove_trailing_single_backslash,
-                                  is_python_script)
+                                  remove_backslashes, is_python_script)
 from spyderlib.utils.qthelpers import get_icon, create_action, mimedata2url
 from spyderlib.widgets.tabs import Tabs
 from spyderlib.widgets.externalshell.pythonshell import ExternalPythonShell
@@ -659,9 +658,9 @@ def get_running_python_shell(self):
 
     def run_script_in_current_shell(self, filename, wdir, args, debug):
         """Run script in current shell, if any"""
-        line = "%s(r'%s'" % ('debugfile' if debug else 'runfile',
-                             unicode(filename))
-        norm = lambda text: remove_trailing_single_backslash(unicode(text))
+        norm = lambda text: remove_backslashes(unicode(text))
+        line = "%s('%s'" % ('debugfile' if debug else 'runfile',
+                            norm(filename))
         if args:
             line += ", args=r'%s'" % norm(args)
         if wdir:

spyderlib/plugins/ipythonconsole.py

@@ -34,8 +34,7 @@
 # Local imports
 from spyderlib.baseconfig import get_conf_path, _
 from spyderlib.utils import programs
-from spyderlib.utils.misc import (get_error_match,
-                                  remove_trailing_single_backslash)
+from spyderlib.utils.misc import get_error_match, remove_backslashes
 from spyderlib.utils.qthelpers import (get_icon, get_std_icon, create_action,
                                        create_toolbutton, add_actions)
 from spyderlib.widgets.tabs import Tabs
@@ -690,17 +689,17 @@ def get_current_client(self):
 
     def run_script_in_current_client(self, filename, wdir, args, debug):
         """Run script in current client, if any"""
-        norm = lambda text: remove_trailing_single_backslash(unicode(text))
+        norm = lambda text: remove_backslashes(unicode(text))
         client = self.get_current_client()
         if client is not None:
             # Internal kernels, use runfile
             if client.kernel_widget_id is not None:
-                line = "%s(r'%s'" % ('debugfile' if debug else 'runfile',
-                                     unicode(filename))
+                line = "%s('%s'" % ('debugfile' if debug else 'runfile',
+                                    norm(filename))
                 if args:
-                    line += ", args=r'%s'" % norm(args)
+                    line += ", args='%s'" % norm(args)
                 if wdir:
-                    line += ", wdir=r'%s'" % norm(wdir)
+                    line += ", wdir='%s'" % norm(wdir)
                 line += ")"
             else: # External kernels, use %run
                 line = "%run "

spyderlib/utils/misc.py

@@ -140,15 +140,23 @@ def fix_reference_name(name, blacklist=None):
     return name
 
 
-def remove_trailing_single_backslash(text):
-    """Remove trailing single backslash in *text*
+def remove_backslashes(path):
+    """Remove backslashes in *path*
+
+    For Windows platforms only.
+    Returns the path unchanged on other platforms.    
     
     This is especially useful when formatting path strings on 
-    Windows platforms for which folder paths may end with such 
-    a character"""
-    if text.endswith('\\') and not text.endswith('\\\\'):
-        text = text[:-1]
-    return text
+    Windows platforms for which folder paths may contain backslashes 
+    and provoke unicode decoding errors in Python 3 (or in Python 2
+    when future 'unicode_literals' symbol has been imported)."""
+    if os.name == 'nt':
+        # Removing trailing single backslash
+        if path.endswith('\\') and not path.endswith('\\\\'):
+            path = path[:-1]
+        # Replacing backslashes by slashes
+        path = path.replace('\\', '/')
+    return path
 
 
 def get_error_match(text):

spyderlib/widgets/externalshell/sitecustomize.py

@@ -553,6 +553,8 @@ def debugfile(filename, args=None, wdir=None):
     debugger._wait_for_mainpyfile = 1
     debugger.mainpyfile = filename
     debugger._user_requested_quit = 0
+    if os.name == 'nt':
+        filename = filename.replace('\\', '/')
     debugger.run("runfile(%r, args=%r, wdir=%r)" % (filename, args, wdir))
 
 __builtin__.debugfile = debugfile