Module:Introspection utils - Revision history

Ganaram inukshuk at 22:34, 30 October 2025

2025-10-30T22:34:33Z

← Older revision		Revision as of 22:34, 30 October 2025
Line 3:		Line 3:

	-- TODO:		-- TODO:
	-- Add support for detecting modules providing data, not just functions		-- Add support for detecting modules providing data, not just functions.
			-- Address edge case of lazy-loaded modules (loaded within a function)

	-- Common functions for module and template introspection.		-- Common functions for module and template introspection.

Ganaram inukshuk: todo

2025-10-30T11:06:01Z

todo

← Older revision		Revision as of 11:06, 30 October 2025
Line 3:		Line 3:

	-- TODO:		-- TODO:
	-- ~~- Detect whether a template invokes a specific module~~		-- Add support for detecting modules providing data, not just functions

	-- Common functions for module and template introspection.		-- Common functions for module and template introspection.

Ganaram inukshuk at 08:44, 30 October 2025

2025-10-30T08:44:32Z

← Older revision		Revision as of 08:44, 30 October 2025
Line 82:		Line 82:
	end		end

	-- Normalize tags ~~and subst~~		-- Normalize tags
	text_to_scan = text_to_scan		text_to_scan = text_to_scan
	:gsub("<noinclude>.-</noinclude>", "")		:gsub("<noinclude>.-</noinclude>", "")
Line 90:		Line 90:
	:gsub("<onlyinclude>", "")		:gsub("<onlyinclude>", "")
	:gsub("</onlyinclude>", "")		:gsub("</onlyinclude>", "")
	~~:gsub("{{%s*safesubst:", "{{")~~
	~~:gsub("{{%s*subst:", "{{")~~

	-- Normalize:		-- Normalize subst/safesubst
			text_to_scan = text_to_scan
			:gsub("{{+%s*[Ss]afesubst:", "{{")
			:gsub("{{+%s*[Ss]ubst:", "{{")

			-- Normalize spaces
	text_to_scan = text_to_scan		text_to_scan = text_to_scan
	:gsub("[\r\n]", " ")		:gsub("[\r\n]", " ")

Ganaram inukshuk at 08:35, 30 October 2025

2025-10-30T08:35:44Z

← Older revision		Revision as of 08:35, 30 October 2025
Line 328:		Line 328:
	local function normalize_module_name(name)		local function normalize_module_name(name)
	if not name then return "" end		if not name then return "" end
	-- Trim, replace spaces with underscores, remove namespace		-- Trim, replace spaces with underscores, remove namespace, lowercase first
			-- letter
	name = mw.text.trim(name)		name = mw.text.trim(name)
	name = name:gsub(" ", "_")		name = name:gsub(" ", "_")
	name = name:gsub("^[Mm]odule:", "")		name = name:gsub("^[Mm]odule:", "")
			name = name:gsub("^%a", string.lower)
	return name		return name
	end		end

Ganaram inukshuk at 08:30, 30 October 2025

2025-10-30T08:30:31Z

← Older revision		Revision as of 08:30, 30 October 2025
Line 324:		Line 324:

	return title and title.exists		return title and title.exists
			end

			local function normalize_module_name(name)
			if not name then return "" end
			-- Trim, replace spaces with underscores, remove namespace
			name = mw.text.trim(name)
			name = name:gsub(" ", "_")
			name = name:gsub("^[Mm]odule:", "")
			return name
	end		end

Line 329:		Line 338:
	-- of invocations, from find_invokes, and mod_name is the module name.		-- of invocations, from find_invokes, and mod_name is the module name.
	function p.invocation_exists(invokes, mod_name)		function p.invocation_exists(invokes, mod_name)
	~~-- Normalize module name~~		if type(invokes) ~= "table" then
	~~local function normalize(name)~~		return false
	if type(~~name~~) ~= "~~string~~" then
	~~name = tostring(name or "")~~
	~~end~~
	~~name = name:gsub("_", " "):lower():gsub("^module:%s*", "")~~
	return ~~name~~
	end		end

			local target_mod = normalize_module_name(mod_name)

	~~local target_mod = normalize(mod_name)~~

	~~-- Search~~
	for _, invoke in ipairs(invokes) do		for _, invoke in ipairs(invokes) do
	if ~~normalize~~(invoke.module) == target_mod then		if normalize_module_name(invoke["module"]) == target_mod then
	return true		return true
	end		end
	end		end

	return false		return false
			end

			function p.tester()

			local wikitext = p.get_and_preprocess_content("Template", "MOS intro")
			local invokes = p.find_invokes(wikitext)

			return p.invocation_exists(invokes, "MOS intro")
	end		end

	return p		return p

Ganaram inukshuk at 07:43, 30 October 2025

2025-10-30T07:43:16Z

← Older revision		Revision as of 07:43, 30 October 2025
Line 331:		Line 331:
	-- Normalize module name		-- Normalize module name
	local function normalize(name)		local function normalize(name)
	if ~~not~~ name then ~~return~~ "" end		if type(name) ~= "string" then
	~~return~~ name:gsub("_", " ").lower():gsub("^module:%s*", "")		name = tostring(name or "")
			end
			name = name:gsub("_", " "):lower():gsub("^module:%s*", "")
			return name
	end		end

Ganaram inukshuk at 07:40, 30 October 2025

2025-10-30T07:40:43Z

← Older revision		Revision as of 07:40, 30 October 2025
Line 330:		Line 330:
	function p.invocation_exists(invokes, mod_name)		function p.invocation_exists(invokes, mod_name)
	-- Normalize module name		-- Normalize module name
	local normalize ~~= function~~(name)		local function normalize(name)
	name ~~= name or~~ ""		if not name then return "" end
	~~name =~~ name:gsub("_", " ")		return name:gsub("_", " ").lower():gsub("^module:%s*", "")
	~~name = name:~~lower()
	~~name = name~~:gsub("^module:%s*", "")
	~~return name~~
	end		end

