diff options
Diffstat (limited to 'translate-toolkit-1.3.0/translate/doc/api/translate.filters.checks.UnitChecker-class.html')
| -rw-r--r-- | translate-toolkit-1.3.0/translate/doc/api/translate.filters.checks.UnitChecker-class.html | 505 |
1 files changed, 505 insertions, 0 deletions
diff --git a/translate-toolkit-1.3.0/translate/doc/api/translate.filters.checks.UnitChecker-class.html b/translate-toolkit-1.3.0/translate/doc/api/translate.filters.checks.UnitChecker-class.html new file mode 100644 index 0000000..bdcccb4 --- /dev/null +++ b/translate-toolkit-1.3.0/translate/doc/api/translate.filters.checks.UnitChecker-class.html @@ -0,0 +1,505 @@ +<?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.filters.checks.UnitChecker</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"> + + <!-- 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">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"> + Package translate :: + <a href="translate.filters-module.html">Package filters</a> :: + <a href="translate.filters.checks-module.html">Module checks</a> :: + Class UnitChecker + </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.filters.checks.UnitChecker-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class UnitChecker</h1><p class="nomargin-top"><span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker">source code</a></span></p> +<pre class="base-tree"> +object --+ + | + <strong class="uidshort">UnitChecker</strong> +</pre> + +<dl><dt>Known Subclasses:</dt> +<dd> + <ul class="subclass-list"> +<li><a href="translate.filters.checks.TranslationChecker-class.html">TranslationChecker</a></li><li>, <a href="translate.filters.checks.StandardUnitChecker-class.html">StandardUnitChecker</a></li> </ul> +</dd></dl> + +<hr /> +<p>Parent Checker class which does the checking based on functions + available in derived classes.</p> + +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></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">Instance Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-InstanceMethods" + 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.filters.checks.UnitChecker-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">checkerconfig</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">excludefilters</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">limitfilters</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">errorhandler</span>=<span class="summary-sig-default">None</span>)</span><br /> + x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.__init__">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 name="getfilters"></a><span class="summary-sig-name">getfilters</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">excludefilters</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">limitfilters</span>=<span class="summary-sig-default">None</span>)</span><br /> + returns dictionary of available filters, including/excluding those in + the given lists</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.getfilters">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 name="setconfig"></a><span class="summary-sig-name">setconfig</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">config</span>)</span><br /> + sets the accelerator list</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.setconfig">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 name="setsuggestionstore"></a><span class="summary-sig-name">setsuggestionstore</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">store</span>)</span><br /> + Sets the filename that a checker should use for evaluating + suggestions.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.setsuggestionstore">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 name="filtervariables"></a><span class="summary-sig-name">filtervariables</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">param1</span>)</span><br /> + filter out variables from str1</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.filtervariables">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 name="removevariables"></a><span class="summary-sig-name">removevariables</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">param1</span>)</span><br /> + remove variables from str1</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.removevariables">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 name="filteraccelerators"></a><span class="summary-sig-name">filteraccelerators</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">param1</span>)</span><br /> + filter out accelerators from str1</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.filteraccelerators">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 name="filteraccelerators_by_list"></a><span class="summary-sig-name">filteraccelerators_by_list</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">str1</span>, + <span class="summary-sig-arg">acceptlist</span>=<span class="summary-sig-default">None</span>)</span><br /> + filter out accelerators from str1</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.filteraccelerators_by_list">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 name="filterwordswithpunctuation"></a><span class="summary-sig-name">filterwordswithpunctuation</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">param1</span>)</span><br /> + replaces words with punctuation with their unpunctuated equivalents</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.filterwordswithpunctuation">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 name="filterxml"></a><span class="summary-sig-name">filterxml</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">param1</span>)</span><br /> + filter out XML from the string so only text remains</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.filterxml">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.filters.checks.UnitChecker-class.html#run_test" class="summary-sig-name">run_test</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">test</span>, + <span class="summary-sig-arg">unit</span>)</span><br /> + Runs the given test on the given unit.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.run_test">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 name="run_filters"></a><span class="summary-sig-name">run_filters</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">unit</span>)</span><br /> + run all the tests in this suite, return failures as testname, + message_or_exception</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.run_filters">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__delattr__</code>, + <code>__getattribute__</code>, + <code>__hash__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__repr__</code>, + <code>__setattr__</code>, + <code>__str__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== CLASS VARIABLES ==================== --> +<a name="section-ClassVariables"></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">Class Variables</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-ClassVariables" + 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"> + <a name="preconditions"></a><span class="summary-name">preconditions</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code> + </td> + </tr> +</table> +<!-- ==================== PROPERTIES ==================== --> +<a name="section-Properties"></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">Properties</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Properties" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__class__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></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">Method Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-MethodDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">checkerconfig</span>=<span class="sig-default">None</span>, + <span class="sig-arg">excludefilters</span>=<span class="sig-default">None</span>, + <span class="sig-arg">limitfilters</span>=<span class="sig-default">None</span>, + <span class="sig-arg">errorhandler</span>=<span class="sig-default">None</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.__init__">source code</a></span> + </td> + </tr></table> + + <p>x.__init__(...) initializes x; see x.__class__.__doc__ for + signature</p> + <dl class="fields"> + <dt>Overrides: + object.__init__ + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="run_test"></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">run_test</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">test</span>, + <span class="sig-arg">unit</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.filters.checks-pysrc.html#UnitChecker.run_test">source code</a></span> + </td> + </tr></table> + + <p>Runs the given test on the given unit.</p> + <p>Note that this can raise a FilterFailure as part of normal + operation</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + + <!-- 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">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 Tue Sep 23 13:50:52 2008 + </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> |