Merge pull request #2466 from VWS-Python/no-asserts

Only allow asserts in tests

Author: adamtheturtle

admin/create_secrets_files.py

@@ -34,7 +34,9 @@ def main() -> None:
     existing_secrets_file = Path(
         os.environ["EXISTING_SECRETS_FILE"]
     ).expanduser()
-    assert existing_secrets_file.exists(), existing_secrets_file
+    if not existing_secrets_file.exists():
+        msg = f"Existing secrets file does not exist: {existing_secrets_file}"
+        raise FileNotFoundError(msg)
     load_dotenv(dotenv_path=existing_secrets_file)
     new_secrets_dir.mkdir(exist_ok=True)
 

docs/source/conf.py

@@ -50,7 +50,11 @@
 requires_python = project_metadata["Requires-Python"]
 specifiers = SpecifierSet(specifiers=requires_python)
 (specifier,) = specifiers
-assert specifier.operator == ">="
+if specifier.operator != ">=":
+    msg = (
+        f"We only support '>=' for Requires-Python, got {specifier.operator}."
+    )
+    raise ValueError(msg)
 minimum_python_version = specifier.version
 
 language = "en"

pyproject.toml

@@ -165,10 +165,17 @@ lint.ignore = [
     # Also, allow 'assert' in other code as it is the standard for Python type hint
     # narrowing - see
     # https://mypy.readthedocs.io/en/stable/type_narrowing.html#type-narrowing-expressions.
+    # "S101",
+]
+
+lint.per-file-ignores."ci/test_custom_linters.py" = [
+    # Allow asserts in tests.
     "S101",
 ]
 
 lint.per-file-ignores."tests/**" = [
+    # Allow asserts in tests.
+    "S101",
     # Allow possible hardcoded passwords in tests.
     "S105",
     "S106",

src/mock_vws/_requests_mock_server/decorators.py

@@ -192,7 +192,7 @@ def __exit__(self, *exc: object) -> Literal[False]:
         """
         # __exit__ needs this to be passed in but vulture thinks that it is
         # unused, so we "use" it here.
-        assert isinstance(exc, tuple)
+        del exc
 
         self._mock.stop()
         return False

src/mock_vws/_requests_mock_server/mock_web_query_api.py

@@ -69,10 +69,9 @@ def _body_bytes(request: PreparedRequest) -> bytes:
     """
     Return the body of a request as bytes.
     """
-    if request.body is None:
+    if request.body is None or isinstance(request.body, str):
         return b""
 
-    assert isinstance(request.body, bytes)
     return request.body
 
 

src/mock_vws/_requests_mock_server/mock_web_services_api.py

@@ -90,7 +90,6 @@ def _body_bytes(request: PreparedRequest) -> bytes:
     if isinstance(request.body, str):
         return request.body.encode(encoding="utf-8")
 
-    assert isinstance(request.body, bytes)
     return request.body
 
 

src/mock_vws/target_raters.py

@@ -73,7 +73,7 @@ def __call__(self, image_content: bytes) -> int:
         Args:
             image_content: A target's image's content.
         """
-        assert image_content
+        del image_content
         return secrets.randbelow(exclusive_upper_bound=6)
 
 
@@ -96,7 +96,7 @@ def __call__(self, image_content: bytes) -> int:
         Args:
             image_content: A target's image's content.
         """
-        assert image_content
+        del image_content
         return self._rating