| | |
-- func_set_timeout(timeout, allowOverride=False)
- set_timeout - Wrapper to run a function with a given/calculated timeout (max execution time).
+- func_set_timeout(timeout, allowOverride=False)
- func_set_timeout - Decorator to run a function with a given/calculated timeout (max execution time).
Optionally (if #allowOverride is True), adds a paramater, "forceTimeout", to the
function which, if provided, will override the default timeout for that invocation.
@@ -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
@param timeout <float> - Maximum number of seconds to run #func# before terminating
+
@param func <function> - The function to call
+
@param args <tuple> - Any ordered arguments to pass to the function
+
@param kwargs <dict/None> - Keyword arguments to pass to the function.
+
@raises - FunctionTimedOut if #timeout# is exceeded, otherwise anything #func# could raise will be raised
If the timeout is exceeded, FunctionTimedOut will be raised within the context of the called function every two seconds until it terminates,
@@ -95,6 +99,7 @@ but will not block the calling thread (a
to return cleanly, but in most cases it will 'just work'.
Be careful of code like:
+
def myfunc():
while True:
try:
diff --git a/doc/func_timeout.exceptions.html b/doc/func_timeout.exceptions.html
index 1480418..541d7ec 100644
--- a/doc/func_timeout.exceptions.html
+++ b/doc/func_timeout.exceptions.html
@@ -41,7 +41,8 @@ LICENSE, otherwise it is available at https://gith
@property timedOutArgs - Ordered args to function
@property timedOutKwargs - Keyword args to function
-@method retry - R
|
|
+@method retry - Retries the function with same arguments, with option to run with original timeout, no timeout, or a different