Fix a threading related bug in tplink_utils.

1 files changed, 7 insertions, 0 deletions

diff --git a/decorator_utils.py b/decorator_utils.py
index 438d7f9..4615fec 100644
--- a/decorator_utils.py
+++ b/decorator_utils.py
@@ -647,6 +647,13 @@ def timeout(
     main thread).  When not using signals, timeout granularity will be
     rounded to the nearest 0.1s.
 
+    Beware that an @timeout on a function inside a module will be
+    evaluated at module load time and not when the wrapped function is
+    invoked.  This can lead to problems when relying on the automatic
+    main thread detection code (use_signals=None, the default) since
+    the import probably happens on the main thread and the invocation
+    can happen on a different thread (which can't use signals).
+
     Raises an exception when/if the timeout is reached.
 
     It is illegal to pass anything other than a function as the first