File: //proc/self/root/opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyo
�
a�Nc @ sY d Z d d l Z d d l Z d d l Z y d d l m Z Wn! e k
ra d d l m Z n Xd d l Z d d l m Z d d l
Z
e Z d Z
d Z d d g Z d e f d � � YZ d
Z d e f d � � YZ d
e f d � � YZ d e f d � � YZ d e f d � � YZ e e d � r@e e e j � Z n e � Z e d � Z d S( sJ
An exception collector that finds traceback information plus
supplements
i����N( t StringIO( t serial_number_generators E-s UTF-8t collect_exceptiont ExceptionCollectorc B sb e Z d Z d Z d
d � Z d � Z d � Z d � Z d � Z d � Z
d
d � Z d � Z RS( s
Produces a data structure that can be used by formatters to
display exception reports.
Magic variables:
If you define one of these variables in your local scope, you can
add information to tracebacks that happen in that context. This
allows applications to add all sorts of extra information about
the context of the error, including URLs, environmental variables,
users, hostnames, etc. These are the variables we look for:
``__traceback_supplement__``:
You can define this locally or globally (unlike all the other
variables, which must be defined locally).
``__traceback_supplement__`` is a tuple of ``(factory, arg1,
arg2...)``. When there is an exception, ``factory(arg1, arg2,
...)`` is called, and the resulting object is inspected for
supplemental information.
``__traceback_info__``:
This information is added to the traceback, usually fairly
literally.
``__traceback_hide__``:
If set and true, this indicates that the frame should be
hidden from abbreviated tracebacks. This way you can hide
some of the complexity of the larger framework and let the
user focus on their own errors.
By setting it to ``'before'``, all frames before this one will
be thrown away. By setting it to ``'after'`` then all frames
after this will be thrown away until ``'reset'`` is found. In
each case the frame where it is set is included, unless you
append ``'_and_this'`` to the value (e.g.,
``'before_and_this'``).
Note that formatters will ignore this entirely if the frame
that contains the error wouldn't normally be shown according
to these rules.
``__traceback_reporter__``:
This should be a reporter object (see the reporter module),
or a list/tuple of reporter objects. All reporters found this
way will be given the exception, innermost first.
``__traceback_decorator__``:
This object (defined in a local or global scope) will get the
result of this function (the CollectedException defined
below). It may modify this object in place, or return an
entirely new object. This gives the object the ability to
manipulate the traceback arbitrarily.
The actually interpretation of these values is largely up to the
reporters and formatters.
``collect_exception(*sys.exc_info())`` will return an object with
several attributes:
``frames``:
A list of frames
``exception_formatted``:
The formatted exception, generally a full traceback
``exception_type``:
The type of the exception, like ``ValueError``
``exception_value``:
The string value of the exception, like ``'x not in list'``
``identification_code``:
A hash of the exception data meant to identify the general
exception, so that it shares this code with other exceptions
that derive from the same problem. The code is a hash of
all the module names and function names in the traceback,
plus exception_type. This should be shown to users so they
can refer to the exception later. (@@: should it include a
portion that allows identification of the specific instance
of the exception as well?)
The list of frames goes innermost first. Each frame has these
attributes; some values may be None if they could not be
determined.
``modname``:
the name of the module
``filename``:
the filename of the module
``lineno``:
the line of the error
``revision``:
the contents of __version__ or __revision__
``name``:
the function name
``supplement``:
an object created from ``__traceback_supplement__``
``supplement_exception``:
a simple traceback of any exception ``__traceback_supplement__``
created
``traceback_info``:
the str() of any ``__traceback_info__`` variable found in the local
scope (@@: should it str()-ify it or not?)
``traceback_hide``:
the value of any ``__traceback_hide__`` variable
``traceback_log``:
the value of any ``__traceback_log__`` variable
``__traceback_supplement__`` is thrown away, but a fixed
set of attributes are captured; each of these attributes is
optional.
``object``:
the name of the object being visited
``source_url``:
the original URL requested
``line``:
the line of source being executed (for interpreters, like ZPT)
``column``:
the column of source being executed
``expression``:
the expression being evaluated (also for interpreters)
``warnings``:
a list of (string) warnings to be displayed
``getInfo``:
a function/method that takes no arguments, and returns a string
describing any extra information
``extraData``:
a function/method that takes no arguments, and returns a
dictionary. The contents of this dictionary will not be
displayed in the context of the traceback, but globally for
the exception. Results will be grouped by the keys in the
dictionaries (which also serve as titles). The keys can also
be tuples of (importance, title); in this case the importance
should be ``important`` (shows up at top), ``normal`` (shows
up somewhere; unspecified), ``supplemental`` (shows up at
bottom), or ``extra`` (shows up hidden or not at all).
These are used to create an object with attributes of the same
names (``getInfo`` becomes a string attribute, not a method).
``__traceback_supplement__`` implementations should be careful to
produce values that are relatively static and unlikely to cause
further errors in the reporting system -- any complex
introspection should go in ``getInfo()`` and should ultimately
return a string.
Note that all attributes are optional, and under certain
circumstances may be None or may not exist at all -- the collector
can only do a best effort, but must avoid creating any exceptions
itself.
Formatters may want to use ``__traceback_hide__`` as a hint to
hide frames that are part of the 'framework' or underlying system.
There are a variety of rules about special values for this
variables that formatters should be aware of.
TODO:
More attributes in __traceback_supplement__? Maybe an attribute
that gives a list of local variables that should also be
collected? Also, attributes that would be explicitly meant for
the entire request, not just a single frame. Right now some of
the fixed set of attributes (e.g., source_url) are meant for this
use, but there's no explicit way for the supplement to indicate
new values, e.g., logged-in user, HTTP referrer, environment, etc.
Also, the attributes that do exist are Zope/Web oriented.
More information on frames? cgitb, for instance, produces
extensive information on local variables. There exists the
possibility that getting this information may cause side effects,
which can make debugging more difficult; but it also provides
fodder for post-mortem debugging. However, the collector is not
meant to be configurable, but to capture everything it can and let
the formatters be configurable. Maybe this would have to be a
configuration value, or maybe it could be indicated by another
magical variable (which would probably mean 'show all local
variables below this frame')
i c C s
| | _ d S( N( t limit( t selfR ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt __init__� s c C s. | j } | d k r* t t d d � } n | S( Nt tracebacklimit( R t Nonet getattrt sys( R R ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt getLimit� s c C sy | j s
d S| j d d � } | d k r@ | j d d � } n | d k ru y t | � j � } Wqu d } qu Xn | S( Nt __revision__t __version__s ???( t show_revisionsR t gett strt strip( R t globalst revision( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt getRevision� s
c C s� i } x$ d D] } t | | d � | | <q
Wt | d d � } | rU | � | d <n
d | d <t | d d � } | r� | � | d
<n
d | d
<t | � S( Nt objectt
source_urlt linet columnt
expressiont warningst getInfot infot extraDatat extra( s objects
source_urls lines columns
expressions warnings( R R t SupplementaryData( R t
supplementt tbt resultt namet func( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt collectSupplement� s
c C s� | j } | j } | j } | j } | j } | j } | j } t | d � sz t j d | j
d d � | f � i } n i }
| j
d d � |
d <| |
d <| |
d <| j | � |
d <| |
d <t
| � |
d
<| j d � r� | d } n" | j d � r| d } n d } | d k r�| d } | d
}
ys | |
� } | j | | � |
d <|
d j r�x= |
d j j � D]% \ } } | j | g � j | � q{Wn Wq�t r�t � } t j d | � | j � } | |
d <q�q�Xn y5 | j
d d � } | d k r!t | � |
d <n Wn n Xg } xZ d D]R } yB | j
| | j
| | � � } | | k r�| |
| d d !<n Wq9q9Xq9W|
S( Nt has_keys$ Frame %s has an invalid locals(): %rt __name__t unknownt modnamet filenamet linenoR R# t tbidt __traceback_supplement__i i R t filet supplement_exceptiont __traceback_info__t traceback_infot __traceback_hide__t __traceback_log__t __traceback_decorator__i i����( R2 R3 R4 ( t tb_framet tb_linenot f_codet co_filenamet co_namet f_globalst f_localst hasattrR t warnR R R t idR& R% R t itemst
setdefaultt appendt DEBUG_EXCEPTION_FORMATTERR t tracebackt print_exct getvalueR ( R R! t
extra_datat fR+ t coR* R# R t localst datat tbst factoryt argst suppt keyt valuet outt textt tbit markert tbh( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt collectLine sn
$
c C s t j | | � S( N( RC t format_exception_only( R t etypeRP ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt collectExceptionOnlyL s c C s
d } g } g } g } | d k r3 | j � } n d } i }
x� | d k r| d k sf | | k r| j j j d � r� | j d � Pn | j | |
� } t | � } | j | � | j d k r� | j | j � n | j | j p� d � | j | j
pd � | j } | d } qB W| j t | � � t
j d j | � d d d t d
t �}
t d | d | j | | � d
| d | j | � d |
d t j � d |
� } | t k r�t j g |
d <n x= | D]5 } y% | | � } | d k r�| } n Wq�q�Xq�W| S( Ni i t __exception_formatter__s& (Recursive formatException() stopped)
t ?t t lengthi t uppert prefixt framest exception_formattedt exception_typet exception_valuet identification_codet dateRF t importants sys.path( Rf s sys.path( R R R5 R; R RA RV t ExceptionFramet traceback_decoratorR) R# t tb_nextR R t hash_identifiert joint Truet DEBUG_IDENT_PREFIXt CollectedExceptionRY t safeStrt timet localtimet ImportErrorR
t path( R RX RP R! R RZ R` t
ident_datat traceback_decoratorst nRF RJ t framet identR" t decoratort
new_result( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt collectExceptionO sV '
c C s[ y t | � SWnF t k
rV y t | � j t d � SWqW t k
rR t | � SXn Xd S( Nt replace( R t UnicodeEncodeErrort unicodet encodet FALLBACK_ENCODINGt repr( R t obj( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyRo s
N(
R' t
__module__t __doc__R R R R R R% RV RY R{ Ro ( ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyR ( s � D 0i� t Bunchc B s e Z d Z d � Z d � Z RS( s
A generic container
c K s1 x* | j � D] \ } } t | | | � q
Wd S( N( R? t setattr( R t attrsR# RP ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyR � s c C sp d | j j } | d j g | j j � D]5 \ } } | j d � s) d | t | � d f ^ q) � 7} | d S( Ns <%s R\ t _s %s=%ri t >( t __class__R' Rk t __dict__R? t
startswithR ( R R# RP ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt __repr__� s
3( R' R� R� R R� ( ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyR� � s Rn c B s8 e Z d Z g Z d Z d Z d Z d Z d Z i Z
RS( se
This is the result of collection the exception; it contains copies
of data of interest.
N( R' R� R� R` R Ra Rb Rc Rd Re RF ( ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyRn � s R c B s8 e Z d Z d Z d Z d Z d Z d Z d Z d Z
RS( s�
The result of __traceback_supplement__. We don't keep the
supplement object around, for fear of GC problems and whatnot.
(@@: Maybe I'm being too superstitious about copying only specific
information over)
N( R' R� R� R R R R R R R R ( ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyR � s Rg c B s\ e Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z e Z
d Z d Z d d � Z RS( s�
This represents one frame of the exception. Each frame is a
context in the call stack, typically represented by a line
number and module name in the traceback.
i c C ss | j s | j r d Sg } xE t | j | | j | d � D]" } | j t j | j | � � q@ Wd j | � S( s2
Return the source of the current line of this frame. You
probably want to .strip() it as well, as it is likely to have
leading whitespace.
If context is given, then that many lines on either side will
also be returned. E.g., context=1 will give 3 lines.
i t N( R* R+ R t rangeRA t linecachet getlineRk ( R t contextt linesR+ ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt get_source_line� s ( N( R' R� R� R R) R* R+ R R# R R/ R1 t Falset traceback_hideRh R, R� ( ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyRg � s R c C s t j | | | d | �S( s�
Collection an exception from ``sys.exc_info()``.
Use like::
try:
blah blah
except:
exc_data = collect_exception(*sys.exc_info())
R ( t colR{ ( t tt vR! R ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyR s ( R� R
RC Rp t cStringIOR Rr R� t paste.exceptionsR R Rl RB Rm R� t __all__R R R R� Rn R Rg R< t minR R� R R ( ( ( sK /opt/alt/python27/lib/python2.7/site-packages/paste/exceptions/collector.pyt <module> s2
� c5