upstream/ipython Files · IPython/quarantine/ipy_which.py

Backport PR : Unicode content crashes the pager (console)...

Backport PR : Unicode content crashes the pager (console) We've run into an interesting bug in the astropy project. https://github.com/astropy/astropy/issues/600 When displaying a docstring that contains Unicode and is also long enough that it gets sent to the pager it fails since the docstring can't be sent to the pager as ascii. This crashes in the middle of sending content to the pager, so the shell ends up in an inconsistent state and stops echoing the keyboard etc. The fix (attached) is merely to encode the content sent to the pager in the same encoding as the terminal (`sys.stdout.encoding`). Strictly speaking, this isn't always the right thing to do, since the pager may be configured to expect a different encoding than the terminal, but that is sort of an irrational way to configure a machine... ;) For example, `less`, in the absence of any special environment variables to tell it otherwise, uses the standard `LC*` environment variables to determine what to do, which should be the same mechanism the terminal also uses by default. If anyone can suggest a better fix, I'm all for it. Perhaps it should be configurable, defaulting to `sys.stdout.encoding`?

Brian Granger - - Load All Authors

File last commit:

r2267:928c921b


                r9853:7f9a133e

Download file

             ipy_which.py
        
                    76 lines
            
             | 1.9 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / quarantine / ipy_which.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      r""" %which magic command

      %which <cmd> => search PATH for files matching PATH. Also scans aliases

      """

      from IPython.core import ipapi

      ip = ipapi.get()

      import os,sys

      from fnmatch import fnmatch

      def which(fname):

          fullpath = filter(os.path.isdir,os.environ['PATH'].split(os.pathsep))

          if '.' not in fullpath:

              fullpath = ['.'] + fullpath

          fn = fname

          for p in fullpath:

              for f in os.listdir(p):

                  head, ext = os.path.splitext(f)

                  if f == fn or fnmatch(head, fn):

                      yield os.path.join(p,f)

          return

      def which_alias(fname):

          for al, tgt in ip.alias_table.items():

              if not (al == fname or fnmatch(al, fname)):

                  continue

              if callable(tgt):

                  print "Callable alias",tgt

                  d = tgt.__doc__

                  if d:

                      print "Docstring:\n",d

                      continue

              trg = tgt[1]

              trans = ip.expand_alias(trg)

              cmd = trans.split(None,1)[0]

              print al,"->",trans

              for realcmd in which(cmd):

                  print "  ==",realcmd

      def which_f(self, arg):

          r""" %which <cmd> => search PATH for files matching cmd. Also scans aliases.

          Traverses PATH and prints all files (not just executables!) that match the

          pattern on command line. Probably more useful in finding stuff

          interactively than 'which', which only prints the first matching item.

          Also discovers and expands aliases, so you'll see what will be executed

          when you call an alias.

          Example:

          [~]|62> %which d

          d -> ls -F --color=auto

            == c:\cygwin\bin\ls.exe

          c:\cygwin\bin\d.exe

          [~]|64> %which diff*

          diff3 -> diff3

            == c:\cygwin\bin\diff3.exe

          diff -> diff

            == c:\cygwin\bin\diff.exe

          c:\cygwin\bin\diff.exe

          c:\cygwin\bin\diff3.exe

          """

          which_alias(arg)

          for e in which(arg):

              print e

      ip.define_magic("which",which_f)

	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

				r""" %which magic command

				%which <cmd> => search PATH for files matching PATH. Also scans aliases

				"""

				from IPython.core import ipapi
				ip = ipapi.get()

				import os,sys
				from fnmatch import fnmatch
				def which(fname):
				fullpath = filter(os.path.isdir,os.environ['PATH'].split(os.pathsep))

				if '.' not in fullpath:
				fullpath = ['.'] + fullpath
				fn = fname
				for p in fullpath:
				for f in os.listdir(p):
				head, ext = os.path.splitext(f)
				if f == fn or fnmatch(head, fn):
				yield os.path.join(p,f)
				return

				def which_alias(fname):
				for al, tgt in ip.alias_table.items():
				if not (al == fname or fnmatch(al, fname)):
				continue
				if callable(tgt):
				print "Callable alias",tgt
				d = tgt.__doc__
				if d:
				print "Docstring:\n",d
				continue
				trg = tgt[1]

				trans = ip.expand_alias(trg)
				cmd = trans.split(None,1)[0]
				print al,"->",trans
				for realcmd in which(cmd):
				print " ==",realcmd

				def which_f(self, arg):
				r""" %which <cmd> => search PATH for files matching cmd. Also scans aliases.

				Traverses PATH and prints all files (not just executables!) that match the
				pattern on command line. Probably more useful in finding stuff
				interactively than 'which', which only prints the first matching item.

				Also discovers and expands aliases, so you'll see what will be executed
				when you call an alias.

				Example:

				[~]\|62> %which d
				d -> ls -F --color=auto
				== c:\cygwin\bin\ls.exe
				c:\cygwin\bin\d.exe

				[~]\|64> %which diff*
				diff3 -> diff3
				== c:\cygwin\bin\diff3.exe
				diff -> diff
				== c:\cygwin\bin\diff.exe
				c:\cygwin\bin\diff.exe
				c:\cygwin\bin\diff3.exe

				"""

				which_alias(arg)

				for e in which(arg):
				print e

				ip.define_magic("which",which_f)