Translation script: Fix incorrect multiline matches (#15)

SmallJoker · web-flow · commit bd16ad824ca0 · 2025-11-13T18:48:46.000+01:00
Prevously, the translation update script would match 'if not input:find("%S") then' because 'S"' is
a valid function call expression. This commit addresses that by only matching single lines.
Whereas that's a workaround, it does work well. --&gt; Tested on luanti/builtin
diff --git a/mod_translation_updater.py b/mod_translation_updater.py
@@ -119,15 +119,16 @@ def main():
 				update_folder(os.path.abspath("./"))
 
 # Compile pattern for matching lua function call
-def compile_func_call_pattern(argument_pattern):
+# flag = re.DOTALL : Allow matching multiple lines
+# flag = re.NOFLAG : Match single lines only
+def compile_func_call_pattern(argument_pattern: str, flag):
 	return re.compile(
 		# Look for beginning of file or anything that isn't a function identifier
 		r'(?<![a-zA-Z0-9_])' +
 		# Matches S, FS, NS, or NFS function call
 		r'N?F?S\s*' +
 		# The pattern to match argument
-		argument_pattern,
-		re.DOTALL)
+		argument_pattern, flag)
 
 # Add parentheses around a pattern
 def parenthesize_pattern(pattern):
@@ -148,17 +149,17 @@ def parenthesize_pattern(pattern):
 pattern_lua_square_bracket_string = r'\[\[(.*?)\]\]'
 
 # Handles the " ... " or ' ... ' string delimiters
-pattern_lua_quoted = compile_func_call_pattern(parenthesize_pattern(pattern_lua_quoted_string))
+pattern_lua_quoted = compile_func_call_pattern(parenthesize_pattern(pattern_lua_quoted_string), re.NOFLAG)
 
 # Handles the [[ ... ]] string delimiters
-pattern_lua_bracketed = compile_func_call_pattern(parenthesize_pattern(pattern_lua_square_bracket_string))
+pattern_lua_bracketed = compile_func_call_pattern(parenthesize_pattern(pattern_lua_square_bracket_string), re.DOTALL)
 
 # Handles like pattern_lua_quoted, but for single parameter (without parentheses)
 # See https://www.lua.org/pil/5.html for informations about single argument call
-pattern_lua_quoted_single = compile_func_call_pattern(pattern_lua_quoted_string)
+pattern_lua_quoted_single = compile_func_call_pattern(pattern_lua_quoted_string, re.NOFLAG)
 
 # Same as pattern_lua_quoted_single, but for [[ ... ]] string delimiters
-pattern_lua_bracketed_single = compile_func_call_pattern(pattern_lua_square_bracket_string)
+pattern_lua_bracketed_single = compile_func_call_pattern(pattern_lua_square_bracket_string, re.DOTALL)
 
 # Handles "concatenation" .. " of strings"
 pattern_concat = re.compile(r'["\'][\s]*\.\.[\s]*["\']', re.DOTALL)
@@ -220,14 +221,15 @@ def mkdir_p(path):
 # dKeyStrings is a dictionary of localized string to source file sets
 # dOld is a dictionary of existing translations and comments from
 # the previous version of this text
-def strings_to_text(dkeyStrings, dOld, mod_name, header_comments, textdomain, templ = None):
+def strings_to_text(dkeyStrings: dict, dOld: dict, mod_name: str, header_comments,
+		textdomain: str|None, templ: list|None):
 	# if textdomain is specified, insert it at the top
 	if textdomain != None:
 		lOut = [textdomain] # argument is full textdomain line
 	# otherwise, use mod name as textdomain automatically
 	else:
 		lOut = [f"# textdomain: {mod_name}"]
-	if templ is not None and templ[2] and (header_comments is None or not header_comments.startswith(templ[2])):
+	if templ != None and templ[2] and (header_comments is None or not header_comments.startswith(templ[2])):
 		# header comments in the template file
 		lOut.append(templ[2])
 	if header_comments is not None:
@@ -245,6 +247,7 @@ def strings_to_text(dkeyStrings, dOld, mod_name, header_comments, textdomain, te
 	lSourceKeys = list(dGroupedBySource.keys())
 	lSourceKeys.sort()
 	for source in lSourceKeys:
+		# source: relative path to the .lua file
 		localizedStrings = dGroupedBySource[source]
 		if params["print-source"]:
 			if lOut[-1] != "":
@@ -296,7 +299,8 @@ def write_template(templ_file, dkeyStrings, mod_name):
 	# read existing template file to preserve comments
 	existing_template = import_tr_file(templ_file)
 
-	text = strings_to_text(dkeyStrings, existing_template[0], mod_name, existing_template[2], existing_template[3])
+	text = strings_to_text(dkeyStrings, existing_template[0], mod_name,
+			existing_template[2], existing_template[3], None)
 	mkdir_p(os.path.dirname(templ_file))
 	with open(templ_file, "wt", encoding='utf-8') as template_file:
 		template_file.write(text)
