Module:Repr/doc - Revision history

Mr. Stradivarius: fix section link

2021-03-14T02:27:07Z

fix section link

← Previous revision		Revision as of 02:27, 14 March 2021
Line 127:		Line 127:
	* <code>funcName</code>: The function name. This parameter is required, and must be a string.		* <code>funcName</code>: The function name. This parameter is required, and must be a string.
	* <code>args</code>: The function arguments. This should be sequence table. The sequence items can be any Lua value, and will each be rendered using the [[#repr\|]] function. This argument is optional.		* <code>args</code>: The function arguments. This should be sequence table. The sequence items can be any Lua value, and will each be rendered using the [[#repr\|]] function. This argument is optional.
	* <code>options</code>: A table of options. The options are the same as for the [[#repr\|]] function. This argument is optional.		* <code>options</code>: A table of options. The options are the same as for the [[#repr\|repr]] function. This argument is optional.

	Examples:		Examples:

Mr. Stradivarius: fix Python repr link text

2021-02-27T10:47:00Z

fix Python repr link text

← Previous revision		Revision as of 10:47, 27 February 2021
Line 1:		Line 1:
	This module contains functions for generating string representations of Lua objects. It is inspired by Python's [https://docs.python.org/3/library/functions.html#repr ~~Python's~~ repr] function.		This module contains functions for generating string representations of Lua objects. It is inspired by Python's [https://docs.python.org/3/library/functions.html#repr repr] function.

	== Usage ==		== Usage ==

Mr. Stradivarius: better headings

2021-02-27T10:33:05Z

better headings

← Previous revision		Revision as of 10:33, 27 February 2021
Line 3:		Line 3:
	== Usage ==		== Usage ==

	~~First,~~ ~~import~~ the module.		To use the module, first you have to import it.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 10:		Line 10:

	Then you can use the functions it contains. The documentation for each function is below.		Then you can use the functions it contains. The documentation for each function is below.

	== Functions ==

	=== repr ===		=== repr ===
Line 51:		Line 49:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local repr = require("Module:Repr").repr

	local myTable = {		local myTable = {
	hello = "repr",		hello = "repr",
Line 77:		Line 73:
	depth = 0, -- when pretty pretty printing, what level to start indenting at?		depth = 0, -- when pretty pretty printing, what level to start indenting at?
	}		}
	mw.log(repr(myTable, options))		mw.log(mRepr.repr(myTable, options))
	</syntaxhighlight>		</syntaxhighlight>

Line 112:		Line 108:
	</pre>		</pre>

	== invocationRepr ==		=== invocationRepr ===

	This function generates a string representation of a function invocation.		This function generates a string representation of a function invocation.

Mr. Stradivarius: update docs for tables with mixed sequence items and key-value pairs

2021-02-27T10:30:10Z

update docs for tables with mixed sequence items and key-value pairs

← Previous revision		Revision as of 10:30, 27 February 2021
Line 46:		Line 46:
	* The function handles cyclic tables gracefully; when it detects a cycle, the inner table is rendered as <code>{CYCLIC}</code>.		* The function handles cyclic tables gracefully; when it detects a cycle, the inner table is rendered as <code>{CYCLIC}</code>.
	* <code>__tostring</code> metamethods are automatically called if they are available.		* <code>__tostring</code> metamethods are automatically called if they are available.
			* The sequence part of a table is always rendered as a sequence. If there are also key-value pairs, they will be rendered after the sequence part.

	Here is an example that shows off all the bells and whistles:		Here is an example that shows off all the bells and whistles:
Line 57:		Line 58:
	isEasyToUse = true,		isEasyToUse = true,
	sequence = {"a", "sequence", "table"},		sequence = {"a", "sequence", "table"},
			mixed = {"a", "sequence", with = "key-value pairs"},
	subTables = {		subTables = {
	moreInfo = "Calls itself recursively on sub-tables"		moreInfo = "Calls itself recursively on sub-tables"
Line 65:		Line 67:
	cyclic = {note = "cyclical tables are printed as just {CYCLIC}"}		cyclic = {note = "cyclical tables are printed as just {CYCLIC}"}
	}		}
	-- Create a cycle:		myTable.cyclic.cyclic = myTable.cyclic -- Create a cycle
	myTable.cyclic.cyclic = myTable.cyclic

	local options = {		local options = {
Line 93:		Line 94:
	hello = "repr",		hello = "repr",
	isEasyToUse = true,		isEasyToUse = true,
			mixed = {
			"a",
			"sequence",
			with = "key-value pairs"
			},
	sequence = {		sequence = {
	"a",		"a",

Mr. Stradivarius: add docs for invocationRepr

2021-02-27T09:45:32Z

add docs for invocationRepr

@@ Line 32: / Line 32: @@
 Parameters:
-* <code>value</code>: The value to convert to a string. This can be any Lua value.
+* <code>value</code>: The value to convert to a string. This can be any Lua value. This parameter is optional, and defaults to <code>nil</code>.
 * <code>options</code>: A table of options. This parameter is optional.
@@ Line 105: / Line 105: @@
+}
 </pre>
 <includeonly>{{Sandbox other||

Mr. Stradivarius: fix comment indentation

2021-02-27T09:05:45Z

fix comment indentation

← Previous revision		Revision as of 09:05, 27 February 2021
Line 69:		Line 69:

	local options = {		local options = {
	pretty = true, -- print with \n and indentation?		pretty = true, -- print with \n and indentation?
	semicolons = false, -- when printing tables, use semicolons (;) instead of commas (,)?		semicolons = false, -- when printing tables, use semicolons (;) instead of commas (,)?
	sortKeys = true, -- when printing dictionary tables, sort keys alphabetically?		sortKeys = true, -- when printing dictionary tables, sort keys alphabetically?
	spaces = 3, -- when pretty printing, use how many spaces to indent?		spaces = 3, -- when pretty printing, use how many spaces to indent?
	tabs = false, -- when pretty printing, use tabs instead of spaces?		tabs = false, -- when pretty printing, use tabs instead of spaces?
	depth = 0, -- when pretty pretty printing, what level to start indenting at?		depth = 0, -- when pretty pretty printing, what level to start indenting at?
	}		}
	mw.log(repr(myTable, options))		mw.log(repr(myTable, options))

Mr. Stradivarius: tweak the example and add output

2021-02-27T08:56:54Z

tweak the example and add output

← Previous revision		Revision as of 08:56, 27 February 2021
Line 54:		Line 54:
	local myTable = {		local myTable = {
	hello = "repr",		hello = "repr",
	usefulness = ~~9001~~,		usefulness = 100,
	isEasyToUse = true,		isEasyToUse = true,
	~~array~~ = {"~~numerical~~", "~~arrays~~", "~~are", "easy~~"},		sequence = {"a", "sequence", "table"},
	land = workspace["a b c"]["1 2 3"],
	subTables = {		subTables = {
	moreInfo = "~~calls~~ itself recursively ~~to print~~ sub-tables"		moreInfo = "Calls itself recursively on sub-tables"
	},		},
	usesToString = {__tostring = function () return "__tostring functions are called automatically" end},		usesToString = setmetatable({}, {__tostring = function () return "__tostring functions are called automatically" end}),
	["$YMBOL$"] = "~~keys~~ that aren't Lua identifiers are quoted";		["$YMBOL$"] = "Keys that aren't Lua identifiers are quoted";
	[{also = "~~tables~~ as keys work too";}] = "in case you need that",		[{also = "Tables as keys work too";}] = "in case you need that",
	cyclic = {note = "cyclical tables are printed as just {CYCLIC}"}		cyclic = {note = "cyclical tables are printed as just {CYCLIC}"}
	}		}
	-- ~~create~~ a cycle:		-- Create a cycle:
	myTable.cyclic.cyclic = myTable.cyclic		myTable.cyclic.cyclic = myTable.cyclic

	local ~~reprSettings~~ = {		local options = {
	pretty = ~~false;~~ -- print with \n and indentation?		pretty = true, -- print with \n and indentation?
	semicolons = false; -- when printing tables, use semicolons (;) instead of commas (,)?		semicolons = false, -- when printing tables, use semicolons (;) instead of commas (,)?
	sortKeys = true; -- when printing dictionary tables, sort keys alphabetically?		sortKeys = true, -- when printing dictionary tables, sort keys alphabetically?
	spaces = 3; -- when pretty printing, use how many spaces to indent?		spaces = 3, -- when pretty printing, use how many spaces to indent?
	tabs = false; -- when pretty printing, use tabs instead of spaces?		tabs = false, -- when pretty printing, use tabs instead of spaces?
			depth = 0, -- when pretty pretty printing, what level to start indenting at?
	}		}
	~~print~~(repr(myTable, ~~reprSettings~~))		mw.log(repr(myTable, options))
	</syntaxhighlight>		</syntaxhighlight>

			This logs the following:

			<pre>
			{
			["$YMBOL$"] = "Keys that aren't Lua identifiers are quoted",
			[{
			also = "Tables as keys work too"
			}] = "in case you need that",
			cyclic = {
			cyclic = {CYCLIC},
			note = "cyclical tables are printed as just {CYCLIC}"
			},
			hello = "repr",
			isEasyToUse = true,
			sequence = {
			"a",
			"sequence",
			"table"
			},
			subTables = {
			moreInfo = "Calls itself recursively on sub-tables"
			},
			usefulness = 100,
			usesToString = __tostring functions are called automatically
			}
			</pre>

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	[[Category:Lua metamodules]]		[[Category:Lua metamodules]]

Mr. Stradivarius: expand the repr function docs

2021-02-27T05:46:50Z

expand the repr function docs

@@ Line 1: / Line 1: @@
-<syntaxhighlight lang="lua" inline>repr</syntaxhighlight>. is a simple Lua function that works a lot like [https://docs.python.org/3/library/functions.html#repr Python's repr]. It converts a Lua value into a printable string.
+This module contains functions for generating string representations of Lua objects. It is inspired by Python's [https://docs.python.org/3/library/functions.html#repr Python's repr] function.
 == Usage ==
 <syntaxhighlight lang="lua">
-local repr = require("Module:Repr").repr
+local mRepr = require("Module:Repr")
 </syntaxhighlight>
 <syntaxhighlight lang="lua">
-print(repr(myTable, {pretty=true}))
+mRepr.repr(value, options)
 </syntaxhighlight>
 Here is an example that shows off all the bells and whistles:

Pppery: Add category

2021-02-22T20:22:15Z

Add category

← Previous revision		Revision as of 20:22, 22 February 2021
Line 53:		Line 53:
	print(repr(myTable, reprSettings))		print(repr(myTable, reprSettings))
	</syntaxhighlight>		</syntaxhighlight>
			<includeonly>{{Sandbox other\|\|
			[[Category:Lua metamodules]]
			}}</includeonly>

Pppery: Cleanup and wikify

2021-02-21T16:05:21Z

Cleanup and wikify

@@ Line 1: / Line 1: @@
 Call the function with any single value and it will return a string.
 local myTable = {
@@ Line 35: / Line 14: @@
+}
 print(repr(myTable)) --> {hello = "world", isCool = true, score = 5}
 The second value can be a table of options, which allows you to **pretty-print** with newlines:
 print(repr(myTable, {pretty=true}))
 Here is an example that shows off all the bells and whistles:
-local repr = require(3148021300)
+local repr = require("Module:Repr").repr
 local myTable = {
@@ Line 71: / Line 50: @@
 	spaces = 3;                  -- when pretty printing, use how many spaces to indent?
 	tabs = false;                -- when pretty printing, use tabs instead of spaces?
+}
 print(repr(myTable, reprSettings))