upstream/ipython Files · IPython/core/magics/deprecated.py

Renamed @register_magics to @magics_class to avoid confusion....

Renamed @register_magics to @magics_class to avoid confusion. The main ipython object also has a .register_magics method that must often be used in close proximity to the class decorator, yet does something completely different. Having these two objects with the same name yet different purposes was proving to be quite confusing in my testing usage so far.

Fernando Perez - - Load All Authors

File last commit:

r6973:1f1d8fa1


                r6973:1f1d8fa1

Download file

             deprecated.py
        
                    45 lines
            
             | 1.8 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / magics / deprecated.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Fernando Perez
    
Create core.magics.deprecated according to new API.

              r6969
            
      """Deprecated Magic functions.

        Fernando Perez
    
Separate magic code into base file and implementation of magics....

              r6919
            
      """

      #-----------------------------------------------------------------------------

        Fernando Perez
    
Create core.magics.deprecated according to new API.

              r6969
            
      #  Copyright (c) 2012 The IPython Development Team.

      #

      #  Distributed under the terms of the Modified BSD License.

      #

      #  The full license is in the file COPYING.txt, distributed with this software.

        Fernando Perez
    
Separate magic code into base file and implementation of magics....

              r6919
            
      #-----------------------------------------------------------------------------

        Fernando Perez
    
Create core.magics.config according to new API.

              r6961
            
        Fernando Perez
    
Separate magic code into base file and implementation of magics....

              r6919
            
      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

        Fernando Perez
    
Create core.magics.config according to new API.

              r6961
            
        Fernando Perez
    
Create core.magics.code according to new API.

              r6960
            
      # Our own packages

        Fernando Perez
    
Renamed @register_magics to @magics_class to avoid confusion....

              r6973
            
      from IPython.core.magic import Magics, magics_class, line_magic

        Fernando Perez
    
Separate magic code into base file and implementation of magics....

              r6919
            
        Fernando Perez
    
Create core.magics.code according to new API.

              r6960
            
      #-----------------------------------------------------------------------------

      # Magic implementation classes

      #-----------------------------------------------------------------------------

        Fernando Perez
    
Separate magic code into base file and implementation of magics....

              r6919
            
        Fernando Perez
    
Renamed @register_magics to @magics_class to avoid confusion....

              r6973
            
      @magics_class

        Fernando Perez
    
Add all decorators to tag magics....

              r6922
            
      class DeprecatedMagics(Magics):

          """Magics slated for later removal."""

        Fernando Perez
    
Add proper initialization of magics to main shell instance....

              r6923
            
        Fernando Perez
    
Add all decorators to tag magics....

              r6922
            
          @line_magic

          def install_profiles(self, parameter_s=''):

              """%install_profiles has been deprecated."""

              print '\n'.join([

                  "%install_profiles has been deprecated.",

                  "Use `ipython profile list` to view available profiles.",

                  "Requesting a profile with `ipython profile create <name>`",

                  "or `ipython --profile=<name>` will start with the bundled",

                  "profile of that name if it exists."

              ])

          @line_magic

          def install_default_config(self, parameter_s=''):

              """%install_default_config has been deprecated."""

              print '\n'.join([

                  "%install_default_config has been deprecated.",

                  "Use `ipython profile create <name>` to initialize a profile",

                  "with the default config files.",

                  "Add `--reset` to overwrite already existing config files with defaults."

              ])

	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

Fernando Perez Create core.magics.deprecated according to new API.	r6969	"""Deprecated Magic functions.
Fernando Perez Separate magic code into base file and implementation of magics....	r6919	"""
		#-----------------------------------------------------------------------------
Fernando Perez Create core.magics.deprecated according to new API.	r6969	# Copyright (c) 2012 The IPython Development Team.
		#
		# Distributed under the terms of the Modified BSD License.
		#
		# The full license is in the file COPYING.txt, distributed with this software.
Fernando Perez Separate magic code into base file and implementation of magics....	r6919	#-----------------------------------------------------------------------------
Fernando Perez Create core.magics.config according to new API.	r6961
Fernando Perez Separate magic code into base file and implementation of magics....	r6919	#-----------------------------------------------------------------------------
		# Imports
		#-----------------------------------------------------------------------------
Fernando Perez Create core.magics.config according to new API.	r6961
Fernando Perez Create core.magics.code according to new API.	r6960	# Our own packages
Fernando Perez Renamed @register_magics to @magics_class to avoid confusion....	r6973	from IPython.core.magic import Magics, magics_class, line_magic
Fernando Perez Separate magic code into base file and implementation of magics....	r6919
Fernando Perez Create core.magics.code according to new API.	r6960	#-----------------------------------------------------------------------------
		# Magic implementation classes
		#-----------------------------------------------------------------------------
Fernando Perez Separate magic code into base file and implementation of magics....	r6919
Fernando Perez Renamed @register_magics to @magics_class to avoid confusion....	r6973	@magics_class
Fernando Perez Add all decorators to tag magics....	r6922	class DeprecatedMagics(Magics):
		"""Magics slated for later removal."""
Fernando Perez Add proper initialization of magics to main shell instance....	r6923
Fernando Perez Add all decorators to tag magics....	r6922	@line_magic
		def install_profiles(self, parameter_s=''):
		"""%install_profiles has been deprecated."""
		print '\n'.join([
		"%install_profiles has been deprecated.",
		"Use `ipython profile list` to view available profiles.",
		"Requesting a profile with `ipython profile create <name>`",
		"or `ipython --profile=<name>` will start with the bundled",
		"profile of that name if it exists."
		])

		@line_magic
		def install_default_config(self, parameter_s=''):
		"""%install_default_config has been deprecated."""
		print '\n'.join([
		"%install_default_config has been deprecated.",
		"Use `ipython profile create <name>` to initialize a profile",
		"with the default config files.",
		"Add `--reset` to overwrite already existing config files with defaults."
		])