From b2e36634d67e9ac0de7d95f6dedd49519c9b9543 Mon Sep 17 00:00:00 2001
From: barredterra <14891507+barredterra@users.noreply.github.com>
Date: Sat, 4 Mar 2023 19:30:03 +0100
Subject: [PATCH] refactor: rename `get_time_zone` to `get_system_timezone`

---
 frappe/boot.py                                  |  6 +++---
 frappe/core/doctype/user/user.py                |  4 ++--
 .../doctype/google_calendar/google_calendar.py  | 10 +++++-----
 .../doctype/token_cache/token_cache.py          |  4 ++--
 frappe/oauth.py                                 |  3 ++-
 frappe/utils/data.py                            | 17 ++++++++++++-----
 frappe/website/utils.py                         |  6 +++---
 7 files changed, 29 insertions(+), 21 deletions(-)

diff --git a/frappe/boot.py b/frappe/boot.py
index 9594635c70..0cab7a060c 100644
--- a/frappe/boot.py
+++ b/frappe/boot.py
@@ -21,7 +21,7 @@ from frappe.social.doctype.energy_point_settings.energy_point_settings import (
 	is_energy_point_enabled,
 )
 from frappe.translate import get_lang_dict, get_messages_for_boot, get_translated_doctypes
-from frappe.utils import add_user_info, cstr, get_time_zone
+from frappe.utils import add_user_info, cstr, get_system_timezone
 from frappe.utils.change_log import get_versions
 from frappe.website.doctype.web_page_view.web_page_view import is_tracking_enabled
 
@@ -402,9 +402,9 @@ def get_link_title_doctypes():
 
 def set_time_zone(bootinfo):
 	bootinfo.time_zone = {
-		"system": get_time_zone(),
+		"system": get_system_timezone(),
 		"user": bootinfo.get("user_info", {}).get(frappe.session.user, {}).get("time_zone", None)
-		or get_time_zone(),
+		or get_system_timezone(),
 	}
 
 
diff --git a/frappe/core/doctype/user/user.py b/frappe/core/doctype/user/user.py
index e04e43051f..c79e1cef63 100644
--- a/frappe/core/doctype/user/user.py
+++ b/frappe/core/doctype/user/user.py
@@ -23,7 +23,7 @@ from frappe.utils import (
 	flt,
 	format_datetime,
 	get_formatted_email,
-	get_time_zone,
+	get_system_timezone,
 	has_gravatar,
 	now_datetime,
 	today,
@@ -647,7 +647,7 @@ class User(Document):
 
 	def set_time_zone(self):
 		if not self.time_zone:
-			self.time_zone = get_time_zone()
+			self.time_zone = get_system_timezone()
 
 
 @frappe.whitelist()
diff --git a/frappe/integrations/doctype/google_calendar/google_calendar.py b/frappe/integrations/doctype/google_calendar/google_calendar.py
index 5056f536fc..a663c9c593 100644
--- a/frappe/integrations/doctype/google_calendar/google_calendar.py
+++ b/frappe/integrations/doctype/google_calendar/google_calendar.py
@@ -21,7 +21,7 @@ from frappe.utils import (
 	add_to_date,
 	get_datetime,
 	get_request_site_address,
-	get_time_zone,
+	get_system_timezone,
 	get_weekdays,
 	now_datetime,
 )
@@ -575,14 +575,14 @@ def google_calendar_to_repeat_on(start, end, recurrence=None):
 			get_datetime(start.get("date"))
 			if start.get("date")
 			else parser.parse(start.get("dateTime"))
-			.astimezone(ZoneInfo(get_time_zone()))
+			.astimezone(ZoneInfo(get_system_timezone()))
 			.replace(tzinfo=None)
 		),
 		"ends_on": (
 			get_datetime(end.get("date"))
 			if end.get("date")
 			else parser.parse(end.get("dateTime"))
-			.astimezone(ZoneInfo(get_time_zone()))
+			.astimezone(ZoneInfo(get_system_timezone()))
 			.replace(tzinfo=None)
 		),
 		"all_day": 1 if start.get("date") else 0,
@@ -648,11 +648,11 @@ def format_date_according_to_google_calendar(all_day, starts_on, ends_on=None):
 	date_format = {
 		"start": {
 			"dateTime": starts_on.isoformat(),
-			"timeZone": get_time_zone(),
+			"timeZone": get_system_timezone(),
 		},
 		"end": {
 			"dateTime": ends_on.isoformat(),
-			"timeZone": get_time_zone(),
+			"timeZone": get_system_timezone(),
 		},
 	}
 
