terminator/doc/apidoc/_build/html/_modules/terminatorlib/plugins/url_handlers.html

282 lines
20 KiB
HTML

<!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>terminatorlib.plugins.url_handlers &mdash; terminatorlib 0.98 documentation</title>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="top" title="terminatorlib 0.98 documentation" href="../../../index.html"/>
<link rel="up" title="Module code" href="../../index.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-nav-search">
<a href="../../../index.html" class="icon icon-home"> terminatorlib
</a>
<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="../../../terminatorlib.html">terminatorlib package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../terminatorlib.configobj.html">terminatorlib.configobj package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#module-terminatorlib.configobj.configobj">terminatorlib.configobj.configobj module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#module-terminatorlib.configobj.validate">terminatorlib.configobj.validate module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.configobj.html#module-terminatorlib.configobj">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../../terminatorlib.plugins.html">terminatorlib.plugins package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.activitywatch">terminatorlib.plugins.activitywatch module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.custom_commands">terminatorlib.plugins.custom_commands module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.logger">terminatorlib.plugins.logger module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.maven">terminatorlib.plugins.maven module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.terminalshot">terminatorlib.plugins.terminalshot module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.testplugin">terminatorlib.plugins.testplugin module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins.url_handlers">terminatorlib.plugins.url_handlers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../terminatorlib.plugins.html#module-terminatorlib.plugins">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.borg">terminatorlib.borg module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.config">terminatorlib.config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.container">terminatorlib.container module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.cwd">terminatorlib.cwd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.debugserver">terminatorlib.debugserver module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.editablelabel">terminatorlib.editablelabel module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.encoding">terminatorlib.encoding module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.factory">terminatorlib.factory module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.freebsd">terminatorlib.freebsd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.ipc">terminatorlib.ipc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.keybindings">terminatorlib.keybindings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.layoutlauncher">terminatorlib.layoutlauncher module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.notebook">terminatorlib.notebook module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.optionparse">terminatorlib.optionparse module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.paned">terminatorlib.paned module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.plugin">terminatorlib.plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.prefseditor">terminatorlib.prefseditor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.searchbar">terminatorlib.searchbar module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.signalman">terminatorlib.signalman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.terminal">terminatorlib.terminal module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.terminal_popup_menu">terminatorlib.terminal_popup_menu module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.terminator">terminatorlib.terminator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.titlebar">terminatorlib.titlebar module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.translation">terminatorlib.translation module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.util">terminatorlib.util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.version">terminatorlib.version module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib.window">terminatorlib.window module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../terminatorlib.html#module-terminatorlib">Module contents</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</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">terminatorlib</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> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>terminatorlib.plugins.url_handlers</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<h1>Source code for terminatorlib.plugins.url_handlers</h1><div class="highlight"><pre>
<span class="c"># Terminator by Chris Jones &lt;cmsj@tenshu.net?</span>
<span class="c"># GPL v2 only</span>
<span class="sd">&quot;&quot;&quot;url_handlers.py - Default plugins for URL handling&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">terminatorlib.plugin</span> <span class="kn">as</span> <span class="nn">plugin</span>
<span class="c"># Every plugin you want Terminator to load *must* be listed in &#39;AVAILABLE&#39;</span>
<span class="n">AVAILABLE</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;LaunchpadBugURLHandler&#39;</span><span class="p">,</span> <span class="s">&#39;LaunchpadCodeURLHandler&#39;</span><span class="p">,</span> <span class="s">&#39;APTURLHandler&#39;</span><span class="p">]</span>
<div class="viewcode-block" id="LaunchpadBugURLHandler"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.url_handlers.LaunchpadBugURLHandler">[docs]</a><span class="k">class</span> <span class="nc">LaunchpadBugURLHandler</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">URLHandler</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Launchpad Bug URL handler. If the URL looks like a Launchpad changelog</span>
<span class="sd"> closure entry... &#39;LP: #12345&#39; then it should be transformed into a </span>
<span class="sd"> Launchpad Bug URL&quot;&quot;&quot;</span>
<span class="n">capabilities</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;url_handler&#39;</span><span class="p">]</span>
<span class="n">handler_name</span> <span class="o">=</span> <span class="s">&#39;launchpad_bug&#39;</span>
<span class="n">match</span> <span class="o">=</span> <span class="s">&#39;</span><span class="se">\\</span><span class="s">b(lp|LP):?\s?#?[0-9]+(,\s*#?[0-9]+)*</span><span class="se">\\</span><span class="s">b&#39;</span>
<span class="n">nameopen</span> <span class="o">=</span> <span class="s">&quot;Open Launchpad bug&quot;</span>
<span class="n">namecopy</span> <span class="o">=</span> <span class="s">&quot;Copy bug URL&quot;</span>
<div class="viewcode-block" id="LaunchpadBugURLHandler.callback"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.url_handlers.LaunchpadBugURLHandler.callback">[docs]</a> <span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Look for the number in the supplied string and return it as a URL&quot;&quot;&quot;</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">re</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">r&#39;[0-9]+&#39;</span><span class="p">,</span> <span class="n">url</span><span class="p">):</span>
<span class="n">url</span> <span class="o">=</span> <span class="s">&#39;https://bugs.launchpad.net/bugs/</span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">item</span>
<span class="k">return</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="LaunchpadCodeURLHandler"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.url_handlers.LaunchpadCodeURLHandler">[docs]</a><span class="k">class</span> <span class="nc">LaunchpadCodeURLHandler</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">URLHandler</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Launchpad Code URL handler. If the URL looks like a Launchpad project or</span>
<span class="sd"> branch entry then it should be transformed into a code.launchpad.net URL&quot;&quot;&quot;</span>
<span class="n">capabilities</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;url_handler&#39;</span><span class="p">]</span>
<span class="n">handler_name</span> <span class="o">=</span> <span class="s">&#39;launchpad_code&#39;</span>
<span class="n">nameopen</span> <span class="o">=</span> <span class="s">&quot;Open Launchpad branch&quot;</span>
<span class="n">namecopy</span> <span class="o">=</span> <span class="s">&quot;Copy branch URL&quot;</span>
<span class="n">lpfilters</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">lpfilters</span><span class="p">[</span><span class="s">&#39;project&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;[a-z0-9]{1}[a-z0-9+.-]+&#39;</span>
<span class="n">lpfilters</span><span class="p">[</span><span class="s">&#39;group&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;~</span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">lpfilters</span><span class="p">[</span><span class="s">&#39;project&#39;</span><span class="p">]</span>
<span class="n">lpfilters</span><span class="p">[</span><span class="s">&#39;series&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">lpfilters</span><span class="p">[</span><span class="s">&#39;project&#39;</span><span class="p">]</span>
<span class="n">lpfilters</span><span class="p">[</span><span class="s">&#39;branch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;[a-zA-Z0-9]{1}[a-zA-Z0-9_+@.-]+&#39;</span>
<span class="n">match</span> <span class="o">=</span> <span class="s">&#39;</span><span class="se">\\</span><span class="s">b((lp|LP):</span><span class="si">%(project)s</span><span class="s">(/</span><span class="si">%(series)s</span><span class="s">)?|(lp|LP):</span><span class="si">%(group)s</span><span class="s">/(</span><span class="si">%(project)s</span><span class="s">|\+junk)/</span><span class="si">%(branch)s</span><span class="s">)</span><span class="se">\\</span><span class="s">b&#39;</span> <span class="o">%</span> <span class="n">lpfilters</span>
<div class="viewcode-block" id="LaunchpadCodeURLHandler.callback"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.url_handlers.LaunchpadCodeURLHandler.callback">[docs]</a> <span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Look for the number in the supplied string and return it as a URL&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&#39;lp:&#39;</span><span class="p">):</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span><span class="p">[</span><span class="mi">3</span><span class="p">:]</span>
<span class="k">return</span><span class="p">(</span><span class="s">&#39;https://code.launchpad.net/+branch/</span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">url</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="APTURLHandler"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.url_handlers.APTURLHandler">[docs]</a><span class="k">class</span> <span class="nc">APTURLHandler</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">URLHandler</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;APT URL handler. If there is a URL that looks like an apturl, handle</span>
<span class="sd"> it appropriately&quot;&quot;&quot;</span>
<span class="n">capabilities</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;url_handler&#39;</span><span class="p">]</span>
<span class="n">handler_name</span> <span class="o">=</span> <span class="s">&#39;apturl&#39;</span>
<span class="n">nameopen</span> <span class="o">=</span> <span class="s">&quot;Open software manager&quot;</span>
<span class="n">namecopy</span> <span class="o">=</span> <span class="s">&quot;Copy package URI&quot;</span>
<span class="n">match</span> <span class="o">=</span> <span class="s">&#39;</span><span class="se">\\</span><span class="s">bapt:.*</span><span class="se">\\</span><span class="s">b&#39;</span>
<div class="viewcode-block" id="APTURLHandler.callback"><a class="viewcode-back" href="../../../terminatorlib.plugins.html#terminatorlib.plugins.url_handlers.APTURLHandler.callback">[docs]</a> <span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Actually we don&#39;t need to do anything for this to work&quot;&quot;&quot;</span>
<span class="k">return</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
</pre></div></div></div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
</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:'0.98',
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>