gh-130472: Integrate fancycompleter with the new repl, to get colored tab completions #130473

antocuni · 2025-02-22T20:54:40Z

As the title says, this is (WIP) to integrate fancycompleter into the new REPL.

Issue: Use colors in tab-completion in PyREPL #130472

… now

…'t work because they need to be ported from pytest to unittest

…n exception when evaluated, just color it as None

hugovk

Exciting! Just some nits.

hugovk · 2025-02-22T21:16:03Z

Lib/_colorize.py

+    BOLD_BLUE = "\x1b[1;34m"
    BOLD_GREEN = "\x1b[1;32m"
    BOLD_MAGENTA = "\x1b[1;35m"
    BOLD_RED = "\x1b[1;31m"
+    BOLD_TEAL = "\x1b[1;36m"


ANSI colour with code 36 is more commonly called cyan: https://en.wikipedia.org/wiki/ANSI_escape_code#Colors

Suggested change

BOLD_BLUE = "\x1b[1;34m"

BOLD_GREEN = "\x1b[1;32m"

BOLD_MAGENTA = "\x1b[1;35m"

BOLD_RED = "\x1b[1;31m"

BOLD_TEAL = "\x1b[1;36m"

BOLD_BLUE = "\x1b[1;34m"

BOLD_CYAN = "\x1b[1;36m"

BOLD_GREEN = "\x1b[1;32m"

BOLD_MAGENTA = "\x1b[1;35m"

BOLD_RED = "\x1b[1;31m"

hugovk · 2025-02-22T21:17:05Z

Lib/_colorize.py

    BLACK = "\x1b[30m"
    GREEN = "\x1b[32m"
    GREY = "\x1b[90m"
    MAGENTA = "\x1b[35m"
    RED = "\x1b[31m"
    RESET = "\x1b[0m"
+    TEAL = "\x1b[36m"


Suggested change

BLACK = "\x1b[30m"

GREEN = "\x1b[32m"

GREY = "\x1b[90m"

MAGENTA = "\x1b[35m"

RED = "\x1b[31m"

RESET = "\x1b[0m"

TEAL = "\x1b[36m"

BLACK = "\x1b[30m"

CYAN = "\x1b[36m"

GREEN = "\x1b[32m"

GREY = "\x1b[90m"

MAGENTA = "\x1b[35m"

RED = "\x1b[31m"

RESET = "\x1b[0m"

hugovk · 2025-02-22T21:17:35Z

Lib/_pyrepl/fancycompleter.py

+        types.BuiltinMethodType: ANSIColors.BOLD_TEAL,
+        types.MethodType: ANSIColors.BOLD_TEAL,
+        type((42).__add__): ANSIColors.BOLD_TEAL,
+        type(int.__add__): ANSIColors.BOLD_TEAL,
+        type(str.replace): ANSIColors.BOLD_TEAL,


Suggested change

types.BuiltinMethodType: ANSIColors.BOLD_TEAL,

types.MethodType: ANSIColors.BOLD_TEAL,

type((42).__add__): ANSIColors.BOLD_TEAL,

type(int.__add__): ANSIColors.BOLD_TEAL,

type(str.replace): ANSIColors.BOLD_TEAL,

types.BuiltinMethodType: ANSIColors.BOLD_CYAN,

types.MethodType: ANSIColors.BOLD_CYAN,

type((42).__add__): ANSIColors.BOLD_CYAN,

type(int.__add__): ANSIColors.BOLD_CYAN,

type(str.replace): ANSIColors.BOLD_CYAN,

Hugo's suggestion & using types from types

Suggested change

types.BuiltinMethodType: ANSIColors.BOLD_TEAL,

types.MethodType: ANSIColors.BOLD_TEAL,

type((42).__add__): ANSIColors.BOLD_TEAL,

type(int.__add__): ANSIColors.BOLD_TEAL,

type(str.replace): ANSIColors.BOLD_TEAL,

types.BuiltinMethodType: ANSIColors.BOLD_CYAN,

types.MethodType: ANSIColors.BOLD_CYAN,

types.MethodWrapperType: ANSIColors.BOLD_CYAN,

types.WrapperDescriptorType: ANSIColors.BOLD_CYAN,

types.MethodDescriptorType: ANSIColors.BOLD_CYAN,

hugovk · 2025-02-22T21:17:44Z

Lib/_pyrepl/fancycompleter.py

+
+        type: ANSIColors.BOLD_MAGENTA,
+
+        types.ModuleType: ANSIColors.TEAL,


Suggested change

