chore: put assert statements inside 'if TYPE_CHECKING:'

JohnVillalovos · JohnVillalovos · commit b562458f063c · 2021-03-02T08:27:32.000-08:00
To be safe that we don't assert while running, put the assert
statements, which are used by mypy to check that types are correct,
inside an 'if TYPE_CHECKING:' block.

Also, instead of asserting that the item is a dict, instead assert
that it is not a requests.Response object. Theoretically the JSON
could return as a list or dict, though at this time we are assuming a
dict.
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -17,7 +17,7 @@
 """Wrapper for the GitLab API."""
 
 import time
-from typing import cast, Any, Dict, List, Optional, Tuple, Union
+from typing import cast, Any, Dict, List, Optional, Tuple, TYPE_CHECKING, Union
 
 import requests
 import requests.utils
@@ -266,7 +266,8 @@ def lint(self, content: str, **kwargs: Any) -> Tuple[bool, List[str]]:
         """
         post_data = {"content": content}
         data = self.http_post("/ci/lint", post_data=post_data, **kwargs)
-        assert isinstance(data, dict)
+        if TYPE_CHECKING:
+            assert not isinstance(data, requests.Response)
         return (data["status"] == "valid", data["errors"])
 
     @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabMarkdownError)
@@ -294,7 +295,8 @@ def markdown(
         if project is not None:
             post_data["project"] = project
         data = self.http_post("/markdown", post_data=post_data, **kwargs)
-        assert isinstance(data, dict)
+        if TYPE_CHECKING:
+            assert not isinstance(data, requests.Response)
         return data["html"]
 
     @gitlab.exceptions.on_http_error(gitlab.exceptions.GitlabLicenseError)
@@ -333,7 +335,8 @@ def set_license(self, license: str, **kwargs: Any) -> Dict[str, Any]:
         """
         data = {"license": license}
         result = self.http_post("/license", post_data=data, **kwargs)
-        assert isinstance(result, dict)
+        if TYPE_CHECKING:
+            assert not isinstance(result, requests.Response)
         return result
 
     def _set_auth_info(self) -> None:
@@ -855,7 +858,8 @@ def _query(
     @property
     def current_page(self) -> int:
         """The current page number."""
-        assert self._current_page is not None
+        if TYPE_CHECKING:
+            assert self._current_page is not None
         return int(self._current_page)
 
     @property
@@ -877,19 +881,22 @@ def next_page(self) -> Optional[int]:
     @property
     def per_page(self) -> int:
         """The number of items per page."""
-        assert self._per_page is not None
+        if TYPE_CHECKING:
+            assert self._per_page is not None
         return int(self._per_page)
 
     @property
     def total_pages(self) -> int:
         """The total number of pages."""
-        assert self._total_pages is not None
+        if TYPE_CHECKING:
+            assert self._total_pages is not None
         return int(self._total_pages)
 
     @property
     def total(self) -> int:
         """The total number of items."""
-        assert self._total is not None
+        if TYPE_CHECKING:
+            assert self._total is not None
         return int(self._total)
 
     def __iter__(self) -> "GitlabList":
