diff options
author | michele.simionato <devnull@localhost> | 2007-12-02 11:13:11 +0000 |
---|---|---|
committer | michele.simionato <devnull@localhost> | 2007-12-02 11:13:11 +0000 |
commit | 20ce686b0193d67ea56823a30551140f88b3aee1 (patch) | |
tree | 76015e7e4dc0b000bd857a2bdba6fb7976ac29a7 /pypers/pep318/pydoc.html | |
parent | f08f40335ad7f0ac961f25dabaaed34c4d4bcc44 (diff) | |
download | micheles-20ce686b0193d67ea56823a30551140f88b3aee1.tar.gz |
Commited all py papers into Google code
Diffstat (limited to 'pypers/pep318/pydoc.html')
-rwxr-xr-x | pypers/pep318/pydoc.html | 508 |
1 files changed, 508 insertions, 0 deletions
diff --git a/pypers/pep318/pydoc.html b/pypers/pep318/pydoc.html new file mode 100755 index 0000000..8de6660 --- /dev/null +++ b/pypers/pep318/pydoc.html @@ -0,0 +1,508 @@ + +<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module decorators</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>decorators</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/mnt/exp/MyDocs/pypers/pep318/decorators.py">/mnt/exp/MyDocs/pypers/pep318/decorators.py</a></font></td></tr></table> + <p><tt>A module to implement pep318 (decorator syntax) via magic doctrings.<br> +For the documentation see<br> + <br> +<a href="http://www.phyast.pitt.edu/~micheles/python/decorators,html">http://www.phyast.pitt.edu/~micheles/python/decorators,html</a><br> + <br> +and the on-line help.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> + +<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> +<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__builtin__.html">__builtin__</a><br> +<a href="inspect.html">inspect</a><br> +</td><td width="25%" valign=top><a href="noconflict.html">noconflict</a><br> +<a href="re.html">re</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="decorators.html#UnknownDecoratorError">UnknownDecoratorError</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="decorators.html#Decorator">Decorator</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="decorators.html#ClassDecorator">ClassDecorator</a>(<a href="__builtin__.html#type">__builtin__.type</a>, <a href="decorators.html#Decorator">Decorator</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="decorators.html#Decorated">Decorated</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="decorators.html#MethodDecorator">MethodDecorator</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="decorators.html#classmethod">classmethod</a> +</font></dt><dt><font face="helvetica, arial"><a href="decorators.html#staticmethod">staticmethod</a> +</font></dt></dl> +</dd> +</dl> +</dd> +</dl> +</dd> +<dt><font face="helvetica, arial"><a href="__builtin__.html#type">__builtin__.type</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="decorators.html#ClassDecorator">ClassDecorator</a>(<a href="__builtin__.html#type">__builtin__.type</a>, <a href="decorators.html#Decorator">Decorator</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="decorators.html#Decorated">Decorated</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="decorators.html#MetaDecorator">MetaDecorator</a> +</font></dt></dl> +</dd> +</dl> + <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ClassDecorator">class <strong>ClassDecorator</strong></a>(<a href="__builtin__.html#type">__builtin__.type</a>, <a href="decorators.html#Decorator">Decorator</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Metaclass callable with one or three arguments, having its calling<br> +syntax redefined by the meta-metaclass <a href="#MetaDecorator">MetaDecorator</a>. It redefines<br> +__str__ both on classes and instances.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="decorators.html#ClassDecorator">ClassDecorator</a></dd> +<dd><a href="__builtin__.html#type">__builtin__.type</a></dd> +<dd><a href="decorators.html#Decorator">Decorator</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ClassDecorator-__init__"><strong>__init__</strong></a>(cls, name, bases, dic)</dt></dl> + +<dl><dt><a name="ClassDecorator-__str__"><strong>__str__</strong></a>(cls)</dt></dl> + +<hr> +Methods inherited from <a href="__builtin__.html#type">__builtin__.type</a>:<br> +<dl><dt><a name="ClassDecorator-__call__"><strong>__call__</strong></a>(...)</dt><dd><tt>x.<a href="#ClassDecorator-__call__">__call__</a>(...) <==> x(...)</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#ClassDecorator-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClassDecorator-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ClassDecorator-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#ClassDecorator-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClassDecorator-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClassDecorator-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-__subclasses__"><strong>__subclasses__</strong></a>(...)</dt><dd><tt><a href="#ClassDecorator-__subclasses__">__subclasses__</a>() -> list of immediate subclasses</tt></dd></dl> + +<dl><dt><a name="ClassDecorator-mro"><strong>mro</strong></a>(...)</dt><dd><tt><a href="#ClassDecorator-mro">mro</a>() -> list<br> +return a <a href="__builtin__.html#type">type</a>'s method resolution order</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="__builtin__.html#type">__builtin__.type</a>:<br> +<dl><dt><strong>__base__</strong> = <type 'type'></dl> + +<dl><dt><strong>__bases__</strong> = (<type 'type'>, <class 'decorators.Decorator'>)</dl> + +<dl><dt><strong>__basicsize__</strong> = 420</dl> + +<dl><dt><strong>__dict__</strong> = <dictproxy object></dl> + +<dl><dt><strong>__dictoffset__</strong> = 132</dl> + +<dl><dt><strong>__flags__</strong> = 22523</dl> + +<dl><dt><strong>__itemsize__</strong> = 20</dl> + +<dl><dt><strong>__mro__</strong> = (<class 'decorators.ClassDecorator'>, <type 'type'>, <class 'decorators.Decorator'>, <type 'object'>)</dl> + +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ClassDecorator-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with <a href="__builtin__.html#type">type</a> S, a subtype of T</tt></dl> + +<dl><dt><strong>__weakrefoffset__</strong> = 184</dl> + +<hr> +Data and other attributes inherited from <a href="decorators.html#Decorator">Decorator</a>:<br> +<dl><dt><strong>__metaclass__</strong> = <class 'decorators.MetaDecorator'><dd><tt>Metaclass inducing a certain amount of magic on decorators:<br> +1. Each time a decorator is defined in any module, it is stored in<br> + <a href="#MetaDecorator">MetaDecorator</a>.dic and <a href="#MetaDecorator">MetaDecorator</a>.ls.<br> +2. If the (method) decorator has a 'get' method, a '__get__' method<br> + is automagically created as an alias to 'get'.<br> +3. Decorators calls are dispatched to the decorator _call_<br> + <a href="#classmethod">classmethod</a>.</tt></dl> + +<dl><dt><strong>__weakref__</strong> = <attribute '__weakref__' of 'Decorator' objects><dd><tt>list of weak references to the <a href="__builtin__.html#object">object</a> (if defined)</tt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="Decorated">class <strong>Decorated</strong></a>(<a href="decorators.html#ClassDecorator">ClassDecorator</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Metaclass which decorates its instances<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="decorators.html#Decorated">Decorated</a></dd> +<dd><a href="decorators.html#ClassDecorator">ClassDecorator</a></dd> +<dd><a href="__builtin__.html#type">__builtin__.type</a></dd> +<dd><a href="decorators.html#Decorator">Decorator</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Decorated-__init__"><strong>__init__</strong></a>(cls, name, bases, dic)</dt></dl> + +<hr> +Methods inherited from <a href="decorators.html#ClassDecorator">ClassDecorator</a>:<br> +<dl><dt><a name="Decorated-__str__"><strong>__str__</strong></a>(cls)</dt></dl> + +<hr> +Methods inherited from <a href="__builtin__.html#type">__builtin__.type</a>:<br> +<dl><dt><a name="Decorated-__call__"><strong>__call__</strong></a>(...)</dt><dd><tt>x.<a href="#Decorated-__call__">__call__</a>(...) <==> x(...)</tt></dd></dl> + +<dl><dt><a name="Decorated-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Decorated-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl> + +<dl><dt><a name="Decorated-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Decorated-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="Decorated-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Decorated-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="Decorated-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Decorated-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl> + +<dl><dt><a name="Decorated-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Decorated-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="Decorated-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Decorated-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="Decorated-__subclasses__"><strong>__subclasses__</strong></a>(...)</dt><dd><tt><a href="#Decorated-__subclasses__">__subclasses__</a>() -> list of immediate subclasses</tt></dd></dl> + +<dl><dt><a name="Decorated-mro"><strong>mro</strong></a>(...)</dt><dd><tt><a href="#Decorated-mro">mro</a>() -> list<br> +return a <a href="__builtin__.html#type">type</a>'s method resolution order</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="__builtin__.html#type">__builtin__.type</a>:<br> +<dl><dt><strong>__base__</strong> = <class 'decorators.ClassDecorator'></dl> + +<dl><dt><strong>__bases__</strong> = (<class 'decorators.ClassDecorator'>,)</dl> + +<dl><dt><strong>__basicsize__</strong> = 420</dl> + +<dl><dt><strong>__dict__</strong> = <dictproxy object></dl> + +<dl><dt><strong>__dictoffset__</strong> = 132</dl> + +<dl><dt><strong>__flags__</strong> = 22523</dl> + +<dl><dt><strong>__itemsize__</strong> = 20</dl> + +<dl><dt><strong>__mro__</strong> = (<class 'decorators.Decorated'>, <class 'decorators.ClassDecorator'>, <type 'type'>, <class 'decorators.Decorator'>, <type 'object'>)</dl> + +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Decorated-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with <a href="__builtin__.html#type">type</a> S, a subtype of T</tt></dl> + +<dl><dt><strong>__weakrefoffset__</strong> = 184</dl> + +<hr> +Data and other attributes inherited from <a href="decorators.html#Decorator">Decorator</a>:<br> +<dl><dt><strong>__metaclass__</strong> = <class 'decorators.MetaDecorator'><dd><tt>Metaclass inducing a certain amount of magic on decorators:<br> +1. Each time a decorator is defined in any module, it is stored in<br> + <a href="#MetaDecorator">MetaDecorator</a>.dic and <a href="#MetaDecorator">MetaDecorator</a>.ls.<br> +2. If the (method) decorator has a 'get' method, a '__get__' method<br> + is automagically created as an alias to 'get'.<br> +3. Decorators calls are dispatched to the decorator _call_<br> + <a href="#classmethod">classmethod</a>.</tt></dl> + +<dl><dt><strong>__weakref__</strong> = <attribute '__weakref__' of 'Decorator' objects><dd><tt>list of weak references to the <a href="__builtin__.html#object">object</a> (if defined)</tt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="Decorator">class <strong>Decorator</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Instance of <a href="#MetaDecorator">MetaDecorator</a> and mothers of all decorators. When called<br> +in the form <a href="#Decorator">Decorator</a>(obj), with obj having a magic docstring, it returns<br> +an instance of the correct decorator, otherwise it returns None.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Data and other attributes defined here:<br> +<dl><dt><strong>__dict__</strong> = <dictproxy object><dd><tt>dictionary for instance variables (if defined)</tt></dl> + +<dl><dt><strong>__metaclass__</strong> = <class 'decorators.MetaDecorator'><dd><tt>Metaclass inducing a certain amount of magic on decorators:<br> +1. Each time a decorator is defined in any module, it is stored in<br> + <a href="#MetaDecorator">MetaDecorator</a>.dic and <a href="#MetaDecorator">MetaDecorator</a>.ls.<br> +2. If the (method) decorator has a 'get' method, a '__get__' method<br> + is automagically created as an alias to 'get'.<br> +3. Decorators calls are dispatched to the decorator _call_<br> + <a href="#classmethod">classmethod</a>.</tt></dl> + +<dl><dt><strong>__weakref__</strong> = <attribute '__weakref__' of 'Decorator' objects><dd><tt>list of weak references to the <a href="__builtin__.html#object">object</a> (if defined)</tt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="MetaDecorator">class <strong>MetaDecorator</strong></a>(<a href="__builtin__.html#type">__builtin__.type</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Metaclass inducing a certain amount of magic on decorators:<br> +1. Each time a decorator is defined in any module, it is stored in<br> + <a href="#MetaDecorator">MetaDecorator</a>.dic and <a href="#MetaDecorator">MetaDecorator</a>.ls.<br> +2. If the (method) decorator has a 'get' method, a '__get__' method<br> + is automagically created as an alias to 'get'.<br> +3. Decorators calls are dispatched to the decorator _call_<br> + <a href="#classmethod">classmethod</a>.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="decorators.html#MetaDecorator">MetaDecorator</a></dd> +<dd><a href="__builtin__.html#type">__builtin__.type</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="MetaDecorator-__call__"><strong>__call__</strong></a>(dec, *args)</dt></dl> + +<dl><dt><a name="MetaDecorator-__init__"><strong>__init__</strong></a>(dec, *args)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>dic</strong> = {'ClassDecorator': <class 'decorators.ClassDecorator'>, 'Decorated': <class 'decorators.Decorated'>, 'Decorator': <class 'decorators.Decorator'>, 'MethodDecorator': <class 'decorators.MethodDecorator'>, 'classmethod': <class 'decorators.classmethod'>, 'staticmethod': <class 'decorators.staticmethod'>}</dl> + +<dl><dt><strong>ls</strong> = [<class 'decorators.Decorator'>, <class 'decorators.MethodDecorator'>, <class 'decorators.ClassDecorator'>, <class 'decorators.Decorated'>, <class 'decorators.staticmethod'>, <class 'decorators.classmethod'>]</dl> + +<hr> +Methods inherited from <a href="__builtin__.html#type">__builtin__.type</a>:<br> +<dl><dt><a name="MetaDecorator-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#MetaDecorator-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl> + +<dl><dt><a name="MetaDecorator-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MetaDecorator-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="MetaDecorator-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MetaDecorator-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="MetaDecorator-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#MetaDecorator-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl> + +<dl><dt><a name="MetaDecorator-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MetaDecorator-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="MetaDecorator-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MetaDecorator-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="MetaDecorator-__subclasses__"><strong>__subclasses__</strong></a>(...)</dt><dd><tt><a href="#MetaDecorator-__subclasses__">__subclasses__</a>() -> list of immediate subclasses</tt></dd></dl> + +<dl><dt><a name="MetaDecorator-mro"><strong>mro</strong></a>(...)</dt><dd><tt><a href="#MetaDecorator-mro">mro</a>() -> list<br> +return a <a href="__builtin__.html#type">type</a>'s method resolution order</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="__builtin__.html#type">__builtin__.type</a>:<br> +<dl><dt><strong>__base__</strong> = <type 'type'></dl> + +<dl><dt><strong>__bases__</strong> = (<type 'type'>,)</dl> + +<dl><dt><strong>__basicsize__</strong> = 420</dl> + +<dl><dt><strong>__dict__</strong> = <dictproxy object></dl> + +<dl><dt><strong>__dictoffset__</strong> = 132</dl> + +<dl><dt><strong>__flags__</strong> = 22523</dl> + +<dl><dt><strong>__itemsize__</strong> = 20</dl> + +<dl><dt><strong>__mro__</strong> = (<class 'decorators.MetaDecorator'>, <type 'type'>, <type 'object'>)</dl> + +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#MetaDecorator-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with <a href="__builtin__.html#type">type</a> S, a subtype of T</tt></dl> + +<dl><dt><strong>__weakrefoffset__</strong> = 184</dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="MethodDecorator">class <strong>MethodDecorator</strong></a>(<a href="decorators.html#Decorator">Decorator</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Descriptor class callable with a function as argument. The calling<br> +syntax is redefined by the meta-metaclass <a href="#MetaDecorator">MetaDecorator</a>. It redefines<br> +__str__ and get (i.e. __get__) on its instances.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="decorators.html#MethodDecorator">MethodDecorator</a></dd> +<dd><a href="decorators.html#Decorator">Decorator</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="MethodDecorator-__get__"><strong>__get__</strong></a> = <a href="#MethodDecorator-get">get</a>(self, obj, cls<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="MethodDecorator-__init__"><strong>__init__</strong></a>(self, func)</dt></dl> + +<dl><dt><a name="MethodDecorator-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="MethodDecorator-get"><strong>get</strong></a>(self, obj, cls<font color="#909090">=None</font>)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>__klass__</strong> = <class 'decorators.?'></dl> + +<hr> +Data and other attributes inherited from <a href="decorators.html#Decorator">Decorator</a>:<br> +<dl><dt><strong>__dict__</strong> = <dictproxy object><dd><tt>dictionary for instance variables (if defined)</tt></dl> + +<dl><dt><strong>__metaclass__</strong> = <class 'decorators.MetaDecorator'><dd><tt>Metaclass inducing a certain amount of magic on decorators:<br> +1. Each time a decorator is defined in any module, it is stored in<br> + <a href="#MetaDecorator">MetaDecorator</a>.dic and <a href="#MetaDecorator">MetaDecorator</a>.ls.<br> +2. If the (method) decorator has a 'get' method, a '__get__' method<br> + is automagically created as an alias to 'get'.<br> +3. Decorators calls are dispatched to the decorator _call_<br> + <a href="#classmethod">classmethod</a>.</tt></dl> + +<dl><dt><strong>__weakref__</strong> = <attribute '__weakref__' of 'Decorator' objects><dd><tt>list of weak references to the <a href="__builtin__.html#object">object</a> (if defined)</tt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="UnknownDecoratorError">class <strong>UnknownDecoratorError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The name says it all<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="UnknownDecoratorError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl> + +<dl><dt><a name="UnknownDecoratorError-__init__"><strong>__init__</strong></a>(...)</dt></dl> + +<dl><dt><a name="UnknownDecoratorError-__str__"><strong>__str__</strong></a>(...)</dt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="classmethod">class <strong>classmethod</strong></a>(<a href="decorators.html#MethodDecorator">MethodDecorator</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#Decorator">Decorator</a>, converts a function in a <a href="#classmethod">classmethod</a><br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="decorators.html#classmethod">classmethod</a></dd> +<dd><a href="decorators.html#MethodDecorator">MethodDecorator</a></dd> +<dd><a href="decorators.html#Decorator">Decorator</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="classmethod-__get__"><strong>__get__</strong></a> = <a href="#classmethod-get">get</a>(self, obj, cls<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="classmethod-get"><strong>get</strong></a>(self, obj, cls<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="decorators.html#MethodDecorator">MethodDecorator</a>:<br> +<dl><dt><a name="classmethod-__init__"><strong>__init__</strong></a>(self, func)</dt></dl> + +<dl><dt><a name="classmethod-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="decorators.html#MethodDecorator">MethodDecorator</a>:<br> +<dl><dt><strong>__klass__</strong> = <class 'decorators.?'></dl> + +<hr> +Data and other attributes inherited from <a href="decorators.html#Decorator">Decorator</a>:<br> +<dl><dt><strong>__dict__</strong> = <dictproxy object><dd><tt>dictionary for instance variables (if defined)</tt></dl> + +<dl><dt><strong>__metaclass__</strong> = <class 'decorators.MetaDecorator'><dd><tt>Metaclass inducing a certain amount of magic on decorators:<br> +1. Each time a decorator is defined in any module, it is stored in<br> + <a href="#MetaDecorator">MetaDecorator</a>.dic and <a href="#MetaDecorator">MetaDecorator</a>.ls.<br> +2. If the (method) decorator has a 'get' method, a '__get__' method<br> + is automagically created as an alias to 'get'.<br> +3. Decorators calls are dispatched to the decorator _call_<br> + <a href="#classmethod">classmethod</a>.</tt></dl> + +<dl><dt><strong>__weakref__</strong> = <attribute '__weakref__' of 'Decorator' objects><dd><tt>list of weak references to the <a href="__builtin__.html#object">object</a> (if defined)</tt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="staticmethod">class <strong>staticmethod</strong></a>(<a href="decorators.html#MethodDecorator">MethodDecorator</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#Decorator">Decorator</a>, converts a function in a <a href="#staticmethod">staticmethod</a><br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="decorators.html#staticmethod">staticmethod</a></dd> +<dd><a href="decorators.html#MethodDecorator">MethodDecorator</a></dd> +<dd><a href="decorators.html#Decorator">Decorator</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="staticmethod-__get__"><strong>__get__</strong></a> = <a href="#staticmethod-get">get</a>(self, obj, cls<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="staticmethod-get"><strong>get</strong></a>(self, obj, cls<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="decorators.html#MethodDecorator">MethodDecorator</a>:<br> +<dl><dt><a name="staticmethod-__init__"><strong>__init__</strong></a>(self, func)</dt></dl> + +<dl><dt><a name="staticmethod-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="decorators.html#MethodDecorator">MethodDecorator</a>:<br> +<dl><dt><strong>__klass__</strong> = <class 'decorators.?'></dl> + +<hr> +Data and other attributes inherited from <a href="decorators.html#Decorator">Decorator</a>:<br> +<dl><dt><strong>__dict__</strong> = <dictproxy object><dd><tt>dictionary for instance variables (if defined)</tt></dl> + +<dl><dt><strong>__metaclass__</strong> = <class 'decorators.MetaDecorator'><dd><tt>Metaclass inducing a certain amount of magic on decorators:<br> +1. Each time a decorator is defined in any module, it is stored in<br> + <a href="#MetaDecorator">MetaDecorator</a>.dic and <a href="#MetaDecorator">MetaDecorator</a>.ls.<br> +2. If the (method) decorator has a 'get' method, a '__get__' method<br> + is automagically created as an alias to 'get'.<br> +3. Decorators calls are dispatched to the decorator _call_<br> + <a href="#classmethod">classmethod</a>.</tt></dl> + +<dl><dt><strong>__weakref__</strong> = <attribute '__weakref__' of 'Decorator' objects><dd><tt>list of weak references to the <a href="__builtin__.html#object">object</a> (if defined)</tt></dl> + +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-decorate"><strong>decorate</strong></a>(objdict)</dt><dd><tt>Takes an <a href="__builtin__.html#object">object</a> with a dictionary and decorates all its functions<br> +and classes according to their docstrings.</tt></dd></dl> + <dl><dt><a name="-decorated"><strong>decorated</strong></a>(obj)</dt><dd><tt>Returns a new decorated <a href="__builtin__.html#object">object</a> created from obj, if obj is a function<br> +or a class; otherwise it returns None</tt></dd></dl> + <dl><dt><a name="-decorator_from"><strong>decorator_from</strong></a>(docstring, defaultdec<font color="#909090">=None</font>)</dt><dd><tt>Takes a magic docstring and a default decorator<br> +and returns a decorator class or None. It tries to be smart.</tt></dd></dl> + <dl><dt><a name="-enhance_classes"><strong>enhance_classes</strong></a>(docstring<font color="#909090">=''</font>)</dt><dd><tt>Enhance all the classes in the caller module with a metaclass<br> +built from the given docstring; the default is <a href="#ClassDecorator">ClassDecorator</a>.</tt></dd></dl> + <dl><dt><a name="-get"><strong>get</strong></a>(docstring<font color="#909090">=None</font>)</dt><dd><tt>List of recognized decorators</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>MAGICDOC</strong> = <_sre.SRE_Pattern object></td></tr></table> +</body></html>
\ No newline at end of file |