Add a function to complain about obselete packages. (googleapis#3724)

lukesneeringer · web-flow · commit 6d7fae96d25a · 2017-08-04T09:50:46.000-07:00
diff --git a/core/google/cloud/obselete.py b/core/google/cloud/obselete.py
@@ -0,0 +1,40 @@
+# 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 warnings
+
+import pkg_resources
+
+
+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:
+        distribution_name (str): The name of the obselete distribution.
+    """
+    try:
+        pkg_resources.get_distribution(distribution_name)
+        warnings.warn(
+            'The {pkg} distribution is now obselete. '
+            'Please `pip uninstall {pkg}`. '
+            'In the future, this warning will become an ImportError.'.format(
+                pkg=distribution_name,
+            ),
+            DeprecationWarning,
+        )
+    except pkg_resources.DistributionNotFound:
+        pass
diff --git a/core/tests/unit/test_obselete.py b/core/tests/unit/test_obselete.py
@@ -0,0 +1,31 @@
+# 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 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)
