-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmigration.html
More file actions
164 lines (155 loc) · 9.61 KB
/
migration.html
File metadata and controls
164 lines (155 loc) · 9.61 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Migration — argparse4j 0.9.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/default2.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Examples" href="examples.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="examples.html" title="Examples"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">argparse4j 0.9.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Migration</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="migration">
<h1>Migration<a class="headerlink" href="#migration" title="Permalink to this headline">¶</a></h1>
<div class="section" id="to-0-5-0">
<h2>To 0.5.0:<a class="headerlink" href="#to-0-5-0" title="Permalink to this headline">¶</a></h2>
<p>The rules for the default <a class="reference internal" href="usage.html#argument-dest"><span class="std std-ref">Argument.dest()</span></a> for positional arguments has
been made consistent with options, in that the dash (<code class="docutils literal notranslate"><span class="pre">-</span></code>) character is
is converted to an underscore (<code class="docutils literal notranslate"><span class="pre">_</span></code>)</p>
<p>Prior to 0.5.0:</p>
<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="n">parser</span><span class="p">.</span><span class="na">addArgument</span><span class="p">(</span><span class="s">"foo-bar"</span><span class="p">);</span>
<span class="n">Namespace</span> <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="p">.</span><span class="na">parseArgs</span><span class="p">(</span><span class="n">args</span><span class="p">);</span>
<span class="n">args</span><span class="p">.</span><span class="na">get</span><span class="p">(</span><span class="s">"foo-bar"</span><span class="p">);</span>
</pre></div>
</div>
<p>Starting from 0.5.0:</p>
<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="n">parser</span><span class="p">.</span><span class="na">addArgument</span><span class="p">(</span><span class="s">"foo-bar"</span><span class="p">);</span>
<span class="n">Namespace</span> <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="p">.</span><span class="na">parseArgs</span><span class="p">(</span><span class="n">args</span><span class="p">);</span>
<span class="n">args</span><span class="p">.</span><span class="na">get</span><span class="p">(</span><span class="s">"foo_bar"</span><span class="p">);</span>
</pre></div>
</div>
<p>We encourage the applications to review about this change and update
their code, but it is not feasible, use
<code class="docutils literal notranslate"><span class="pre">ArgumentParsers.setNoDestConversionForPositionalArgs(true)</span></code> to tell
the library not to do this conversion.</p>
</div>
<div class="section" id="to-0-8-0">
<h2>To 0.8.0:<a class="headerlink" href="#to-0-8-0" title="Permalink to this headline">¶</a></h2>
<p>The global variables of <code class="docutils literal notranslate"><span class="pre">ArgumentParsers</span></code> have been replaced by a
builder. Using builders multiple differently configured
ArgumentParser instances can be used on the same or other threads
without interfering with each other.</p>
<p>Prior to 0.8.0:</p>
<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="n">ArgumentParsers</span><span class="p">.</span><span class="na">setCJKWidthHack</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="n">ArgumentParsers</span><span class="p">.</span><span class="na">setNoDestConversionForPositionalArgs</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="n">ArgumentParsers</span><span class="p">.</span><span class="na">setSingleMetavar</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="n">ArgumentParsers</span><span class="p">.</span><span class="na">setTerminalWidthDetection</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="n">ArgumentParser</span> <span class="n">ap</span> <span class="o">=</span> <span class="n">ArgumentParsers</span><span class="p">.</span><span class="na">newArgumentParser</span><span class="p">(</span><span class="s">"prog"</span><span class="p">,</span> <span class="p">...);</span>
</pre></div>
</div>
<p>Starting from 0.8.0:</p>
<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="n">ArgumentParser</span> <span class="n">ap</span> <span class="o">=</span> <span class="n">ArgumentParsers</span><span class="p">.</span><span class="na">newFor</span><span class="p">(</span><span class="s">"prog"</span><span class="p">)</span>
<span class="p">...</span>
<span class="p">.</span><span class="na">cjkWidthHack</span><span class="p">(</span><span class="kc">true</span><span class="p">)</span>
<span class="p">.</span><span class="na">noDestConversionForPositionalArgs</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="p">.</span><span class="na">singleMetavar</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="p">.</span><span class="na">terminalWidthDetection</span><span class="p">(</span><span class="kc">true</span><span class="p">)</span>
<span class="p">.</span><span class="na">build</span><span class="p">();</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">ArgumentParsers.newArgumentParser(String,</span> <span class="pre">...)</span></code> methods and
the getters and setters for the global variables have been
deprecated. It is encouraged to port applications to the builder
style creation of an ArgumentParser object.</p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><h3>Menu</h3>
<ul>
<li><a href="https://github.com/argparse4j/argparse4j/releases">Download</a></li>
<li><a href="http://sourceforge.net/projects/argparse4j/files/">Download (~0.5.0)</a></li>
<li><a href="https://github.com/argparse4j/argparse4j">Source Code</a></li>
<li><a href="https://github.com/argparse4j/argparse4j/issues">Issues</a></li>
<li><a href="usage.html">Usage</a></li>
<li><a href="examples.html">Examples</a></li>
<li><a href="project-info.html">Project Information</a></li>
<li><a href="apidocs/index.html">JavaDocs</a></li>
</ul>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Migration</a><ul>
<li><a class="reference internal" href="#to-0-5-0">To 0.5.0:</a></li>
<li><a class="reference internal" href="#to-0-8-0">To 0.8.0:</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="examples.html"
title="previous chapter">Examples</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/migration.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="examples.html" title="Examples"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">argparse4j 0.9.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Migration</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011, 2015, Tatsuhiro Tsujikawa.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.1.
</div>
</body>
</html>