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

Thomas Kluyver - - Load All Authors

File last commit:

r9244:666fdfa8


                r10962:f96aac3a

Download file

             encoding.py
        
                    56 lines
            
             | 2.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / encoding.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # coding: utf-8

      """

      Utilities for dealing with text encodings

      """

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

      #  Copyright (C) 2008-2012  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

      import locale

      # to deal with the possibility of sys.std* not being a stream at all

      def get_stream_enc(stream, default=None):

          """Return the given stream's encoding or a default.

          There are cases where ``sys.std*`` might not actually be a stream, so

          check for the encoding attribute prior to returning it, and return

          a default if it doesn't exist or evaluates as False. ``default``

          is None if not provided.

          """

          if not hasattr(stream, 'encoding') or not stream.encoding:

              return default

          else:

              return stream.encoding

      # Less conservative replacement for sys.getdefaultencoding, that will try

      # to match the environment.

      # Defined here as central function, so if we find better choices, we

      # won't need to make changes all over IPython.

      def getdefaultencoding():

          """Return IPython's guess for the default encoding for bytes as text.

          Asks for stdin.encoding first, to match the calling Terminal, but that

          is often None for subprocesses.  Fall back on locale.getpreferredencoding()

          which should be a sensible platform default (that respects LANG environment),

          and finally to sys.getdefaultencoding() which is the most conservative option,

          and usually ASCII.

          """

          enc = get_stream_enc(sys.stdin)

          if not enc or enc=='ascii':

              try:

                  # There are reports of getpreferredencoding raising errors

                  # in some cases, which may well be fixed, but let's be conservative here.

                  enc = locale.getpreferredencoding()

              except Exception:

                  pass

          return enc or sys.getdefaultencoding()

      DEFAULT_ENCODING = getdefaultencoding()

	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

				# coding: utf-8
				"""
				Utilities for dealing with text encodings
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2012 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
				import locale

				# to deal with the possibility of sys.std* not being a stream at all
				def get_stream_enc(stream, default=None):
				"""Return the given stream's encoding or a default.

				There are cases where ``sys.std*`` might not actually be a stream, so
				check for the encoding attribute prior to returning it, and return
				a default if it doesn't exist or evaluates as False. ``default``
				is None if not provided.
				"""
				if not hasattr(stream, 'encoding') or not stream.encoding:
				return default
				else:
				return stream.encoding

				# Less conservative replacement for sys.getdefaultencoding, that will try
				# to match the environment.
				# Defined here as central function, so if we find better choices, we
				# won't need to make changes all over IPython.
				def getdefaultencoding():
				"""Return IPython's guess for the default encoding for bytes as text.

				Asks for stdin.encoding first, to match the calling Terminal, but that
				is often None for subprocesses. Fall back on locale.getpreferredencoding()
				which should be a sensible platform default (that respects LANG environment),
				and finally to sys.getdefaultencoding() which is the most conservative option,
				and usually ASCII.
				"""
				enc = get_stream_enc(sys.stdin)
				if not enc or enc=='ascii':
				try:
				# There are reports of getpreferredencoding raising errors
				# in some cases, which may well be fixed, but let's be conservative here.
				enc = locale.getpreferredencoding()
				except Exception:
				pass
				return enc or sys.getdefaultencoding()

				DEFAULT_ENCODING = getdefaultencoding()