From 1a359fe986d7d3dfa6278d66e3dd958b28477f3b Mon Sep 17 00:00:00 2001
From: Lars Buntemeyer <larsbuntemeyer@gmail.com>
Date: Tue, 4 Jul 2023 14:55:03 +0200
Subject: [PATCH] added deprecation warning to prudence regions

---
 cordex/regions/_prudence.py | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/cordex/regions/_prudence.py b/cordex/regions/_prudence.py
index c45ae77..08af93f 100644
--- a/cordex/regions/_prudence.py
+++ b/cordex/regions/_prudence.py
@@ -1,9 +1,16 @@
+from warnings import warn
+
 import pandas as pd
 import xarray as xr
 
 from ._regions import WGS84
 from ._resources import fetch_prudence
 
+message = (
+    "Prudence regions are deprecated and will be removed in a future version."
+    "Please use regionmask.defined_regions.prudence instead."
+)
+
 
 def _create_polygons(df):
     from shapely.geometry import Polygon
@@ -63,17 +70,37 @@ class Prudence:
 
     @property
     def df(self):
+        warn(
+            message,
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return pd.read_csv(fetch_prudence(), na_filter=False, index_col="area")
 
     @property
     def geodataframe(self):
+        warn(
+            message,
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return geodataframe(self.df)
 
     @property
     def regionmask(self):
+        warn(
+            message,
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return regions(self.df)
 
     def mask_3D(self, lon, lat, **kwargs):
+        warn(
+            message,
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return mask_3D(self.regionmask, lon, lat, **kwargs)