upstream/ipython Files · IPython/utils/generics.py

Allow to customise shortcuts using a traitlet (#13928)...

Allow to customise shortcuts using a traitlet (#13928) This is a refactor of keybindings code aiming to enable users to modify, disable, and add new shortcuts. Closes , relates to . ## Code changes - The filters are no longer defined as Python condition expression but as strings. This ensures that all shortcuts that we define can be unambiguously overridden by users from JSON config files. - All filters were moved to a new `filters.py` module - All commands previously defined in closure of `create_ipython_shortcuts(shell)` were moved to globals (which ensures nice identifier names and makes unit-testing easier) - All bindings are now collected in `KEY_BINDINGS` global variable; in future one could consider further splitting them up and moving bindings definition to respective modules (e.g. `AUTO_MATCH_BINDINGS` to `auto_match.py`). ## User-facing changes - New configuration traitlet: `c.TerminalInteractiveShell.shortcuts` - Accept single character in autosuggestion shortcut now uses <kbd>alt</kbd> + <kbd>right</kbd> instead of <kbd>right</kbd> (which is accepting the entire suggestion as in versions 8.8 and before). After a few iterations I arrived to a specification that separates the existing key/filter from the new key/filter and has a separate "create" flag used to indicate that a new shortcut should be created (rather than modifying an existing one): > Each entry on the list should be a dictionary with ``command`` key identifying the target function executed by the shortcut and at least one of the following: > - `match_keys`: list of keys used to match an existing shortcut, > - `match_filter`: shortcut filter used to match an existing shortcut, > - `new_keys`: list of keys to set, > - `new_filter`: a new shortcut filter to set > > The filters have to be composed of pre-defined verbs and joined by one of the following conjunctions: `&` (and), `|` (or), `~` (not). The pre-defined verbs are: ..... > > To disable a shortcut set `new_keys` to an empty list. To add a shortcut add key `create` with value `True`. When modifying/disabling shortcuts, `match_keys`/`match_filter` can be omitted if the provided specification uniquely identifies a shortcut to be overridden/disabled. > > When modifying a shortcut `new_filter` or `new_keys` can be omitted which will result in reuse of the existing filter/keys. > > Only shortcuts defined in IPython (and not default prompt toolkit shortcuts) can be modified or disabled.

Matthias Bussonnier - - Load All Authors

File last commit:

r26419:7663c521


                r28115:442c33cf

Download file

             generics.py
        
                    29 lines
            
             | 706 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / generics.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Brian Granger
    
Work to address the review comments on Fernando's branch....

              r2498
            
      # encoding: utf-8

        Brian Granger
    
Continuing a massive refactor of everything.

              r2205
            
      """Generic functions for extending IPython.

      """

        vivainio
    
crlf normalization

              r851
            
        Brian Granger
    
Continuing a massive refactor of everything.

              r2205
            
      from IPython.core.error import TryNext

        Hugo
    
Replace simplegeneric.generic with functools.singledispatch

              r24687
            
      from functools import singledispatch

        Brian Granger
    
Work to address the review comments on Fernando's branch....

              r2498
            
        Hugo
    
Replace simplegeneric.generic with functools.singledispatch

              r24687
            
      @singledispatch

        vivainio
    
crlf normalization

              r851
            
      def inspect_object(obj):

        Brian Granger
    
Continuing a massive refactor of everything.

              r2205
            
          """Called when you do obj?"""

        vivainio
    
crlf normalization

              r851
            
          raise TryNext

        vivainio
    
implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)

              r908
            
        Brian Granger
    
Work to address the review comments on Fernando's branch....

              r2498
            
        Hugo
    
Replace simplegeneric.generic with functools.singledispatch

              r24687
            
      @singledispatch

        vivainio
    
implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)

              r908
            
      def complete_object(obj, prev_completions):

        Brian Granger
    
Continuing a massive refactor of everything.

              r2205
            
          """Custom completer dispatching for python objects.

          Parameters

          ----------

          obj : object

              The object to complete.

          prev_completions : list

              List of attributes discovered so far.

        vivainio
    
implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)

              r908
            
          This should return the list of attributes in obj. If you only wish to

        Bernardo B. Marques
    
remove all trailling spaces

              r4872
            
          add to the attributes already discovered normally, return

        vivainio
    
implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)

              r908
            
          own_attrs + prev_completions.

          """

          raise TryNext

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Brian Granger Work to address the review comments on Fernando's branch....	r2498	# encoding: utf-8
Brian Granger Continuing a massive refactor of everything.	r2205	"""Generic functions for extending IPython.
		"""
vivainio crlf normalization	r851
Brian Granger Continuing a massive refactor of everything.	r2205	from IPython.core.error import TryNext
Hugo Replace simplegeneric.generic with functools.singledispatch	r24687	from functools import singledispatch
Brian Granger Work to address the review comments on Fernando's branch....	r2498

Hugo Replace simplegeneric.generic with functools.singledispatch	r24687	@singledispatch
vivainio crlf normalization	r851	def inspect_object(obj):
Brian Granger Continuing a massive refactor of everything.	r2205	"""Called when you do obj?"""
vivainio crlf normalization	r851	raise TryNext
vivainio implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)	r908
Brian Granger Work to address the review comments on Fernando's branch....	r2498
Hugo Replace simplegeneric.generic with functools.singledispatch	r24687	@singledispatch
vivainio implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)	r908	def complete_object(obj, prev_completions):
Brian Granger Continuing a massive refactor of everything.	r2205	"""Custom completer dispatching for python objects.

		Parameters
		----------
		obj : object
		The object to complete.
		prev_completions : list
		List of attributes discovered so far.
vivainio implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)	r908	This should return the list of attributes in obj. If you only wish to
Bernardo B. Marques remove all trailling spaces	r4872	add to the attributes already discovered normally, return
vivainio implement complete_object(obj, prev_completions) generic function to provide custom completers for python object attributes (as opposed to string dispatching)	r908	own_attrs + prev_completions.
		"""
		raise TryNext