This file is indexed.

/usr/share/doc/python-apt/html/tutorials/apt-cdrom.html is in python-apt-doc 0.8.3ubuntu7.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Writing your own apt-cdrom &mdash; python-apt 0.8.3ubuntu7 documentation</title>
    
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '0.8.3ubuntu7',
        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>
    <link rel="top" title="python-apt 0.8.3ubuntu7 documentation" href="../index.html" />
    <link rel="up" title="Tutorials" href="index.html" />
    <link rel="next" title="Doing stuff apt-get does" href="apt-get.html" />
    <link rel="prev" title="Tutorials" href="index.html" />
    <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 

  </head>
  <body>
    <div class="related">
      <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="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="apt-get.html" title="Doing stuff apt-get does"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Tutorials"
             accesskey="P">previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="../index.html">python-apt 0.8.3ubuntu7 documentation</a> &raquo;</li>

          <li><a href="index.html" accesskey="U">Tutorials</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="writing-your-own-apt-cdrom">
<h1>Writing your own apt-cdrom<a class="headerlink" href="#writing-your-own-apt-cdrom" title="Permalink to this headline"></a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body">Julian Andres Klode &lt;<a class="reference external" href="mailto:jak&#37;&#52;&#48;debian&#46;org">jak<span>&#64;</span>debian<span>&#46;</span>org</a>&gt;</td>
</tr>
<tr class="field-even field"><th class="field-name">Release:</th><td class="field-body">0.8.3ubuntu7</td>
</tr>
<tr class="field-odd field"><th class="field-name">Date:</th><td class="field-body">April 18, 2012</td>
</tr>
</tbody>
</table>
<p>This article explains how to utilise python-apt to build your own clone of the
<strong class="command">apt-cdrom</strong> command. To do this, we will take a look at the
<a class="reference internal" href="../library/apt.cdrom.html#module-apt.cdrom" title="apt.cdrom"><tt class="xref py py-mod docutils literal"><span class="pre">apt.cdrom</span></tt></a> and <a class="reference internal" href="../library/apt.progress.text.html#module-apt.progress.text" title="apt.progress.text"><tt class="xref py py-mod docutils literal"><span class="pre">apt.progress.text</span></tt></a> modules, and we will learn how
to use apt_pkg.parse_commandline to parse commandline arguments. The code shown
here works on Python 2 and Python 3.</p>
<div class="section" id="basics">
<h2>Basics<a class="headerlink" href="#basics" title="Permalink to this headline"></a></h2>
<p>The first step in building your own <strong class="command">apt-cdrom</strong> clone is to import the
<tt class="xref py py-mod docutils literal"><span class="pre">apt</span></tt> package, which will import <a class="reference internal" href="../library/apt.cdrom.html#module-apt.cdrom" title="apt.cdrom"><tt class="xref py py-mod docutils literal"><span class="pre">apt.cdrom</span></tt></a> and
<a class="reference internal" href="../library/apt.progress.text.html#module-apt.progress.text" title="apt.progress.text"><tt class="xref py py-mod docutils literal"><span class="pre">apt.progress.text</span></tt></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">apt</span>
</pre></div>
</div>
<p>Now we have to create a new <a class="reference internal" href="../library/apt.cdrom.html#apt.cdrom.Cdrom" title="apt.cdrom.Cdrom"><tt class="xref py py-class docutils literal"><span class="pre">apt.cdrom.Cdrom</span></tt></a> object and pass to it an
<a class="reference internal" href="../library/apt.progress.text.html#apt.progress.text.CdromProgress" title="apt.progress.text.CdromProgress"><tt class="xref py py-class docutils literal"><span class="pre">apt.progress.text.CdromProgress</span></tt></a> object, which is responsible for
displaying the progress and asking questions:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">cdrom</span> <span class="o">=</span> <span class="n">apt</span><span class="o">.</span><span class="n">Cdrom</span><span class="p">(</span><span class="n">apt</span><span class="o">.</span><span class="n">progress</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">CdromProgress</span><span class="p">())</span>
</pre></div>
</div>
<p>Now we have to choose the action, depending on the given options on the
command line. For now, we simply use the value of <tt class="docutils literal"><span class="pre">sys.argv[1]</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sys</span>
<span class="k">if</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="o">==</span> <span class="s">&#39;add&#39;</span><span class="p">:</span>
    <span class="n">cdrom</span><span class="o">.</span><span class="n">add</span><span class="p">()</span>