types.ModuleType: ANSIColors.TEAL,

types.ModuleType: ANSIColors.CYAN,

hugovk · 2025-02-22T21:20:26Z

Lib/_pyrepl/fancycompleter.py

+#
+#                        All Rights Reserved
+"""
+Colorful TAB completion for Python prompt


Suggested change

Colorful TAB completion for Python prompt

Colorful tab completion for Python prompt

hugovk · 2025-02-22T21:27:48Z

Lib/_pyrepl/fancycompleter.py

+            # this is needed to offer pyrepl a better chance to patch
+            # raw_input. Usually, it does at import time, but is we are under
+            # pytest with output captured, at import time we don't have a
+            # terminal and thus the raw_input hook is not installed


Suggested change

# this is needed to offer pyrepl a better chance to patch

# raw_input. Usually, it does at import time, but is we are under

# pytest with output captured, at import time we don't have a

# terminal and thus the raw_input hook is not installed

# This is needed to offer PyREPL a better chance to patch

# raw_input. Usually, it does at import time, but if we are under

# pytest with output captured, at import time we don't have a

# terminal and thus the raw_input hook is not installed.

hugovk · 2025-02-22T21:28:19Z

Lib/_pyrepl/fancycompleter.py

+        # disable automatic insertion of '(' for global callables:
+        # this method exists only in Python 2.6+


Doesn't matter in CPython 3.14 in 2025 :)

Suggested change

# disable automatic insertion of '(' for global callables:

# this method exists only in Python 2.6+

# disable automatic insertion of '(' for global callables

hugovk · 2025-02-22T21:30:08Z

Lib/test/test_pyrepl/test_fancycompleter.py

+        # in this case, we want to display all attributes which start with
+        # 'a'. MOREOVER, we also include a space to prevent readline to
+        # automatically insert the common prefix (which will the the ANSI escape
+        # sequence if we use colors)


Suggested change

# in this case, we want to display all attributes which start with

# 'a'. MOREOVER, we also include a space to prevent readline to

# automatically insert the common prefix (which will the the ANSI escape

# sequence if we use colors)

# In this case, we want to display all attributes which start with

# 'a'. Moreover, we also include a space to prevent readline to

# automatically insert the common prefix (which will the the ANSI escape

# sequence if we use colors).

hugovk · 2025-02-22T21:31:00Z

Lib/test/test_pyrepl/test_fancycompleter.py

+        # finally, at the next TAB, we display again all the completions available
+        # for this common prefix. Agai, we insert a spurious space to prevent the
+        # automatic completion of ANSI sequences


Suggested change

# finally, at the next TAB, we display again all the completions available

# for this common prefix. Agai, we insert a spurious space to prevent the

# automatic completion of ANSI sequences

# Finally, at the next tab, we display again all the completions available

# for this common prefix. Again, we insert a spurious space to prevent the

# automatic completion of ANSI sequences.

hugovk · 2025-02-22T21:32:07Z

Lib/_pyrepl/fancycompleter.py

+                   for i, name, obj
+                   in zip(count(), names, values)]
+        # We add a space at the end to prevent the automatic completion of the
+        # common prefix, which is the ANSI ESCAPE sequence.


Suggested change

# common prefix, which is the ANSI ESCAPE sequence.

# common prefix, which is the ANSI escape sequence.

tomasr8 · 2025-02-22T21:59:34Z

Lib/_pyrepl/fancycompleter.py

+        # XXX: double check what happens in this case once fancycompleter works
+        if False and hasattr(readline, '_setup'):
+            # this is needed to offer pyrepl a better chance to patch
+            # raw_input. Usually, it does at import time, but is we are under


Suggested change

# raw_input. Usually, it does at import time, but is we are under

# raw_input. Usually, it does at import time, but if we are under

tomasr8 · 2025-02-22T22:02:19Z

Lib/_pyrepl/fancycompleter.py

+            return []
+
+        if len(names) == 1:
+            return ['%s.%s' % (expr, names[0])]  # only option, no coloring.


Suggested change

return ['%s.%s' % (expr, names[0])] # only option, no coloring.

return [f'{expr}.{names[0]}'] # only option, no coloring.

tomasr8 · 2025-02-22T22:02:50Z

Lib/_pyrepl/fancycompleter.py

+
+        prefix = commonprefix(names)
+        if prefix and prefix != attr:
+            return ['%s.%s' % (expr, prefix)]  # autocomplete prefix


Suggested change

return ['%s.%s' % (expr, prefix)] # autocomplete prefix

return [f'{expr}.{prefix}'] # autocomplete prefix

tomasr8 · 2025-02-22T22:07:05Z

Lib/_pyrepl/fancycompleter.py

+                   for i, name, obj
+                   in zip(count(), names, values)]


Maybe? This also lets you remove the itertools import.

Suggested change

for i, name, obj

in zip(count(), names, values)]

for i, (name, obj)

in enumerate(zip(names, values))]

tomasr8 · 2025-02-22T22:09:00Z

Lib/_pyrepl/readline.py

@@ -587,7 +588,12 @@ def _setup(namespace: Mapping[str, Any]) -> None:
    # set up namespace in rlcompleter, which requires it to be a bona fide dict
    if not isinstance(namespace, dict):
        namespace = dict(namespace)
-    _wrapper.config.readline_completer = RLCompleter(namespace).complete
+
+    if os.getenv('PYTHON_BASIC_COMPLETER'):


Should this variable be documented?

tomasr8 · 2025-02-22T22:10:14Z

Lib/test/test_pyrepl/test_fancycompleter.py

+    def test_unicode_in___dir__(self):
+        class Foo(object):
+            def __dir__(self):
+                return [u'hello', 'world']


Suggested change

return [u'hello', 'world']

return ['hello', 'world']

AA-Turner · 2025-02-26T23:18:37Z

Lib/_pyrepl/fancycompleter.py

+#   Copyright 2010-2025 Antonio Cuni
+#                       Daniel Hahler
+#
+#                        All Rights Reserved


Should this have a licence grant (e.g. BSD-3-Clause)? If so, we should add it here and to the included software licences section.

Another option, which might be slightly nicer, is for the contributors of the relevant bits of fancycompleter to sign the CLA and have this work relicenced under the PSF licence. This seems to include @blueyed, @theY4Kman, @singingwolfboy, and @slinkp.

I'm happy to do so

I only made this one obsolete commit to fancycompleter 13 years ago, but i'll sign if it helps :) How do I do that?

AA-Turner · 2025-02-26T23:19:19Z

Lib/_pyrepl/fancycompleter.py

+"""
+Colorful TAB completion for Python prompt
+"""


Suggested change

"""

