Module:Repr/doc

MyWikiBiz, Author Your Legacy — Friday July 19, 2024
Jump to navigationJump to search

This is the documentation page for Module:Repr

This module contains functions for generating string representations of Lua objects. It is inspired by Python's repr function.

Usage

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

<syntaxhighlight lang="lua"> local mRepr = require("Module:Repr") </syntaxhighlight>

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

repr

This function generates a string representation of any given Lua object. The idea is that if you copy the string this function produces it, and paste it back into a Lua program, then you should be able to reproduce the original object. This doesn't work for all values, but it should hold for simple cases.

For example, <syntaxhighlight lang="lua" inline>mRepr.repr({bool = true, number = 6, str = "hello world"})</syntaxhighlight> will output the string {bool = true, number = 6, str = "hello world"}.

Basic syntax:

<syntaxhighlight lang="lua"> mRepr.repr(value) </syntaxhighlight>

Full syntax:

<syntaxhighlight lang="lua"> mRepr.repr(value, options) </syntaxhighlight>

Parameters:

  • value: The value to convert to a string. This can be any Lua value. This parameter is optional, and defaults to nil.
  • options: A table of options. This parameter is optional.

The following options can be specified in the options table:

  • pretty: If true, output the string in "pretty" format (as in pretty-printing). This will add new lines and indentation between table items. If false, format everything on one line. The default is false.
  • tabs: If true, indent with tabs; otherwise, indent with spaces. The default is true. This only has an effect if pretty is true.
  • spaces: The number of spaces to indent with, if tabs is false. The default is 4. This only has an effect if pretty is true.
  • semicolons: If true, table items are separated with semicolons. If false, they are separated with spaces. The default is false.
  • sortKeys: If true, sort table keys in lexical order, after other table key formatting has been applied (such as adding square brackets). If false, table keys are output in arbitrary order (the order they are processed by the pairs function). The default is true.
  • depth: The indentation depth to output the top-level object at. The default is 0. This only has an effect if pretty is true.

Features:

  • The function handles cyclic tables gracefully; when it detects a cycle, the inner table is rendered as {CYCLIC}.
  • __tostring 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:

<syntaxhighlight lang="lua"> local myTable = { hello = "repr", usefulness = 100, isEasyToUse = true, sequence = {"a", "sequence", "table"}, mixed = {"a", "sequence", with = "key-value pairs"}, subTables = { moreInfo = "Calls itself recursively on sub-tables" }, usesToString = setmetatable({}, {__tostring = function () return "__tostring functions are called automatically" end}), ["$YMBOL$"] = "Keys that aren't Lua identifiers are quoted"; [{also = "Tables as keys work too";}] = "in case you need that", cyclic = {note = "cyclical tables are printed as just {CYCLIC}"} } myTable.cyclic.cyclic = myTable.cyclic -- Create a cycle

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

This logs the following:

{
   ["$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,
   mixed = {
      "a",
      "sequence",
      with = "key-value pairs"
   },
   sequence = {
      "a",
      "sequence",
      "table"
   },
   subTables = {
      moreInfo = "Calls itself recursively on sub-tables"
   },
   usefulness = 100,
   usesToString = __tostring functions are called automatically
}

invocationRepr

This function generates a string representation of a function invocation.

Basic syntax:

<syntaxhighlight lang="lua"> mRepr.invocationRepr{funcName = functionName, args = functionArgs} </syntaxhighlight>

Full syntax:

<syntaxhighlight lang="lua"> mRepr.invocationRepr{funcName = functionName, args = functionArgs, options = options} </syntaxhighlight>

Parameters:

  • funcName: The function name. This parameter is required, and must be a string.
  • args: 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.
  • options: A table of options. The options are the same as for the repr function. This argument is optional.

Examples: <syntaxhighlight lang="lua">mRepr.invocationRepr{funcName = "myFunc", args = {"test", 4, true, {"a", "b", "c"}}}</syntaxhighlight>

Result: myFunc("test", 4, true, {"a", "b", "c"})