Add deprecation warnings for python 2 (#809)

* Add deprecation warnings for python 2 * Use PendingDeprecationWarning and update docs * Update docs/index.asciidoc Co-Authored-By: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

Author: basepi

docs/index.asciidoc

@@ -8,6 +8,9 @@ endif::[]
 
 = APM Python Agent Reference
 
+NOTE: Python 2.7 reached End of Life on January 1, 2020.
+The Elastic APM agent will stop supporting Python 2.7 starting in version 6.0.0.
+
 include::./getting-started.asciidoc[]
 
 include::./set-up.asciidoc[]

docs/supported-technologies.asciidoc

@@ -24,8 +24,8 @@ The following Python versions are supported:
  * 3.7
  * 3.8
 
-WARNING: Python 2.7 will reach End of Life on January 1, 2020.
-The Elastic APM agent will stop supporting Python 2.7 in the first major version after that date.
+WARNING: Python 2.7 reached End of Life on January 1, 2020.
+The Elastic APM agent will stop supporting Python 2.7 starting in 6.0.0.
 
 [float]
 [[supported-django]]

elasticapm/base.py

@@ -530,8 +530,16 @@ def load_processors(self):
 
  def check_python_version(self):
  v = tuple(map(int, platform.python_version_tuple()[:2]))
- if (2, 7) < v < (3, 5):
- warnings.warn("The Elastic APM agent only supports Python 2.7 and 3.5+", DeprecationWarning)
+ if v == (2, 7):
+ warnings.warn(
+ (
+ "The Elastic APM agent will stop supporting Python 2.7 starting in 6.0.0 -- "
+ "Please upgrade to Python 3.5+ to continue to use the latest features."
+ ),
+ PendingDeprecationWarning,
+ )
+ elif v < (3, 5):
+ warnings.warn("The Elastic APM agent only supports Python 3.5+", DeprecationWarning)
 
 
 class DummyClient(Client):

tests/client/client_tests.py

@@ -770,11 +770,16 @@ def test_server_url_joining(elasticapm_client, expected):
 
 
 @pytest.mark.parametrize(
- "version,raises",
- [(("2", "7", "0"), False), (("3", "3", "0"), True), (("3", "4", "0"), True), (("3", "5", "0"), False)],
+ "version,raises,pending",
+ [
+ (("2", "7", "0"), True, True),
+ (("3", "3", "0"), True, False),
+ (("3", "4", "0"), True, False),
+ (("3", "5", "0"), False, False),
+ ],
 )
 @mock.patch("platform.python_version_tuple")
-def test_python_version_deprecation(mock_python_version_tuple, version, raises, recwarn):
+def test_python_version_deprecation(mock_python_version_tuple, version, raises, pending, recwarn):
  warnings.simplefilter("always")
 
  mock_python_version_tuple.return_value = version
@@ -786,7 +791,11 @@ def test_python_version_deprecation(mock_python_version_tuple, version, raises,
  e.close()
  if raises:
  assert len(recwarn) == 1
- w = recwarn.pop(DeprecationWarning)
- assert "agent only supports" in w.message.args[0]
+ if pending:
+ w = recwarn.pop(PendingDeprecationWarning)
+ assert "will stop supporting" in w.message.args[0]
+ else:
+ w = recwarn.pop(DeprecationWarning)
+ assert "agent only supports" in w.message.args[0]
  else:
  assert len(recwarn) == 0