Merge pull request #16698 from gavindsouza/traceback-with-context

feat: Traceback with context

frappe/__init__.py

@@ -354,11 +354,11 @@ def cache() -> "RedisWrapper":
 	return redis_server
 
 
-def get_traceback():
+def get_traceback(with_context=False):
 	"""Returns error traceback."""
 	from frappe.utils import get_traceback
 
-	return get_traceback()
+	return get_traceback(with_context=with_context)
 
 
 def errprint(msg):
@@ -2086,7 +2086,6 @@ def logger(
 
 def log_error(title=None, message=None, reference_doctype=None, reference_name=None):
 	"""Log error to Error Log"""
-
 	# Parameter ALERT:
 	# the title and message may be swapped
 	# the better API for this is log_error(title, message), and used in many cases this way
@@ -2099,20 +2098,15 @@ def log_error(title=None, message=None, reference_doctype=None, reference_name=N
 		else:
 			traceback = message
 
-	if not traceback:
-		traceback = get_traceback()
-
-	if not title:
-		title = "Error"
+	title = title or "Error"
+	traceback = as_unicode(traceback or get_traceback(with_context=True))
 
 	return get_doc(
-		dict(
-			doctype="Error Log",
-			error=as_unicode(traceback),
-			method=title,
-			reference_doctype=reference_doctype,
-			reference_name=reference_name,
-		)
+		doctype="Error Log",
+		error=traceback,
+		method=title,
+		reference_doctype=reference_doctype,
+		reference_name=reference_name,
 	).insert(ignore_permissions=True)
 
 

frappe/database/database.py

@@ -1066,7 +1066,7 @@ class Database(object):
 			now_datetime() - relativedelta(minutes=minutes),
 		)[0][0]
 
-	def get_db_table_columns(self, table):
+	def get_db_table_columns(self, table) -> List[str]:
 		"""Returns list of column names from given table."""
 		columns = frappe.cache().hget("table_columns", table)
 		if columns is None:

frappe/model/base_document.py

@@ -2,6 +2,7 @@
 # License: MIT. See LICENSE
 import datetime
 import json
+from typing import Dict, List
 
 import frappe
 from frappe import _
@@ -252,7 +253,7 @@ class BaseDocument(object):
 
 	def get_valid_dict(
 		self, sanitize=True, convert_dates_to_str=False, ignore_nulls=False, ignore_virtual=False
-	):
+	) -> Dict:
 		d = frappe._dict()
 		for fieldname in self.meta.get_valid_columns():
 			d[fieldname] = self.get(fieldname)
@@ -329,7 +330,7 @@ class BaseDocument(object):
 			if key not in self.__dict__:
 				self.__dict__[key] = None
 
-	def get_valid_columns(self):
+	def get_valid_columns(self) -> List[str]:
 		if self.doctype not in frappe.local.valid_columns:
 			if self.doctype in DOCTYPES_FOR_DOCTYPE:
 				from frappe.model.meta import get_table_columns
@@ -342,7 +343,7 @@ class BaseDocument(object):
 
 		return frappe.local.valid_columns[self.doctype]
 
-	def is_new(self):
+	def is_new(self) -> bool:
 		return self.get("__islocal")
 
 	@property
@@ -359,7 +360,7 @@ class BaseDocument(object):
 		no_default_fields=False,
 		convert_dates_to_str=False,
 		no_child_table_fields=False,
-	):
+	) -> Dict:
 		doc = self.get_valid_dict(convert_dates_to_str=convert_dates_to_str)
 		doc["doctype"] = self.doctype
 

frappe/utils/__init__.py

@@ -18,6 +18,7 @@ from typing import Generator, Iterable
 from urllib.parse import quote, urlparse
 
 from redis.exceptions import ConnectionError
+from traceback_with_variables import iter_exc_lines
 from werkzeug.test import Client
 
 import frappe
@@ -255,7 +256,7 @@ def get_gravatar(email):
 	return gravatar_url
 
 
-def get_traceback() -> str:
+def get_traceback(with_context=False) -> str:
 	"""
 	Returns the traceback of the Exception
 	"""
@@ -264,14 +265,19 @@ def get_traceback() -> str:
 	if not any([exc_type, exc_value, exc_tb]):
 		return ""
 
-	trace_list = traceback.format_exception(exc_type, exc_value, exc_tb)
-	bench_path = get_bench_path() + "/"
+	if with_context:
+		trace_list = iter_exc_lines()
+		tb = "\n".join(trace_list)
+	else:
+		trace_list = traceback.format_exception(exc_type, exc_value, exc_tb)
+		tb = "".join(cstr(t) for t in trace_list)
 
-	return "".join(cstr(t) for t in trace_list).replace(bench_path, "")
+	bench_path = get_bench_path() + "/"
+	return tb.replace(bench_path, "")
 
 
 def log(event, details):
-	frappe.logger().info(details)
+	frappe.logger(event).info(details)
 
 
 def dict_to_str(args, sep="&"):

requirements.txt

@@ -63,6 +63,7 @@ semantic-version~=2.8.5
 sqlparse~=0.4.1
 stripe~=2.56.0
 terminaltables~=3.1.0
+traceback-with-variables~=2.0.4
 urllib3~=1.26.4
 Werkzeug~=2.0.3
 Whoosh~=2.7.4