vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4
seitime-frappe/docs/_build/html/_modules/webnotes/modules.html
Rushabh Mehta b624972f0d added new docs
2011-06-29 14:41:49 +05:30

183 lines
No EOL
18 KiB
HTML
Raw Blame History

<!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>webnotes.modules &mdash; WNFramework v1.8 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.8',
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="WNFramework v1.8 documentation" href="../../index.html" />
<link rel="up" title="webnotes" href="../webnotes.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><a href="../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../index.html" >Module code</a> &raquo;</li>
<li><a href="../webnotes.html" accesskey="U">webnotes</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for webnotes.modules</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Utilities for using modules</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="n">transfer_types</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;Role&#39;</span><span class="p">,</span> <span class="s">&#39;Print Format&#39;</span><span class="p">,</span><span class="s">&#39;DocType&#39;</span><span class="p">,</span><span class="s">&#39;Page&#39;</span><span class="p">,</span><span class="s">&#39;DocType Mapper&#39;</span><span class="p">,</span><span class="s">&#39;GL Mapper&#39;</span><span class="p">,</span><span class="s">&#39;Search Criteria&#39;</span><span class="p">,</span> <span class="s">&#39;Patch&#39;</span><span class="p">]</span>
<div class="viewcode-block" id="scrub"><a class="viewcode-back" href="../../webnotes.modules.html#webnotes.modules.scrub">[docs]</a><span class="k">def</span> <span class="nf">scrub</span><span class="p">(</span><span class="n">txt</span><span class="p">):</span>
<span class="k">return</span> <span class="n">txt</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39; &#39;</span><span class="p">,</span><span class="s">&#39;_&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;-&#39;</span><span class="p">,</span> <span class="s">&#39;_&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;/&#39;</span><span class="p">,</span> <span class="s">&#39;_&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="scrub_dt_and_dn"><a class="viewcode-back" href="../../webnotes.modules.html#webnotes.modules.scrub_dt_and_dn">[docs]</a><span class="k">def</span> <span class="nf">scrub_dt_and_dn</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns in lowercase and code friendly names of doctype and name for certain types</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ndt</span><span class="p">,</span> <span class="n">ndn</span> <span class="o">=</span> <span class="n">dt</span><span class="p">,</span> <span class="n">dn</span>
<span class="k">if</span> <span class="n">dt</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&#39;doctype&#39;</span><span class="p">,</span> <span class="s">&#39;search criteria&#39;</span><span class="p">,</span> <span class="s">&#39;page&#39;</span><span class="p">):</span>
<span class="n">ndt</span><span class="p">,</span> <span class="n">ndn</span> <span class="o">=</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dt</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dn</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ndt</span><span class="p">,</span> <span class="n">ndn</span>
</div>
<div class="viewcode-block" id="get_item_file"><a class="viewcode-back" href="../../webnotes.modules.html#webnotes.modules.get_item_file">[docs]</a><span class="k">def</span> <span class="nf">get_item_file</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the path of the item file</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">ndt</span><span class="p">,</span> <span class="n">ndn</span> <span class="o">=</span> <span class="n">scrub_dt_and_dn</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">)</span>
<span class="k">return</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">get_module_path</span><span class="p">(</span><span class="n">module</span><span class="p">),</span> <span class="n">ndt</span><span class="p">,</span> <span class="n">ndn</span><span class="p">,</span> <span class="n">ndn</span> <span class="o">+</span> <span class="s">&#39;.txt&#39;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="get_item_timestamp"><a class="viewcode-back" href="../../webnotes.modules.html#webnotes.modules.get_item_timestamp">[docs]</a><span class="k">def</span> <span class="nf">get_item_timestamp</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return ths timestamp of the given item (if exists)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">get_file_timestamp</span><span class="p">(</span><span class="n">get_item_file</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="get_file_timestamp"><a class="viewcode-back" href="../../webnotes.modules.html#webnotes.modules.get_file_timestamp">[docs]</a><span class="k">def</span> <span class="nf">get_file_timestamp</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns timestamp of the given file</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">webnotes.utils</span> <span class="kn">import</span> <span class="n">cint</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">cint</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span><span class="o">.</span><span class="n">st_mtime</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">!=</span><span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="get_module_path"><a class="viewcode-back" href="../../webnotes.modules.html#webnotes.modules.get_module_path">[docs]</a><span class="k">def</span> <span class="nf">get_module_path</span><span class="p">(</span><span class="n">module</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns path of the given module (imports it and reads it from __file__)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">webnotes.defs</span><span class="o">,</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">os.path</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">exec</span> <span class="p">(</span><span class="s">&#39;import &#39;</span> <span class="o">+</span> <span class="n">scrub</span><span class="p">(</span><span class="n">module</span><span class="p">))</span> <span class="ow">in</span> <span class="nb">locals</span><span class="p">()</span>
<span class="n">modules_path</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">scrub</span><span class="p">(</span><span class="n">module</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;.__file__&#39;</span><span class="p">)</span>
<span class="n">modules_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">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">modules_path</span><span class="o">.</span><span class="n">split</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">sep</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="c"># get module path by importing the module</span>
<span class="n">modules_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">webnotes</span><span class="o">.</span><span class="n">defs</span><span class="o">.</span><span class="n">modules_path</span><span class="p">,</span> <span class="n">scrub</span><span class="p">(</span><span class="n">module</span><span class="p">))</span>
<span class="k">return</span> <span class="n">modules_path</span>
</div>
<div class="viewcode-block" id="switch_module"><a class="viewcode-back" href="../../webnotes.modules.html#webnotes.modules.switch_module">[docs]</a><span class="k">def</span> <span class="nf">switch_module</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">,</span> <span class="n">to</span><span class="p">,</span> <span class="n">frm</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">export</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Change the module of the given doctype, if export is true, then also export txt and copy</span>
<span class="sd"> code files from src</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `tab&quot;</span><span class="o">+</span><span class="n">dt</span><span class="o">+</span><span class="s">&quot;` set module=</span><span class="si">%s</span><span class="s"> where name=</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">to</span><span class="p">,</span> <span class="n">dn</span><span class="p">))</span>
<span class="k">if</span> <span class="n">export</span><span class="p">:</span>
<span class="n">export_doc</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">dn</span><span class="p">)</span>
<span class="c"># copy code files</span>
<span class="k">if</span> <span class="n">dt</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&#39;DocType&#39;</span><span class="p">,</span> <span class="s">&#39;Page&#39;</span><span class="p">,</span> <span class="s">&#39;Search Criteria&#39;</span><span class="p">):</span>
<span class="n">from_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">get_module_path</span><span class="p">(</span><span class="n">frm</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dt</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dn</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dn</span><span class="p">))</span>
<span class="n">to_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">get_module_path</span><span class="p">(</span><span class="n">to</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dt</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dn</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dn</span><span class="p">))</span>
<span class="c"># make dire if exists</span>
<span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="s">&#39;mkdir -p </span><span class="si">%s</span><span class="s">&#39;</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">get_module_path</span><span class="p">(</span><span class="n">to</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dt</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">dn</span><span class="p">)))</span>
<span class="k">for</span> <span class="n">ext</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&#39;py&#39;</span><span class="p">,</span><span class="s">&#39;js&#39;</span><span class="p">,</span><span class="s">&#39;html&#39;</span><span class="p">,</span><span class="s">&#39;css&#39;</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="s">&#39;cp </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">&#39;</span><span class="p">)</span>
</pre></div></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/wnflogo200.gif" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" size="18" />
<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><a href="../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../index.html" >Module code</a> &raquo;</li>
<li><a href="../webnotes.html" >webnotes</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink