Work around bug in coverage.

python-websockets · Apr 2, 2023 · 901e434 · 901e434
1 parent f075aac
commit 901e434
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/src/websockets/legacy/protocol.py b/src/websockets/legacy/protocol.py
@@ -1361,7 +1361,8 @@ async def close_transport(self) -> None:
         # Abort the TCP connection. Buffers are discarded.
         if self.debug:
             self.logger.debug("x aborting TCP connection")
-        self.transport.abort()
+        # Due to a bug in coverage, this is erroneously reported as not covered.
+        self.transport.abort()  # pragma: no cover
 
         # connection_lost() is called quickly after aborting.
         await self.wait_for_connection_lost()

diff --git a/tests/legacy/test_protocol.py b/tests/legacy/test_protocol.py
@@ -1579,7 +1579,8 @@ def test_local_close_connection_lost_timeout_after_write_eof(self):
             self.receive_frame(self.close_frame)
             self.run_loop_once()
             self.loop.run_until_complete(self.protocol.close(reason="close"))
-        self.assertConnectionClosed(1000, "close")
+        # Due to a bug in coverage, this is erroneously reported as not covered.
+        self.assertConnectionClosed(1000, "close")  # pragma: no cover
 
     def test_local_close_connection_lost_timeout_after_close(self):
         self.protocol.close_timeout = 10 * MS
@@ -1596,7 +1597,8 @@ def test_local_close_connection_lost_timeout_after_close(self):
             self.receive_frame(self.close_frame)
             self.run_loop_once()
             self.loop.run_until_complete(self.protocol.close(reason="close"))
-        self.assertConnectionClosed(1000, "close")
+        # Due to a bug in coverage, this is erroneously reported as not covered.
+        self.assertConnectionClosed(1000, "close")  # pragma: no cover
 
 
 class ClientTests(CommonTests, AsyncioTestCase):
@@ -1614,7 +1616,8 @@ def test_local_close_send_close_frame_timeout(self):
         # Check the timing within -1/+9ms for robustness.
         with self.assertCompletesWithin(19 * MS, 29 * MS):
             self.loop.run_until_complete(self.protocol.close(reason="close"))
-        self.assertConnectionClosed(1006, "")
+        # Due to a bug in coverage, this is erroneously reported as not covered.
+        self.assertConnectionClosed(1006, "")  # pragma: no cover
 
     def test_local_close_receive_close_frame_timeout(self):
         self.protocol.close_timeout = 10 * MS
@@ -1624,7 +1627,8 @@ def test_local_close_receive_close_frame_timeout(self):
         # Check the timing within -1/+9ms for robustness.
         with self.assertCompletesWithin(19 * MS, 29 * MS):
             self.loop.run_until_complete(self.protocol.close(reason="close"))
-        self.assertConnectionClosed(1006, "")
+        # Due to a bug in coverage, this is erroneously reported as not covered.
+        self.assertConnectionClosed(1006, "")  # pragma: no cover
 
     def test_local_close_connection_lost_timeout_after_write_eof(self):
         self.protocol.close_timeout = 10 * MS
@@ -1639,7 +1643,8 @@ def test_local_close_connection_lost_timeout_after_write_eof(self):
             self.receive_frame(self.close_frame)
             self.run_loop_once()
             self.loop.run_until_complete(self.protocol.close(reason="close"))
-        self.assertConnectionClosed(1000, "close")
+        # Due to a bug in coverage, this is erroneously reported as not covered.
+        self.assertConnectionClosed(1000, "close")  # pragma: no cover
 
     def test_local_close_connection_lost_timeout_after_close(self):
         self.protocol.close_timeout = 10 * MS
@@ -1659,4 +1664,5 @@ def test_local_close_connection_lost_timeout_after_close(self):
             self.receive_frame(self.close_frame)
             self.run_loop_once()
             self.loop.run_until_complete(self.protocol.close(reason="close"))
-        self.assertConnectionClosed(1000, "close")
+        # Due to a bug in coverage, this is erroneously reported as not covered.
+        self.assertConnectionClosed(1000, "close")  # pragma: no cover