1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
Miscellaneous
=============
Argparse version
----------------
``argparse`` module is a table with ``__call`` metamethod. ``argparse.version`` is a string in ``MAJOR.MINOR.PATCH`` format specifying argparse version.
Overwriting default help option
-------------------------------
If the property ``add_help`` of a parser is set to ``false``, no help option will be added to it. Otherwise, the value of the field will be used to configure it.
.. code-block:: lua
:linenos:
local parser = argparse()
:add_help "/?"
.. code-block:: none
$ lua script.lua /?
.. code-block:: none
Usage: script.lua [/?]
Options:
/? Show this help message and exit.
Help command
------------
A help command can be added to the parser using the ``:add_help_command([value])`` method. It accepts an optional string or table value which is used to configure the command.
.. code-block:: lua
:linenos:
local parser = argparse()
:add_help_command()
parser:command "install"
:description "Install a rock."
.. code-block:: none
$ lua script.lua help
.. code-block:: none
Usage: script.lua [-h] <command> ...
Options:
-h, --help Show this help message and exit.
Commands:
help Show help for commands.
install Install a rock.
.. code-block:: none
$ lua script.lua help install
.. code-block:: none
Usage: script.lua install [-h]
Install a rock.
Options:
-h, --help Show this help message and exit.
Disabling option handling
-------------------------
When ``handle_options`` property of a parser or a command is set to ``false``, all options will be passed verbatim to the argument list, as if the input included double-hyphens.
.. code-block:: lua
:linenos:
parser:handle_options(false)
parser:argument "input"
:args "*"
parser:option "-f" "--foo"
:args "*"
.. code-block:: none
$ lua script.lua bar -f --foo bar
.. code-block:: lua
{
input = {"bar", "-f", "--foo", "bar"}
}
Prohibiting overuse of options
------------------------------
By default, if an option is invoked too many times, latest invocations overwrite the data passed earlier.
.. code-block:: lua
:linenos:
parser:option "-o --output"
.. code-block:: none
$ lua script.lua -oFOO -oBAR
.. code-block:: lua
{
output = "BAR"
}
Set ``overwrite`` property to ``false`` to prohibit this behavior.
.. code-block:: lua
:linenos:
parser:option "-o --output"
:overwrite(false)
.. code-block:: none
$ lua script.lua -oFOO -oBAR
.. code-block:: none
Usage: script.lua [-h] [-o <output>]
Error: option '-o' must be used at most 1 time
Parsing algorithm
-----------------
argparse interprets command line arguments in the following way:
============= ================================================================================================================
Argument Interpretation
============= ================================================================================================================
``foo`` An argument of an option or a positional argument.
``--foo`` An option.
``--foo=bar`` An option and its argument. The option must be able to take arguments.
``-f`` An option.
``-abcdef`` Letters are interpreted as options. If one of them can take an argument, the rest of the string is passed to it.
``--`` The rest of the command line arguments will be interpreted as positional arguments.
============= ================================================================================================================
Property lists
--------------
Parser properties
^^^^^^^^^^^^^^^^^
Properties that can be set as arguments when calling or constructing a parser, in this order:
=============== ======
Property Type
=============== ======
``name`` String
``description`` String
``epilog`` String
=============== ======
Other properties:
=========================== ==========================
Property Type
=========================== ==========================
``usage`` String
``help`` String
``require_command`` Boolean
``handle_options`` Boolean
``add_help`` Boolean or string or table
``command_target`` String
``usage_max_width`` Number
``usage_margin`` Number
``help_max_width`` Number
``help_usage_margin`` Number
``help_description_margin`` Number
``help_vertical_space`` Number
=========================== ==========================
Command properties
^^^^^^^^^^^^^^^^^^
Properties that can be set as arguments when calling or constructing a command, in this order:
=============== ======
Property Type
=============== ======
``name`` String
``description`` String
``epilog`` String
=============== ======
Other properties:
=========================== ==========================
Property Type
=========================== ==========================
``hidden_name`` String
``summary`` String
``target`` String
``usage`` String
``help`` String
``require_command`` Boolean
``handle_options`` Boolean
``action`` Function
``add_help`` Boolean or string or table
``command_target`` String
``hidden`` Boolean
``usage_max_width`` Number
``usage_margin`` Number
``help_max_width`` Number
``help_usage_margin`` Number
``help_description_margin`` Number
``help_vertical_space`` Number
=========================== ==========================
Argument properties
^^^^^^^^^^^^^^^^^^^
Properties that can be set as arguments when calling or constructing an argument, in this order:
=============== =================
Property Type
=============== =================
``name`` String
``description`` String
``default`` Any
``convert`` Function or table
``args`` Number or string
=============== =================
Other properties:
=================== ===============
Property Type
=================== ===============
``target`` String
``defmode`` String
``show_default`` Boolean
``argname`` String or table
``choices`` Table
``action`` Function or string
``init`` Any
``hidden`` Boolean
=================== ===============
Option and flag properties
^^^^^^^^^^^^^^^^^^^^^^^^^^
Properties that can be set as arguments when calling or constructing an option or a flag, in this order:
=============== =================
Property Type
=============== =================
``name`` String
``description`` String
``default`` Any
``convert`` Function or table
``args`` Number or string
``count`` Number or string
=============== =================
Other properties:
=================== ==================
Property Type
=================== ==================
``hidden_name`` String
``target`` String
``defmode`` String
``show_default`` Boolean
``overwrite`` Booleans
``argname`` String or table
``choices`` Table
``action`` Function or string
``init`` Any
``hidden`` Boolean
=================== ==================
|