← Back to branch summary

~stephen-j-boddy/terminator/bugfix-1318542-double-chars

« back to all changes in this revision

Viewing changes to doc/apidoc/_build/html/_modules/terminatorlib/cwd.html

  • Committer: Stephen Boddy
  • Date: 2015-08-08 02:11:30 UTC
  • Revision ID: stephen.j.boddy@gmail.com-20150808021130-9c1npu4gvenkcb1p
A manual has been added to Terminator
* Added source and generated html of manual, and API doc
* setup.py can install the manual (and by extension do can debuild)
* setup.py has (inactive) code for generating the html from the source
  but this will break if rtd theme is not available
* A few changes to doc strings to make the autodoc prettier
* Added help shortcut, by default F1 to open the local manual
* Added button to About tab to launch manual
* A couple of additional string to translate related to manual/help

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/apidoc/_build/html/_modules/terminatorlib/cwd.html
 
1
 
 
2
 
 
3
<!DOCTYPE html>
 
4
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 
5
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 
6
<head>
 
7
  <meta charset="utf-8">
 
8
  
 
9
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
10
  
 
11
  <title>terminatorlib.cwd &mdash; terminatorlib 0.98 documentation</title>
 
12
  
 
13
 
 
14
  
 
15
  
 
16
 
 
17
  
 
18
 
 
19
  
 
20
  
 
21
    
 
22
 
 
23
  
 
24
 
 
25
  
 
26
  
 
27
    <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
 
28
  
 
29
 
 
30
  
 
31
 
 
32
  
 
33
    <link rel="top" title="terminatorlib 0.98 documentation" href="../../index.html"/>
 
34
        <link rel="up" title="Module code" href="../index.html"/> 
 
35
 
 
36
  
 
37
  <script src="_static/js/modernizr.min.js"></script>
 
38
 
 
39
</head>
 
40
 
 
41
<body class="wy-body-for-nav" role="document">
 
42
 
 
43
  <div class="wy-grid-for-nav">
 
44
 
 
45
    
 
46
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 
47
      <div class="wy-side-nav-search">
 
48
        
 
49
 
 
50
        
 
51
          <a href="../../index.html" class="icon icon-home"> terminatorlib
 
52
        
 
53
 
 
54
        
 
55
        </a>
 
56
 
 
57
        
 
58
<div role="search">
 
59
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
 
60
    <input type="text" name="q" placeholder="Search docs" />
 
61
    <input type="hidden" name="check_keywords" value="yes" />
 
62
    <input type="hidden" name="area" value="default" />
 
63
  </form>
 
64
</div>
 
65
 
 
66
        
 
67
      </div>
 
68
 
 
69
      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 
70
        
 
71
          
 
72
          
 
73
              <ul>
 
74
<li class="toctree-l1"><a class="reference internal" href="../../terminatorlib.html">terminatorlib package</a><ul>
 
75
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#subpackages">Subpackages</a><ul>
 
76
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.configobj.html">terminatorlib.configobj package</a><ul>
 
77
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#submodules">Submodules</a></li>
 
78
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.configobj">terminatorlib.configobj.configobj module</a></li>
 
79
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.validate">terminatorlib.configobj.validate module</a></li>
 
80
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj">Module contents</a></li>
 
81
</ul>
 
82
</li>
 
83
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.plugins.html">terminatorlib.plugins package</a><ul>
 
84
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#submodules">Submodules</a></li>
 
85
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.activitywatch">terminatorlib.plugins.activitywatch module</a></li>
 
86
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.custom_commands">terminatorlib.plugins.custom_commands module</a></li>
 
87
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.logger">terminatorlib.plugins.logger module</a></li>
 
88
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.maven">terminatorlib.plugins.maven module</a></li>
 
89
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.terminalshot">terminatorlib.plugins.terminalshot module</a></li>
 
90
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.testplugin">terminatorlib.plugins.testplugin module</a></li>
 
91
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.url_handlers">terminatorlib.plugins.url_handlers module</a></li>
 
92
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins">Module contents</a></li>
 