Colorful TAB completion for Python prompt

"""

"""Colorful tab completion for the Python prompt"""

AA-Turner · 2025-02-26T23:19:55Z

Lib/_pyrepl/fancycompleter.py

+from _colorize import ANSIColors
+import rlcompleter
+import types
+from itertools import count


Can be removed with the enumerate suggestion

Suggested change

from itertools import count

AA-Turner · 2025-02-26T23:22:40Z

Lib/_pyrepl/fancycompleter.py

+        types.BuiltinMethodType: ANSIColors.BOLD_TEAL,
+        types.MethodType: ANSIColors.BOLD_TEAL,
+        type((42).__add__): ANSIColors.BOLD_TEAL,
+        type(int.__add__): ANSIColors.BOLD_TEAL,
+        type(str.replace): ANSIColors.BOLD_TEAL,


Hugo's suggestion & using types from types

Suggested change

types.BuiltinMethodType: ANSIColors.BOLD_TEAL,

types.MethodType: ANSIColors.BOLD_TEAL,

type((42).__add__): ANSIColors.BOLD_TEAL,

type(int.__add__): ANSIColors.BOLD_TEAL,

type(str.replace): ANSIColors.BOLD_TEAL,

types.BuiltinMethodType: ANSIColors.BOLD_CYAN,

types.MethodType: ANSIColors.BOLD_CYAN,

types.MethodWrapperType: ANSIColors.BOLD_CYAN,

types.WrapperDescriptorType: ANSIColors.BOLD_CYAN,

types.MethodDescriptorType: ANSIColors.BOLD_CYAN,

AA-Turner · 2025-02-26T23:23:14Z

Lib/_pyrepl/fancycompleter.py

+        type: ANSIColors.BOLD_MAGENTA,
+
+        types.ModuleType: ANSIColors.TEAL,
+        type(None): ANSIColors.GREY,


Suggested change

type(None): ANSIColors.GREY,

types.NoneType: ANSIColors.GREY,

AA-Turner · 2025-02-26T23:26:31Z

Lib/_pyrepl/fancycompleter.py

+        return word
+
+    def global_matches(self, text):
+        import keyword


Is a lazy import worth it here?

AA-Turner · 2025-02-26T23:29:53Z

Lib/_pyrepl/fancycompleter.py

+        words = set(dir(thisobject))
+        words.discard("__builtins__")


Suggested change

words = set(dir(thisobject))

words.discard("__builtins__")

words = set(dir(thisobject)) - {'__builtins__'}

AA-Turner · 2025-02-26T23:31:19Z

Lib/_pyrepl/fancycompleter.py

+                if (word[:n] == attr and
+                        not (noprefix and word[:n+1] == noprefix)):


Style:

Suggested change

if (word[:n] == attr and

not (noprefix and word[:n+1] == noprefix)):

if (

word[:n] == attr

and not (noprefix and word[:n+1] == noprefix)

):

AA-Turner · 2025-02-26T23:31:59Z

Lib/_pyrepl/fancycompleter.py

+    """ return the common prefix of all 'names' starting with 'base'
+    """


Suggested change

""" return the common prefix of all 'names' starting with 'base'

