diff options
Diffstat (limited to 'translate-toolkit-1.5.1/translate/doc/api/translate.misc.contextlib-module.html')
| -rw-r--r-- | translate-toolkit-1.5.1/translate/doc/api/translate.misc.contextlib-module.html | 311 |
1 files changed, 311 insertions, 0 deletions
diff --git a/translate-toolkit-1.5.1/translate/doc/api/translate.misc.contextlib-module.html b/translate-toolkit-1.5.1/translate/doc/api/translate.misc.contextlib-module.html new file mode 100644 index 0000000..3081844 --- /dev/null +++ b/translate-toolkit-1.5.1/translate/doc/api/translate.misc.contextlib-module.html @@ -0,0 +1,311 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>translate.misc.contextlib</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="translate-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://translate.sourceforge.net/wiki/toolkit/index">Translate Toolkit</a></th> + </tr></table></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="translate-module.html">Package translate</a> :: + <a href="translate.misc-module.html">Package misc</a> :: + Module contextlib + </span> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" + onclick="toggle_private();">hide private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="translate.misc.contextlib-module.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== MODULE DESCRIPTION ==================== --> +<h1 class="epydoc">Module contextlib</h1><p class="nomargin-top"><span class="codelink"><a href="translate.misc.contextlib-pysrc.html">source code</a></span></p> +<p>Utilities for with-statement contexts. See PEP 343.</p> + +<!-- ==================== CLASSES ==================== --> +<a name="section-Classes"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Classes</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Classes" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr class="private"> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a href="translate.misc.contextlib.GeneratorContextManager-class.html" class="summary-name" onclick="show_private();">GeneratorContextManager</a><br /> + Helper for @contextmanager decorator. + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <a href="translate.misc.contextlib.closing-class.html" class="summary-name">closing</a><br /> + Context to automatically close something at the end of a block. + </td> + </tr> +</table> +<!-- ==================== FUNCTIONS ==================== --> +<a name="section-Functions"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Functions</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Functions" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="translate.misc.contextlib-module.html#contextmanager" class="summary-sig-name">contextmanager</a>(<span class="summary-sig-arg">func</span>)</span><br /> + @contextmanager decorator.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.misc.contextlib-pysrc.html#contextmanager">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="translate.misc.contextlib-module.html#nested" class="summary-sig-name">nested</a>(<span class="summary-sig-arg">*args</span>, + <span class="summary-sig-arg">**kwds</span>)</span><br /> + Support multiple context managers in a single with-statement.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.misc.contextlib-pysrc.html#nested">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<p class="indent-wrapped-lines"><b>Imports:</b> + <span title="sys">sys</span> +</p><br /> +<!-- ==================== FUNCTION DETAILS ==================== --> +<a name="section-FunctionDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Function Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-FunctionDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="contextmanager"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">contextmanager</span>(<span class="sig-arg">func</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.misc.contextlib-pysrc.html#contextmanager">source code</a></span> + </td> + </tr></table> + + <pre class="literalblock"> +@contextmanager decorator. + +Typical usage: + + @contextmanager + def some_generator(<arguments>): + <setup> + try: + yield <value> + finally: + <cleanup> + +This makes this: + + with some_generator(<arguments>) as <variable>: + <body> + +equivalent to this: + + <setup> + try: + <variable> = <value> + <body> + finally: + <cleanup> + +</pre> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="nested"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">nested</span>(<span class="sig-arg">*args</span>, + <span class="sig-arg">**kwds</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.misc.contextlib-pysrc.html#nested">source code</a></span> + </td> + </tr></table> + + <pre class="literalblock"> +Support multiple context managers in a single with-statement. + +Code like this: + + with nested(A, B, C) as (X, Y, Z): + <body> + +is equivalent to this: + + with A as X: + with B as Y: + with C as Z: + <body> + +</pre> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@contextmanager</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="translate-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://translate.sourceforge.net/wiki/toolkit/index">Translate Toolkit</a></th> + </tr></table></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Wed Nov 25 17:16:59 2009 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> |