Merge pull request #2337 from rcomer/deprecate-style

MNT: deprecate the style module
SciTools · Mar 9, 2024 · 46aec1e · 46aec1e
2 parents 0fd1de7 + 3bfe800
commit 46aec1e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/lib/cartopy/mpl/style.py b/lib/cartopy/mpl/style.py
@@ -11,6 +11,10 @@
 import warnings
 
 
+warnings.warn('The style module is deprecated and will be removed in a future release.',
+              DeprecationWarning, stacklevel=2)
+
+
 # Define the matplotlib style aliases that cartopy can expand.
 # Note: This should not contain the plural aliases
 # (e.g. linewidths -> linewidth).

diff --git a/lib/cartopy/tests/mpl/test_style.py b/lib/cartopy/tests/mpl/test_style.py
@@ -3,9 +3,14 @@
 # This file is part of Cartopy and is released under the BSD 3-clause license.
 # See LICENSE in the root of the repository for full licensing details.
 
+import warnings
+
 import pytest
 
-from cartopy.mpl import style
+
+with warnings.catch_warnings():
+    warnings.simplefilter('ignore', DeprecationWarning)
+    from cartopy.mpl import style
 
 
 @pytest.mark.parametrize(