mirror of
https://github.com/TangentFoxy/argparse.git
synced 2025-08-23 15:02:30 +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
280
doc/arguments.html
Normal file
280
doc/arguments.html
Normal file
@@ -0,0 +1,280 @@
|
||||
|
||||
|
||||
<!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>Adding and configuring arguments — 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="next" title="Adding and configuring options" href="options.html"/>
|
||||
<link rel="prev" title="Creating and using parsers" href="parsers.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 current"><a class="current reference internal" href="">Adding and configuring arguments</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#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"><a class="reference internal" href="misc.html">Miscellaneous</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="misc.html#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="misc.html#overwriting-default-help-option">Overwriting default help option</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="misc.html#setting-argument-placeholder">Setting argument placeholder</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="misc.html#disabling-option-handling">Disabling option handling</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="misc.html#prohibiting-overuse-of-options">Prohibiting overuse of options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="misc.html#parsing-algorithm">Parsing algorithm</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="misc.html#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>Adding and configuring arguments</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
<a href="_sources/arguments.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main">
|
||||
|
||||
<div class="section" id="adding-and-configuring-arguments">
|
||||
<h1>Adding and configuring arguments<a class="headerlink" href="#adding-and-configuring-arguments" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Positional arguments can be added using <tt class="docutils literal"><span class="pre">:argument(name,</span> <span class="pre">description,</span> <span class="pre">default,</span> <span class="pre">convert,</span> <span class="pre">args)</span></tt> method. It returns an Argument instance, which can be configured in the same way as Parsers. The <tt class="docutils literal"><span class="pre">name</span></tt> property is required.</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">argument</span> <span class="s2">"</span><span class="s">input"</span>
|
||||
</pre></div>
|
||||
</td></tr></table></div>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ lua script.lua foo
|
||||
</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="s2">"</span><span class="s">foo"</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The data passed to the argument is stored in the result table at index <tt class="docutils literal"><span class="pre">input</span></tt> because it is the argument’s name. The index can be changed using <tt class="docutils literal"><span class="pre">target</span></tt> property.</p>
|
||||
<div class="section" id="setting-number-of-consumed-arguments">
|
||||
<h2>Setting number of consumed arguments<a class="headerlink" href="#setting-number-of-consumed-arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<p><tt class="docutils literal"><span class="pre">args</span></tt> property sets how many command line arguments the argument consumes. Its value is interpreted as follows:</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="63%" />
|
||||
<col width="37%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Value</th>
|
||||
<th class="head">Interpretation</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td>Number <tt class="docutils literal"><span class="pre">N</span></tt></td>
|
||||
<td>Exactly <tt class="docutils literal"><span class="pre">N</span></tt> arguments</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>String <tt class="docutils literal"><span class="pre">A-B</span></tt>, where <tt class="docutils literal"><span class="pre">A</span></tt> and <tt class="docutils literal"><span class="pre">B</span></tt> are numbers</td>
|
||||
<td>From <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">B</span></tt> arguments</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>String <tt class="docutils literal"><span class="pre">N+</span></tt>, where <tt class="docutils literal"><span class="pre">N</span></tt> is a number</td>
|
||||
<td><tt class="docutils literal"><span class="pre">N</span></tt> or more arguments</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>String <tt class="docutils literal"><span class="pre">?</span></tt></td>
|
||||
<td>An optional argument</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>String <tt class="docutils literal"><span class="pre">*</span></tt></td>
|
||||
<td>Any number of arguments</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>String <tt class="docutils literal"><span class="pre">+</span></tt></td>
|
||||
<td>At least one argument</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>If more than one argument can be consumed, a table is used to store the data.</p>
|
||||
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
|
||||
2
|
||||
3
|
||||
4</pre></div></td><td class="code"><div class="highlight"><pre><span class="n">parser</span><span class="p">:</span><span class="n">argument</span><span class="p">(</span><span class="s2">"</span><span class="s">pair"</span><span class="p">,</span> <span class="s2">"</span><span class="s">A pair of arguments."</span><span class="p">)</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="n">parser</span><span class="p">:</span><span class="n">argument</span><span class="p">(</span><span class="s2">"</span><span class="s">optional"</span><span class="p">,</span> <span class="s2">"</span><span class="s">An optional argument."</span><span class="p">)</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 foo bar
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-lua"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="n">pair</span> <span class="o">=</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 class="highlight-python"><div class="highlight"><pre>$ lua script.lua foo bar baz
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-lua"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="n">pair</span> <span class="o">=</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="n">optional</span> <span class="o">=</span> <span class="s2">"</span><span class="s">baz"</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="options.html" class="btn btn-neutral float-right" title="Adding and configuring options"/>Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="parsers.html" class="btn btn-neutral" title="Creating and using parsers"><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