From bc6d65d203200c32aec94c5f81778decde0352ee Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mike=20F=C3=A4hrmann?= <mike_faehrmann@web.de>
Date: Thu, 4 May 2023 10:49:14 +0200
Subject: [PATCH] implement 'Extractor.config_deprecated()'

a version of 'Extractor.config()'
that logs a warning when using a deprecated option name
---
 gallery_dl/extractor/common.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/gallery_dl/extractor/common.py b/gallery_dl/extractor/common.py
index 8e3a9a9b..78760e0a 100644
--- a/gallery_dl/extractor/common.py
+++ b/gallery_dl/extractor/common.py
@@ -90,6 +90,21 @@ class Extractor():
     def config(self, key, default=None):
         return config.interpolate(self._cfgpath, key, default)
 
+    def config_deprecated(self, key, deprecated, default=None,
+                          sentinel=util.SENTINEL, history=set()):
+        value = self.config(deprecated, sentinel)
+        if value is not sentinel:
+            if deprecated not in history:
+                history.add(deprecated)
+                self.log.warning("'%s' is deprecated. Use '%s' instead.",
+                                 deprecated, key)
+            default = value
+
+        value = self.config(key, sentinel)
+        if value is not sentinel:
+            return value
+        return default
+
     def config_accumulate(self, key):
         return config.accumulate(self._cfgpath, key)