feat: remove compat module (#303)

Author: frostming

.github/workflows/tests.yml

@@ -25,8 +25,8 @@ jobs:
             os: "windows-latest"
 
     steps:
-      - uses: "actions/checkout@v2"
-      - uses: "actions/setup-python@v2"
+      - uses: "actions/checkout@v3"
+      - uses: "actions/setup-python@v4"
         with:
           python-version: "${{ matrix.python-version }}"
       - name: "Install dependencies"
@@ -38,6 +38,3 @@ jobs:
 
       - name: "Run tox targets for ${{ matrix.python-version }}"
         run: "python -m tox"
-
-      - name: "Run mypy for ${{ matrix.python-version }}"
-        run: "python -m tox -e mypy"

cachecontrol/__init__.py

@@ -10,9 +10,9 @@
 __email__ = "eric@ionrock.org"
 __version__ = "0.12.11"
 
-from .adapter import CacheControlAdapter
-from .controller import CacheController
-from .wrapper import CacheControl
+from cachecontrol.adapter import CacheControlAdapter
+from cachecontrol.controller import CacheController
+from cachecontrol.wrapper import CacheControl
 
 __all__ = [
     "__author__",

cachecontrol/_cmd.py

@@ -15,7 +15,7 @@
 if TYPE_CHECKING:
     from argparse import Namespace
 
-    from .controller import CacheController
+    from cachecontrol.controller import CacheController
 
 
 def setup_logging() -> None:

cachecontrol/adapter.py

@@ -9,17 +9,17 @@
 
 from requests.adapters import HTTPAdapter
 
-from .cache import DictCache
-from .controller import PERMANENT_REDIRECT_STATUSES, CacheController
-from .filewrapper import CallbackFileWrapper
+from cachecontrol.cache import DictCache
+from cachecontrol.controller import PERMANENT_REDIRECT_STATUSES, CacheController
+from cachecontrol.filewrapper import CallbackFileWrapper
 
 if TYPE_CHECKING:
     from requests import PreparedRequest, Response
+    from urllib3 import HTTPResponse
 
-    from .cache import BaseCache
-    from .compat import HTTPResponse
-    from .heuristics import BaseHeuristic
-    from .serialize import Serializer
+    from cachecontrol.cache import BaseCache
+    from cachecontrol.heuristics import BaseHeuristic
+    from cachecontrol.serialize import Serializer
 
 
 class CacheControlAdapter(HTTPAdapter):
@@ -128,21 +128,21 @@ def build_response(
             else:
                 # Wrap the response file with a wrapper that will cache the
                 #   response when the stream has been consumed.
-                response._fp = CallbackFileWrapper(
-                    response._fp,
+                response._fp = CallbackFileWrapper(  # type: ignore[attr-defined]
+                    response._fp,  # type: ignore[attr-defined]
                     functools.partial(
                         self.controller.cache_response, request, response
                     ),
                 )
                 if response.chunked:
-                    super_update_chunk_length = response._update_chunk_length
+                    super_update_chunk_length = response._update_chunk_length  # type: ignore[attr-defined]
 
                     def _update_chunk_length(self: "HTTPResponse") -> None:
                         super_update_chunk_length()
                         if self.chunk_left == 0:
-                            self._fp._close()
+                            self._fp._close()  # type: ignore[attr-defined]
 
-                    response._update_chunk_length = types.MethodType(
+                    response._update_chunk_length = types.MethodType(  # type: ignore[attr-defined]
                         _update_chunk_length, response
                     )
 

cachecontrol/caches/__init__.py

@@ -2,8 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-from .file_cache import FileCache, SeparateBodyFileCache
-from .redis_cache import RedisCache
-
+from cachecontrol.caches.file_cache import FileCache, SeparateBodyFileCache
+from cachecontrol.caches.redis_cache import RedisCache
 
 __all__ = ["FileCache", "SeparateBodyFileCache", "RedisCache"]

cachecontrol/caches/file_cache.py

@@ -7,22 +7,15 @@
 from textwrap import dedent
 from typing import IO, TYPE_CHECKING, Optional, Type, Union
 
-from ..cache import BaseCache, SeparateBodyBaseCache
-from ..controller import CacheController
+from cachecontrol.cache import BaseCache, SeparateBodyBaseCache
+from cachecontrol.controller import CacheController
 
 if TYPE_CHECKING:
     from datetime import datetime
 
     from filelock import BaseFileLock
 
 
-try:
-    FileNotFoundError
-except NameError:
-    # py2.X
-    FileNotFoundError = (IOError, OSError)
-
-
 def _secure_open_write(filename: str, fmode: int) -> "IO[bytes]":
     # We only want to write to this file, so open it in write only mode
     flags = os.O_WRONLY

cachecontrol/compat.py

@@ -14,14 +14,16 @@
 
 from requests.structures import CaseInsensitiveDict
 
-from .cache import DictCache, SeparateBodyBaseCache
-from .serialize import Serializer
+from cachecontrol.cache import DictCache, SeparateBodyBaseCache
+from cachecontrol.serialize import Serializer
 
 if TYPE_CHECKING:
+    from typing import Literal
+
     from requests import PreparedRequest
+    from urllib3 import HTTPResponse
 
-    from .cache import BaseCache
-    from .compat import HTTPResponse
+    from cachecontrol.cache import BaseCache
 
 logger = logging.getLogger(__name__)
 
@@ -157,7 +159,9 @@ def _load_from_cache(self, request: "PreparedRequest") -> Optional["HTTPResponse
             logger.warning("Cache entry deserialization failed, entry ignored")
         return result
 
-    def cached_request(self, request: "PreparedRequest") -> Union["HTTPResponse", bool]:
+    def cached_request(
+        self, request: "PreparedRequest"
+    ) -> Union["HTTPResponse", "Literal[False]"]:
         """
         Return a cached response if it exists in the cache, otherwise
         return False.
@@ -478,7 +482,7 @@ def update_cached_response(
         cached_response.headers.update(
             dict(
                 (k, v)
-                for k, v in response.headers.items()
+                for k, v in response.headers.items()  # type: ignore[no-untyped-call]
                 if k.lower() not in excluded_headers
             )
         )

cachecontrol/controller.py

@@ -9,7 +9,7 @@
 from typing import TYPE_CHECKING, Any, Dict, Mapping, Optional
 
 if TYPE_CHECKING:
-    from .compat import HTTPResponse
+    from urllib3 import HTTPResponse
 
 TIME_FMT = "%a, %d %b %Y %H:%M:%S GMT"
 

cachecontrol/heuristics.py

@@ -5,13 +5,13 @@
 import base64
 import io
 import json
+import pickle
 import zlib
 from typing import IO, TYPE_CHECKING, Any, Mapping, Optional
 
 import msgpack
 from requests.structures import CaseInsensitiveDict
-
-from .compat import HTTPResponse, pickle, text_type
+from urllib3 import HTTPResponse
 
 if TYPE_CHECKING:
     from requests import PreparedRequest, Request
@@ -44,18 +44,16 @@ def dumps(
             # also update the response with a new file handler to be
             # sure it acts as though it was never read.
             body = response.read(decode_content=False)
-            response._fp = io.BytesIO(body)
+            response._fp = io.BytesIO(body)  # type: ignore[attr-defined]
             response.length_remaining = len(body)
 
         data = {
             "response": {
                 "body": body,  # Empty bytestring if body is stored separately
-                "headers": dict(
-                    (text_type(k), text_type(v)) for k, v in response.headers.items()
-                ),
+                "headers": dict((str(k), str(v)) for k, v in response.headers.items()),  # type: ignore[no-untyped-call]
                 "status": response.status,
                 "version": response.version,
-                "reason": text_type(response.reason),
+                "reason": str(response.reason),
                 "decode_content": response.decode_content,
             }
         }
@@ -65,10 +63,10 @@ def dumps(
         if "vary" in response_headers:
             varied_headers = response_headers["vary"].split(",")
             for header in varied_headers:
-                header = text_type(header).strip()
+                header = str(header).strip()
                 header_value = request.headers.get(header, None)
                 if header_value is not None:
-                    header_value = text_type(header_value)
+                    header_value = str(header_value)
                 data["vary"][header] = header_value
 
         return b",".join([b"cc=4", msgpack.dumps(data, use_bin_type=True)])
@@ -78,10 +76,10 @@ def loads(
         request: "PreparedRequest",
         data: bytes,
         body_file: Optional["IO[bytes]"] = None,
-    ) -> HTTPResponse:
+    ) -> Optional[HTTPResponse]:
         # Short circuit if we've been given an empty set of data
         if not data:
-            return
+            return None
 
         # Determine what version of the serializer the data was serialized
         # with
@@ -101,12 +99,12 @@ def loads(
 
         # Dispatch to the actual load method for the given version
         try:
-            return getattr(self, "_loads_v{}".format(verstr))(request, data, body_file)
+            return getattr(self, "_loads_v{}".format(verstr))(request, data, body_file)  # type: ignore[no-any-return]
 
         except AttributeError:
             # This is a version we don't have a loads function for, so we'll
             # just treat it as a miss and return None
-            return
+            return None
 
     def prepare_response(
         self,