PR: Add disambiguation functionality for Editor tabs

spyder/utils/sourcecode.py

@@ -9,7 +9,10 @@
 """
 
 import re
-
+import os
+from spyder.py3compat import PY2
+if PY2:
+    from itertools import izip as zip
 
 # Order is important:
 EOL_CHARS = (("\r\n", 'nt'), ("\n", 'posix'), ("\r", 'mac'))
@@ -120,12 +123,46 @@ def get_identifiers(source_code):
     valid = re.compile(r'[a-zA-Z_]')
     return [token for token in tokens if re.match(valid, token)]
 
-
-if __name__ == '__main__':
-    code = 'import functools\nfunctools.partial'
-    assert get_primary_at(code, len(code)) == 'functools.partial'
-    assert set(get_identifiers(code)) == set(['import', 'functools',
-                                              'functools.partial'])
-    assert split_source(code) == ['import functools', 'functools.partial']
-    code = code.replace('\n', '\r\n')
-    assert split_source(code) == ['import functools', 'functools.partial']
+def path_components(path):
+    """
+    Return the individual components of a given file path
+    string (for the local operating system).
+
+    Taken from http://stackoverflow.com/q/21498939/438386
+    """
+    components = []
+    # The loop guarantees that the returned components can be
+    # os.path.joined with the path separator and point to the same
+    # location:    
+    while True:
+        (new_path, tail) = os.path.split(path)  # Works on any platform
+        components.append(tail)        
+        if new_path == path:  # Root (including drive, on Windows) reached
+            break
+        path = new_path
+    components.append(new_path)    
+    components.reverse()  # First component first 
+    return components
+
+def differentiate_prefix(path_components0, path_components1):
+    """
+    Return the differ prefix of the given two iterables. 
+
+    Taken from http://stackoverflow.com/q/21498939/438386
+    """
+    longest_prefix = []
+    common_elmt = None
+    for (elmt0, elmt1) in zip(path_components0, path_components1):
+        if elmt0 != elmt1:
+            break
+        else:
+            common_elmt = elmt0
+        longest_prefix.append(elmt0)
+    file_name_length = len(path_components0[len(path_components0)-1])
+    path_0 = os.path.join(*path_components0)[:-file_name_length-1]
+    if(len(longest_prefix)>3):
+        longest_path_prefix = os.path.join(*longest_prefix)
+        length_to_delete = len(longest_path_prefix)-len(common_elmt) 
+        return path_0[length_to_delete:]
+    else:
+        return path_0

spyder/utils/tests/test_sourcecode.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright © Spyder Project Contributors
+# Licensed under the terms of the MIT License
+
+"""Tests for sourcecode.py"""
+
+import os
+import sys
+
+import pytest
+
+from spyder.utils import sourcecode
+
+
+def test_get_primary_at(tmpdir, qtbot):
+    code = 'import functools\nfunctools.partial'
+    assert sourcecode.get_primary_at(code, len(code)) == 'functools.partial'
+
+
+def test_get_identifiers(tmpdir, qtbot):
+    code = 'import functools\nfunctools.partial'
+    assert set(sourcecode.get_identifiers(code)) == set(['import', 'functools',
+                                              'functools.partial'])
+
+
+def test_split_source(tmpdir, qtbot):
+    code = 'import functools\nfunctools.partial'
+    assert sourcecode.split_source(code) == ['import functools', 'functools.partial']
+    code = code.replace('\n', '\r\n')
+    assert sourcecode.split_source(code) == ['import functools', 'functools.partial']
+
+
+def test_path_components(tmpdir, qtbot):
+    if sys.platform.startswith('linux'):
+        path_components0 = ['','','documents','test','test.py']
+        path_components1 = ['','','documents','projects','test','test.py']
+    else:
+        path_components0 = ['c:','','documents','test','test.py']
+        path_components1 = ['c:','','documents','projects','test','test.py']
+    path0 = os.path.join(*path_components0)
+    path1 = os.path.join(*path_components1)
+    assert sourcecode.path_components(path0) == path_components0
+    assert sourcecode.path_components(path1) == path_components1
+
+
+def test_differentiate_prefix(tmpdir, qtbot):
+    path_components0 = ['documents','test','test.py']
+    path_components1 = ['documents','projects','test','test.py']
+    differ_path0 = os.path.join(*['documents','test'])
+    differ_path1 = os.path.join(*['documents', 'projects', 'test'])
+    assert sourcecode.differentiate_prefix(
+                        path_components0, path_components1) ==  differ_path0
+    assert sourcecode.differentiate_prefix(
+                        path_components1, path_components0) ==  differ_path1
+
+
+if __name__ == '__main__':
+    pytest.main()
+

spyder/widgets/editor.py

@@ -941,11 +941,33 @@ def __modified_readonly_title(self, title, is_modified, is_readonly):
             title = "(%s)" % title
         return title
 
-    def get_tab_text(self, filename, is_modified=None, is_readonly=None):
+    def get_tab_text(self, index, filename, is_modified=None, is_readonly=None):
         """Return tab title"""
-        return self.__modified_readonly_title(osp.basename(filename),
+        fname = self.get_file_title(index)
+        return self.__modified_readonly_title(fname,
                                               is_modified, is_readonly)
 
+    def get_file_title(self, index):
+        """Get tab title without ambiguation."""
+        finfo = self.data[index]
+        fname = osp.basename(finfo.filename)
+        for findex, source in enumerate(self.data):
+            fname_to_compare = osp.basename(source.filename)
+            if findex is not index and fname == fname_to_compare:
+                differ_path = sourcecode.differentiate_prefix(
+                                   sourcecode.path_components(finfo.filename), 
+                                   sourcecode.path_components(source.filename))
+                differ_path_length = len(differ_path)
+                if (differ_path_length > 20):
+                    path_component = sourcecode.path_components(differ_path)
+                    last_component_index = len(path_component) - 1
+                    path_component = [path_component[0], '...', 
+                                       path_component[last_component_index]]
+                    differ_path = os.path.join(*path_component)
+                fname = fname + " - " + differ_path
+                break
+        return fname
+
     def get_tab_tip(self, filename, is_modified=None, is_readonly=None):
         """Return tab menu title"""
         if self.fullpath_sorting_enabled:
@@ -979,7 +1001,7 @@ def add_to_data(self, finfo, set_current):
         self.data.sort(key=self.__get_sorting_func())
         index = self.data.index(finfo)
         fname, editor = finfo.filename, finfo.editor
-        self.tabs.insertTab(index, editor, self.get_tab_text(fname))
+        self.tabs.insertTab(index, editor, self.get_tab_text(index, fname))
         self.set_stack_title(index, False)
         if set_current:
             self.set_stack_index(index)
@@ -995,7 +1017,8 @@ def __repopulate_stack(self):
                 is_modified = True
             else:
                 is_modified = None
-            tab_text = self.get_tab_text(finfo.filename, is_modified)
+            index = self.data.index(finfo)
+            tab_text = self.get_tab_text(index, finfo.filename, is_modified)
             tab_tip = self.get_tab_tip(finfo.filename)
             index = self.tabs.addTab(finfo.editor, tab_text)
             self.tabs.setTabToolTip(index, tab_tip)
@@ -1029,7 +1052,7 @@ def set_stack_title(self, index, is_modified):
         fname = finfo.filename
         is_modified = (is_modified or finfo.newly_created) and not finfo.default
         is_readonly = finfo.editor.isReadOnly()
-        tab_text = self.get_tab_text(fname, is_modified, is_readonly)
+        tab_text = self.get_tab_text(index, fname, is_modified, is_readonly)
         tab_tip = self.get_tab_tip(fname, is_modified, is_readonly)
         self.tabs.setTabText(index, tab_text)
         self.tabs.setTabToolTip(index, tab_tip)
@@ -1171,7 +1194,9 @@ def close_file(self, index=None, force=False):
         if self.get_stack_count() == 0 and self.create_new_file_if_empty:
             self.sig_new_file[()].emit()
             return False
-
+
+        self.__modify_stack_title()
+
         return is_ok
 
     def close_all_files(self):
@@ -1558,6 +1583,11 @@ def __check_file_status(self, index):
         # Finally, resetting temporary flag:
         self.__file_status_flag = False
 
+    def __modify_stack_title(self):
+        for index, finfo in enumerate(self.data):
+            state = finfo.editor.document().isModified()
+            self.set_stack_title(index, state)
+
     def refresh(self, index=None):
         """Refresh tabwidget"""
         if index is None:
@@ -1573,6 +1603,7 @@ def refresh(self, index=None):
             self.__refresh_statusbar(index)
             self.__refresh_readonly(index)
             self.__check_file_status(index)
+            self.__modify_stack_title()
             self.update_plugin_title.emit()
         else:
             editor = None