93
</ul>
 
94
</li>
 
95
</ul>
 
96
</li>
 
97
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#submodules">Submodules</a></li>
 
98
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.borg">terminatorlib.borg module</a></li>
 
99
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.config">terminatorlib.config module</a></li>
 
100
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.container">terminatorlib.container module</a></li>
 
101
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.cwd">terminatorlib.cwd module</a></li>
 
102
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.debugserver">terminatorlib.debugserver module</a></li>
 
103
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.editablelabel">terminatorlib.editablelabel module</a></li>
 
104
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.encoding">terminatorlib.encoding module</a></li>
 
105
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.factory">terminatorlib.factory module</a></li>
 
106
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.freebsd">terminatorlib.freebsd module</a></li>
 
107
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.ipc">terminatorlib.ipc module</a></li>
 
108
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.keybindings">terminatorlib.keybindings module</a></li>
 
109
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.layoutlauncher">terminatorlib.layoutlauncher module</a></li>
 
110
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.notebook">terminatorlib.notebook module</a></li>
 
111
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.optionparse">terminatorlib.optionparse module</a></li>
 
112
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.paned">terminatorlib.paned module</a></li>
 
113
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.plugin">terminatorlib.plugin module</a></li>
 
114
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.prefseditor">terminatorlib.prefseditor module</a></li>
 
115
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.searchbar">terminatorlib.searchbar module</a></li>
 
116
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.signalman">terminatorlib.signalman module</a></li>
 
117
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal">terminatorlib.terminal module</a></li>
 
118
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal_popup_menu">terminatorlib.terminal_popup_menu module</a></li>
 
119
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminator">terminatorlib.terminator module</a></li>
 
120
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.titlebar">terminatorlib.titlebar module</a></li>
 
121
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.translation">terminatorlib.translation module</a></li>
 
122
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.util">terminatorlib.util module</a></li>
 
123
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.version">terminatorlib.version module</a></li>
 
124
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.window">terminatorlib.window module</a></li>
 
125
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib">Module contents</a></li>
 
126
</ul>
 
127
</li>
 
128
</ul>
 
129
 
 
130
          
 
131
        
 
132
      </div>
 
133
      &nbsp;
 
134
    </nav>
 
135
 
 
136
    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
137
 
 
138
      
 
139
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 
140
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 
141
        <a href="../../index.html">terminatorlib</a>
 
142
      </nav>
 
143
 
 
144
 
 
145
      
 
146
      <div class="wy-nav-content">
 
147
        <div class="rst-content">
 
148
          <div role="navigation" aria-label="breadcrumbs navigation">
 
149
  <ul class="wy-breadcrumbs">
 
150
    <li><a href="../../index.html">Docs</a> &raquo;</li>
 
151
      
 
152
          <li><a href="../index.html">Module code</a> &raquo;</li>
 
153
      
 
154
    <li>terminatorlib.cwd</li>
 
155
      <li class="wy-breadcrumbs-aside">
 
156
        
 
157
          
 
158
        
 
159
      </li>
 
160
  </ul>
 
161
  <hr/>
 
162
</div>
 
163
          <div role="main" class="document">
 
164
            
 
165
  <h1>Source code for terminatorlib.cwd</h1><div class="highlight"><pre>
 
166
<span class="c">#!/usr/bin/python</span>
 
167
<span class="c"># Terminator by Chris Jones &lt;cmsj@tenshu.net&gt;</span>
 
168
<span class="c"># GPL v2 only</span>
 
169
<span class="sd">&quot;&quot;&quot;cwd.py - function necessary to get the cwd for a given pid on various OSes</span>
 
170
 
 
171
<span class="sd">&gt;&gt;&gt; cwd = get_default_cwd()</span>
 
172
<span class="sd">&gt;&gt;&gt; cwd.__class__.__name__</span>
 
173
<span class="sd">&#39;str&#39;</span>
 
174
<span class="sd">&gt;&gt;&gt; func = get_pid_cwd()</span>
 
