lint and doc

Author: abhinavsingh

docs/conf.py

@@ -267,6 +267,7 @@
     (_py_class_role, 'HttpWebServerBasePlugin'),
     (_py_class_role, 'multiprocessing.context.Process'),
     (_py_class_role, 'multiprocessing.synchronize.Lock'),
+    (_py_class_role, 'NonBlockingQueue'),
     (_py_class_role, 'paramiko.channel.Channel'),
     (_py_class_role, 'proxy.http.parser.parser.T'),
     (_py_class_role, 'proxy.plugin.cache.store.base.CacheStore'),

proxy/common/backports.py

@@ -11,7 +11,7 @@
 import time
 import threading
 
-from typing import Any
+from typing import Any, Deque
 from queue import Empty
 from collections import deque
 
@@ -94,25 +94,25 @@ class NonBlockingQueue:
     Here because proxy.py still supports 3.6
     '''
 
-    def __init__(self):
-        self._queue = deque()
-        self._count = threading.Semaphore(0)
+    def __init__(self) -> None:
+        self._queue: Deque[Any] = deque()
+        self._count: threading.Semaphore = threading.Semaphore(0)
 
-    def put(self, item):
+    def put(self, item: Any) -> None:
         '''Put the item on the queue.'''
         self._queue.append(item)
         self._count.release()
 
-    def get(self):
+    def get(self) -> Any:
         '''Remove and return an item from the queue.'''
         if not self._count.acquire(False, None):
             raise Empty
         return self._queue.popleft()
 
-    def empty(self):
+    def empty(self) -> bool:
         '''Return True if the queue is empty, False otherwise (not reliable!).'''
         return len(self._queue) == 0
 
-    def qsize(self):
+    def qsize(self) -> int:
         '''Return the approximate size of the queue (not reliable!).'''
         return len(self._queue)

tests/core/test_listener.py

@@ -37,11 +37,11 @@ def test_setup_and_teardown(self, mock_socket: mock.Mock) -> None:
         self.assertEqual(sock.setsockopt.call_count, 2)
         self.assertEqual(
             sock.setsockopt.call_args_list[0][0],
-            (socket.SOL_SOCKET, socket.SO_REUSEADDR, 1,),
+            (socket.SOL_SOCKET, socket.SO_REUSEADDR, 1),
         )
         self.assertEqual(
             sock.setsockopt.call_args_list[1][0],
-            (socket.IPPROTO_TCP, socket.TCP_NODELAY, 1,),
+            (socket.IPPROTO_TCP, socket.TCP_NODELAY, 1),
         )
         sock.bind.assert_called_with(
             (str(flags.hostname), 0),
@@ -77,11 +77,11 @@ def test_unix_path_listener(self, mock_socket: mock.Mock, mock_remove: mock.Mock
         self.assertEqual(sock.setsockopt.call_count, 2)
         self.assertEqual(
             sock.setsockopt.call_args_list[0][0],
-            (socket.SOL_SOCKET, socket.SO_REUSEADDR, 1,),
+            (socket.SOL_SOCKET, socket.SO_REUSEADDR, 1),
         )
         self.assertEqual(
             sock.setsockopt.call_args_list[1][0],
-            (socket.IPPROTO_TCP, socket.TCP_NODELAY, 1,),
+            (socket.IPPROTO_TCP, socket.TCP_NODELAY, 1),
         )
         sock.bind.assert_called_with(sock_path)
         sock.listen.assert_called_with(flags.backlog)