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

Add -q option (suppress print upon creation) to %macro...

Add -q option (suppress print upon creation) to %macro Macros are very, very useful and "Matlab" like (as well as other similar math computing environs). Often I (or my students) use a macro to load long complex code from a url -- e.g., large data sets, simulated data, preprocessing of data, special plotting commands, grading routines... Currently, this requires defining the macro at the end of the notebook so when the "print upon creation" occurs it doesn't overwhelm the notebook (except at the end). The -q option suppresses the print contents upon creation. Example with a Matplotlib example: In[1]: %macro tmp http://matplotlib.org/mpl_examples/api/date_demo.py Macro `tmp` created. To execute, type its name (without quotes). === Macro contents: === """ Show how to make date plots in matplotlib using date tick locators and formatters. See major_minor_demo1.py for more information on controlling major and minor ticks ... In[2]: %macro -q tmp2 http://matplotlib.org/mpl_examples/api/date_demo.py (nothing) Perhaps, though, the first line should print -- e.g., Macro `tmp` created. To execute, type its name (without quotes). In the docstraing, I also fixed a typo (an "as" that should be an "at") and clarified how to produce an example output.

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r10962:f96aac3a

Download file

             syspathcontext.py
        
                    69 lines
            
             | 2.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / syspathcontext.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """

      Context managers for adding things to sys.path temporarily.

      Authors:

      * Brian Granger

      """

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

      #  Copyright (C) 2008-2011  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

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

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

      # Imports

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

      import sys

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

      # Code

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

      class appended_to_syspath(object):

          """A context for appending a directory to sys.path for a second."""

          def __init__(self, dir):

              self.dir = dir

          def __enter__(self):

              if self.dir not in sys.path:

                  sys.path.append(self.dir)

                  self.added = True

              else:

                  self.added = False

          def __exit__(self, type, value, traceback):

              if self.added:

                  try:

                      sys.path.remove(self.dir)

                  except ValueError:

                      pass

              # Returning False causes any exceptions to be re-raised.

              return False

      class prepended_to_syspath(object):

          """A context for prepending a directory to sys.path for a second."""

          def __init__(self, dir):

              self.dir = dir

          def __enter__(self):

              if self.dir not in sys.path:

                  sys.path.insert(0,self.dir)

                  self.added = True

              else:

                  self.added = False

          def __exit__(self, type, value, traceback):

              if self.added:

                  try:

                      sys.path.remove(self.dir)

                  except ValueError:

                      pass

              # Returning False causes any exceptions to be re-raised.

              return False

	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
				"""
				Context managers for adding things to sys.path temporarily.

				Authors:

				* Brian Granger
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2011 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				import sys

				#-----------------------------------------------------------------------------
				# Code
				#-----------------------------------------------------------------------------

				class appended_to_syspath(object):
				"""A context for appending a directory to sys.path for a second."""

				def __init__(self, dir):
				self.dir = dir

				def __enter__(self):
				if self.dir not in sys.path:
				sys.path.append(self.dir)
				self.added = True
				else:
				self.added = False

				def __exit__(self, type, value, traceback):
				if self.added:
				try:
				sys.path.remove(self.dir)
				except ValueError:
				pass
				# Returning False causes any exceptions to be re-raised.
				return False

				class prepended_to_syspath(object):
				"""A context for prepending a directory to sys.path for a second."""

				def __init__(self, dir):
				self.dir = dir

				def __enter__(self):
				if self.dir not in sys.path:
				sys.path.insert(0,self.dir)
				self.added = True
				else:
				self.added = False

				def __exit__(self, type, value, traceback):
				if self.added:
				try:
				sys.path.remove(self.dir)
				except ValueError:
				pass
				# Returning False causes any exceptions to be re-raised.
				return False