upstream/ipython Files · docs/sphinxext/magics.py

Simplify debugger classes....

Simplify debugger classes. Directly get the color scheme from the interactive shell (which is created if not already present, anyways). The goal is ultimately to allow the IPython debugger to be a drop-in replacement of the stdlib pdb with the same signature (in particular, this would obviate the need for plugins such as nose-ipdb and pytest-ipdb; nose and pytest could instead let their `--pdb` command line arg take an argument specifying the Pdb (sub)class to use, e.g. `py.test --pdb=IPython.core.debugger.Pdb`). Also deprecate the `Tracer` class (and related utilities), which can be fairly trivially replaced by `IPython.core.debugger.Pdb().set_trace()` (we can let `Pdb` catch `BdbQuit` itself).

Michael Droettboom - - Load All Authors

File last commit:

r21874:3ffdf6f9


                r22687:ec2d023d

Download file

             magics.py
        
                    45 lines
            
             | 1.4 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / docs / sphinxext / magics.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      import re

      from sphinx import addnodes

      from sphinx.domains.std import StandardDomain

      from sphinx.roles import XRefRole

      name_re = re.compile(r"[\w_]+")

      def parse_magic(env, sig, signode):

          m = name_re.match(sig)

          if not m:

              raise Exception("Invalid magic command: %s" % sig)

          name = "%" + sig

          signode += addnodes.desc_name(name, name)

          return m.group(0)

      class LineMagicRole(XRefRole):

          """Cross reference role displayed with a % prefix"""

          prefix = "%"

          def process_link(self, env, refnode, has_explicit_title, title, target):

              if not has_explicit_title:

                  title = self.prefix + title.lstrip("%")

              target = target.lstrip("%")

              return title, target

      def parse_cell_magic(env, sig, signode):

          m = name_re.match(sig)

          if not m:

              raise ValueError("Invalid cell magic: %s" % sig)

          name = "%%" + sig

          signode += addnodes.desc_name(name, name)

          return m.group(0)

      class CellMagicRole(LineMagicRole):

          """Cross reference role displayed with a %% prefix"""

          prefix = "%%"

      def setup(app):

          app.add_object_type('magic', 'magic', 'pair: %s; magic command', parse_magic)

          StandardDomain.roles['magic'] = LineMagicRole()

          app.add_object_type('cellmagic', 'cellmagic', 'pair: %s; cell magic', parse_cell_magic)

          StandardDomain.roles['cellmagic'] = CellMagicRole()

          metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}

          return metadata

	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

				import re
				from sphinx import addnodes
				from sphinx.domains.std import StandardDomain
				from sphinx.roles import XRefRole

				name_re = re.compile(r"[\w_]+")

				def parse_magic(env, sig, signode):
				m = name_re.match(sig)
				if not m:
				raise Exception("Invalid magic command: %s" % sig)
				name = "%" + sig
				signode += addnodes.desc_name(name, name)
				return m.group(0)

				class LineMagicRole(XRefRole):
				"""Cross reference role displayed with a % prefix"""
				prefix = "%"

				def process_link(self, env, refnode, has_explicit_title, title, target):
				if not has_explicit_title:
				title = self.prefix + title.lstrip("%")
				target = target.lstrip("%")
				return title, target

				def parse_cell_magic(env, sig, signode):
				m = name_re.match(sig)
				if not m:
				raise ValueError("Invalid cell magic: %s" % sig)
				name = "%%" + sig
				signode += addnodes.desc_name(name, name)
				return m.group(0)

				class CellMagicRole(LineMagicRole):
				"""Cross reference role displayed with a %% prefix"""
				prefix = "%%"

				def setup(app):
				app.add_object_type('magic', 'magic', 'pair: %s; magic command', parse_magic)
				StandardDomain.roles['magic'] = LineMagicRole()
				app.add_object_type('cellmagic', 'cellmagic', 'pair: %s; cell magic', parse_cell_magic)
				StandardDomain.roles['cellmagic'] = CellMagicRole()

				metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
				return metadata