"""

"""Return the common prefix of all 'names' starting with 'base'"""

AA-Turner · 2025-02-26T23:32:44Z

Lib/_pyrepl/readline.py

@@ -35,6 +35,7 @@
 from site import gethistoryfile   # type: ignore[attr-defined]
 import sys
 from rlcompleter import Completer as RLCompleter
+from .fancycompleter import Completer as FancyCompleter


Sort this import below from .console?

antocuni added 19 commits February 18, 2025 16:34

import fancycompleter from pdbpp/fancycompleter@67e3ec1

4eb226b

add copyright notice

c5dfc85

enable FancyCompleter by default, unless you set PYTHON_BASIC_COMPLETER

b561a2e

WIP: kill a lot of code which is no longer necessary

5f56673

force colors for now

40563f2

kill the logic to find a readline, we can always use _pyrepl.readline…

88181da

… now

kill LazyVersion

77c578a

we surely don't need to support python 2.7 now :)

9069419

kill ConfigurableClass

bdbe022

better name

0ea7c49

use _colorize instead of our own Color

6ddfa61

WIP: copy&adapt some tests from the original fancycompleter. They don…

30abd71

…'t work because they need to be ported from pytest to unittest

edited by copilot: move from pytest-style to unittest-style

983824a

don't try to be too clever with exceptions: if a global name raises a…

acbafe4

…n exception when evaluated, just color it as None

no longer needed

5546b94

this doesn't test anything meaningful

327648f

fix this test

44549b9

fix this test

c9c97f7

Fix this test

c61bab6

bedevere-app bot mentioned this pull request Feb 22, 2025

Use colors in tab-completion in PyREPL #130472

Open

hugovk reviewed Feb 22, 2025

View reviewed changes

tomasr8 reviewed Feb 22, 2025

View reviewed changes

AA-Turner reviewed Feb 26, 2025

View reviewed changes


		type: ANSIColors.BOLD_MAGENTA,

		types.ModuleType: ANSIColors.TEAL,

	types.ModuleType: ANSIColors.TEAL,
	types.ModuleType: ANSIColors.CYAN,

	Colorful TAB completion for Python prompt
	Colorful tab completion for Python prompt

		# disable automatic insertion of '(' for global callables:
		# this method exists only in Python 2.6+

	# common prefix, which is the ANSI ESCAPE sequence.
	# common prefix, which is the ANSI escape sequence.

	# raw_input. Usually, it does at import time, but is we are under
	# raw_input. Usually, it does at import time, but if we are under

	return ['%s.%s' % (expr, names[0])] # only option, no coloring.
	return [f'{expr}.{names[0]}'] # only option, no coloring.

	return ['%s.%s' % (expr, prefix)] # autocomplete prefix
	return [f'{expr}.{prefix}'] # autocomplete prefix

	type(None): ANSIColors.GREY,
	types.NoneType: ANSIColors.GREY,

	words = set(dir(thisobject))
	words.discard("__builtins__")
	words = set(dir(thisobject)) - {'__builtins__'}

		if (word[:n] == attr and
		not (noprefix and word[:n+1] == noprefix)):

		""" return the common prefix of all 'names' starting with 'base'
		"""

	""" return the common prefix of all 'names' starting with 'base'
	"""
	"""Return the common prefix of all 'names' starting with 'base'"""

Uh oh!

gh-130472: Integrate fancycompleter with the new repl, to get colored tab completions #130473

Are you sure you want to change the base?

gh-130472: Integrate fancycompleter with the new repl, to get colored tab completions #130473

Uh oh!

Conversation

antocuni commented Feb 22, 2025 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

antocuni commented Feb 22, 2025 •

edited by bedevere-app bot

Loading