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

docs/autogen_shortcuts.py: support Python 3.8...

docs/autogen_shortcuts.py: support Python 3.8 In 64e72a955 (Restore shortcuts in documentation, define identifiers, 2023-01-08), some typing annotations were added to docs/autogen_shortcuts.py using the builtin container type 'list'. This feature is only available starting in Python 3.9 [1], but setup.cfg lists Python 3.8 as the earliest supported Python version. This leads to a failing documentation build in a Python 3.8 virtual environment. Fix this by using the capitalized name 'List' from the 'typing' module to keep Python 3.8 compatibility. [1] https://docs.python.org/3/whatsnew/3.9.html#type-hinting-generics-in-standard-collections

Matthias Bussonnier - - Load All Authors

File last commit:

r26419:7663c521


                r28181:2c9a826a

Download file

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

      # encoding: utf-8

      """Generic functions for extending IPython.

      """

      from IPython.core.error import TryNext

      from functools import singledispatch

      @singledispatch

      def inspect_object(obj):

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

          raise TryNext

      @singledispatch

      def complete_object(obj, prev_completions):

          """Custom completer dispatching for python objects.

          Parameters

          ----------

          obj : object

              The object to complete.

          prev_completions : list

              List of attributes discovered so far.

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

          add to the attributes already discovered normally, return

          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

				# encoding: utf-8
				"""Generic functions for extending IPython.
				"""

				from IPython.core.error import TryNext
				from functools import singledispatch


				@singledispatch
				def inspect_object(obj):
				"""Called when you do obj?"""
				raise TryNext


				@singledispatch
				def complete_object(obj, prev_completions):
				"""Custom completer dispatching for python objects.

				Parameters
				----------
				obj : object
				The object to complete.
				prev_completions : list
				List of attributes discovered so far.
				This should return the list of attributes in obj. If you only wish to
				add to the attributes already discovered normally, return
				own_attrs + prev_completions.
				"""
				raise TryNext