etc/emacs.py

   1 """Definitions used by commands sent to inferior Python in python.el."""
   2
   3 # Copyright (C) 2004, 2005, 2006, 2007  Free Software Foundation, Inc.
   4 # Author: Dave Love <fx@gnu.org>
   5
   6 # This file is part of GNU Emacs.
   7
   8 # GNU Emacs is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2, or (at your option)
  11 # any later version.
  12
  13 # GNU Emacs is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17
  18 # You should have received a copy of the GNU General Public License
  19 # along with GNU Emacs; see the file COPYING.  If not, write to the
  20 # Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21 # Boston, MA 02110-1301, USA.
  22
  23 import os, sys, traceback, inspect, __main__
  24 from sets import Set
  25
  26 __all__ = ["eexecfile", "eargs", "complete", "ehelp", "eimport", "modpath"]
  27
  28 def format_exception (filename, should_remove_self):
  29     type, value, tb = sys.exc_info ()
  30     sys.last_type = type
  31     sys.last_value = value
  32     sys.last_traceback = tb
  33     if type is SyntaxError:
  34         try: # parse the error message
  35             msg, (dummy_filename, lineno, offset, line) = value
  36         except:
  37             pass # Not the format we expect; leave it alone
  38         else:
  39             # Stuff in the right filename
  40             value = SyntaxError(msg, (filename, lineno, offset, line))
  41             sys.last_value = value
  42     res = traceback.format_exception_only (type, value)
  43     # There are some compilation errors which do not provide traceback so we
  44     # should not massage it.
  45     if should_remove_self:
  46         tblist = traceback.extract_tb (tb)
  47         del tblist[:1]
  48         res = traceback.format_list (tblist)
  49         if res:
  50             res.insert(0, "Traceback (most recent call last):\n")
  51         res[len(res):] = traceback.format_exception_only (type, value)
  52     # traceback.print_exception(type, value, tb)
  53     for line in res: print line,
  54
  55 def eexecfile (file):
  56     """Execute FILE and then remove it.
  57     Execute the file within the __main__ namespace.
  58     If we get an exception, print a traceback with the top frame
  59     (ourselves) excluded."""
  60     # We cannot use real execfile since it has a bug where the file stays
  61     # locked forever (under w32) if SyntaxError occurs.
  62     # --- code based on code.py and PyShell.py.
  63     try:
  64         try:
  65             source = open (file, "r").read()
  66             code = compile (source, file, "exec")
  67         # Other exceptions (shouldn't be any...) will (correctly) fall
  68         # through to "final".
  69         except (OverflowError, SyntaxError, ValueError):
  70             # FIXME: When can compile() raise anything else than
  71             # SyntaxError ????
  72             format_exception (file, False)
  73             return
  74         try:
  75             exec code in __main__.__dict__
  76         except:
  77             format_exception (file, True)
  78     finally:
  79         os.remove (file)
  80
  81 def eargs (name, imports):
  82     "Get arglist of NAME for Eldoc &c."
  83     try:
  84         if imports: exec imports
  85         parts = name.split ('.')
  86         if len (parts) > 1:
  87             exec 'import ' + parts[0] # might fail
  88         func = eval (name)
  89         if inspect.isbuiltin (func) or type(func) is type:
  90             doc = func.__doc__
  91             if doc.find (' ->') != -1:
  92                 print '_emacs_out', doc.split (' ->')[0]
  93             else:
  94                 print '_emacs_out', doc.split ('\n')[0]
  95             return
  96         if inspect.ismethod (func):
  97             func = func.im_func
  98         if not inspect.isfunction (func):
  99             print '_emacs_out '
 100             return
 101         (args, varargs, varkw, defaults) = inspect.getargspec (func)
 102         # No space between name and arglist for consistency with builtins.
 103         print '_emacs_out', \
 104             func.__name__ + inspect.formatargspec (args, varargs, varkw,
 105                                                    defaults)
 106     except:
 107         print "_emacs_out "
 108
 109 def all_names (object):
 110     """Return (an approximation to) a list of all possible attribute
 111     names reachable via the attributes of OBJECT, i.e. roughly the
 112     leaves of the dictionary tree under it."""
 113
 114     def do_object (object, names):
 115         if inspect.ismodule (object):
 116             do_module (object, names)
 117         elif inspect.isclass (object):
 118             do_class (object, names)
 119         # Might have an object without its class in scope.
 120         elif hasattr (object, '__class__'):
 121             names.add ('__class__')
 122             do_class (object.__class__, names)
 123         # Probably not a good idea to try to enumerate arbitrary
 124         # dictionaries...
 125         return names
 126
 127     def do_module (module, names):
 128         if hasattr (module, '__all__'): # limited export list
 129             names.union_update (module.__all__)
 130             for i in module.__all__:
 131                 do_object (getattr (module, i), names)
 132         else:                   # use all names
 133             names.union_update (dir (module))
 134             for i in dir (module):
 135                 do_object (getattr (module, i), names)
 136         return names
 137
 138     def do_class (object, names):
 139         ns = dir (object)
 140         names.union_update (ns)
 141         if hasattr (object, '__bases__'): # superclasses
 142             for i in object.__bases__: do_object (i, names)
 143         return names
 144
 145     return do_object (object, Set ([]))
 146
 147 def complete (name, imports):
 148     """Complete TEXT in NAMESPACE and print a Lisp list of completions.
 149     Exec IMPORTS first."""
 150     import __main__, keyword
 151
 152     def class_members(object):
 153         names = dir (object)
 154         if hasattr (object, '__bases__'):
 155             for super in object.__bases__:
 156                 names = class_members (super)
 157         return names
 158
 159     names = Set ([])
 160     base = None
 161     try:
 162         dict = __main__.__dict__.copy()
 163         if imports: exec imports in dict
 164         l = len (name)
 165         if not "." in name:
 166             for list in [dir (__builtins__), keyword.kwlist, dict.keys()]:
 167                 for elt in list:
 168                     if elt[:l] == name: names.add(elt)
 169         else:
 170             base = name[:name.rfind ('.')]
 171             name = name[name.rfind('.')+1:]
 172             try:
 173                 object = eval (base, dict)
 174                 names = Set (dir (object))
 175                 if hasattr (object, '__class__'):
 176                     names.add('__class__')
 177                     names.union_update (class_members (object))
 178             except: names = all_names (dict)
 179     except: return []
 180     l = len(name)
 181     print '_emacs_out (',
 182     for n in names:
 183         if name == n[:l]:
 184             if base: print '"%s.%s"' % (base, n),
 185             else: print '"%s"' % n,
 186     print ')'
 187
 188 def ehelp (name, imports):
 189     """Get help on string NAME.
 190     First try to eval name for, e.g. user definitions where we need
 191     the object.  Otherwise try the string form."""
 192     locls = {}
 193     if imports:
 194         try: exec imports in locls
 195         except: pass
 196     try: help (eval (name, globals(), locls))
 197     except: help (name)
 198
 199 def eimport (mod, dir):
 200     """Import module MOD with directory DIR at the head of the search path.
 201     NB doesn't load from DIR if MOD shadows a system module."""
 202     from __main__ import __dict__
 203
 204     path0 = sys.path[0]
 205     sys.path[0] = dir
 206     try:
 207         try:
 208             if __dict__.has_key(mod) and inspect.ismodule (__dict__[mod]):
 209                 reload (__dict__[mod])
 210             else:
 211                 __dict__[mod] = __import__ (mod)
 212         except:
 213             (type, value, tb) = sys.exc_info ()
 214             print "Traceback (most recent call last):"
 215             traceback.print_exception (type, value, tb.tb_next)
 216     finally:
 217         sys.path[0] = path0
 218
 219 def modpath (module):
 220     """Return the source file for the given MODULE (or None).
 221 Assumes that MODULE.py and MODULE.pyc are in the same directory."""
 222     try:
 223         path = __import__ (module).__file__
 224         if path[-4:] == '.pyc' and os.path.exists (path[0:-1]):
 225             path = path[:-1]
 226         print "_emacs_out", path
 227     except:
 228         print "_emacs_out ()"
 229
 230 # print '_emacs_ok'             # ready for input and can call continuation
 231
 232 # arch-tag: d90408f3-90e2-4de4-99c2-6eb9c7b9ca46