175
<span class="sd">&gt;&gt;&gt; func.__class__.__name__</span>
 
176
<span class="sd">&#39;function&#39;</span>
 
177
 
 
178
<span class="sd">&quot;&quot;&quot;</span>
 
179
 
 
180
<span class="kn">import</span> <span class="nn">platform</span>
 
181
<span class="kn">import</span> <span class="nn">os</span>
 
182
<span class="kn">import</span> <span class="nn">pwd</span>
 
183
<span class="kn">from</span> <span class="nn">util</span> <span class="kn">import</span> <span class="n">dbg</span><span class="p">,</span> <span class="n">err</span>
 
184
 
 
185
<div class="viewcode-block" id="get_default_cwd"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.cwd.get_default_cwd">[docs]</a><span class="k">def</span> <span class="nf">get_default_cwd</span><span class="p">():</span>
 
186
    <span class="sd">&quot;&quot;&quot;Determine a reasonable default cwd&quot;&quot;&quot;</span>
 
187
    <span class="n">cwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>
 
188
    <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">cwd</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">cwd</span><span class="p">):</span>
 
189
        <span class="k">try</span><span class="p">:</span>
 
190
            <span class="n">cwd</span> <span class="o">=</span> <span class="n">pwd</span><span class="o">.</span><span class="n">getpwuid</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getuid</span><span class="p">())[</span><span class="mi">5</span><span class="p">]</span>
 
191
        <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
 
192
            <span class="n">cwd</span> <span class="o">=</span> <span class="s">&#39;/&#39;</span>
 
193
    
 
194
    <span class="k">return</span><span class="p">(</span><span class="n">cwd</span><span class="p">)</span>
 
195
</div>
 
196
<div class="viewcode-block" id="get_pid_cwd"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.cwd.get_pid_cwd">[docs]</a><span class="k">def</span> <span class="nf">get_pid_cwd</span><span class="p">():</span>
 
197
    <span class="sd">&quot;&quot;&quot;Determine an appropriate cwd function for the OS we are running on&quot;&quot;&quot;</span>
 
198
 
 
199
    <span class="n">func</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">pid</span><span class="p">:</span> <span class="bp">None</span>
 
200
    <span class="n">system</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span>
 
201
 
 
202
    <span class="k">if</span> <span class="n">system</span> <span class="o">==</span> <span class="s">&#39;Linux&#39;</span><span class="p">:</span>
 
203
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Using Linux get_pid_cwd&#39;</span><span class="p">)</span>
 
204
        <span class="n">func</span> <span class="o">=</span> <span class="n">linux_get_pid_cwd</span>
 
205
    <span class="k">elif</span> <span class="n">system</span> <span class="o">==</span> <span class="s">&#39;FreeBSD&#39;</span><span class="p">:</span>
 
206
        <span class="k">try</span><span class="p">:</span>
 
207
            <span class="kn">import</span> <span class="nn">freebsd</span>
 
208
            <span class="n">func</span> <span class="o">=</span> <span class="n">freebsd</span><span class="o">.</span><span class="n">get_process_cwd</span>
 
209
            <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Using FreeBSD get_pid_cwd&#39;</span><span class="p">)</span>
 
210
        <span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="ne">NotImplementedError</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">):</span>
 
211
            <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;FreeBSD version too old for get_pid_cwd&#39;</span><span class="p">)</span>
 
212
    <span class="k">elif</span> <span class="n">system</span> <span class="o">==</span> <span class="s">&#39;SunOS&#39;</span><span class="p">:</span>
 
213
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Using SunOS get_pid_cwd&#39;</span><span class="p">)</span>
 
214
        <span class="n">func</span> <span class="o">=</span> <span class="n">sunos_get_pid_cwd</span>
 
215
    <span class="k">else</span><span class="p">:</span>
 
216
        <span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Unable to determine a get_pid_cwd for OS: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">system</span><span class="p">)</span>
 
217
 
 
218
    <span class="k">return</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
 
219
</div>
 
