source: sasview/_modules/sas/guiframe/customdir.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 13.4 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.guiframe.customdir &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../../index.html" />
28    <link rel="up" title="sas.guiframe" href="../guiframe.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../../../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../../../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
41          <li><a href="../../index.html" >Module code</a> &raquo;</li>
42          <li><a href="../guiframe.html" accesskey="U">sas.guiframe</a> &raquo;</li> 
43      </ul>
44    </div> 
45
46    <div class="document">
47      <div class="documentwrapper">
48        <div class="bodywrapper">
49          <div class="body">
50           
51  <h1>Source code for sas.guiframe.customdir</h1><div class="highlight"><pre>
52<span class="c"># Setup and find Custom config dir</span>
53<span class="kn">import</span> <span class="nn">sys</span>
54<span class="kn">import</span> <span class="nn">os.path</span>
55<span class="kn">import</span> <span class="nn">shutil</span>
56<span class="kn">from</span> <span class="nn">sas.guiframe.CategoryInstaller</span> <span class="kn">import</span> <span class="n">CategoryInstaller</span>
57
58<span class="n">CONF_DIR</span> <span class="o">=</span> <span class="s">&#39;config&#39;</span> 
59<span class="n">APPLICATION_NAME</span> <span class="o">=</span> <span class="s">&#39;sasview&#39;</span>
60
61<span class="k">def</span> <span class="nf">_find_usersasview_dir</span><span class="p">():</span>
62    <span class="sd">&quot;&quot;&quot;</span>
63<span class="sd">    Find and return user/.sasview dir</span>
64<span class="sd">    &quot;&quot;&quot;</span>
65    <span class="nb">dir</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">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s">&quot;~&quot;</span><span class="p">),</span> 
66                       <span class="p">(</span><span class="s">&quot;.&quot;</span> <span class="o">+</span> <span class="n">APPLICATION_NAME</span><span class="p">))</span>
67    <span class="k">return</span> <span class="nb">dir</span>
68
69<span class="k">def</span> <span class="nf">_find_customconf_dir</span><span class="p">():</span>
70    <span class="sd">&quot;&quot;&quot;</span>
71<span class="sd">    Find path of the config directory.</span>
72<span class="sd">    The plugin directory is located in the user&#39;s home directory.</span>
73<span class="sd">    &quot;&quot;&quot;</span>
74    <span class="n">u_dir</span> <span class="o">=</span> <span class="n">_find_usersasview_dir</span><span class="p">()</span>
75    <span class="nb">dir</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">join</span><span class="p">(</span><span class="n">u_dir</span><span class="p">,</span> <span class="n">CONF_DIR</span><span class="p">)</span>
76   
77    <span class="k">return</span> <span class="nb">dir</span>
78
79<span class="k">def</span> <span class="nf">_setup_conf_dir</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
80    <span class="sd">&quot;&quot;&quot;</span>
81<span class="sd">    Setup the custom config dir and cat file</span>
82<span class="sd">    &quot;&quot;&quot;</span>
83    <span class="nb">dir</span> <span class="o">=</span> <span class="n">_find_customconf_dir</span><span class="p">()</span>
84    <span class="c"># If the plugin directory doesn&#39;t exist, create it</span>
85    <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">isdir</span><span class="p">(</span><span class="nb">dir</span><span class="p">):</span>
86        <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="nb">dir</span><span class="p">)</span>
87    <span class="nb">file</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">join</span><span class="p">(</span><span class="nb">dir</span><span class="p">,</span> <span class="s">&quot;custom_config.py&quot;</span><span class="p">)</span>
88    <span class="n">cat_file</span> <span class="o">=</span> <span class="n">CategoryInstaller</span><span class="o">.</span><span class="n">get_user_file</span><span class="p">()</span>
89    <span class="c"># If the user category file doesn&#39;t exist copy the default to</span>
90    <span class="c"># the user directory</span>
91    <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">isfile</span><span class="p">(</span><span class="n">cat_file</span><span class="p">):</span>
92        <span class="k">try</span><span class="p">:</span>
93            <span class="n">default_cat_file</span> <span class="o">=</span> <span class="n">CategoryInstaller</span><span class="o">.</span><span class="n">get_default_file</span><span class="p">()</span>
94            <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">default_cat_file</span><span class="p">):</span>
95                <span class="n">shutil</span><span class="o">.</span><span class="n">copyfile</span><span class="p">(</span><span class="n">default_cat_file</span><span class="p">,</span> <span class="n">cat_file</span><span class="p">)</span>
96            <span class="k">else</span><span class="p">:</span>
97                <span class="k">print</span> <span class="s">&quot;Unable to find/copy default cat file&quot;</span>
98        <span class="k">except</span><span class="p">:</span>
99            <span class="k">print</span> <span class="s">&quot;Unable to copy default cat file to the user dir.&quot;</span>
100
101    <span class="c"># Place example user models as needed</span>
102    <span class="k">try</span><span class="p">:</span>
103        <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">isfile</span><span class="p">(</span><span class="nb">file</span><span class="p">):</span>
104         <span class="n">shutil</span><span class="o">.</span><span class="n">copyfile</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s">&quot;custom_config.py&quot;</span><span class="p">),</span> <span class="nb">file</span><span class="p">)</span>
105    <span class="k">except</span><span class="p">:</span>
106        <span class="c"># Check for data path next to exe/zip file.</span>
107        <span class="c">#Look for maximum n_dir up of the current dir to find plugins dir</span>
108        <span class="n">n_dir</span> <span class="o">=</span> <span class="mi">12</span>
109        <span class="n">is_dir</span> <span class="o">=</span> <span class="bp">False</span>
110        <span class="n">f_dir</span> <span class="o">=</span> <span class="n">path</span>
111        <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n_dir</span><span class="p">):</span>
112            <span class="k">if</span> <span class="n">i</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
113                <span class="n">f_dir</span><span class="p">,</span> <span class="n">_</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">split</span><span class="p">(</span><span class="n">f_dir</span><span class="p">)</span>
114            <span class="n">temp_path</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">join</span><span class="p">(</span><span class="n">f_dir</span><span class="p">,</span> <span class="s">&quot;custom_config.py&quot;</span><span class="p">)</span>
115            <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">temp_path</span><span class="p">):</span>
116                <span class="n">shutil</span><span class="o">.</span><span class="n">copyfile</span><span class="p">(</span><span class="n">temp_path</span><span class="p">,</span> <span class="nb">file</span><span class="p">)</span>
117                <span class="n">is_dir</span> <span class="o">=</span> <span class="bp">True</span>
118                <span class="k">break</span>
119        <span class="k">if</span> <span class="ow">not</span> <span class="n">is_dir</span><span class="p">:</span>
120            <span class="k">raise</span>
121       
122    <span class="k">return</span> <span class="nb">dir</span>
123 
124       
125<div class="viewcode-block" id="SetupCustom"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.customdir.SetupCustom">[docs]</a><span class="k">class</span> <span class="nc">SetupCustom</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
126    <span class="sd">&quot;&quot;&quot;</span>
127<span class="sd">    implement custom config dir</span>
128<span class="sd">    &quot;&quot;&quot;</span>
129<div class="viewcode-block" id="SetupCustom.find_dir"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.customdir.SetupCustom.find_dir">[docs]</a>    <span class="k">def</span> <span class="nf">find_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
130        <span class="k">return</span> <span class="n">_find_customconf_dir</span><span class="p">()</span>
131    </div>
132<div class="viewcode-block" id="SetupCustom.setup_dir"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.customdir.SetupCustom.setup_dir">[docs]</a>    <span class="k">def</span> <span class="nf">setup_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
133        <span class="k">return</span> <span class="n">_setup_conf_dir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
134   
135
136   
137   
138  </div></div>
139</pre></div>
140
141          </div>
142        </div>
143      </div>
144      <div class="sphinxsidebar">
145        <div class="sphinxsidebarwrapper">
146<div id="searchbox" style="display: none">
147  <h3>Quick search</h3>
148    <form class="search" action="../../../search.html" method="get">
149      <input type="text" name="q" />
150      <input type="submit" value="Go" />
151      <input type="hidden" name="check_keywords" value="yes" />
152      <input type="hidden" name="area" value="default" />
153    </form>
154    <p class="searchtip" style="font-size: 90%">
155    Enter search terms or a module, class or function name.
156    </p>
157</div>
158<script type="text/javascript">$('#searchbox').show(0);</script>
159        </div>
160      </div>
161      <div class="clearer"></div>
162    </div>
163    <div class="related">
164      <h3>Navigation</h3>
165      <ul>
166        <li class="right" style="margin-right: 10px">
167          <a href="../../../genindex.html" title="General Index"
168             >index</a></li>
169        <li class="right" >
170          <a href="../../../py-modindex.html" title="Python Module Index"
171             >modules</a> |</li>
172        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
173          <li><a href="../../index.html" >Module code</a> &raquo;</li>
174          <li><a href="../guiframe.html" >sas.guiframe</a> &raquo;</li> 
175      </ul>
176    </div>
177    <div class="footer">
178        &copy; Copyright 2013, The SasView Project.
179      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
180    </div>
181  </body>
182</html>
Note: See TracBrowser for help on using the repository browser.