From 66f5f4dd467087a7a4eeb19a9a6566201550ee89 Mon Sep 17 00:00:00 2001
From: Ankush Menat <ankush@frappe.io>
Date: Wed, 9 Nov 2022 14:28:52 +0530
Subject: [PATCH] refactor(db): deprecated unused functions

---
 frappe/database/database.py  | 22 ++++++++++------------
 frappe/utils/deprecations.py | 27 +++++++++++++++++++++++++++
 2 files changed, 37 insertions(+), 12 deletions(-)
 create mode 100644 frappe/utils/deprecations.py

diff --git a/frappe/database/database.py b/frappe/database/database.py
index 8f8aa2bba2..91f73ba006 100644
--- a/frappe/database/database.py
+++ b/frappe/database/database.py
@@ -7,7 +7,6 @@ import random
 import re
 import string
 import traceback
-import warnings
 from contextlib import contextmanager, suppress
 from time import time
 
@@ -31,6 +30,7 @@ from frappe.model.utils.link_count import flush_local_link_count
 from frappe.query_builder.functions import Count
 from frappe.utils import cast as cast_fieldtype
 from frappe.utils import cint, get_datetime, get_table_name, getdate, now, sbool
+from frappe.utils.deprecations import deprecated, deprecation_warning
 
 IFNULL_PATTERN = re.compile(r"ifnull\(", flags=re.IGNORECASE)
 INDEX_PATTERN = re.compile(r"\s*\([^)]+\)\s*")
@@ -275,18 +275,9 @@ class Database:
 			return [r[0] for r in self.last_result]
 
 		if as_utf8:
-			warnings.warn(
-				"as_utf8 parameter is deprecated and will be removed in version 15.",
-				DeprecationWarning,
-				stacklevel=2,
-			)
-
+			deprecation_warning("as_utf8 parameter is deprecated and will be removed in version 15.")
 		if formatted:
-			warnings.warn(
-				"formatted parameter is deprecated and will be removed in version 15.",
-				DeprecationWarning,
-				stacklevel=2,
-			)
+			deprecation_warning("formatted parameter is deprecated and will be removed in version 15.")
 
 		# scrub output if required
 		if as_dict:
@@ -858,6 +849,7 @@ class Database:
 			).run(debug=debug, run=run, as_dict=as_dict)
 		return {}
 
+	@deprecated
 	def update(self, *args, **kwargs):
 		"""Update multiple values. Alias for `set_value`."""
 		return self.set_value(*args, **kwargs)
@@ -897,6 +889,9 @@ class Database:
 			modified_by = modified_by or frappe.session.user
 			to_update.update({"modified": modified, "modified_by": modified_by})
 
+		if for_update:
+			deprecation_warning("for_update parameter is deprecated and will be removed in v15.")
+
 		if is_single_doctype:
 			frappe.db.delete(
 				"Singles", filters={"field": ("in", tuple(to_update)), "doctype": dt}, debug=debug
@@ -927,11 +922,13 @@ class Database:
 		if dt in self.value_cache:
 			del self.value_cache[dt]
 
+	@deprecated
 	@staticmethod
 	def set(doc, field, val):
 		"""Set value in document. **Avoid**"""
 		doc.db_set(field, val)
 
+	@deprecated
 	def touch(self, doctype, docname):
 		"""Update the modified timestamp of this document."""
 		modified = now()
@@ -1254,6 +1251,7 @@ class Database:
 		"""
 		return self.sql_ddl(f"truncate `{get_table_name(doctype)}`")
 
+	@deprecated
 	def clear_table(self, doctype):
 		return self.truncate(doctype)
 
diff --git a/frappe/utils/deprecations.py b/frappe/utils/deprecations.py
new file mode 100644
index 0000000000..e98362198b
--- /dev/null
+++ b/frappe/utils/deprecations.py
@@ -0,0 +1,27 @@
+""" Utils for deprecating functionality in Framework.
+
+WARNING: This file is internal, instead of depending just copy the code or use deprecation
+libraries.
+"""
+import functools
+import warnings
+
+
+def deprecated(func):
+	"""Decorator to wrap a function/method as deprecated."""
+
+	@functools.wraps(func)
+	def wrapper(*args, **kwargs):
+		deprecation_warning(
+			f"{func.__name__} is deprecated and will be removed in next major version.",
+			stacklevel=1,
+		)
+		return func(*args, **kwargs)
+
+	return wrapper
+
+
+def deprecation_warning(message, category=DeprecationWarning, stacklevel=1):
+	"""like warnings.warn but with auto incremented sane stacklevel."""
+
+	warnings.warn(message=message, category=category, stacklevel=stacklevel + 2)