From 9487ae5614321b6fa1a59b2ccd8d518df41ac747 Mon Sep 17 00:00:00 2001 From: Luke Sneeringer Date: Fri, 4 Aug 2017 09:19:32 -0700 Subject: [PATCH 1/4] Add a function to complain about obselete packages. --- core/google/cloud/obselete.py | 38 ++++++++++++++++++++++++++++++++ core/tests/unit/test_obselete.py | 31 ++++++++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 core/google/cloud/obselete.py create mode 100644 core/tests/unit/test_obselete.py diff --git a/core/google/cloud/obselete.py b/core/google/cloud/obselete.py new file mode 100644 index 000000000000..d884945121f3 --- /dev/null +++ b/core/google/cloud/obselete.py @@ -0,0 +1,38 @@ +# Copyright 2017 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pkg_resources +import warnings + + +def complain(package_name): + """Issue a warning if `package_name` is installed. + + In a future release, this method will be updated to raise ImportError + rather than just send a warning. + + Args: + package_name (str): The name of the obselete package. + """ + try: + pkg_resources.get_distribution(package_name) + warnings.warn( + 'The {pkg} package is now obselete. Please `pip uninstall {pkg}`. ' + 'In the future, this warning will become an ImportError.'.format( + pkg=package_name, + ), + DeprecationWarning, + ) + except pkg_resources.DistributionNotFound: + pass diff --git a/core/tests/unit/test_obselete.py b/core/tests/unit/test_obselete.py new file mode 100644 index 000000000000..5c0153b5c2a9 --- /dev/null +++ b/core/tests/unit/test_obselete.py @@ -0,0 +1,31 @@ +# Copyright 2016 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import warnings + +import mock + +from google.cloud import obselete + + +def test_complain_noop(): + with mock.patch.object(warnings, 'warn', autospec=True) as warn: + obselete.complain('bogus_package') + assert warn.call_count == 0 + + +def test_complain(): + with mock.patch.object(warnings, 'warn', autospec=True) as warn: + obselete.complain('google-cloud-core') + warn.assert_called_once_with(mock.ANY, DeprecationWarning) From 17232f81683b4b5c1fcb69e6d8eab01791870760 Mon Sep 17 00:00:00 2001 From: Luke Sneeringer Date: Fri, 4 Aug 2017 09:21:50 -0700 Subject: [PATCH 2/4] 2017 --- core/tests/unit/test_obselete.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/tests/unit/test_obselete.py b/core/tests/unit/test_obselete.py index 5c0153b5c2a9..78764c749490 100644 --- a/core/tests/unit/test_obselete.py +++ b/core/tests/unit/test_obselete.py @@ -1,4 +1,4 @@ -# Copyright 2016 Google Inc. +# Copyright 2017 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. From b5e3db05c04d403c0d3fb096ae732e1b7e8b1ac7 Mon Sep 17 00:00:00 2001 From: Luke Sneeringer Date: Fri, 4 Aug 2017 09:32:35 -0700 Subject: [PATCH 3/4] s/package/distribution --- core/google/cloud/obselete.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/core/google/cloud/obselete.py b/core/google/cloud/obselete.py index d884945121f3..b5ce6acd52a6 100644 --- a/core/google/cloud/obselete.py +++ b/core/google/cloud/obselete.py @@ -16,21 +16,22 @@ import warnings -def complain(package_name): - """Issue a warning if `package_name` is installed. +def complain(distribution_name): + """Issue a warning if `distribution_name` is installed. In a future release, this method will be updated to raise ImportError rather than just send a warning. Args: - package_name (str): The name of the obselete package. + distribution_name (str): The name of the obselete distribution. """ try: - pkg_resources.get_distribution(package_name) + pkg_resources.get_distribution(distribution_name) warnings.warn( - 'The {pkg} package is now obselete. Please `pip uninstall {pkg}`. ' + 'The {pkg} distribution is now obselete. ' + 'Please `pip uninstall {pkg}`. ' 'In the future, this warning will become an ImportError.'.format( - pkg=package_name, + pkg=distribution_name, ), DeprecationWarning, ) From e9971fa7b71cb480e0c528edd6eb45ee8fbddbe6 Mon Sep 17 00:00:00 2001 From: Luke Sneeringer Date: Fri, 4 Aug 2017 09:37:31 -0700 Subject: [PATCH 4/4] Fix import order. --- core/google/cloud/obselete.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/core/google/cloud/obselete.py b/core/google/cloud/obselete.py index b5ce6acd52a6..9af28cd85d52 100644 --- a/core/google/cloud/obselete.py +++ b/core/google/cloud/obselete.py @@ -12,9 +12,10 @@ # See the License for the specific language governing permissions and # limitations under the License. -import pkg_resources import warnings +import pkg_resources + def complain(distribution_name): """Issue a warning if `distribution_name` is installed.