feat: extractor for customizations

Added extraction for property setters and links

babel_extractors.csv

@@ -7,5 +7,5 @@ hooks.py,frappe.gettext.extractors.navbar.extract
 **.py,frappe.gettext.extractors.python.extract
 **.js,frappe.gettext.extractors.javascript.extract
 **.html,frappe.gettext.extractors.html_template.extract
-**/custom/*.json,frappe.gettext.extractors.customizations.extract
+**/custom/*.json,frappe.gettext.extractors.customization.extract
 **/fixtures/custom_field.json,frappe.gettext.extractors.custom_field.extract

frappe/gettext/extractors/customization.py

@@ -0,0 +1,117 @@
+import json
+
+EXCLUDE_SELECT_OPTIONS = [
+	"naming_series",
+	"number_format",
+	"float_precision",
+	"currency_precision",
+	"minimum_password_score",
+]
+
+
+def extract(fileobj, *args, **kwargs):
+	"""
+	Extract messages from DocType JSON files. To be used to babel extractor
+	:param fileobj: the file-like object the messages should be extracted from
+	:rtype: `iterator`
+	"""
+	data = json.load(fileobj)
+
+	if isinstance(data, list):
+		return
+
+	doctype = data.get("doctype")
+
+	messages = []
+
+	for field in data.get("custom_fields", []):
+		fieldtype = field.get("fieldtype")
+		fieldname = field.get("fieldname")
+		label = field.get("label")
+
+		if label:
+			messages.append((label, f"Label of the '{fieldname}' ({fieldtype}) field in DocType '{doctype}'"))
+			_label = label
+		else:
+			_label = fieldname
+
+		if description := field.get("description"):
+			messages.append(
+				(
+					description,
+					f"Description of the '{_label}' ({fieldtype}) field in DocType '{doctype}'",
+				)
+			)
+
+		if message := field.get("options"):
+			if fieldtype == "Select":
+				if fieldname in EXCLUDE_SELECT_OPTIONS:
+					continue
+
+				select_options = [option for option in message.split("\n") if option and not option.isdigit()]
+
+				if select_options and "icon" in select_options[0]:
+					continue
+
+				messages.extend(
+					(
+						option,
+						f"Option for the '{_label}' ({fieldtype}) field in DocType '{doctype}'",
+					)
+					for option in select_options
+				)
+			elif fieldtype == "HTML":
+				messages.append(
+					(
+						message,
+						f"Content of the '{_label}' ({fieldtype}) field in DocType '{doctype}'",
+					)
+				)
+
+	for property_setter in data.get("property_setters", []):
+		if property_setter.get("doctype_or_field") != "DocField":
+			continue
+
+		property_name = property_setter.get("property")
+
+		fieldname = property_setter.get("field_name")
+		if property_name == "options" and fieldname not in EXCLUDE_SELECT_OPTIONS:
+			message = property_setter.get("value")
+			select_options = [option for option in message.split("\n") if option and not option.isdigit()]
+
+			if select_options and "icon" in select_options[0]:
+				continue
+
+			messages.extend(
+				(
+					option,
+					f"Option for the '{fieldname}' (Select) field in DocType '{doctype}'",
+				)
+				for option in select_options
+			)
+
+		if property_name == "label":
+			messages.append(
+				(
+					property_setter.get("value"),
+					f"Label of the '{fieldname}' field in DocType '{doctype}'",
+				)
+			)
+
+		if property_name == "description":
+			messages.append(
+				(
+					property_setter.get("value"),
+					f"Description of the '{fieldname}' field in DocType '{doctype}'",
+				)
+			)
+
+	for link in data.get("links", []):
+		group = link.get("group")
+		if not group:
+			continue
+
+		messages.append((group, f"Connections link group in DocType '{doctype}'"))
+
+	# By using "pgettext" as the function name we can supply the doctype as context
+	yield from ((None, "_", message, [comment]) for message, comment in messages)

frappe/gettext/extractors/customizations.py

@@ -1,73 +0,0 @@
-import json
-
-EXCLUDE_SELECT_OPTIONS = [
-	"naming_series",
-	"number_format",
-	"float_precision",
-	"currency_precision",
-	"minimum_password_score",
-]
-
-
-def extract(fileobj, *args, **kwargs):
-	"""
-	Extract messages from DocType JSON files. To be used to babel extractor
-	:param fileobj: the file-like object the messages should be extracted from
-	:rtype: `iterator`
-	"""
-	data = json.load(fileobj)
-
-	if isinstance(data, list):
-		return
-
-	doctype = data.get("doctype")
-
-	messages = []
-	fields = data.get("custom_fields", [])
-
-	for field in fields:
-		fieldtype = field.get("fieldtype")
-		fieldname = field.get("fieldname")
-		label = field.get("label")
-
-		if label:
-			messages.append((label, f"Label of a {fieldtype} field in Customization of DocType '{doctype}'"))
-			_label = label
-		else:
-			_label = fieldname
-
-		if description := field.get("description"):
-			messages.append(
-				(
-					description,
-					f"Description of the '{_label}' ({fieldtype}) field in Customization of DocType '{doctype}'",
-				)
-			)
-
-		if message := field.get("options"):
-			if fieldtype == "Select":
-				if fieldname in EXCLUDE_SELECT_OPTIONS:
-					continue
-
-				select_options = [option for option in message.split("\n") if option and not option.isdigit()]
-
-				if select_options and "icon" in select_options[0]:
-					continue
-
-				messages.extend(
-					(
-						option,
-						f"Option for the '{_label}' ({fieldtype}) field in Customization of DocType '{doctype}'",
-					)
-					for option in select_options
-				)
-			elif fieldtype == "HTML":
-				messages.append(
-					(
-						message,
-						f"Content of the '{_label}' ({fieldtype}) field in Customization of DocType '{doctype}'",
-					)
-				)
-
-	# By using "pgettext" as the function name we can supply the doctype as context
-	yield from ((None, "pgettext", (doctype, message), [comment]) for message, comment in messages)