Line 342:		Line 339:
	-- Search		-- Search
	for _, invoke in ipairs(invokes) do		for _, invoke in ipairs(invokes) do
	~~local invoke_mod =~~ normalize(invoke.module)		if normalize(invoke.module) == target_mod then
	~~if invoke_mod~~ == target_mod then
	return true		return true
	end		end

Ganaram inukshuk at 07:29, 30 October 2025

2025-10-30T07:29:06Z

← Older revision		Revision as of 07:29, 30 October 2025
Line 329:		Line 329:
	-- of invocations, from find_invokes, and mod_name is the module name.		-- of invocations, from find_invokes, and mod_name is the module name.
	function p.invocation_exists(invokes, mod_name)		function p.invocation_exists(invokes, mod_name)
			-- Normalize module name
			local normalize = function(name)
			name = name or ""
			name = name:gsub("_", " ")
			name = name:lower()
			name = name:gsub("^module:%s*", "")
			return name
			end

			local target_mod = normalize(mod_name)

			-- Search
	for _, invoke in ipairs(invokes) do		for _, invoke in ipairs(invokes) do
	if invoke.module ~~== module_name then~~		local invoke_mod = normalize(invoke.module)
	if ~~not func_name or invoke.func~~ == ~~func_name~~ then		if invoke_mod == target_mod then
	return true		return true
	~~end~~
	end		end
	end		end

Ganaram inukshuk: refactor invocation_exists to search through a table of invokes provided by find_invokes; will momentarily break other modules

2025-10-30T07:25:43Z

refactor invocation_exists to search through a table of invokes provided by find_invokes; will momentarily break other modules

← Older revision		Revision as of 07:25, 30 October 2025
Line 326:		Line 326:
	end		end

	-- Check whether a template invokes a function from a module.		-- Check whether a template invokes a function from a module. Input is a table
	-- ~~If no function name~~ is ~~provided, it will match any function~~ name.		-- of invocations, from find_invokes, and mod_name is the module name.
	~~-- Wikitext is assumed to have been preprocessed~~.		function p.invocation_exists(invokes, mod_name)
	function p.invocation_exists(~~wikitext~~, mod_name~~, func_name~~)		for _, invoke in ipairs(invokes) do
	~~local func_name = func_name or "[%w_%-]+" -- Default function name (pattern~~ for ~~any function name)~~		if invoke.module == module_name then
			if not func_name or invoke.func == func_name then
	~~-- Normalize module name according to how #~~invoke ~~works~~		return true
	~~local function normalize_module_name~~(~~mod_name~~)		end
	if ~~not mod_name~~ then ~~return nil end~~		end
	~~mod_name~~ = ~~mw.text.trim(mod_name) -- Trim whitespace~~
	~~mod_name = mod_name:gsub(" ", "_") -- Replace spaces with underscores~~
	~~-- Preserve original case~~
	~~return mod_name~~
	end		end
			return false
	~~-- Escape special characters for Lua pattern~~
	~~local safe_mod_name = normalize_module_name(mod_name)~~
	~~safe_mod_name = safe_mod_name:gsub("([^%w_])", "%%%1")~~

	~~-- Build pattern to match #invoke usage~~
	~~local pattern = "{{%s#invoke:%s" .. safe_mod_name .. "%s\|%s" .. func_name~~

	~~-- Normalize again~~
	~~local normalized_wikitext = mw.text.trim(wikitext):gsub("%s+", " ")~~

	~~-- Search in the wikitext~~
	return ~~string.find(normalized_wikitext, pattern) ~= nil~~
	end		end

	return p		return p

Ganaram inukshuk: bugfix wikitext preprocessing some more

2025-10-30T07:09:00Z

bugfix wikitext preprocessing some more

← Older revision		Revision as of 07:09, 30 October 2025
Line 81:		Line 81:
	text_to_scan = raw_wikitext		text_to_scan = raw_wikitext
	end		end

			-- Normalize tags and subst
			text_to_scan = text_to_scan
			:gsub("<noinclude>.-</noinclude>", "")
			:gsub("<noinclude%s*/>", "")
			:gsub("<includeonly>", "")
			:gsub("</includeonly>", "")
			:gsub("<onlyinclude>", "")
			:gsub("</onlyinclude>", "")
			:gsub("{{%s*safesubst:", "{{")
			:gsub("{{%s*subst:", "{{")

	-- Normalize:		-- Normalize:
	~~-- 1. Convert all newlines to spaces~~		text_to_scan = text_to_scan
	~~-- 2. Collapse multiple spaces/tabs/newlines~~
	~~-- 3. Trim leading/trailing whitespace~~
	~~local normalized~~ = text_to_scan
	:gsub("[\r\n]", " ")		:gsub("[\r\n]", " ")
	:gsub("%s+", " ")		:gsub("%s+", " ")
	:match("^%s(.-)%s$")		:match("^%s(.-)%s$")

	~~-- Normalize more by removing subst, safesubst, and any extra curly brackets~~
	~~normalized = normalized~~
	~~:gsub("{{{\|safesubst:}}}", "") -- Remove {{{{\|safesubst:}}} if used~~
	~~:gsub("{{{\|subst:}}}", "") -- Remove {{{{\|subst:}}} if used~~
	~~:gsub("{{{{", "{{") -- Collapse excessive curly brackets~~
	~~:gsub("}}}}", "}}") -- Collapse excessive curly brackets~~

	return ~~normalized~~		return text_to_scan
	end		end