/usr/share/doc/python-cement-doc/html/examples/abstract_base_controllers.html is in python-cement-doc 2.10.0-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 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 365 366 367 368 369 370 371 | <!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>Abstract Base Controllers for Shared Arguments and Commands — Cement 2.10.0 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="top" title="Cement 2.10.0 documentation" href="../index.html"/>
<link rel="up" title="Examples" href="index.html"/>
<link rel="next" title="Multiple Controllers With Same Label" href="controllers_with_same_label.html"/>
<link rel="prev" title="Multiple Stacked Controllers" href="multiple_stacked_controllers.html"/>
<script src="../_static/js/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-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> Cement
</a>
<div class="version">
2.10
</div>
<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>
<li class="toctree-l1"><a class="reference internal" href="../changes.html">ChangeLog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributors.html">Contributors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="../whats_new.html">What’s New</a></li>
<li class="toctree-l1"><a class="reference internal" href="../projects_built_on_cement.html">Projects Built on Cement™</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequenty Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">API Reference</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Developer Documentation</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Examples</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="app_version.html">Adding a Version Option to Your App</a></li>
<li class="toctree-l2"><a class="reference internal" href="multiple_stacked_controllers.html">Multiple Stacked Controllers</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Abstract Base Controllers for Shared Arguments and Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="controllers_with_same_label.html">Multiple Controllers With Same Label</a></li>
<li class="toctree-l2"><a class="reference internal" href="bash_auto_completion.html">BASH Auto Completion</a></li>
<li class="toctree-l2"><a class="reference internal" href="arbitrary_extra_arguments.html">Handling Arbitrary Extra Positional Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="reload_config.html">Auto Reload When Configuration Files Change</a></li>
<li class="toctree-l2"><a class="reference internal" href="tabularized_output.html">Tabularized Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="sighup_reload.html">Reload Application on SIGHUP</a></li>
<li class="toctree-l2"><a class="reference internal" href="managing_multiple_environments.html">Managing Multiple Environments</a></li>
</ul>
</li>
</ul>
</div>
</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">Cement</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><a href="index.html">Examples</a> »</li>
<li>Abstract Base Controllers for Shared Arguments and Commands</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/examples/abstract_base_controllers.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="abstract-base-controllers-for-shared-arguments-and-commands">
<h1>Abstract Base Controllers for Shared Arguments and Commands<a class="headerlink" href="#abstract-base-controllers-for-shared-arguments-and-commands" title="Permalink to this headline">¶</a></h1>
<p>For larger, complex applications it is often very useful to have abstract
base controllers that hold shared arguments and commands that a number of
other controllers have in common. Note that in the example below, you can
not override the Meta.arguments in a sub-class or you overwrite the shared
arguments, but it is possible to <cite>append</cite> to them in order to maintain the
defaults while having unique options/arguments for the sub-classed controller.
As well, you can add any number of additional commands in the sub-class but
still maintain the existing shared commands (or override them as necessary).</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cement.core.foundation</span> <span class="kn">import</span> <span class="n">CementApp</span>
<span class="kn">from</span> <span class="nn">cement.core.controller</span> <span class="kn">import</span> <span class="n">CementBaseController</span><span class="p">,</span> <span class="n">expose</span>
<span class="k">class</span> <span class="nc">AbstractBaseController</span><span class="p">(</span><span class="n">CementBaseController</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This is an abstract base class that is useless on its own, but used</span>
<span class="sd"> by other classes to sub-class from and to share common commands and</span>
<span class="sd"> arguments. This should not be confused with the `MyAppBaseController`</span>
<span class="sd"> used as the ``base_controller`` namespace.</span>
<span class="sd"> """</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="n">stacked_on</span> <span class="o">=</span> <span class="s1">'base'</span>
<span class="n">stacked_type</span> <span class="o">=</span> <span class="s1">'nested'</span>
<span class="n">arguments</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span> <span class="p">[</span><span class="s1">'-f'</span><span class="p">,</span> <span class="s1">'--foo'</span><span class="p">],</span> <span class="nb">dict</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s1">'notorious foo option'</span><span class="p">)),</span>
<span class="p">]</span>
<span class="k">def</span> <span class="nf">_setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base_app</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">AbstractBaseController</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_setup</span><span class="p">(</span><span class="n">base_app</span><span class="p">)</span>
<span class="c1"># add a common object that will be used in any sub-class</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reusable_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="nd">@expose</span><span class="p">(</span><span class="n">hide</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This command will be shared within all controllers that sub-class</span>
<span class="sd"> from here. It can also be overridden in the sub-class, but for</span>
<span class="sd"> this example we are making it dynamic.</span>
<span class="sd"> """</span>
<span class="c1"># do something with self.my_shared_obj here?</span>
<span class="k">if</span> <span class="s1">'some_key'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">reusable_dict</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="k">pass</span>
<span class="c1"># or do something with parsed args?</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">pargs</span><span class="o">.</span><span class="n">foo</span><span class="p">:</span>
<span class="k">print</span> <span class="s2">"Foo option was passed with value: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">pargs</span><span class="o">.</span><span class="n">foo</span>
<span class="c1"># or maybe do something dynamically</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"Inside </span><span class="si">%s</span><span class="s2">.default()"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">MyAppBaseController</span><span class="p">(</span><span class="n">CementBaseController</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This is the application base controller, but we don't want to use our</span>
<span class="sd"> abstract base class here.</span>
<span class="sd"> """</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="n">label</span> <span class="o">=</span> <span class="s1">'base'</span>
<span class="nd">@expose</span><span class="p">(</span><span class="n">hide</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"Inside MyAppBaseController.default()"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Controller1</span><span class="p">(</span><span class="n">AbstractBaseController</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This controller sub-classes from the abstract base class as to inherite</span>
<span class="sd"> shared arguments, and commands.</span>
<span class="sd"> """</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="n">label</span> <span class="o">=</span> <span class="s1">'controller1'</span>
<span class="nd">@expose</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command1</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"Inside Controller1.command1()"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Controller2</span><span class="p">(</span><span class="n">AbstractBaseController</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This controller also sub-classes from the abstract base class as to</span>
<span class="sd"> inherite shared arguments, and commands.</span>
<span class="sd"> """</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="n">label</span> <span class="o">=</span> <span class="s1">'controller2'</span>
<span class="nd">@expose</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command2</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"Inside Controller2.command2()"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">MyApp</span><span class="p">(</span><span class="n">CementApp</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="n">label</span> <span class="o">=</span> <span class="s1">'myapp'</span>
<span class="n">base_controller</span> <span class="o">=</span> <span class="s1">'base'</span>
<span class="n">handlers</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">MyAppBaseController</span><span class="p">,</span>
<span class="n">Controller1</span><span class="p">,</span>
<span class="n">Controller2</span><span class="p">,</span>
<span class="p">]</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="k">with</span> <span class="n">MyApp</span><span class="p">()</span> <span class="k">as</span> <span class="n">app</span><span class="p">:</span>
<span class="n">app</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
<p>And:</p>
<div class="highlight-text"><div class="highlight"><pre><span></span>$ python myapp.py
Inside MyAppBaseController.default()
$ python myapp.py --help
usage: myapp.py (sub-commands ...) [options ...] {arguments ...}
Base Controller
commands:
controller1
Controller1 Controller
controller2
Controller2 Controller
optional arguments:
-h, --help show this help message and exit
--debug toggle debug output
--quiet suppress all output
$ python myapp.py controller1
Inside Controller1.default()
$ python myapp.py controller1 --foo=bar
Foo option was passed with value: bar
Inside Controller1.default()
$ python myapp.py controller2
Inside Controller2.default()
</pre></div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="controllers_with_same_label.html" class="btn btn-neutral float-right" title="Multiple Controllers With Same Label" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="multiple_stacked_controllers.html" class="btn btn-neutral" title="Multiple Stacked Controllers" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2009-2016, Data Folk Labs, LLC.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">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:'2.10.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>
|