diff --git a/frappe/integrations/doctype/token_cache/token_cache.py b/frappe/integrations/doctype/token_cache/token_cache.py
index a4f34b4ad9..b79dfe0abf 100644
--- a/frappe/integrations/doctype/token_cache/token_cache.py
+++ b/frappe/integrations/doctype/token_cache/token_cache.py
@@ -8,7 +8,7 @@ import pytz
 import frappe
 from frappe import _
 from frappe.model.document import Document
-from frappe.utils import cint, cstr, get_time_zone
+from frappe.utils import cint, cstr, get_system_timezone
 
 
 class TokenCache(Document):
@@ -52,7 +52,7 @@ class TokenCache(Document):
 		return self
 
 	def get_expires_in(self):
-		system_timezone = pytz.timezone(get_time_zone())
+		system_timezone = pytz.timezone(get_system_timezone())
 		modified = frappe.utils.get_datetime(self.modified)
 		modified = system_timezone.localize(modified)
 		expiry_utc = modified.astimezone(pytz.utc) + timedelta(seconds=self.expires_in)
diff --git a/frappe/oauth.py b/frappe/oauth.py
index 68e21ac88b..8099bdab45 100644
--- a/frappe/oauth.py
+++ b/frappe/oauth.py
@@ -11,6 +11,7 @@ from oauthlib.openid import RequestValidator
 
 import frappe
 from frappe.auth import LoginManager
+from frappe.utils.data import get_system_timezone
 
 
 class OAuthWebRequestValidator(RequestValidator):
@@ -248,7 +249,7 @@ class OAuthWebRequestValidator(RequestValidator):
 		# Remember to check expiration and scope membership
 		otoken = frappe.get_doc("OAuth Bearer Token", token)
 		token_expiration_local = otoken.expiration_time.replace(
-			tzinfo=pytz.timezone(frappe.utils.get_time_zone())
+			tzinfo=pytz.timezone(get_system_timezone())
 		)
 		token_expiration_utc = token_expiration_local.astimezone(pytz.utc)
 		is_token_valid = (
diff --git a/frappe/utils/data.py b/frappe/utils/data.py
index 1e75d93fd1..767d6b4f4b 100644
--- a/frappe/utils/data.py
+++ b/frappe/utils/data.py
@@ -318,15 +318,22 @@ def get_eta(from_time, percent_complete):
 	return str(datetime.timedelta(seconds=(100 - percent_complete) / percent_complete * diff))
 
 
-def _get_time_zone():
+def _get_system_timezone():
 	return frappe.db.get_system_setting("time_zone") or "Asia/Kolkata"  # Default to India ?!
 
 
-def get_time_zone():
+def get_system_timezone():
 	if frappe.local.flags.in_test:
-		return _get_time_zone()
+		return _get_system_timezone()
 
-	return frappe.cache().get_value("time_zone", _get_time_zone)
+	return frappe.cache().get_value("time_zone", _get_system_timezone)
+
+
+def get_time_zone():
+	deprecation_warning(
+		"`get_time_zone` is deprecated and will be removed in version 16. Use `get_system_timezone` instead."
+	)
+	return get_system_timezone()
 
 
 def convert_utc_to_timezone(utc_timestamp, time_zone):
@@ -345,7 +352,7 @@ def get_datetime_in_timezone(time_zone):
 
 
 def convert_utc_to_system_timezone(utc_timestamp):
-	time_zone = get_time_zone()
+	time_zone = get_system_timezone()
 	return convert_utc_to_timezone(utc_timestamp, time_zone)
 
 
diff --git a/frappe/website/utils.py b/frappe/website/utils.py
index 244fd010b6..71af463c96 100644
--- a/frappe/website/utils.py
+++ b/frappe/website/utils.py
@@ -12,7 +12,7 @@ from werkzeug.wrappers import Response
 import frappe
 from frappe import _
 from frappe.model.document import Document
-from frappe.utils import cint, get_assets_json, get_time_zone, md_to_html
+from frappe.utils import cint, get_assets_json, get_system_timezone, md_to_html
 
 FRONTMATTER_PATTERN = re.compile(r"^\s*(?:---|\+\+\+)(.*?)(?:---|\+\+\+)\s*(.+)$", re.S | re.M)
 H1_TAG_PATTERN = re.compile("<h1>([^<]*)")
@@ -167,8 +167,8 @@ def get_boot_data():
 			"time_format": frappe.get_system_settings("time_format") or "HH:mm:ss",
 		},
 		"time_zone": {
-			"system": get_time_zone(),
-			"user": frappe.db.get_value("User", frappe.session.user, "time_zone") or get_time_zone(),
+			"system": get_system_timezone(),
+			"user": frappe.db.get_value("User", frappe.session.user, "time_zone") or get_system_timezone(),
 		},
 		"assets_json": get_assets_json(),
 	}