python-cliapp 1.20140719-1 / usr / share / doc / python-cliapp / html / walkthrough.html

This file is indexed.

/usr/share/doc/python-cliapp/html/walkthrough.html is in python-cliapp 1.20140719-1.

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
<!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>2. Walkthrough &mdash; cliapp 1.20140719 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:     '1.20140719',
        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="cliapp 1.20140719 documentation" href="index.html" />
    <link rel="next" title="3. Logging" href="logging.html" />
    <link rel="prev" title="1. Example" href="example.html" /> 
  </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="logging.html" title="3. Logging"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="example.html" title="1. Example"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">cliapp 1.20140719 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="walkthrough">
<h1>2. Walkthrough<a class="headerlink" href="#walkthrough" title="Permalink to this headline">ΒΆ</a></h1>
<p>Every application should be a class that subclasses <tt class="docutils literal"><span class="pre">cliapp.Application</span></tt>.
The subclass should provide specific methods. Read the documentation
for the <tt class="docutils literal"><span class="pre">cliapp.Application</span></tt> class to see all methods, but a rough
summary is here:</p>
<ul class="simple">
<li>the <tt class="docutils literal"><span class="pre">settings</span></tt> attribute is the <tt class="docutils literal"><span class="pre">cliapp.Settings</span></tt> instance used by
the application</li>
<li>override <tt class="docutils literal"><span class="pre">add_settings</span></tt> to add new settings for the application</li>
<li>override <tt class="docutils literal"><span class="pre">process_*</span></tt> methods to override various stages in how
arguments and input files are processed</li>
<li>override <tt class="docutils literal"><span class="pre">process_args</span></tt> to decide how each argument is processed;
by default, this called <tt class="docutils literal"><span class="pre">process_inputs</span></tt> or handles subcommands</li>
<li><tt class="docutils literal"><span class="pre">process_inputs</span></tt> calls <tt class="docutils literal"><span class="pre">process_input</span></tt> (note singular) for each
argument, or on <tt class="docutils literal"><span class="pre">-</span></tt> to process standard input if no files are named
on the command line</li>
<li><tt class="docutils literal"><span class="pre">process_input</span></tt> calls <tt class="docutils literal"><span class="pre">open_input</span></tt> to open each file, then calls
<tt class="docutils literal"><span class="pre">process_input_line</span></tt> for each input line</li>
<li><tt class="docutils literal"><span class="pre">process_input_line</span></tt> does nothing, by default</li>
</ul>
<p>This cascade of overrideable methods is started by the <cite>run</cite>
method, which also sets up logging, loads configuration files,
parses the command line, and handles reporting of exceptions.
It can also run the rest of the code under the Python profiler,
if the appropriate environment variable is set.</p>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="example.html"
                        title="previous chapter">1. Example</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="logging.html"
                        title="next chapter">3. Logging</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/walkthrough.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="logging.html" title="3. Logging"
             >next</a> |</li>
        <li class="right" >
          <a href="example.html" title="1. Example"
             >previous</a> |</li>
        <li><a href="index.html">cliapp 1.20140719 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, Lars Wirzenius.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.