Excluded monkey from tests

labthings · Apr 22, 2020 · cecd8e8 · cecd8e8
1 parent c37e7b3
commit cecd8e8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/.coveragerc b/.coveragerc
@@ -1,7 +1,7 @@
 [run]
 branch = True
 source = ./labthings
-omit = .venv/*, labthings/server/wsgi/*
+omit = .venv/*, labthings/server/wsgi/*, , labthings/server/monkey/*
 concurrency = greenlet
 
 [report]

diff --git a/labthings/server/monkey.py b/labthings/server/monkey.py
@@ -1,3 +1,18 @@
 from gevent.monkey import patch_all
 
 __all__ = ["patch_all"]
+
+"""
+NOTE: THIS FILE IS EXCLUDED FROM OUR UNIT TESTS.
+
+MONKEY PATCHING IN THE MIDDLE OF A TEST SUITE RUNNING
+MAY CAUSE PROBLEMS.
+
+GIVEN THAT THIS MODULE IS SIMPLY A PROXY FOR GEVENTS
+MONKEY PATCHER, TESTSING IS FAIRLY REDUNDANT ANYWAY.
+
+THIS SHOULD BE PERIODICALLY REVISITED TO MAKE SURE ITS
+STILL TRUE.
+
+THANKS
+"""