moved 2.20.* warnings into a proper Python PendingDeprecationWarning message

Author: mahtin

CloudFlare/cloudflare.py

@@ -18,7 +18,7 @@
 from .api_extras import api_extras
 from .api_decode_from_openapi import api_decode_from_openapi
 from .exceptions import CloudFlareAPIError, CloudFlareInternalError
-from .warning_2_20 import warning_2_20, print_warning_2_20
+from .warning_2_20 import warning_2_20, warn_warning_2_20, indent_warning_2_20
 
 BASE_URL = 'https://api.cloudflare.com/client/v4'
 OPENAPI_URL = 'https://github.com/cloudflare/api-schemas/raw/main/openapi.json'
@@ -93,10 +93,11 @@ def __init__(self, config, warnings=True):
                 # After 2.20.* there is a warning message posted to handle un-pinned versions
                 warning = warning_2_20()
                 if warning:
+                    # we are running 2.20.* or above and hence it's time to warn the user
                     if self.logger:
-                        self.logger.warning(''.join(['\n       ' + v for v in warning.split('\n')]))
+                        self.logger.warning(indent_warning_2_20(warning))
                     else:
-                        print_warning_2_20(warning)
+                        warn_warning_2_20(indent_warning_2_20(warning))
 
         def __del__(self):
             if self.network:

CloudFlare/warning_2_20.py

@@ -1,6 +1,7 @@
 """ warning message if version is 2.20 or above (technically, there's no version above 2.20.0) """
 
 import sys
+import warnings
 
 from . import __version__
 
@@ -26,6 +27,19 @@ def warning_2_20():
         return None
     return MAJOR_VERSION_WARNING
 
-def print_warning_2_20(warning):
-    """ print_warning_2_20 """
-    print(warning, file=sys.stderr)
+#def print_warning_2_20(warning):
+#    """ print_warning_2_20 """
+#    # boring stderr message printing - however, warn_ form is prefered
+#    print(warning, file=sys.stderr)
+#    pass
+
+def warn_warning_2_20(warning):
+    """ warn_warning_2_20 """
+    # force these warnings to be shown (even if -Wd isn't used on python command line)
+    warnings.simplefilter('always', PendingDeprecationWarning)
+    # stacklevel=4 cleanly upstacks the calls in cloudflare.py (and hence should chanhge if cloudflare.py changes)
+    warnings.warn(warning,  PendingDeprecationWarning, stacklevel=4)
+
+def indent_warning_2_20(warning):
+    """ indent_warning_2_20 """
+    return ''.join(['\n       ' + v for v in warning.split('\n')])