[Python-checkins] cpython: Issue #25011: rlcomplete now omits private and special attribute names unless

[serhiy.storchaka]

https://hg.python.org/cpython/rev/4dbb315fe667
changeset:   98326:4dbb315fe667
user:        Serhiy Storchaka <storchaka at gmail.com>
date:        Sun Sep 27 13:43:50 2015 +0300
summary:
  Issue #25011: rlcomplete now omits private and special attribute names unless
the prefix starts with underscores.

files:
  Doc/whatsnew/3.6.rst         |   8 +++++
  Lib/rlcompleter.py           |  35 +++++++++++++++++------
  Lib/test/test_rlcompleter.py |  15 ++++++++++
  Misc/NEWS                    |   3 ++
  4 files changed, 51 insertions(+), 10 deletions(-)


diff --git a/Doc/whatsnew/3.6.rst b/Doc/whatsnew/3.6.rst
--- a/Doc/whatsnew/3.6.rst
+++ b/Doc/whatsnew/3.6.rst
@@ -103,6 +103,14 @@
   (Contributed by Joe Jevnik in :issue:`24379`.)
 
 
+rlcomplete
+----------
+
+Private and special attribute names now are omitted unless the prefix starts
+with underscores.  A space or a colon can be added after completed keyword.
+(Contributed by Serhiy Storchaka in :issue:`25011` and :issue:`25209`.)
+
+
 Optimizations
 =============
 
diff --git a/Lib/rlcompleter.py b/Lib/rlcompleter.py
--- a/Lib/rlcompleter.py
+++ b/Lib/rlcompleter.py
@@ -142,20 +142,35 @@
             return []
 
         # get the content of the object, except __builtins__
-        words = dir(thisobject)
-        if "__builtins__" in words:
-            words.remove("__builtins__")
+        words = set(dir(thisobject))
+        words.discard("__builtins__")
 
         if hasattr(thisobject, '__class__'):
-            words.append('__class__')
-            words.extend(get_class_members(thisobject.__class__))
+            words.add('__class__')
+            words.update(get_class_members(thisobject.__class__))
         matches = []
         n = len(attr)
-        for word in words:
-            if word[:n] == attr and hasattr(thisobject, word):
-                val = getattr(thisobject, word)
-                word = self._callable_postfix(val, "%s.%s" % (expr, word))
-                matches.append(word)
+        if attr == '':
+            noprefix = '_'
+        elif attr == '_':
+            noprefix = '__'
+        else:
+            noprefix = None
+        while True:
+            for word in words:
+                if (word[:n] == attr and
+                    not (noprefix and word[:n+1] == noprefix) and
+                    hasattr(thisobject, word)):
+                    val = getattr(thisobject, word)
+                    word = self._callable_postfix(val, "%s.%s" % (expr, word))
+                    matches.append(word)
+            if matches or not noprefix:
+                break
+            if noprefix == '_':
+                noprefix = '__'
+            else:
+                noprefix = None
+        matches.sort()
         return matches
 
 def get_class_members(klass):
diff --git a/Lib/test/test_rlcompleter.py b/Lib/test/test_rlcompleter.py
--- a/Lib/test/test_rlcompleter.py
+++ b/Lib/test/test_rlcompleter.py
@@ -5,6 +5,7 @@
 class CompleteMe:
     """ Trivial class used in testing rlcompleter.Completer. """
     spam = 1
+    _ham = 2
 
 
 class TestRlcompleter(unittest.TestCase):
@@ -51,11 +52,25 @@
                          ['str.{}('.format(x) for x in dir(str)
                           if x.startswith('s')])
         self.assertEqual(self.stdcompleter.attr_matches('tuple.foospamegg'), [])
+        expected = sorted({'None.%s%s' % (x, '(' if x != '__doc__' else '')
+                           for x in dir(None)})
+        self.assertEqual(self.stdcompleter.attr_matches('None.'), expected)
+        self.assertEqual(self.stdcompleter.attr_matches('None._'), expected)
+        self.assertEqual(self.stdcompleter.attr_matches('None.__'), expected)
 
         # test with a customized namespace
         self.assertEqual(self.completer.attr_matches('CompleteMe.sp'),
                          ['CompleteMe.spam'])
         self.assertEqual(self.completer.attr_matches('Completeme.egg'), [])
+        self.assertEqual(self.completer.attr_matches('CompleteMe.'),
+                         ['CompleteMe.mro(', 'CompleteMe.spam'])
+        self.assertEqual(self.completer.attr_matches('CompleteMe._'),
+                         ['CompleteMe._ham'])
+        matches = self.completer.attr_matches('CompleteMe.__')
+        for x in matches:
+            self.assertTrue(x.startswith('CompleteMe.__'), x)
+        self.assertIn('CompleteMe.__name__', matches)
+        self.assertIn('CompleteMe.__new__(', matches)
 
         CompleteMe.me = CompleteMe
         self.assertEqual(self.completer.attr_matches('CompleteMe.me.me.sp'),
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -27,6 +27,9 @@
 Library
 -------
 
+- Issue #25011: rlcomplete now omits private and special attribute names unless
+  the prefix starts with underscores.
+
 - Issue #25209: rlcomplete now can add a space or a colon after completed keyword.
 
 - Issue #22241: timezone.utc name is now plain 'UTC', not 'UTC-00:00'.

-- 
Repository URL: https://hg.python.org/cpython