document new codemod and register it

integration_tests/test_fix_assert_tuple.py

@@ -0,0 +1,17 @@
+from core_codemods.fix_assert_tuple import FixAssertTuple
+from integration_tests.base_test import (
+    BaseIntegrationTest,
+    original_and_expected_from_code_path,
+)
+
+
+class TestFixAssertTuple(BaseIntegrationTest):
+    codemod = FixAssertTuple
+    code_path = "tests/samples/fix_assert_tuple.py"
+    original_code, expected_new_code = original_and_expected_from_code_path(
+        code_path, [(0, "assert 1 == 1\n"), (1, "assert 2 == 2\n")]
+    )
+    expected_diff = "--- \n+++ \n@@ -1 +1,2 @@\n-assert (1 == 1, 2 == 2)\n+assert 1 == 1\n+assert 2 == 2\n"
+    expected_line_change = "1"
+    change_description = FixAssertTuple.change_description
+    num_changes = 2

src/codemodder/scripts/generate_docs.py

@@ -210,6 +210,10 @@ class DocMetadata:
         importance="Medium",
         guidance_explained="We believe this change is safe and will not cause any issues.",
     ),
+    "fix-assert-tuple": DocMetadata(
+        importance="Medium",
+        guidance_explained="We believe this change is safe and will not cause any issues.",
+    ),
 }
 
 

src/core_codemods/__init__.py

@@ -46,6 +46,7 @@
 from .fix_deprecated_logging_warn import FixDeprecatedLoggingWarn
 from .flask_enable_csrf_protection import FlaskEnableCSRFProtection
 from .replace_flask_send_file import ReplaceFlaskSendFile
+from .fix_assert_tuple import FixAssertTuple
 
 registry = CodemodCollection(
     origin="pixee",
@@ -98,5 +99,6 @@
         FixDeprecatedLoggingWarn,
         FlaskEnableCSRFProtection,
         ReplaceFlaskSendFile,
+        FixAssertTuple,
     ],
 )

src/core_codemods/docs/pixee_python_fix-assert-tuple.md

@@ -0,0 +1,11 @@
+An assertion on a non-empty tuple will always evaluate to `True` so it's likely to be written unintentionally. This codemod will write one assert statement for each item in the tuple.
+
+
+
+The changes from this codemod look like this:
+
+```diff
+- assert (1 == 1, 2 == 2)
++ assert 1 == 1
++ assert 2 == 2
+```

src/core_codemods/fix_assert_tuple.py

@@ -15,7 +15,6 @@ class FixAssertTuple(SimpleCodemod, NameResolutionMixin):
     change_description = (
         "Separate assertion on a populated tuple into multiple assert statements."
     )
-    REFERENCES: list = ["#TODO"]
 
     def leave_SimpleStatementLine(
         self,

tests/samples/fix_assert_tuple.py

@@ -0,0 +1 @@
+assert (1 == 1, 2 == 2)