func_timeout.exceptions
index

Copyright (c) 2016 Tim Savannah All Rights Reserved.
 
Licensed under the Lesser GNU Public License Version 3, LGPLv3. You should have recieved a copy of this with the source distribution as
LICENSE, otherwise it is available at https://github.com/kata198/func_timeout/LICENSE

 
Classes
       
builtins.BaseException(builtins.object)
FunctionTimedOut

 
class FunctionTimedOut(builtins.BaseException)
    FunctionTimedOut - Exception raised when a function times out
 
@property timedOutAfter - Number of seconds before timeout was triggered
 
@property timedOutFunction - Function called which timed out
@property timedOutArgs - Ordered args to function
@property timedOutKwargs - Keyword args to function
 
@method retry - Retries the function with same arguments, with option to run with original timeout, no timeout, or a different
  explicit timeout. @see FunctionTimedOut.retry
 
 
Method resolution order:
FunctionTimedOut
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, msg='', timedOutAfter=None, timedOutFunction=None, timedOutArgs=None, timedOutKwargs=None)
Initialize self.  See help(type(self)) for accurate signature.
getMsg(self)
getMsg - Generate a default message based on parameters to FunctionTimedOut exception'
 
@return <str> - Message
retry(self, timeout='RETRY_SAME_TIMEOUT')
retry - Retry the timed-out function with same arguments.
 
@param timeout <float/RETRY_SAME_TIMEOUT/None> Default RETRY_SAME_TIMEOUT
    
    If RETRY_SAME_TIMEOUT : Will retry the function same args, same timeout
    If a float/int : Will retry the function same args with provided timeout
    If None : Will retry function same args no timeout
 
@return - Returnval from function

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
Data
        RETRY_SAME_TIMEOUT = 'RETRY_SAME_TIMEOUT'
__all__ = ('FunctionTimedOut', 'RETRY_SAME_TIMEOUT')