Add possibility to ignore common deprecated message (#20444)

potiuk · web-flow · commit daeeb7d401cd · 2021-12-21T18:21:57.000+01:00
There are some cases where deprecation of a commonly used
dependency causes deprecation message in multiple dependencies.

This happened in December 2021 with distutils deprecation.
The disutil deprecation started to appear as new versions of
multiple packages were released.

This change adds such "common" deprecation messages that should
be filtered out independently where they were generated.
diff --git a/dev/provider_packages/prepare_provider_packages.py b/dev/provider_packages/prepare_provider_packages.py
@@ -2049,6 +2049,10 @@ def summarise_total_vs_bad_and_warnings(total: int, bad: int, warns: List[warnin
         console.print("[yellow]There are two cases that are legitimate deprecation warnings though:[/]")
         console.print("[yellow] 1) when you deprecate whole module or class and replace it in provider[/]")
         console.print("[yellow] 2) when 3rd-party module generates Deprecation and you cannot upgrade it[/]")
+        console.print(
+            "[yellow] 3) when many 3rd-party module generates same Deprecation warning that "
+            "comes from another common library[/]"
+        )
         console.print()
         console.print(
             "[yellow]In case 1), add the deprecation message to "
@@ -2058,6 +2062,10 @@ def summarise_total_vs_bad_and_warnings(total: int, bad: int, warns: List[warnin
             "[yellow]In case 2), add the deprecation message together with module it generates to "
             "the KNOWN_DEPRECATED_MESSAGES in prepare_provider_packages.py[/]"
         )
+        console.print(
+            "[yellow]In case 3), add the deprecation message to "
+            "the KNOWN_COMMON_DEPRECATED_MESSAGES in prepare_provider_packages.py[/]"
+        )
         console.print()
         raise_error = True
     else:
@@ -2102,7 +2110,6 @@ def summarise_total_vs_bad_and_warnings(total: int, bad: int, warns: List[warnin
     ("dns.hash module will be removed in future versions. Please use hashlib instead.", "dns"),
     ("PKCS#7 support in pyOpenSSL is deprecated. You should use the APIs in cryptography.", "eventlet"),
     ("PKCS#12 support in pyOpenSSL is deprecated. You should use the APIs in cryptography.", "eventlet"),
-    ("distutils Version classes are deprecated. Use packaging.version instead.", "eventlet"),
     (
         "the imp module is deprecated in favour of importlib; see the module's documentation"
         " for alternative uses",
@@ -2116,7 +2123,10 @@ def summarise_total_vs_bad_and_warnings(total: int, bad: int, warns: List[warnin
     ),
     ("SelectableGroups dict interface is deprecated. Use select.", "kombu"),
     ("The module cloudant is now deprecated. The replacement is ibmcloudant.", "cloudant"),
-    ("distutils Version classes are deprecated. Use packaging.version instead.", "dask"),
+}
+
+KNOWN_COMMON_DEPRECATED_MESSAGES: Set[str] = {
+    "distutils Version classes are deprecated. Use packaging.version instead."
 }
 
 # The set of warning messages generated by direct importing of some deprecated modules. We should only
@@ -2184,6 +2194,14 @@ def filter_direct_importlib_warning(warn: warnings.WarningMessage) -> bool:
     return True
 
 
+def filter_known_common_deprecated_messages(warn: warnings.WarningMessage) -> bool:
+    msg_string = str(warn.message).replace("\n", " ")
+    for m in KNOWN_COMMON_DEPRECATED_MESSAGES:
+        if msg_string == m:
+            return False
+    return True
+
+
 @cli.command()
 def verify_provider_classes():
     """Verifies names for all provider classes."""
@@ -2205,6 +2223,7 @@ def verify_provider_classes():
             bad += inc_bad
         warns = list(filter(filter_known_warnings, warns))
         warns = list(filter(filter_direct_importlib_warning, warns))
+        warns = list(filter(filter_known_common_deprecated_messages, warns))
         if not summarise_total_vs_bad_and_warnings(total, bad, warns):
             sys.exit(1)
 
