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

Change return type in docstring to literal tuple to avoid bogus cross-ref....

Change return type in docstring to literal tuple to avoid bogus cross-ref. Before this change the Sphinx tried to produce cross-reference links for the returned (stdout, stderr) tuple. The docs build produced a warning because there are 2 possible cross-ref objects for `stdout`, one in `IPython.testing.iptestcontroller.TestController`, the other in `IPython.utils.capture.CapturedIO`. Neither of those is correct in the context of the `ipexec()` function. Changing literal ``(stdout, stderr)`` avoids the warning by preventing the attempt to produce cross-references.

Min RK - - Load All Authors

File last commit:

r20859:5f42d500


                r24067:fcbe9bad

Download file

             importstring.py
        
                    39 lines
            
             | 1.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / importstring.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """

      A simple utility to import something by its string name.

      """

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      def import_item(name):

          """Import and return ``bar`` given the string ``foo.bar``.

          Calling ``bar = import_item("foo.bar")`` is the functional equivalent of

          executing the code ``from foo import bar``.

          Parameters

          ----------

          name : string

            The fully qualified name of the module/package being imported.

          Returns

          -------

          mod : module object

             The module that was imported.

          """

          parts = name.rsplit('.', 1)

          if len(parts) == 2:

              # called with 'foo.bar....'

              package, obj = parts

              module = __import__(package, fromlist=[obj])

              try:

                  pak = getattr(module, obj)

              except AttributeError:

                  raise ImportError('No module named %s' % obj)

              return pak

          else:

              # called with un-dotted string

              return __import__(parts[0])

	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
				"""
				A simple utility to import something by its string name.
				"""

				# Copyright (c) IPython Development Team.
				# Distributed under the terms of the Modified BSD License.


				def import_item(name):
				"""Import and return ``bar`` given the string ``foo.bar``.

				Calling ``bar = import_item("foo.bar")`` is the functional equivalent of
				executing the code ``from foo import bar``.

				Parameters
				----------
				name : string
				The fully qualified name of the module/package being imported.

				Returns
				-------
				mod : module object
				The module that was imported.
				"""

				parts = name.rsplit('.', 1)
				if len(parts) == 2:
				# called with 'foo.bar....'
				package, obj = parts
				module = __import__(package, fromlist=[obj])
				try:
				pak = getattr(module, obj)
				except AttributeError:
				raise ImportError('No module named %s' % obj)
				return pak
				else:
				# called with un-dotted string
				return __import__(parts[0])