<span class="k">elif</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="o">==</span> <span class="s">&#39;ident&#39;</span><span class="p">:</span>
    <span class="n">cdrom</span><span class="o">.</span><span class="n">ident</span><span class="p">()</span>
</pre></div>
</div>
<p>Now we have a basic <strong class="command">apt-cdrom</strong> clone which can add and identify
CD-ROMs:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sys</span>

<span class="kn">import</span> <span class="nn">apt</span>

<span class="n">cdrom</span> <span class="o">=</span> <span class="n">apt</span><span class="o">.</span><span class="n">Cdrom</span><span class="p">(</span><span class="n">apt</span><span class="o">.</span><span class="n">progress</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">CdromProgress</span><span class="p">())</span>
<span class="k">if</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="o">==</span> <span class="s">&#39;add&#39;</span><span class="p">:</span>
    <span class="n">cdrom</span><span class="o">.</span><span class="n">add</span><span class="p">()</span>
<span class="k">elif</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="o">==</span> <span class="s">&#39;ident&#39;</span><span class="p">:</span>
    <span class="n">cdrom</span><span class="o">.</span><span class="n">ident</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="advanced-example-with-command-line-parsing">
<h2>Advanced example with command-line parsing<a class="headerlink" href="#advanced-example-with-command-line-parsing" title="Permalink to this headline"></a></h2>
<p>Our example clearly misses a way to parse the commandline in a correct
manner. Luckily, <a class="reference internal" href="../library/apt_pkg.html#module-apt_pkg" title="apt_pkg"><tt class="xref py py-mod docutils literal"><span class="pre">apt_pkg</span></tt></a> provides us with a function to do this:
<a class="reference internal" href="../library/apt_pkg.html#apt_pkg.parse_commandline" title="apt_pkg.parse_commandline"><tt class="xref py py-func docutils literal"><span class="pre">apt_pkg.parse_commandline()</span></tt></a>. To use it, we add <tt class="docutils literal"><span class="pre">import</span> <span class="pre">apt_pkg</span></tt> right
after import apt:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sys</span>

<span class="kn">import</span> <span class="nn">apt_pkg</span>
<span class="kn">import</span> <span class="nn">apt</span>
</pre></div>
</div>
<p><a class="reference internal" href="../library/apt_pkg.html#apt_pkg.parse_commandline" title="apt_pkg.parse_commandline"><tt class="xref py py-func docutils literal"><span class="pre">apt_pkg.parse_commandline()</span></tt></a> is similar to <tt class="xref py py-mod docutils literal"><span class="pre">getopt</span></tt> functions, it
takes a list of recognized options and the arguments and returns all unknown
arguments. If it encounters an unknown argument which starts with a leading
&#8216;-&#8216;, the function raises an error indicating that the option is unknown. The
major difference is that this function manipulates the apt configuration space.</p>
<p>The function takes 3 arguments. The first argument is an
<a class="reference internal" href="../library/apt_pkg.html#apt_pkg.Configuration" title="apt_pkg.Configuration"><tt class="xref py py-class docutils literal"><span class="pre">apt_pkg.Configuration</span></tt></a> object. The second argument is a list of tuples
of the form <tt class="docutils literal"><span class="pre">(shortopt,</span> <span class="pre">longopt,</span> <span class="pre">config,</span> <span class="pre">type)</span></tt>, whereas <em>shortopt</em> is a
character indicating the short option name, <em>longopt</em> a string indicating the
corresponding long option (e.g. <tt class="docutils literal"><span class="pre">&quot;--help&quot;</span></tt>), <em>config</em> the name of the
configuration item which should be set and <em>type</em> the type of the argument.</p>
<p>For apt-cdrom, we can use the following statement:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">arguments</span> <span class="o">=</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">parse_commandline</span><span class="p">(</span><span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
                <span class="p">[(</span><span class="s">&#39;h&#39;</span><span class="p">,</span> <span class="s">&quot;help&quot;</span><span class="p">,</span> <span class="s">&quot;help&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;v&#39;</span><span class="p">,</span> <span class="s">&quot;version&quot;</span><span class="p">,</span> <span class="s">&quot;version&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;d&#39;</span><span class="p">,</span> <span class="s">&quot;cdrom&quot;</span><span class="p">,</span> <span class="s">&quot;Acquire::cdrom::mount&quot;</span><span class="p">,</span> <span class="s">&quot;HasArg&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;r&#39;</span><span class="p">,</span> <span class="s">&quot;rename&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::Rename&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;m&#39;</span><span class="p">,</span> <span class="s">&quot;no-mount&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoMount&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;f&#39;</span><span class="p">,</span> <span class="s">&quot;fast&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::Fast&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;n&#39;</span><span class="p">,</span> <span class="s">&quot;just-print&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoAct&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;n&#39;</span><span class="p">,</span> <span class="s">&quot;recon&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoAct&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;n&#39;</span><span class="p">,</span> <span class="s">&quot;no-act&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoAct&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="s">&quot;thorough&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::Thorough&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;c&#39;</span><span class="p">,</span> <span class="s">&quot;config-file&quot;</span><span class="p">,</span> <span class="s">&quot;&quot;</span><span class="p">,</span> <span class="s">&quot;ConfigFile&quot;</span><span class="p">),</span>
                 <span class="p">(</span><span class="s">&#39;o&#39;</span><span class="p">,</span> <span class="s">&quot;option&quot;</span><span class="p">,</span> <span class="s">&quot;&quot;</span><span class="p">,</span> <span class="s">&quot;ArbItem&quot;</span><span class="p">)],</span> <span class="n">args</span><span class="p">)</span>
</pre></div>
</div>
<p>This allows us to support all options supported by apt-cdrom. The first option
is &#8211;help. As you can see, it omits the fourth field of the tuple; which means
it is a boolean argument. Afterwards you could use
<tt class="docutils literal"><span class="pre">apt_pkg.config.find_b(&quot;help&quot;)</span></tt> to see whether <tt class="docutils literal"><span class="pre">--help</span></tt> was specified. In
<tt class="docutils literal"><span class="pre">('d',&quot;cdrom&quot;,&quot;Acquire::cdrom::mount&quot;,&quot;HasArg&quot;)</span></tt> the fourth field is
<tt class="docutils literal"><span class="pre">&quot;HasArg&quot;</span></tt>. This means that the option has an argument, in this case the
location of the mount pint. <tt class="docutils literal"><span class="pre">('c',&quot;config-file&quot;,&quot;&quot;,&quot;ConfigFile&quot;)</span></tt> shows how
to include configuration files. This option takes a parameter which points to
a configuration file which will be added to the configuration space.
<tt class="docutils literal"><span class="pre">('o',&quot;option&quot;,&quot;&quot;,&quot;ArbItem&quot;)</span></tt> is yet another type of option, which allows users
to set configuration options on the commandline.</p>
<p>Now we have to check whether help or version is specified, and print a message
and exit afterwards. To do this, we use <a class="reference internal" href="../library/apt_pkg.html#apt_pkg.Configuration.find_b" title="apt_pkg.Configuration.find_b"><tt class="xref py py-meth docutils literal"><span class="pre">apt_pkg.Configuration.find_b()</span></tt></a>
which returns <tt class="docutils literal"><span class="pre">True</span></tt> if the configuration option exists and evaluates to
<tt class="docutils literal"><span class="pre">True</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">if</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">find_b</span><span class="p">(</span><span class="s">&quot;help&quot;</span><span class="p">):</span>
    <span class="k">print</span><span class="p">(</span><span class="s">&quot;This should be a help message&quot;</span><span class="p">)</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">find_b</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">):</span>
    <span class="k">print</span><span class="p">(</span><span class="s">&quot;Version blah.&quot;</span><span class="p">)</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
<p>Now we are ready to create our progress object and our cdrom object. Instead
of using <tt class="xref py py-class docutils literal"><span class="pre">apt.Cdrom</span></tt> like in the first example, we will use
<a class="reference internal" href="../library/apt_pkg.html#apt_pkg.Cdrom" title="apt_pkg.Cdrom"><tt class="xref py py-class docutils literal"><span class="pre">apt_pkg.Cdrom</span></tt></a> which provides a very similar interface. We could also
use <tt class="xref py py-class docutils literal"><span class="pre">apt.Cdrom</span></tt>, but <cite>apt.Cdrom</cite> provides options like <em>nomount</em> which
conflict with our commandline parsing:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">progress</span> <span class="o">=</span> <span class="n">apt</span><span class="o">.</span><span class="n">progress</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">CdromProgress</span><span class="p">()</span>
<span class="n">cdrom</span> <span class="o">=</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">Cdrom</span><span class="p">()</span>
</pre></div>
</div>
<p>Now we have to do the action requested by the user on the commandline. To see
which option was requested, we check the list <tt class="docutils literal"><span class="pre">arguments</span></tt> which was returned
by <tt class="docutils literal"><span class="pre">apt_pkg.parse_commandline</span></tt> above, and afterwards call <tt class="docutils literal"><span class="pre">cdrom.add</span></tt> or
<tt class="docutils literal"><span class="pre">cdrom.ident</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">if</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">find_b</span><span class="p">(</span><span class="s">&quot;help&quot;</span><span class="p">):</span>
    <span class="k">print</span><span class="p">(</span><span class="s">&quot;This should be a help message&quot;</span><span class="p">)</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">find_b</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">):</span>
    <span class="k">print</span><span class="p">(</span><span class="s">&quot;Version blah.&quot;</span><span class="p">)</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

<span class="k">if</span> <span class="ow">not</span> <span class="n">arguments</span><span class="p">:</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;E: No operation specified</span><span class="se">\n</span><span class="s">&#39;</span><span class="p">)</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;add&#39;</span><span class="p">:</span>
    <span class="n">cdrom</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">progress</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;ident&#39;</span><span class="p">:</span>
    <span class="n">cdrom</span><span class="o">.</span><span class="n">ident</span><span class="p">(</span><span class="n">progress</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;E: Invalid operation </span><span class="si">%s</span><span class="se">\n</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<p>After putting all our actions into a main() function, we get a completely
working apt-cdrom clone, which just misses useful <tt class="docutils literal"><span class="pre">--help</span></tt> and <tt class="docutils literal"><span class="pre">--version</span></tt>
options. If we add a function show_help(), we get an even more complete
apt-cdrom clone:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/python</span>
<span class="kn">import</span> <span class="nn">sys</span>

<span class="kn">import</span> <span class="nn">apt_pkg</span>
<span class="kn">import</span> <span class="nn">apt</span>


<span class="k">def</span> <span class="nf">show_help</span><span class="p">():</span>
    <span class="k">print</span> <span class="p">(</span><span class="s">&quot;apt </span><span class="si">%s</span><span class="s"> compiled on </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">apt_pkg</span><span class="o">.</span><span class="n">VERSION</span><span class="p">,</span>
                    <span class="n">apt_pkg</span><span class="o">.</span><span class="n">DATE</span><span class="p">,</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">TIME</span><span class="p">))</span>
    <span class="k">if</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">find_b</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">):</span>
        <span class="k">return</span> <span class="mi">0</span>

    <span class="c"># Copied from apt-cdrom</span>
    <span class="k">print</span> <span class="p">(</span><span class="s">&quot;Usage: apt-cdrom [options] command</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;apt-cdrom is a tool to add CDROM&#39;s to APT&#39;s source list. The</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;CDROM mount point and device information is taken from apt.conf</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;and /etc/fstab.</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;Commands:</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;   add - Add a CDROM</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;   ident - Report the identity of a CDROM</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;Options:</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -h   This help text</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -d   CD-ROM mount point</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -r   Rename a recognized CD-ROM</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -m   No mounting</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -f   Fast mode, don&#39;t check package files</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -a   Thorough scan mode</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -c=? Read this configuration file</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;  -o=? Set an arbitrary configuration option, eg -o &quot;</span>
           <span class="s">&quot;dir::cache=/tmp</span><span class="se">\n</span><span class="s">&quot;</span>
           <span class="s">&quot;See fstab(5)&quot;</span><span class="p">)</span>
    <span class="k">return</span> <span class="mi">0</span>


<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
    <span class="n">arguments</span> <span class="o">=</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">parse_commandline</span><span class="p">(</span><span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="p">,</span>
                    <span class="p">[(</span><span class="s">&#39;h&#39;</span><span class="p">,</span> <span class="s">&quot;help&quot;</span><span class="p">,</span> <span class="s">&quot;help&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;v&#39;</span><span class="p">,</span> <span class="s">&quot;version&quot;</span><span class="p">,</span> <span class="s">&quot;version&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;d&#39;</span><span class="p">,</span> <span class="s">&quot;cdrom&quot;</span><span class="p">,</span> <span class="s">&quot;Acquire::cdrom::mount&quot;</span><span class="p">,</span> <span class="s">&quot;HasArg&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;r&#39;</span><span class="p">,</span> <span class="s">&quot;rename&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::Rename&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;m&#39;</span><span class="p">,</span> <span class="s">&quot;no-mount&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoMount&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;f&#39;</span><span class="p">,</span> <span class="s">&quot;fast&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::Fast&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;n&#39;</span><span class="p">,</span> <span class="s">&quot;just-print&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoAct&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;n&#39;</span><span class="p">,</span> <span class="s">&quot;recon&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoAct&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;n&#39;</span><span class="p">,</span> <span class="s">&quot;no-act&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::NoAct&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;a&#39;</span><span class="p">,</span> <span class="s">&quot;thorough&quot;</span><span class="p">,</span> <span class="s">&quot;APT::CDROM::Thorough&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;c&#39;</span><span class="p">,</span> <span class="s">&quot;config-file&quot;</span><span class="p">,</span> <span class="s">&quot;&quot;</span><span class="p">,</span> <span class="s">&quot;ConfigFile&quot;</span><span class="p">),</span>
                     <span class="p">(</span><span class="s">&#39;o&#39;</span><span class="p">,</span> <span class="s">&quot;option&quot;</span><span class="p">,</span> <span class="s">&quot;&quot;</span><span class="p">,</span> <span class="s">&quot;ArbItem&quot;</span><span class="p">)],</span> <span class="n">args</span><span class="p">)</span>

    <span class="k">if</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">find_b</span><span class="p">(</span><span class="s">&quot;help&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">find_b</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">):</span>
        <span class="k">return</span> <span class="n">show_help</span><span class="p">()</span>

    <span class="n">progress</span> <span class="o">=</span> <span class="n">apt</span><span class="o">.</span><span class="n">progress</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">CdromProgress</span><span class="p">()</span>
    <span class="n">cdrom</span> <span class="o">=</span> <span class="n">apt_pkg</span><span class="o">.</span><span class="n">Cdrom</span><span class="p">()</span>

    <span class="k">if</span> <span class="ow">not</span> <span class="n">arguments</span><span class="p">:</span>
        <span class="k">return</span> <span class="n">show_help</span><span class="p">()</span>
    <span class="k">elif</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;add&#39;</span><span class="p">:</span>
        <span class="n">cdrom</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">progress</span><span class="p">)</span>
    <span class="k">elif</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;ident&#39;</span><span class="p">:</span>
        <span class="n">cdrom</span><span class="o">.</span><span class="n">ident</span><span class="p">(</span><span class="n">progress</span><span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;E: Invalid operation </span><span class="si">%s</span><span class="se">\n</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">arguments</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
        <span class="k">return</span> <span class="mi">1</span>

<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;__main__&#39;</span><span class="p">:</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">main</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../contents.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Writing your own apt-cdrom</a><ul>
<li><a class="reference internal" href="#basics">Basics</a></li>
<li><a class="reference internal" href="#advanced-example-with-command-line-parsing">Advanced example with command-line parsing</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Tutorials</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="apt-get.html"
                        title="next chapter">Doing stuff <strong class="command">apt-get</strong> does</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/tutorials/apt-cdrom.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <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="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="apt-get.html" title="Doing stuff apt-get does"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Tutorials"
             >previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="../index.html">python-apt 0.8.3ubuntu7 documentation</a> &raquo;</li>

          <li><a href="index.html" >Tutorials</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2009-2010, Julian Andres Klode &lt;jak@debian.org&gt;.
      Last updated on Apr 18, 2012.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>