upstream/ipython Files · IPython/utils/ulinecache.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.

Jörgen Stenarson - - Load All Authors

File last commit:

r8335:50c631dd


                r10962:f96aac3a

Download file

             ulinecache.py
        
                    45 lines
            
             | 1.6 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / ulinecache.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Wrapper around linecache which decodes files to unicode according to PEP 263.

      This is only needed for Python 2 - linecache in Python 3 does the same thing

      itself.

      """

      import functools

      import linecache

      import sys

      from IPython.utils import py3compat

      from IPython.utils import openpy

      if py3compat.PY3:

          getline = linecache.getline

          # getlines has to be looked up at runtime, because doctests monkeypatch it.

          @functools.wraps(linecache.getlines)

          def getlines(filename, module_globals=None):

              return linecache.getlines(filename, module_globals=module_globals)

      else:

          def getlines(filename, module_globals=None):

              """Get the lines (as unicode) for a file from the cache.

              Update the cache if it doesn't contain an entry for this file already."""

              filename = py3compat.cast_bytes(filename, sys.getfilesystemencoding())

              lines = linecache.getlines(filename, module_globals=module_globals)

              # The bits we cache ourselves can be unicode.

              if (not lines) or isinstance(lines[0], unicode):

                  return lines

              readline = openpy._list_readline(lines)

              try:

                  encoding, _ = openpy.detect_encoding(readline)

              except SyntaxError:

                  encoding = 'ascii'

              return [l.decode(encoding, 'replace') for l in lines]

          # This is a straight copy of linecache.getline

          def getline(filename, lineno, module_globals=None):

              lines = getlines(filename, module_globals)

              if 1 <= lineno <= len(lines):

                  return lines[lineno-1]

              else:

                  return ''

	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

				"""Wrapper around linecache which decodes files to unicode according to PEP 263.

				This is only needed for Python 2 - linecache in Python 3 does the same thing
				itself.
				"""
				import functools
				import linecache
				import sys

				from IPython.utils import py3compat
				from IPython.utils import openpy

				if py3compat.PY3:
				getline = linecache.getline

				# getlines has to be looked up at runtime, because doctests monkeypatch it.
				@functools.wraps(linecache.getlines)
				def getlines(filename, module_globals=None):
				return linecache.getlines(filename, module_globals=module_globals)

				else:
				def getlines(filename, module_globals=None):
				"""Get the lines (as unicode) for a file from the cache.
				Update the cache if it doesn't contain an entry for this file already."""
				filename = py3compat.cast_bytes(filename, sys.getfilesystemencoding())
				lines = linecache.getlines(filename, module_globals=module_globals)

				# The bits we cache ourselves can be unicode.
				if (not lines) or isinstance(lines[0], unicode):
				return lines

				readline = openpy._list_readline(lines)
				try:
				encoding, _ = openpy.detect_encoding(readline)
				except SyntaxError:
				encoding = 'ascii'
				return [l.decode(encoding, 'replace') for l in lines]

				# This is a straight copy of linecache.getline
				def getline(filename, lineno, module_globals=None):
				lines = getlines(filename, module_globals)
				if 1 <= lineno <= len(lines):
				return lines[lineno-1]
				else:
				return ''