2.20.* warning now in its own file and warning sent to stderr or logging only if release number 2.20 or above

Author: mahtin

CloudFlare/cloudflare.py

@@ -18,31 +18,14 @@
 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
 
 BASE_URL = 'https://api.cloudflare.com/client/v4'
 OPENAPI_URL = 'https://github.com/cloudflare/api-schemas/raw/main/openapi.json'
 
 DEFAULT_GLOBAL_REQUEST_TIMEOUT = 5
 DEFAULT_MAX_REQUEST_RETRIES = 5
 
-MAJOR_VERSION_WARNING = """
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!  WARNING  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!!                                                                            !!
-!! You are seeing this warning because you have upgraded to a version that is !!
-!! not intended to be installed.                                              !!
-!!                                                                            !!
-!! This version only exists to catch any accidental upgrades before we        !!
-!! release a major release.                                                   !!
-!!                                                                            !!
-!! You should determine if you need to revert this upgrade and pin to v2.19.* !!
-!! or if you can upgrade to v3.x.                                             !!
-!!                                                                            !!
-!! To see more about upgrading to next major version, please see              !!
-!! https://github.com/cloudflare/python-cloudflare/discussions/191            !!
-!!                                                                            !!
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-"""
-
 class CloudFlare():
     """ A Python interface Cloudflare's v4 API.
 
@@ -68,7 +51,6 @@ class _v4base():
 
         def __init__(self, config):
             """ :meta private: """
-            print(MAJOR_VERSION_WARNING)
 
             self.network = None
             self.config = config
@@ -107,6 +89,13 @@ def __init__(self, config):
 
             self.logger = CFlogger(config['debug']).getLogger() if 'debug' in config and config['debug'] else None
 
+            warning = warning_2_20()
+            if warning:
+                if self.logger:
+                    self.logger.warning('\n' + warning)
+                else:
+                    print_warning_2_20(warning)
+
         def __del__(self):
             if self.network:
                 del self.network
@@ -297,7 +286,6 @@ def do_certauth(self, method, parts, identifiers, params=None, data=None, files=
 
         def _call_network(self, method, headers, parts, identifiers, params, data_str, data_json, files):
             """ Cloudflare v4 API"""
-            print(MAJOR_VERSION_WARNING)
 
             if (method is None) or (parts[0] is None):
                 # should never happen

CloudFlare/warning_2_20.py

@@ -0,0 +1,31 @@
+""" warning message if version is 2.20 or above (technically, there's no version above 2.20.0) """
+
+import sys
+
+from . import __version__
+
+MAJOR_VERSION_WARNING = """\
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!   WARNING  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! You're seeing this warning because you've upgraded the Python package 'cloudflare' to version  !!
+!! 2.20.* via an automated upgrade without version pinning. Version 2.20.0 exists to catch any    !!
+!! of these upgrades before Cloudflare releases a new major release under the release number 3.x. !!
+!!                                                                                                !!
+!! Should you determine that you need to revert this upgrade and pin to v2.19.* it is recommended !!
+!! you do the following: pip install --upgrade cloudflare==2.19.* or equivilant.                  !!
+!!                                                                                                !!
+!! Or you can upgrade to v3.x. NOTE: Release 3.x will not be code-compatible or call-compatible   !!
+!! with previous releases. To see more about upgrading to next major version, please see:         !!
+!! https://github.com/cloudflare/python-cloudflare/discussions/191                                !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\
+"""
+
+def warning_2_20():
+    """ warning_2_20 """
+
+    if __version__ < '2.20.0':
+        return None
+    return MAJOR_VERSION_WARNING
+
+def print_warning_2_20(warning):
+    """ print_warning_2_20 """
+    print(warning, file=sys.stderr)