Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/getopt.html

466 lines
32KB
Raw Blame History 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="getopt — C-style parser for command line options" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/getopt.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/getopt.py This module helps scripts to parse the command line arguments in sys.argv. It supports the same conventions as the Unix getopt() function (including the special meanings ..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/getopt.py This module helps scripts to parse the command line arguments in sys.argv. It supports the same conventions as the Unix getopt() function (including the special meanings ..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>getopt — C-style parser for command line options &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="logging — Logging facility for Python" href="logging.html" />

  39.     <link rel="prev" title="argparse — Parser for command-line options, arguments and sub-commands" href="argparse.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/getopt.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h4>Previous topic</h4>

  97.     <p class="topless"><a href="argparse.html"

  98.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">argparse</span></code> — Parser for command-line options, arguments and sub-commands</a></p>

  99.   </div>

  100.   <div>

  101.     <h4>Next topic</h4>

  102.     <p class="topless"><a href="logging.html"

  103.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">logging</span></code> — Logging facility for Python</a></p>

  104.   </div>

  105.   <div role="note" aria-label="source link">

  106.     <h3>This Page</h3>

  107.     <ul class="this-page-menu">

  108.       <li><a href="../bugs.html">Report a Bug</a></li>

  109.       <li>

  110.         <a href="https://github.com/python/cpython/blob/main/Doc/library/getopt.rst"

  111.             rel="nofollow">Show Source

  112.         </a>

  113.       </li>

  114.     </ul>

  115.   </div>

  116.         </nav>

  117.     </div>

  118. </div>

  119. 

  120.   

  121.     <div class="related" role="navigation" aria-label="related navigation">

  122.       <h3>Navigation</h3>

  123.       <ul>

  124.         <li class="right" style="margin-right: 10px">

  125.           <a href="../genindex.html" title="General Index"

  126.              accesskey="I">index</a></li>

  127.         <li class="right" >

  128.           <a href="../py-modindex.html" title="Python Module Index"

  129.              >modules</a> |</li>

  130.         <li class="right" >

  131.           <a href="logging.html" title="logging — Logging facility for Python"

  132.              accesskey="N">next</a> |</li>

  133.         <li class="right" >

  134.           <a href="argparse.html" title="argparse — Parser for command-line options, arguments and sub-commands"

  135.              accesskey="P">previous</a> |</li>

  136. 

  137.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  138.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  139.           <li class="switchers">

  140.             <div class="language_switcher_placeholder"></div>

  141.             <div class="version_switcher_placeholder"></div>

  142.           </li>

  143.           <li>

  144.               

  145.           </li>

  146.     <li id="cpython-language-and-version">

  147.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  148.     </li>

  149. 

  150.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  151.           <li class="nav-item nav-item-2"><a href="allos.html" accesskey="U">Generic Operating System Services</a> &#187;</li>

  152.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">getopt</span></code> — C-style parser for command line options</a></li>

  153.                 <li class="right">

  154.                     

  155. 

  156.     <div class="inline-search" role="search">

  157.         <form class="inline-search" action="../search.html" method="get">

  158.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  159.           <input type="submit" value="Go" />

  160.         </form>

  161.     </div>

  162.                      |

  163.                 </li>

  164.             <li class="right">

  165. <label class="theme-selector-label">

  166.     Theme

  167.     <select class="theme-selector" oninput="activateTheme(this.value)">

  168.         <option value="auto" selected>Auto</option>

  169.         <option value="light">Light</option>

  170.         <option value="dark">Dark</option>

  171.     </select>

  172. </label> |</li>

  173.             

  174.       </ul>

  175.     </div>    

  176. 

  177.     <div class="document">

  178.       <div class="documentwrapper">

  179.         <div class="bodywrapper">

  180.           <div class="body" role="main">

  181.             

  182.   <section id="module-getopt">

  183. <span id="getopt-c-style-parser-for-command-line-options"></span><h1><a class="reference internal" href="#module-getopt" title="getopt: Portable parser for command line options; support both short and long option names."><code class="xref py py-mod docutils literal notranslate"><span class="pre">getopt</span></code></a> — C-style parser for command line options<a class="headerlink" href="#module-getopt" title="Link to this heading">¶</a></h1>

  184. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/getopt.py">Lib/getopt.py</a></p>

  185. <div class="admonition note">

  186. <p class="admonition-title">Note</p>

  187. <p>The <a class="reference internal" href="#module-getopt" title="getopt: Portable parser for command line options; support both short and long option names."><code class="xref py py-mod docutils literal notranslate"><span class="pre">getopt</span></code></a> module is a parser for command line options whose API is

  188. designed to be familiar to users of the C <code class="xref c c-func docutils literal notranslate"><span class="pre">getopt()</span></code> function. Users who

  189. are unfamiliar with the C <code class="xref c c-func docutils literal notranslate"><span class="pre">getopt()</span></code> function or who would like to write

  190. less code and get better help and error messages should consider using the

  191. <a class="reference internal" href="argparse.html#module-argparse" title="argparse: Command-line option and argument parsing library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">argparse</span></code></a> module instead.</p>

  192. </div>

  193. <hr class="docutils" />

  194. <p>This module helps scripts to parse the command line arguments in <code class="docutils literal notranslate"><span class="pre">sys.argv</span></code>.

  195. It supports the same conventions as the Unix <code class="xref c c-func docutils literal notranslate"><span class="pre">getopt()</span></code> function (including

  196. the special meanings of arguments of the form ‘<code class="docutils literal notranslate"><span class="pre">-</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">--</span></code>‘).  Long

  197. options similar to those supported by GNU software may be used as well via an

  198. optional third argument.</p>

  199. <p>This module provides two functions and an

  200. exception:</p>

  201. <dl class="py function">

  202. <dt class="sig sig-object py" id="getopt.getopt">

  203. <span class="sig-prename descclassname"><span class="pre">getopt.</span></span><span class="sig-name descname"><span class="pre">getopt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shortopts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">longopts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#getopt.getopt" title="Link to this definition">¶</a></dt>

  204. <dd><p>Parses command line options and parameter list.  <em>args</em> is the argument list to

  205. be parsed, without the leading reference to the running program. Typically, this

  206. means <code class="docutils literal notranslate"><span class="pre">sys.argv[1:]</span></code>. <em>shortopts</em> is the string of option letters that the

  207. script wants to recognize, with options that require an argument followed by a

  208. colon (<code class="docutils literal notranslate"><span class="pre">':'</span></code>; i.e., the same format that Unix <code class="xref c c-func docutils literal notranslate"><span class="pre">getopt()</span></code> uses).</p>

  209. <div class="admonition note">

  210. <p class="admonition-title">Note</p>

  211. <p>Unlike GNU <code class="xref c c-func docutils literal notranslate"><span class="pre">getopt()</span></code>, after a non-option argument, all further

  212. arguments are considered also non-options. This is similar to the way

  213. non-GNU Unix systems work.</p>

  214. </div>

  215. <p><em>longopts</em>, if specified, must be a list of strings with the names of the

  216. long options which should be supported.  The leading <code class="docutils literal notranslate"><span class="pre">'--'</span></code> characters

  217. should not be included in the option name.  Long options which require an

  218. argument should be followed by an equal sign (<code class="docutils literal notranslate"><span class="pre">'='</span></code>).  Optional arguments

  219. are not supported.  To accept only long options, <em>shortopts</em> should be an

  220. empty string.  Long options on the command line can be recognized so long as

  221. they provide a prefix of the option name that matches exactly one of the

  222. accepted options.  For example, if <em>longopts</em> is <code class="docutils literal notranslate"><span class="pre">['foo',</span> <span class="pre">'frob']</span></code>, the

  223. option <code class="docutils literal notranslate"><span class="pre">--fo</span></code> will match as <code class="docutils literal notranslate"><span class="pre">--foo</span></code>, but <code class="docutils literal notranslate"><span class="pre">--f</span></code> will

  224. not match uniquely, so <a class="reference internal" href="#getopt.GetoptError" title="getopt.GetoptError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">GetoptError</span></code></a> will be raised.</p>

  225. <p>The return value consists of two elements: the first is a list of <code class="docutils literal notranslate"><span class="pre">(option,</span>

  226. <span class="pre">value)</span></code> pairs; the second is the list of program arguments left after the

  227. option list was stripped (this is a trailing slice of <em>args</em>).  Each

  228. option-and-value pair returned has the option as its first element, prefixed

  229. with a hyphen for short options (e.g., <code class="docutils literal notranslate"><span class="pre">'-x'</span></code>) or two hyphens for long

  230. options (e.g., <code class="docutils literal notranslate"><span class="pre">'--long-option'</span></code>), and the option argument as its

  231. second element, or an empty string if the option has no argument.  The

  232. options occur in the list in the same order in which they were found, thus

  233. allowing multiple occurrences.  Long and short options may be mixed.</p>

  234. </dd></dl>

  235. 

  236. <dl class="py function">

  237. <dt class="sig sig-object py" id="getopt.gnu_getopt">

  238. <span class="sig-prename descclassname"><span class="pre">getopt.</span></span><span class="sig-name descname"><span class="pre">gnu_getopt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shortopts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">longopts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#getopt.gnu_getopt" title="Link to this definition">¶</a></dt>

  239. <dd><p>This function works like <a class="reference internal" href="#module-getopt" title="getopt: Portable parser for command line options; support both short and long option names."><code class="xref py py-func docutils literal notranslate"><span class="pre">getopt()</span></code></a>, except that GNU style scanning mode is

  240. used by default. This means that option and non-option arguments may be

  241. intermixed. The <a class="reference internal" href="#module-getopt" title="getopt: Portable parser for command line options; support both short and long option names."><code class="xref py py-func docutils literal notranslate"><span class="pre">getopt()</span></code></a> function stops processing options as soon as a

  242. non-option argument is encountered.</p>

  243. <p>If the first character of the option string is <code class="docutils literal notranslate"><span class="pre">'+'</span></code>, or if the environment

  244. variable <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">POSIXLY_CORRECT</span></code> is set, then option processing stops as

  245. soon as a non-option argument is encountered.</p>

  246. </dd></dl>

  247. 

  248. <dl class="py exception">

  249. <dt class="sig sig-object py" id="getopt.GetoptError">

  250. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">getopt.</span></span><span class="sig-name descname"><span class="pre">GetoptError</span></span><a class="headerlink" href="#getopt.GetoptError" title="Link to this definition">¶</a></dt>

  251. <dd><p>This is raised when an unrecognized option is found in the argument list or when

  252. an option requiring an argument is given none. The argument to the exception is

  253. a string indicating the cause of the error.  For long options, an argument given

  254. to an option which does not require one will also cause this exception to be

  255. raised.  The attributes <code class="xref py py-attr docutils literal notranslate"><span class="pre">msg</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">opt</span></code> give the error message and

  256. related option; if there is no specific option to which the exception relates,

  257. <code class="xref py py-attr docutils literal notranslate"><span class="pre">opt</span></code> is an empty string.</p>

  258. </dd></dl>

  259. 

  260. <dl class="py exception">

  261. <dt class="sig sig-object py" id="getopt.error">

  262. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">getopt.</span></span><span class="sig-name descname"><span class="pre">error</span></span><a class="headerlink" href="#getopt.error" title="Link to this definition">¶</a></dt>

  263. <dd><p>Alias for <a class="reference internal" href="#getopt.GetoptError" title="getopt.GetoptError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">GetoptError</span></code></a>; for backward compatibility.</p>

  264. </dd></dl>

  265. 

  266. <p>An example using only Unix style options:</p>

  267. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">getopt</span>

  268. <span class="gp">&gt;&gt;&gt; </span><span class="n">args</span> <span class="o">=</span> <span class="s1">&#39;-a -b -cfoo -d bar a1 a2&#39;</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>

  269. <span class="gp">&gt;&gt;&gt; </span><span class="n">args</span>

  270. <span class="go">[&#39;-a&#39;, &#39;-b&#39;, &#39;-cfoo&#39;, &#39;-d&#39;, &#39;bar&#39;, &#39;a1&#39;, &#39;a2&#39;]</span>

  271. <span class="gp">&gt;&gt;&gt; </span><span class="n">optlist</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">getopt</span><span class="o">.</span><span class="n">getopt</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="s1">&#39;abc:d:&#39;</span><span class="p">)</span>

  272. <span class="gp">&gt;&gt;&gt; </span><span class="n">optlist</span>

  273. <span class="go">[(&#39;-a&#39;, &#39;&#39;), (&#39;-b&#39;, &#39;&#39;), (&#39;-c&#39;, &#39;foo&#39;), (&#39;-d&#39;, &#39;bar&#39;)]</span>

  274. <span class="gp">&gt;&gt;&gt; </span><span class="n">args</span>

  275. <span class="go">[&#39;a1&#39;, &#39;a2&#39;]</span>

  276. </pre></div>

  277. </div>

  278. <p>Using long option names is equally easy:</p>

  279. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="s1">&#39;--condition=foo --testing --output-file abc.def -x a1 a2&#39;</span>

  280. <span class="gp">&gt;&gt;&gt; </span><span class="n">args</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>

  281. <span class="gp">&gt;&gt;&gt; </span><span class="n">args</span>

  282. <span class="go">[&#39;--condition=foo&#39;, &#39;--testing&#39;, &#39;--output-file&#39;, &#39;abc.def&#39;, &#39;-x&#39;, &#39;a1&#39;, &#39;a2&#39;]</span>

  283. <span class="gp">&gt;&gt;&gt; </span><span class="n">optlist</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">getopt</span><span class="o">.</span><span class="n">getopt</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="s1">&#39;x&#39;</span><span class="p">,</span> <span class="p">[</span>

  284. <span class="gp">... </span>    <span class="s1">&#39;condition=&#39;</span><span class="p">,</span> <span class="s1">&#39;output-file=&#39;</span><span class="p">,</span> <span class="s1">&#39;testing&#39;</span><span class="p">])</span>

  285. <span class="gp">&gt;&gt;&gt; </span><span class="n">optlist</span>

  286. <span class="go">[(&#39;--condition&#39;, &#39;foo&#39;), (&#39;--testing&#39;, &#39;&#39;), (&#39;--output-file&#39;, &#39;abc.def&#39;), (&#39;-x&#39;, &#39;&#39;)]</span>

  287. <span class="gp">&gt;&gt;&gt; </span><span class="n">args</span>

  288. <span class="go">[&#39;a1&#39;, &#39;a2&#39;]</span>

  289. </pre></div>

  290. </div>

  291. <p>In a script, typical usage is something like this:</p>

  292. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">getopt</span><span class="o">,</span> <span class="nn">sys</span>

  293. 

  294. <span class="k">def</span> <span class="nf">main</span><span class="p">():</span>

  295.     <span class="k">try</span><span class="p">:</span>

  296.         <span class="n">opts</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="n">getopt</span><span class="o">.</span><span class="n">getopt</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="s2">&quot;ho:v&quot;</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;help&quot;</span><span class="p">,</span> <span class="s2">&quot;output=&quot;</span><span class="p">])</span>

  297.     <span class="k">except</span> <span class="n">getopt</span><span class="o">.</span><span class="n">GetoptError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>

  298.         <span class="c1"># print help information and exit:</span>

  299.         <span class="nb">print</span><span class="p">(</span><span class="n">err</span><span class="p">)</span>  <span class="c1"># will print something like &quot;option -a not recognized&quot;</span>

  300.         <span class="n">usage</span><span class="p">()</span>

  301.         <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>

  302.     <span class="n">output</span> <span class="o">=</span> <span class="kc">None</span>

  303.     <span class="n">verbose</span> <span class="o">=</span> <span class="kc">False</span>

  304.     <span class="k">for</span> <span class="n">o</span><span class="p">,</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">opts</span><span class="p">:</span>

  305.         <span class="k">if</span> <span class="n">o</span> <span class="o">==</span> <span class="s2">&quot;-v&quot;</span><span class="p">:</span>

  306.             <span class="n">verbose</span> <span class="o">=</span> <span class="kc">True</span>

  307.         <span class="k">elif</span> <span class="n">o</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;-h&quot;</span><span class="p">,</span> <span class="s2">&quot;--help&quot;</span><span class="p">):</span>

  308.             <span class="n">usage</span><span class="p">()</span>

  309.             <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">()</span>

  310.         <span class="k">elif</span> <span class="n">o</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;-o&quot;</span><span class="p">,</span> <span class="s2">&quot;--output&quot;</span><span class="p">):</span>

  311.             <span class="n">output</span> <span class="o">=</span> <span class="n">a</span>

  312.         <span class="k">else</span><span class="p">:</span>

  313.             <span class="k">assert</span> <span class="kc">False</span><span class="p">,</span> <span class="s2">&quot;unhandled option&quot;</span>

  314.     <span class="c1"># ...</span>

  315. 

  316. <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>

  317.     <span class="n">main</span><span class="p">()</span>

  318. </pre></div>

  319. </div>

  320. <p>Note that an equivalent command line interface could be produced with less code

  321. and more informative help and error messages by using the <a class="reference internal" href="argparse.html#module-argparse" title="argparse: Command-line option and argument parsing library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">argparse</span></code></a> module:</p>

  322. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">argparse</span>

  323. 

  324. <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>

  325.     <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">()</span>

  326.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-o&#39;</span><span class="p">,</span> <span class="s1">&#39;--output&#39;</span><span class="p">)</span>

  327.     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;-v&#39;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s1">&#39;verbose&#39;</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s1">&#39;store_true&#39;</span><span class="p">)</span>

  328.     <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>

  329.     <span class="c1"># ... do something with args.output ...</span>

  330.     <span class="c1"># ... do something with args.verbose ..</span>

  331. </pre></div>

  332. </div>

  333. <div class="admonition seealso">

  334. <p class="admonition-title">See also</p>

  335. <dl class="simple">

  336. <dt>Module <a class="reference internal" href="argparse.html#module-argparse" title="argparse: Command-line option and argument parsing library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">argparse</span></code></a></dt><dd><p>Alternative command line option and argument parsing library.</p>

  337. </dd>

  338. </dl>

  339. </div>

  340. </section>

  341. 

  342. 

  343.             <div class="clearer"></div>

  344.           </div>

  345.         </div>

  346.       </div>

  347.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  348.         <div class="sphinxsidebarwrapper">

  349.   <div>

  350.     <h4>Previous topic</h4>

  351.     <p class="topless"><a href="argparse.html"

  352.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">argparse</span></code> — Parser for command-line options, arguments and sub-commands</a></p>

  353.   </div>

  354.   <div>

  355.     <h4>Next topic</h4>

  356.     <p class="topless"><a href="logging.html"

  357.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">logging</span></code> — Logging facility for Python</a></p>

  358.   </div>

  359.   <div role="note" aria-label="source link">

  360.     <h3>This Page</h3>

  361.     <ul class="this-page-menu">

  362.       <li><a href="../bugs.html">Report a Bug</a></li>

  363.       <li>

  364.         <a href="https://github.com/python/cpython/blob/main/Doc/library/getopt.rst"

  365.             rel="nofollow">Show Source

  366.         </a>

  367.       </li>

  368.     </ul>

  369.   </div>

  370.         </div>

  371. <div id="sidebarbutton" title="Collapse sidebar">

  372. <span>«</span>

  373. </div>

  374. 

  375.       </div>

  376.       <div class="clearer"></div>

  377.     </div>  

  378.     <div class="related" role="navigation" aria-label="related navigation">

  379.       <h3>Navigation</h3>

  380.       <ul>

  381.         <li class="right" style="margin-right: 10px">

  382.           <a href="../genindex.html" title="General Index"

  383.              >index</a></li>

  384.         <li class="right" >

  385.           <a href="../py-modindex.html" title="Python Module Index"

  386.              >modules</a> |</li>

  387.         <li class="right" >

  388.           <a href="logging.html" title="logging — Logging facility for Python"

  389.              >next</a> |</li>

  390.         <li class="right" >

  391.           <a href="argparse.html" title="argparse — Parser for command-line options, arguments and sub-commands"

  392.              >previous</a> |</li>

  393. 

  394.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  395.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  396.           <li class="switchers">

  397.             <div class="language_switcher_placeholder"></div>

  398.             <div class="version_switcher_placeholder"></div>

  399.           </li>

  400.           <li>

  401.               

  402.           </li>

  403.     <li id="cpython-language-and-version">

  404.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  405.     </li>

  406. 

  407.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  408.           <li class="nav-item nav-item-2"><a href="allos.html" >Generic Operating System Services</a> &#187;</li>

  409.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">getopt</span></code> — C-style parser for command line options</a></li>

  410.                 <li class="right">

  411.                     

  412. 

  413.     <div class="inline-search" role="search">

  414.         <form class="inline-search" action="../search.html" method="get">

  415.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  416.           <input type="submit" value="Go" />

  417.         </form>

  418.     </div>

  419.                      |

  420.                 </li>

  421.             <li class="right">

  422. <label class="theme-selector-label">

  423.     Theme

  424.     <select class="theme-selector" oninput="activateTheme(this.value)">

  425.         <option value="auto" selected>Auto</option>

  426.         <option value="light">Light</option>

  427.         <option value="dark">Dark</option>

  428.     </select>

  429. </label> |</li>

  430.             

  431.       </ul>

  432.     </div>  

  433.     <div class="footer">

  434.     &copy; 

  435.       <a href="../copyright.html">

  436.     

  437.     Copyright

  438.     

  439.       </a>

  440.      2001-2024, Python Software Foundation.

  441.     <br />

  442.     This page is licensed under the Python Software Foundation License Version 2.

  443.     <br />

  444.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  445.     <br />

  446.     

  447.       See <a href="/license.html">History and License</a> for more information.<br />

  448.     

  449.     

  450.     <br />

  451. 

  452.     The Python Software Foundation is a non-profit corporation.

  453. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  454. <br />

  455.     <br />

  456.       Last updated on Apr 09, 2024 (13:47 UTC).

  457.     

  458.       <a href="/bugs.html">Found a bug</a>?

  459.     

  460.     <br />

  461. 

  462.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  463.     </div>

  464. 

  465.   </body>

  466. </html>
上海开阖软件有限公司 沪ICP备12045867号-1