Ensure all codemods have non-empty change descriptions (#323)

src/codemodder/codemods/test/utils.py

@@ -80,6 +80,8 @@ def assert_changes(self, root, file_path, input_code, expected, changes):
             output_code = tmp_file.read()
 
         assert output_code == dedent(expected)
+        # All changes must have non-empty descriptions
+        assert all(change.description for change in changes.changes)
 
     def run_and_assert_filepath(
         self,

src/core_codemods/https_connection.py

@@ -66,6 +66,8 @@ class HTTPSConnection(SimpleCodemod):
         ],
     )
 
+    change_description = "Enforce HTTPS connection for `urllib3`"
+
     METADATA_DEPENDENCIES = (PositionProvider,)
 
     matching_functions: set[str] = {

src/core_codemods/remove_unnecessary_f_str.py

@@ -28,6 +28,8 @@ class RemoveUnnecessaryFStr(SimpleCodemod, UnnecessaryFormatString):
         ],
     )
 
+    change_description = "Remove unnecessary f-string"
+
     def __init__(
         self, codemod_context: CodemodContext, *codemod_args, **codemod_kwargs
     ):

src/core_codemods/replace_flask_send_file.py

@@ -21,6 +21,10 @@ class ReplaceFlaskSendFile(SimpleCodemod, NameAndAncestorResolutionMixin):
         ],
     )
 
+    change_description = (
+        "Replace unsafe usage of `flask.send_file` with `flask.send_from_directory`"
+    )
+
     pos_to_key_map: list[str | None] = [
         "mimetype",
         "as_attachment",