Add # pragma: no cover for unnecessary code (#987)

Author: abhinavsingh

proxy/common/_version.py

@@ -15,26 +15,26 @@
 try:
     # pylint: disable=unused-import
     from ._scm_version import version as __version__, version_tuple as _ver_tup  # noqa: WPS433, WPS436
-except ImportError:
+except ImportError:     # pragma: no cover
     from pkg_resources import get_distribution as _get_dist  # noqa: WPS433
     __version__ = _get_dist('proxy.py').version  # noqa: WPS440
 
 
-def _to_int_or_str(inp: str) -> Union[int, str]:
+def _to_int_or_str(inp: str) -> Union[int, str]:    # pragma: no cover
     try:
         return int(inp)
     except ValueError:
         return inp
 
 
-def _split_version_parts(inp: str) -> Tuple[str, ...]:
+def _split_version_parts(inp: str) -> Tuple[str, ...]:  # pragma: no cover
     public_version, _plus, local_version = inp.partition('+')
     return (*public_version.split('.'), local_version)
 
 
 try:
     VERSION = _ver_tup
-except NameError:
+except NameError:   # pragma: no cover
     VERSION = tuple(
         map(_to_int_or_str, _split_version_parts(__version__)),
     )

proxy/common/backports.py

@@ -16,7 +16,7 @@
 from collections import deque
 
 
-class cached_property:
+class cached_property:      # pragma: no cover
     """Decorator for read-only properties evaluated only once within TTL period.
     It can be used to create a cached property like this::
 
@@ -111,8 +111,8 @@ def get(self) -> Any:
 
     def empty(self) -> bool:
         '''Return True if the queue is empty, False otherwise (not reliable!).'''
-        return len(self._queue) == 0
+        return len(self._queue) == 0    # pragma: no cover
 
     def qsize(self) -> int:
         '''Return the approximate size of the queue (not reliable!).'''
-        return len(self._queue)
+        return len(self._queue)     # pragma: no cover

proxy/common/logger.py

@@ -36,7 +36,7 @@ def setup(
             log_level: str = DEFAULT_LOG_LEVEL,
             log_format: str = DEFAULT_LOG_FORMAT,
     ) -> None:
-        if log_file:
+        if log_file:    # pragma: no cover
             logging.basicConfig(
                 filename=log_file,
                 filemode='a',

proxy/common/types.py

@@ -14,8 +14,8 @@
 from typing import TYPE_CHECKING, Dict, Any, List, Tuple, Union
 
 
-if TYPE_CHECKING:
-    DictQueueType = queue.Queue[Dict[str, Any]]    # pragma: no cover
+if TYPE_CHECKING:   # pragma: no cover
+    DictQueueType = queue.Queue[Dict[str, Any]]
 else:
     DictQueueType = queue.Queue
 

proxy/common/utils.py

@@ -28,7 +28,7 @@
     DEFAULT_TIMEOUT, DEFAULT_THREADLESS, IS_WINDOWS,
 )
 
-if not IS_WINDOWS:
+if not IS_WINDOWS:  # pragma: no cover
     import resource
 
 logger = logging.getLogger(__name__)
@@ -282,7 +282,8 @@ def get_available_port() -> int:
 
 def set_open_file_limit(soft_limit: int) -> None:
     """Configure open file description soft limit on supported OS."""
-    if IS_WINDOWS:  # resource module not available on Windows OS
+    # resource module not available on Windows OS
+    if IS_WINDOWS:  # pragma: no cover
         return
 
     curr_soft_limit, curr_hard_limit = resource.getrlimit(

proxy/core/acceptor/acceptor.py

@@ -237,7 +237,7 @@ def _work(self, conn: socket.socket, addr: Optional[Tuple[str, int]]) -> None:
                 event_queue=self.event_queue,
                 publisher_id=self.__class__.__name__,
             )
-            logger.debug(
+            logger.debug(   # pragma: no cover
                 'Started work#{0}.{1}.{2} in thread#{3}'.format(
                     conn.fileno(), self.idd, self._total, thread.ident,
                 ),

proxy/core/connection/pool.py

@@ -139,7 +139,7 @@ async def handle_events(self, readables: Readables, _writables: Writables) -> bo
         has somehow reached an illegal state e.g. upstream sending data for previous
         connection acquisition lifecycle."""
         for fileno in readables:
-            if TYPE_CHECKING:
+            if TYPE_CHECKING:   # pragma: no cover
                 assert isinstance(fileno, int)
             logger.debug('Upstream fd#{0} is read ready'.format(fileno))
             self._remove(fileno)

proxy/core/work/delegate.py

@@ -11,7 +11,7 @@
 from typing import TYPE_CHECKING, Optional, Tuple
 from multiprocessing.reduction import send_handle
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     import socket
     import multiprocessing
     from multiprocessing import connection

proxy/core/work/pool.py

@@ -20,7 +20,7 @@
 from ...common.flag import flags
 from ...common.constants import DEFAULT_NUM_WORKERS, DEFAULT_THREADLESS
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ..event import EventQueue
 
 logger = logging.getLogger(__name__)

proxy/core/work/threaded.py

@@ -17,7 +17,7 @@
 from ..connection import TcpClientConnection
 from ..event import EventQueue, eventNames
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from .work import Work
 
 

proxy/core/work/threadless.py

@@ -28,7 +28,7 @@
 from ..connection import TcpClientConnection, UpstreamConnectionPool
 from ..event import eventNames
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from typing import Any
 
     from ..event import EventQueue

proxy/core/work/work.py

@@ -21,7 +21,7 @@
 from ..event import eventNames, EventQueue
 from ...common.types import Readables, SelectableEvents, Writables
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ..connection import UpstreamConnectionPool
 
 T = TypeVar('T')

proxy/http/exception/base.py

@@ -14,7 +14,7 @@
 """
 from typing import Any, Optional, TYPE_CHECKING
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ..parser import HttpParser
 
 

proxy/http/exception/http_request_rejected.py

@@ -14,7 +14,7 @@
 
 from ...common.utils import build_http_response
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ..parser import HttpParser
 
 

proxy/http/exception/proxy_auth_failed.py

@@ -19,7 +19,7 @@
 
 from ..responses import PROXY_AUTH_FAILED_RESPONSE_PKT
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ..parser import HttpParser
 
 

proxy/http/exception/proxy_conn_failed.py

@@ -18,7 +18,7 @@
 
 from ..responses import BAD_GATEWAY_RESPONSE_PKT
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ..parser import HttpParser
 
 

proxy/http/plugin.py

@@ -21,7 +21,7 @@
 from .descriptors import DescriptorsHandlerMixin
 from .mixins import TlsInterceptionPropertyMixin
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ..core.connection import UpstreamConnectionPool
 
 

proxy/http/proxy/plugin.py

@@ -21,7 +21,7 @@
 from ...core.event import EventQueue
 from ...core.connection import TcpClientConnection
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ...core.connection import UpstreamConnectionPool
 
 

proxy/http/server/plugin.py

@@ -20,7 +20,7 @@
 from ...core.connection import TcpClientConnection
 from ...core.event import EventQueue
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:   # pragma: no cover
     from ...core.connection import UpstreamConnectionPool
 
 

requirements-testing.txt

@@ -21,3 +21,4 @@ h2==4.1.0
 hpack==4.0.0
 hyperframe==6.0.1
 pre-commit==2.16.0
+types-setuptools==57.4.7