Regen html
This commit is contained in:
Tim Savannah
parent
d6ff5e1932
commit
525c291aef
@ -54,7 +54,7 @@ LICENSE, otherwise it is available at https://gith
|
||||
</dl>
|
||||
<hr />
|
||||
Methods defined here:<br />
|
||||
<dl ><dt ><a name="JoinThread-__init__" ><strong >__init__</strong></a>(self, otherThread, exception)</dt><dd ><tt >This constructor should always be called with keyword arguments. Arguments are:<br />
|
||||
<dl ><dt ><a name="JoinThread-__init__" ><strong >__init__</strong></a>(self, otherThread, exception, repeatEvery=2.0)</dt><dd ><tt >This constructor should always be called with keyword arguments. Arguments are:<br />
|
||||
<br />
|
||||
*group* should be None; reserved for future extension when a ThreadGroup<br />
|
||||
class is implemented.<br />
|
||||
|
||||
@ -30,7 +30,7 @@ LICENSE, otherwise it is available at https://gith
|
||||
<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="-func_set_timeout" ><strong >func_set_timeout</strong></a>(timeout, allowOverride=False)</dt><dd ><tt >set_timeout - Wrapper to run a function with a given/calculated timeout (max execution time).<br />
|
||||
<td width="100%" ><dl ><dt ><a name="-func_set_timeout" ><strong >func_set_timeout</strong></a>(timeout, allowOverride=False)</dt><dd ><tt >func_set_timeout - Decorator to run a function with a given/calculated timeout (max execution time).<br />
|
||||
Optionally (if #allowOverride is True), adds a paramater, "forceTimeout", to the<br />
|
||||
function which, if provided, will override the default timeout for that invocation.<br />
|
||||
<br />
|
||||
@ -84,10 +84,14 @@ LICENSE, otherwise it is available at https://gith
|
||||
Raises any exceptions #func# would raise, returns what #func# would return (unless timeout is exceeded), in which case it raises FunctionTimedOut<br />
|
||||
<br />
|
||||
@param timeout <float> - Maximum number of seconds to run #func# before terminating<br />
|
||||
<br />
|
||||
@param func <function> - The function to call<br />
|
||||
<br />
|
||||
@param args <tuple> - Any ordered arguments to pass to the function<br />
|
||||
<br />
|
||||
@param kwargs <dict/None> - Keyword arguments to pass to the function.<br />
|
||||
<br />
|
||||
<br />
|
||||
@raises - FunctionTimedOut if #timeout# is exceeded, otherwise anything #func# could raise will be raised<br />
|
||||
<br />
|
||||
If the timeout is exceeded, FunctionTimedOut will be raised within the context of the called function every two seconds until it terminates,<br />
|
||||
@ -95,6 +99,7 @@ but will not block the calling thread (a 
|
||||
to return cleanly, but in most cases it will 'just work'.<br />
|
||||
<br />
|
||||
Be careful of code like:<br />
|
||||
<br />
|
||||
def myfunc():<br />
|
||||
while True:<br />
|
||||
try:<br />
|
||||
|
||||
@ -41,7 +41,8 @@ LICENSE, otherwise it is available at https://gith
|
||||
@property timedOutArgs - Ordered args to function<br />
|
||||
@property timedOutKwargs - Keyword args to function<br />
|
||||
<br />
|
||||
@method retry - R<br /> </tt></td></tr>
|
||||
@method retry - Retries the function with same arguments, with option to run with original timeout, no timeout, or a different<br />
|
||||
explicit timeout. @see <a href="#FunctionTimedOut" >FunctionTimedOut</a>.retry<br /> </tt></td></tr>
|
||||
<tr ><td > </td>
|
||||
<td width="100%" ><dl ><dt >Method resolution order:</dt>
|
||||
<dd ><a href="func_timeout.exceptions.html#FunctionTimedOut" >FunctionTimedOut</a></dd>
|
||||
@ -56,11 +57,11 @@ Methods defined here:<br />
|
||||
<br />
|
||||
@return <str> - Message</tt></dd></dl>
|
||||
|
||||
<dl ><dt ><a name="FunctionTimedOut-retry" ><strong >retry</strong></a>(self, timeout='__rst')</dt><dd ><tt >retry - Retry the timed-out function with same arguments.<br />
|
||||
<dl ><dt ><a name="FunctionTimedOut-retry" ><strong >retry</strong></a>(self, timeout='RETRY_SAME_TIMEOUT')</dt><dd ><tt >retry - Retry the timed-out function with same arguments.<br />
|
||||
<br />
|
||||
@param timeout <float/RETRY_SAME_TIMEOUT/None> Default RETRY_SAME_TIMEOUT<br />
|
||||
<br />
|
||||
If RETRY_SAME_TIMEOUT : Will retry the function same args, sane timeout<br />
|
||||
If RETRY_SAME_TIMEOUT : Will retry the function same args, same timeout<br />
|
||||
If a float/int : Will retry the function same args with provided timeout<br />
|
||||
If None : Will retry function same args no timeout<br />
|
||||
<br />
|
||||
@ -115,6 +116,6 @@ Data descriptors inherited from <a href="builtins.html#BaseException" >builtins.
|
||||
<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 >RETRY_SAME_TIMEOUT</strong> = '__rst'<br />
|
||||
<td width="100%" ><strong >RETRY_SAME_TIMEOUT</strong> = 'RETRY_SAME_TIMEOUT'<br />
|
||||
<strong >__all__</strong> = ('FunctionTimedOut', 'RETRY_SAME_TIMEOUT')</td></tr></table>
|
||||
</p></p></body></html>
|
||||
@ -51,7 +51,8 @@ LICENSE, otherwise it is available at https://gith
|
||||
@property timedOutArgs - Ordered args to function<br />
|
||||
@property timedOutKwargs - Keyword args to function<br />
|
||||
<br />
|
||||
@method retry - R<br /> </tt></td></tr>
|
||||
@method retry - Retries the function with same arguments, with option to run with original timeout, no timeout, or a different<br />
|
||||
explicit timeout. @see <a href="#FunctionTimedOut" >FunctionTimedOut</a>.retry<br /> </tt></td></tr>
|
||||
<tr ><td > </td>
|
||||
<td width="100%" ><dl ><dt >Method resolution order:</dt>
|
||||
<dd ><a href="func_timeout.exceptions.html#FunctionTimedOut" >FunctionTimedOut</a></dd>
|
||||
@ -66,11 +67,11 @@ Methods defined here:<br />
|
||||
<br />
|
||||
@return <str> - Message</tt></dd></dl>
|
||||
|
||||
<dl ><dt ><a name="FunctionTimedOut-retry" ><strong >retry</strong></a>(self, timeout='__rst')</dt><dd ><tt >retry - Retry the timed-out function with same arguments.<br />
|
||||
<dl ><dt ><a name="FunctionTimedOut-retry" ><strong >retry</strong></a>(self, timeout='RETRY_SAME_TIMEOUT')</dt><dd ><tt >retry - Retry the timed-out function with same arguments.<br />
|
||||
<br />
|
||||
@param timeout <float/RETRY_SAME_TIMEOUT/None> Default RETRY_SAME_TIMEOUT<br />
|
||||
<br />
|
||||
If RETRY_SAME_TIMEOUT : Will retry the function same args, sane timeout<br />
|
||||
If RETRY_SAME_TIMEOUT : Will retry the function same args, same timeout<br />
|
||||
If a float/int : Will retry the function same args with provided timeout<br />
|
||||
If None : Will retry function same args no timeout<br />
|
||||
<br />
|
||||
@ -125,7 +126,7 @@ Data descriptors inherited from <a href="builtins.html#BaseException" >builtins.
|
||||
<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="-func_set_timeout" ><strong >func_set_timeout</strong></a>(timeout, allowOverride=False)</dt><dd ><tt >set_timeout - Wrapper to run a function with a given/calculated timeout (max execution time).<br />
|
||||
<td width="100%" ><dl ><dt ><a name="-func_set_timeout" ><strong >func_set_timeout</strong></a>(timeout, allowOverride=False)</dt><dd ><tt >func_set_timeout - Decorator to run a function with a given/calculated timeout (max execution time).<br />
|
||||
Optionally (if #allowOverride is True), adds a paramater, "forceTimeout", to the<br />
|
||||
function which, if provided, will override the default timeout for that invocation.<br />
|
||||
<br />
|
||||
@ -179,10 +180,14 @@ Data descriptors inherited from <a href="builtins.html#BaseException" >builtins.
|
||||
Raises any exceptions #func# would raise, returns what #func# would return (unless timeout is exceeded), in which case it raises <a href="#FunctionTimedOut" >FunctionTimedOut</a><br />
|
||||
<br />
|
||||
@param timeout <float> - Maximum number of seconds to run #func# before terminating<br />
|
||||
<br />
|
||||
@param func <function> - The function to call<br />
|
||||
<br />
|
||||
@param args <tuple> - Any ordered arguments to pass to the function<br />
|
||||
<br />
|
||||
@param kwargs <dict/None> - Keyword arguments to pass to the function.<br />
|
||||
<br />
|
||||
<br />
|
||||
@raises - <a href="#FunctionTimedOut" >FunctionTimedOut</a> if #timeout# is exceeded, otherwise anything #func# could raise will be raised<br />
|
||||
<br />
|
||||
If the timeout is exceeded, <a href="#FunctionTimedOut" >FunctionTimedOut</a> will be raised within the context of the called function every two seconds until it terminates,<br />
|
||||
@ -190,6 +195,7 @@ but will not block the calling thread (a 
|
||||
to return cleanly, but in most cases it will 'just work'.<br />
|
||||
<br />
|
||||
Be careful of code like:<br />
|
||||
<br />
|
||||
def myfunc():<br />
|
||||
while True:<br />
|
||||
try:<br />
|
||||
|
||||
Loading…
Reference in New Issue
Block a user