220
<div class="viewcode-block" id="proc_get_pid_cwd"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.cwd.proc_get_pid_cwd">[docs]</a><span class="k">def</span> <span class="nf">proc_get_pid_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
 
221
    <span class="sd">&quot;&quot;&quot;Extract the cwd of a PID from proc, given the PID and the /proc path to</span>
 
222
<span class="sd">    insert it into, e.g. /proc/%s/cwd&quot;&quot;&quot;</span>
 
223
    <span class="k">try</span><span class="p">:</span>
 
224
        <span class="n">cwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="n">path</span> <span class="o">%</span> <span class="n">pid</span><span class="p">)</span>
 
225
    <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span>
 
226
        <span class="n">err</span><span class="p">(</span><span class="s">&#39;Unable to get cwd for PID </span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ex</span><span class="p">))</span>
 
227
        <span class="n">cwd</span> <span class="o">=</span> <span class="s">&#39;/&#39;</span>
 
228
 
 
229
    <span class="k">return</span><span class="p">(</span><span class="n">cwd</span><span class="p">)</span>
 
230
</div>
 
231
<div class="viewcode-block" id="linux_get_pid_cwd"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.cwd.linux_get_pid_cwd">[docs]</a><span class="k">def</span> <span class="nf">linux_get_pid_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">):</span>
 
232
    <span class="sd">&quot;&quot;&quot;Determine the cwd for a given PID on Linux kernels&quot;&quot;&quot;</span>
 
233
    <span class="k">return</span><span class="p">(</span><span class="n">proc_get_pid_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="s">&#39;/proc/</span><span class="si">%s</span><span class="s">/cwd&#39;</span><span class="p">))</span>
 
234
</div>
 
235
<div class="viewcode-block" id="sunos_get_pid_cwd"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.cwd.sunos_get_pid_cwd">[docs]</a><span class="k">def</span> <span class="nf">sunos_get_pid_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">):</span>
 
236
    <span class="sd">&quot;&quot;&quot;Determine the cwd for a given PID on SunOS kernels&quot;&quot;&quot;</span>
 
237
    <span class="k">return</span><span class="p">(</span><span class="n">proc_get_pid_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="s">&#39;/proc/</span><span class="si">%s</span><span class="s">/path/cwd&#39;</span><span class="p">))</span>
 
238
 
 
239
<span class="c"># vim: set expandtab ts=4 sw=4:</span></div>
 
240
</pre></div>
 
241
 
 
242
          </div>
 
243
          <footer>
 
244
  
 
245
 
 
246
  <hr/>
 
247
 
 
248
  <div role="contentinfo">
 
249
    <p>
 
250
        &copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
 
251
    </p>
 
252
  </div>
 
253
  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>.
 
254
 
 
255
</footer>
 
256
 
 
257
        </div>
 
258
      </div>
 
259
 
 
260
    </section>
 
261
 
 
262
  </div>
 
263
  
 
264
 
 
265
 
 
266
  
 
267
 
 
268
    <script type="text/javascript">
 
269
        var DOCUMENTATION_OPTIONS = {
 
270
            URL_ROOT:'../../',
 
271
            VERSION:'0.98',
 
272
            COLLAPSE_INDEX:false,
 
273
            FILE_SUFFIX:'.html',
 
274
            HAS_SOURCE:  true
 
275
        };
 
276
    </script>
 
277
      <script type="text/javascript" src="../../_static/jquery.js"></script>
 
278
      <script type="text/javascript" src="../../_static/underscore.js"></script>
 
279
      <script type="text/javascript" src="../../_static/doctools.js"></script>
 
280
 
 
281
  
 
282
 
 
283
  
 
284
  
 
285
    <script type="text/javascript" src="../../_static/js/theme.js"></script>
 
286
  
 
287
 
 
288
  
 
289
  
 
290
  <script type="text/javascript">
 
291
      jQuery(function () {
 
292
          SphinxRtdTheme.StickyNav.enable();
 
293
      });
 
294
  </script>
 
295
   
 
296
 
 
297
</body>
 
298
</html>
 
 
b'\\ No newline at end of file'