upstream/ipython Files · IPython/Extensions/ipy_extutil.py

Remove svn-style $Id marks from docstrings and Release imports....

Remove svn-style $Id marks from docstrings and Release imports. The Id marks show up as junk in the API docs (and they were outdated anyway, since we now use bzr). The Release imports were in there for pulling author/license information for epydoc, but now with sphinx they aren't necessary, and they just are extra startup work.

vivainio - - Load All Authors

File last commit:

r680:5a2d2c1b


                r1853:b8f5152c

Download file

             ipy_extutil.py
        
                    43 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / Extensions / ipy_extutil.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """ IPython extension management tools.

      After installation, you'll have the 'extutil' object in your namespace.

      to.

      """

      # for the purposes of this module, every module that has the name 'ip' globally

      # installed as below is an IPython extension

      import IPython.ipapi

      ip = IPython.ipapi.get()

      import sys,textwrap,inspect

      def indent(s, ind= '    '):

          return '\n'.join([ind +l for l in s.splitlines()])

      class ExtUtil:

          """ IPython extensios (ipy_* etc.) management utilities """

          def describe(self):

              for n,mod in self._active():

                  doc = inspect.getdoc(mod)

                  if doc:

                      print '== %s ==' % n

                      print indent(doc)

          def ls(self):

              """ Show list of installed extensions. """

              for n,m in self._active():

                  print '%-20s %s' % (n,m.__file__.replace('\\','/'))

          def _active(self):

              act = []

              for mname,m in sys.modules.items():

                  o = getattr(m, 'ip', None)

                  if isinstance(o, IPython.ipapi.IPApi):

                      act.append((mname,m))

              act.sort()                

              return act

      extutil = ExtUtil()                

      ip.to_user_ns('extutil')

	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

				""" IPython extension management tools.

				After installation, you'll have the 'extutil' object in your namespace.
				to.
				"""

				# for the purposes of this module, every module that has the name 'ip' globally
				# installed as below is an IPython extension

				import IPython.ipapi
				ip = IPython.ipapi.get()

				import sys,textwrap,inspect

				def indent(s, ind= ' '):
				return '\n'.join([ind +l for l in s.splitlines()])

				class ExtUtil:
				""" IPython extensios (ipy_* etc.) management utilities """

				def describe(self):
				for n,mod in self._active():
				doc = inspect.getdoc(mod)
				if doc:
				print '== %s ==' % n
				print indent(doc)


				def ls(self):
				""" Show list of installed extensions. """
				for n,m in self._active():
				print '%-20s %s' % (n,m.__file__.replace('\\','/'))
				def _active(self):
				act = []
				for mname,m in sys.modules.items():
				o = getattr(m, 'ip', None)
				if isinstance(o, IPython.ipapi.IPApi):
				act.append((mname,m))
				act.sort()
				return act

				extutil = ExtUtil()
				ip.to_user_ns('extutil')