mirror of
https://github.com/TangentFoxy/argparse.git
synced 2025-07-30 03:52:19 +00:00
Generate docs for 0.4.0
It is better to have docs built in the repo so that building scm version doesn't fail with 'missing doc directory' error.
This commit is contained in:
mpeterv
592
doc/misc.html
Normal file
592
doc/misc.html
Normal file
@@ -0,0 +1,592 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Miscellaneous — argparse 0.4.0 tutorial</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="argparse 0.4.0 tutorial" href="index.html"/>
|
||||
<link rel="prev" title="Callbacks" href="callbacks.html"/>
|
||||
|
||||
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="index.html" class="fa fa-home"> argparse</a>
|
||||
<div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="parsers.html">Creating and using parsers</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="parsers.html#parsing-command-line-arguments">Parsing command line arguments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="parsers.html#configuring-parsers">Configuring parsers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="arguments.html">Adding and configuring arguments</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="arguments.html#setting-number-of-consumed-arguments">Setting number of consumed arguments</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="options.html">Adding and configuring options</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="options.html#flags">Flags</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="options.html#control-characters">Control characters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="options.html#setting-number-of-consumed-arguments">Setting number of consumed arguments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="options.html#setting-number-of-invocations">Setting number of invocations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="mutexes.html">Mutually exclusive groups</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="commands.html">Adding and configuring commands</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="commands.html#adding-elements-to-commands">Adding elements to commands</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="commands.html#making-a-command-optional">Making a command optional</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="defaults.html">Default values</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="defaults.html#default-mode">Default mode</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="callbacks.html">Callbacks</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="callbacks.html#converters">Converters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="callbacks.html#actions">Actions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Miscellaneous</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#generating-and-overwriting-help-and-usage-messages">Generating and overwriting help and usage messages</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#overwriting-default-help-option">Overwriting default help option</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#setting-argument-placeholder">Setting argument placeholder</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#disabling-option-handling">Disabling option handling</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#prohibiting-overuse-of-options">Prohibiting overuse of options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#parsing-algorithm">Parsing algorithm</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#property-lists">Property lists</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">argparse</a>
|
||||
</nav>
|
||||
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li>Miscellaneous</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
<a href="_sources/misc.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main">
|
||||
|
||||
<div class="section" id="miscellaneous">
|
||||
<h1>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="generating-and-overwriting-help-and-usage-messages">
|
||||
<h2>Generating and overwriting help and usage messages<a class="headerlink" href="#generating-and-overwriting-help-and-usage-messages" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The usage and help messages of parsers and commands can be generated on demand using <tt class="docutils literal"><span class="pre">:get_usage()</span></tt> and <tt class="docutils literal"><span class="pre">:get_help()</span></tt> methods, and overridden using <tt class="docutils literal"><span class="pre">help</span></tt> and <tt class="docutils literal"><span class="pre">usage</span></tt> properties.</p>
|
||||
</div>
|
||||
<div class="section" id="overwriting-default-help-option">
|
||||
<h2>Overwriting default help option<a class="headerlink" href="#overwriting-default-help-option" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If the property <tt class="docutils literal"><span class="pre">add_help</span></tt> of a parser is set to <tt class="docutils literal"><span class="pre">false</span></tt>, no help option will be added to it. Otherwise, the value of the field will be used to configure it.</p>
|
||||
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
||||
2</pre></div></td><td class="code"><div class="highlight"><pre><span class="kd">local</span> <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="p">()</span>
|
||||
<span class="p">:</span><span class="n">add_help</span> <span class="s2">"</span><span class="s">/?"</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ lua script.lua /?
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>Usage: script.lua [/?]
|
||||
|
||||
Options:
|
||||
/? Show this help message and exit.
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="setting-argument-placeholder">
|
||||
<h2>Setting argument placeholder<a class="headerlink" href="#setting-argument-placeholder" title="Permalink to this headline">¶</a></h2>
|
||||
<p>For options and arguments, <tt class="docutils literal"><span class="pre">argname</span></tt> property controls the placeholder for the argument in the usage message.</p>
|
||||
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
||||
2</pre></div></td><td class="code"><div class="highlight"><pre><span class="n">parser</span><span class="p">:</span><span class="n">option</span> <span class="s2">"</span><span class="s">-f"</span> <span class="s2">"</span><span class="s">--from"</span>
|
||||
<span class="p">:</span><span class="n">argname</span> <span class="s2">"</span><span class="s"><server>"</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ lua script.lua --help
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>Usage: script.lua [-f <server>] [-h]
|
||||
|
||||
Options:
|
||||
-f <server>, --from <server>
|
||||
-h, --help Show this help message and exit.
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><tt class="docutils literal"><span class="pre">argname</span></tt> can be an array of placeholders.</p>
|
||||
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
||||
2
|
||||
3</pre></div></td><td class="code"><div class="highlight"><pre><span class="n">parser</span><span class="p">:</span><span class="n">option</span> <span class="s2">"</span><span class="s">--pair"</span>
|
||||
<span class="p">:</span><span class="n">args</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
|
||||
<span class="p">:</span><span class="n">argname</span> <span class="p">{</span><span class="s2">"</span><span class="s"><key>"</span><span class="p">,</span> <span class="s2">"</span><span class="s"><value>"</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ lua script.lua --help
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>Usage: script.lua [--pair <key> <value>] [-h]
|
||||
|
||||
Options:
|
||||
--pair <key> <value>
|
||||
-h, --help Show this help message and exit.
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="disabling-option-handling">
|
||||
<h2>Disabling option handling<a class="headerlink" href="#disabling-option-handling" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When <tt class="docutils literal"><span class="pre">handle_options</span></tt> property of a parser or a command is set to <tt class="docutils literal"><span class="pre">false</span></tt>, all options will be passed verbatim to the argument list, as if the input included double-hyphens.</p>
|
||||
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
||||
2
|
||||
3
|
||||
4
|
||||
5</pre></div></td><td class="code"><div class="highlight"><pre><span class="n">parser</span><span class="p">:</span><span class="n">handle_options</span><span class="p">(</span><span class="kc">false</span><span class="p">)</span>
|
||||
<span class="n">parser</span><span class="p">:</span><span class="n">argument</span> <span class="s2">"</span><span class="s">input"</span>
|
||||
<span class="p">:</span><span class="n">args</span> <span class="s2">"</span><span class="s">*"</span>
|
||||
<span class="n">parser</span><span class="p">:</span><span class="n">option</span> <span class="s2">"</span><span class="s">-f"</span> <span class="s2">"</span><span class="s">--foo"</span>
|
||||
<span class="p">:</span><span class="n">args</span> <span class="s2">"</span><span class="s">*"</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ lua script.lua bar -f --foo bar
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-lua"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="n">input</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"</span><span class="s">bar"</span><span class="p">,</span> <span class="s2">"</span><span class="s">-f"</span><span class="p">,</span> <span class="s2">"</span><span class="s">--foo"</span><span class="p">,</span> <span class="s2">"</span><span class="s">bar"</span><span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="prohibiting-overuse-of-options">
|
||||
<h2>Prohibiting overuse of options<a class="headerlink" href="#prohibiting-overuse-of-options" title="Permalink to this headline">¶</a></h2>
|
||||
<p>By default, if an option is invoked too many times, latest invocations overwrite the data passed earlier.</p>
|
||||
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1</pre></div></td><td class="code"><div class="highlight"><pre><span class="n">parser</span><span class="p">:</span><span class="n">option</span> <span class="s2">"</span><span class="s">-o --output"</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ lua script.lua -oFOO -oBAR
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-lua"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="n">output</span> <span class="o">=</span> <span class="s2">"</span><span class="s">BAR"</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Set <tt class="docutils literal"><span class="pre">overwrite</span></tt> property to <tt class="docutils literal"><span class="pre">false</span></tt> to prohibit this behavior.</p>
|
||||
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
||||
2</pre></div></td><td class="code"><div class="highlight"><pre><span class="n">parser</span><span class="p">:</span><span class="n">option</span> <span class="s2">"</span><span class="s">-o --output"</span>
|
||||
<span class="p">:</span><span class="n">overwrite</span><span class="p">(</span><span class="kc">false</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ lua script.lua -oFOO -oBAR
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>Usage: script.lua [-o <output>] [-h]
|
||||
|
||||
Error: option '-o' must be used at most 1 time
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="parsing-algorithm">
|
||||
<h2>Parsing algorithm<a class="headerlink" href="#parsing-algorithm" title="Permalink to this headline">¶</a></h2>
|
||||
<p>argparse interprets command line arguments in the following way:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="10%" />
|
||||
<col width="90%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Argument</th>
|
||||
<th class="head">Interpretation</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">foo</span></tt></td>
|
||||
<td>An argument of an option or a positional argument.</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">--foo</span></tt></td>
|
||||
<td>An option.</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">--foo=bar</span></tt></td>
|
||||
<td>An option and its argument. The option must be able to take arguments.</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">-f</span></tt></td>
|
||||
<td>An option.</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">-abcdef</span></tt></td>
|
||||
<td>Letters are interpreted as options. If one of them can take an argument, the rest of the string is passed to it.</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">--</span></tt></td>
|
||||
<td>The rest of the command line arguments will be interpreted as positional arguments.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="property-lists">
|
||||
<h2>Property lists<a class="headerlink" href="#property-lists" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="parser-properties">
|
||||
<h3>Parser properties<a class="headerlink" href="#parser-properties" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Properties that can be set as arguments when calling or constructing a parser, in this order:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="71%" />
|
||||
<col width="29%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">name</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">description</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">epilog</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Other properties:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="42%" />
|
||||
<col width="58%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">usage</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">help</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">require_command</span></tt></td>
|
||||
<td>Boolean</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">handle_options</span></tt></td>
|
||||
<td>Boolean</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">add_help</span></tt></td>
|
||||
<td>Boolean or string or table</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="command-properties">
|
||||
<h3>Command properties<a class="headerlink" href="#command-properties" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Properties that can be set as arguments when calling or constructing a command, in this order:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="71%" />
|
||||
<col width="29%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">name</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">description</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">epilog</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Other properties:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="42%" />
|
||||
<col width="58%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">target</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">usage</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">help</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">require_command</span></tt></td>
|
||||
<td>Boolean</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">handle_options</span></tt></td>
|
||||
<td>Boolean</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">action</span></tt></td>
|
||||
<td>Function</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">add_help</span></tt></td>
|
||||
<td>Boolean or string or table</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="argument-properties">
|
||||
<h3>Argument properties<a class="headerlink" href="#argument-properties" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Properties that can be set as arguments when calling or constructing an argument, in this order:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="47%" />
|
||||
<col width="53%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">name</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">description</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">default</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">convert</span></tt></td>
|
||||
<td>Function or table</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">args</span></tt></td>
|
||||
<td>Number or string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Other properties:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="56%" />
|
||||
<col width="44%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">target</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">defmode</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">show_default</span></tt></td>
|
||||
<td>Boolean</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">argname</span></tt></td>
|
||||
<td>String or table</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="option-and-flag-properties">
|
||||
<h3>Option and flag properties<a class="headerlink" href="#option-and-flag-properties" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Properties that can be set as arguments when calling or constructing an option or a flag, in this order:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="47%" />
|
||||
<col width="53%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">name</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">description</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">default</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">convert</span></tt></td>
|
||||
<td>Function or table</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">args</span></tt></td>
|
||||
<td>Number or string</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">count</span></tt></td>
|
||||
<td>Number or string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Other properties:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="56%" />
|
||||
<col width="44%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Property</th>
|
||||
<th class="head">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">target</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">defmode</span></tt></td>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">show_default</span></tt></td>
|
||||
<td>Boolean</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">overwrite</span></tt></td>
|
||||
<td>Booleans</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">argname</span></tt></td>
|
||||
<td>String or table</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">action</span></tt></td>
|
||||
<td>Function</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
|
||||
<a href="callbacks.html" class="btn btn-neutral" title="Callbacks"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2013 - 2015, Peter Melnichenko.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'0.4.0',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.StickyNav.enable();
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user