From 62732ee08c764c7c8c1ccb8641ca3178bc233380 Mon Sep 17 00:00:00 2001 From: Lars Buntemeyer Date: Thu, 19 Dec 2024 18:36:49 +0000 Subject: [PATCH] added deprecation messages --- cordex/preprocessing/preprocessing.py | 25 +++++++++++++++++++++++++ docs/whats_new.rst | 2 +- 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/cordex/preprocessing/preprocessing.py b/cordex/preprocessing/preprocessing.py index f1835a6..f2e12d4 100644 --- a/cordex/preprocessing/preprocessing.py +++ b/cordex/preprocessing/preprocessing.py @@ -269,6 +269,11 @@ def replace_rlon_rlat(ds, domain=None): Dataset with updated rlon, rlat. """ + warn( + "replace_rlon_rlat is deprecated, please use rewrite_coords instead", + DeprecationWarning, + stacklevel=2, + ) ds = ds.copy() if domain is None: domain = ds.cx.domain_id @@ -297,6 +302,11 @@ def replace_vertices(ds, domain=None): Dataset with updated vertices. """ + warn( + "replace_vertices is deprecated, please use rewrite_coords instead", + DeprecationWarning, + stacklevel=2, + ) ds = ds.copy() if domain is None: domain = ds.attrs.get("CORDEX_domain", None) @@ -325,6 +335,11 @@ def replace_lon_lat(ds, domain=None): Dataset with updated lon, lat. """ + warn( + "replace_lon_lat is deprecated, please use rewrite_coords instead", + DeprecationWarning, + stacklevel=2, + ) ds = ds.copy() if domain is None: domain = ds.cx.domain_id @@ -355,6 +370,11 @@ def replace_coords(ds, domain=None): """ + warn( + "replace_coords is deprecated, please use rewrite_coords instead", + DeprecationWarning, + stacklevel=2, + ) ds = ds.copy() ds = replace_rlon_rlat(ds, domain) ds = replace_lon_lat(ds, domain) @@ -380,6 +400,11 @@ def replace_grid(ds, domain=None): """ + warn( + "replace_grid is deprecated, please use rewrite_coords instead", + DeprecationWarning, + stacklevel=2, + ) ds = ds.copy() ds = replace_rlon_rlat(ds, domain) ds = replace_lon_lat(ds, domain) diff --git a/docs/whats_new.rst b/docs/whats_new.rst index f092ed5..10abcc6 100644 --- a/docs/whats_new.rst +++ b/docs/whats_new.rst @@ -12,7 +12,7 @@ rounding errors. This version drops python3.8 support. New Features ~~~~~~~~~~~~ -- New function :py:meth:`cordex.rewrite_coords` (:pull:`306`). +- New function :py:meth:`cordex.rewrite_coords` (:pull:`306`, :pull:`307`). Breaking Changes ~~~~~~~~~~~~~~~~