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/utils.html
Rushabh Mehta b624972f0d added new docs
2011-06-29 14:41:49 +05:30

646 lines
No EOL
92 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.utils &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.utils</h1><div class="highlight"><pre>
<span class="c"># util __init__.py</span>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="n">user_time_zone</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">month_name</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span><span class="s">&#39;Jan&#39;</span><span class="p">,</span><span class="s">&#39;Feb&#39;</span><span class="p">,</span><span class="s">&#39;Mar&#39;</span><span class="p">,</span><span class="s">&#39;Apr&#39;</span><span class="p">,</span><span class="s">&#39;May&#39;</span><span class="p">,</span><span class="s">&#39;Jun&#39;</span><span class="p">,</span><span class="s">&#39;Jul&#39;</span><span class="p">,</span><span class="s">&#39;Aug&#39;</span><span class="p">,</span><span class="s">&#39;Sep&#39;</span><span class="p">,</span><span class="s">&#39;Oct&#39;</span><span class="p">,</span><span class="s">&#39;Nov&#39;</span><span class="p">,</span><span class="s">&#39;Dec&#39;</span><span class="p">]</span>
<span class="n">month_name_full</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span><span class="s">&#39;January&#39;</span><span class="p">,</span><span class="s">&#39;February&#39;</span><span class="p">,</span><span class="s">&#39;March&#39;</span><span class="p">,</span><span class="s">&#39;April&#39;</span><span class="p">,</span><span class="s">&#39;May&#39;</span><span class="p">,</span><span class="s">&#39;June&#39;</span><span class="p">,</span><span class="s">&#39;July&#39;</span><span class="p">,</span><span class="s">&#39;August&#39;</span><span class="p">,</span><span class="s">&#39;September&#39;</span><span class="p">,</span><span class="s">&#39;October&#39;</span><span class="p">,</span><span class="s">&#39;November&#39;</span><span class="p">,</span><span class="s">&#39;December&#39;</span><span class="p">]</span>
<span class="n">no_value_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;Section Break&#39;</span><span class="p">,</span> <span class="s">&#39;Column Break&#39;</span><span class="p">,</span> <span class="s">&#39;HTML&#39;</span><span class="p">,</span> <span class="s">&#39;Table&#39;</span><span class="p">,</span> <span class="s">&#39;FlexTable&#39;</span><span class="p">,</span> <span class="s">&#39;Button&#39;</span><span class="p">,</span> <span class="s">&#39;Image&#39;</span><span class="p">,</span> <span class="s">&#39;Graph&#39;</span><span class="p">]</span>
<span class="n">default_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;doctype&#39;</span><span class="p">,</span><span class="s">&#39;name&#39;</span><span class="p">,</span><span class="s">&#39;owner&#39;</span><span class="p">,</span><span class="s">&#39;creation&#39;</span><span class="p">,</span><span class="s">&#39;modified&#39;</span><span class="p">,</span><span class="s">&#39;modified_by&#39;</span><span class="p">,</span><span class="s">&#39;parent&#39;</span><span class="p">,</span><span class="s">&#39;parentfield&#39;</span><span class="p">,</span><span class="s">&#39;parenttype&#39;</span><span class="p">,</span><span class="s">&#39;idx&#39;</span><span class="p">,</span><span class="s">&#39;docstatus&#39;</span><span class="p">]</span>
<div class="viewcode-block" id="getCSVelement"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.getCSVelement">[docs]</a><span class="k">def</span> <span class="nf">getCSVelement</span><span class="p">(</span><span class="n">v</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the CSV value of `v`, For example: </span>
<span class="sd"> </span>
<span class="sd"> * apple becomes &quot;apple&quot;</span>
<span class="sd"> * hi&quot;there becomes &quot;hi&quot;&quot;there&quot;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">cstr</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">v</span><span class="p">:</span> <span class="k">return</span> <span class="s">&#39;&#39;</span>
<span class="k">if</span> <span class="p">(</span><span class="s">&#39;,&#39;</span> <span class="ow">in</span> <span class="n">v</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</span> <span class="ow">in</span> <span class="n">v</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="s">&#39;&quot;&#39;</span> <span class="ow">in</span> <span class="n">v</span><span class="p">):</span>
<span class="k">if</span> <span class="s">&#39;&quot;&#39;</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span> <span class="n">v</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;&quot;&#39;</span><span class="p">,</span> <span class="s">&#39;&quot;&quot;&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="s">&#39;&quot;&#39;</span><span class="o">+</span><span class="n">v</span><span class="o">+</span><span class="s">&#39;&quot;&#39;</span>
<span class="k">else</span><span class="p">:</span> <span class="k">return</span> <span class="n">v</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
</div>
<div class="viewcode-block" id="validate_email_add"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.validate_email_add">[docs]</a><span class="k">def</span> <span class="nf">validate_email_add</span><span class="p">(</span><span class="n">email_str</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Validates the email string</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">email_str</span>
<span class="k">if</span> <span class="s">&#39;&lt;&#39;</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;&lt;&#39;</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;&gt;&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="c">#return re.match(&quot;^[a-zA-Z0-9._%-]+@[a-zA-Z0-9._%-]+.[a-zA-Z]{2,6}$&quot;, email_str)</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">&quot;[a-z0-9!#$%&amp;&#39;*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&amp;&#39;*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?&quot;</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="sendmail"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.sendmail">[docs]</a><span class="k">def</span> <span class="nf">sendmail</span><span class="p">(</span><span class="n">recipients</span><span class="p">,</span> <span class="n">sender</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="n">msg</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="n">subject</span><span class="o">=</span><span class="s">&#39;[No Subject]&#39;</span><span class="p">,</span> <span class="n">parts</span><span class="o">=</span><span class="p">[],</span> <span class="n">cc</span><span class="o">=</span><span class="p">[],</span> <span class="n">attach</span><span class="o">=</span><span class="p">[]):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Send an email. For more details see :func:`email_lib.sendmail`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">webnotes.utils.email_lib</span>
<span class="k">return</span> <span class="n">email_lib</span><span class="o">.</span><span class="n">sendmail</span><span class="p">(</span><span class="n">recipients</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">msg</span><span class="p">,</span> <span class="n">subject</span><span class="p">,</span> <span class="n">parts</span><span class="p">,</span> <span class="n">cc</span><span class="p">,</span> <span class="n">attach</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="generate_hash"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.generate_hash">[docs]</a><span class="k">def</span> <span class="nf">generate_hash</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Generates reandom hash for session id</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">sha</span><span class="o">,</span> <span class="nn">time</span>
<span class="k">return</span> <span class="n">sha</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()))</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="db_exists"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.db_exists">[docs]</a><span class="k">def</span> <span class="nf">db_exists</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">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">&#39;select name from `tab</span><span class="si">%s</span><span class="s">` where name=&quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</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="load_json"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.load_json">[docs]</a><span class="k">def</span> <span class="nf">load_json</span><span class="p">(</span><span class="n">arg</span><span class="p">):</span>
<span class="c"># already a dictionary?</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span><span class="o">!=</span><span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="n">arg</span>
<span class="k">try</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">json</span>
<span class="k">except</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">simplejson</span> <span class="kn">as</span> <span class="nn">json</span>
<span class="c">#return json.loads(unicode(arg, &#39;iso-8859-15&#39;))</span>
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
<span class="c"># Get Traceback</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="getTraceback"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.getTraceback">[docs]</a><span class="k">def</span> <span class="nf">getTraceback</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the traceback of the Exception</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">sys</span><span class="o">,</span> <span class="nn">traceback</span><span class="o">,</span> <span class="nn">string</span>
<span class="nb">type</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">tb</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
<span class="n">body</span> <span class="o">=</span> <span class="s">&quot;Traceback (innermost last):</span><span class="se">\n</span><span class="s">&quot;</span>
<span class="nb">list</span> <span class="o">=</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_tb</span><span class="p">(</span><span class="n">tb</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> <span class="o">+</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exception_only</span><span class="p">(</span><span class="nb">type</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="n">body</span> <span class="o">=</span> <span class="n">body</span> <span class="o">+</span> <span class="s">&quot;</span><span class="si">%-20s</span><span class="s"> </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">string</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">list</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="s">&quot;&quot;</span><span class="p">),</span> <span class="nb">list</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="k">if</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">logger</span><span class="p">:</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">&#39;Db:&#39;</span><span class="o">+</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span> <span class="ow">and</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">cur_db_name</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; - &#39;</span> <span class="o">+</span> <span class="n">body</span><span class="p">)</span>
<span class="k">return</span> <span class="n">body</span>
<span class="c"># Log</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="log"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.log">[docs]</a><span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">details</span><span class="p">)</span>
<span class="c"># Date and Time</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="getdate"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.getdate">[docs]</a><span class="k">def</span> <span class="nf">getdate</span><span class="p">(</span><span class="n">string_date</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Coverts string date (yyyy-mm-dd) to datetime.date object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">string_date</span><span class="p">)</span><span class="o">==</span><span class="nb">unicode</span><span class="p">:</span>
<span class="n">string_date</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">string_date</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">string_date</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">):</span>
<span class="k">return</span> <span class="n">string_date</span>
<span class="k">if</span> <span class="s">&#39; &#39;</span> <span class="ow">in</span> <span class="n">string_date</span><span class="p">:</span>
<span class="n">string_date</span> <span class="o">=</span> <span class="n">string_date</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39; &#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">string_date</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;-&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span><span class="o">==</span><span class="mi">3</span><span class="p">:</span>
<span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">(</span><span class="n">cint</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span> <span class="n">cint</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> <span class="n">cint</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">2</span><span class="p">]))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s">&#39;&#39;</span>
</div>
<div class="viewcode-block" id="add_days"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.add_days">[docs]</a><span class="k">def</span> <span class="nf">add_days</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">days</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Adds `days` to the given `string_date`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">date</span><span class="p">:</span>
<span class="n">date</span> <span class="o">=</span> <span class="n">now_datetime</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">date</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">):</span>
<span class="n">date</span> <span class="o">=</span> <span class="n">getdate</span><span class="p">(</span><span class="n">date</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">date</span> <span class="o">+</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="p">))</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%Y-%m-</span><span class="si">%d</span><span class="s">&#39;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="add_months"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.add_months">[docs]</a><span class="k">def</span> <span class="nf">add_months</span><span class="p">(</span><span class="n">string_date</span><span class="p">,</span> <span class="n">months</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">return</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;select DATE_ADD(&#39;</span><span class="si">%s</span><span class="s">&#39;,INTERVAL &#39;</span><span class="si">%s</span><span class="s">&#39; MONTH)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">getdate</span><span class="p">(</span><span class="n">string_date</span><span class="p">),</span><span class="n">months</span><span class="p">))[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="add_years"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.add_years">[docs]</a><span class="k">def</span> <span class="nf">add_years</span><span class="p">(</span><span class="n">string_date</span><span class="p">,</span> <span class="n">years</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">return</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;select DATE_ADD(&#39;</span><span class="si">%s</span><span class="s">&#39;,INTERVAL &#39;</span><span class="si">%s</span><span class="s">&#39; YEAR)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">getdate</span><span class="p">(</span><span class="n">string_date</span><span class="p">),</span><span class="n">years</span><span class="p">))[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="date_diff"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.date_diff">[docs]</a><span class="k">def</span> <span class="nf">date_diff</span><span class="p">(</span><span class="n">string_ed_date</span><span class="p">,</span> <span class="n">string_st_date</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">return</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;SELECT DATEDIFF(&#39;</span><span class="si">%s</span><span class="s">&#39;,&#39;</span><span class="si">%s</span><span class="s">&#39;)&quot;</span> <span class="o">%</span><span class="p">(</span><span class="n">getdate</span><span class="p">(</span><span class="n">string_ed_date</span><span class="p">),</span> <span class="n">getdate</span><span class="p">(</span><span class="n">string_st_date</span><span class="p">)))[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="now_datetime"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.now_datetime">[docs]</a><span class="k">def</span> <span class="nf">now_datetime</span><span class="p">():</span>
<span class="k">global</span> <span class="n">user_time_zone</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
<span class="kn">from</span> <span class="nn">pytz</span> <span class="kn">import</span> <span class="n">timezone</span>
<span class="c"># get localtime</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">user_time_zone</span><span class="p">:</span>
<span class="n">user_time_zone</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="s">&#39;time_zone&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;Asia/Calcutta&#39;</span>
<span class="c"># convert to UTC</span>
<span class="n">utcnow</span> <span class="o">=</span> <span class="n">timezone</span><span class="p">(</span><span class="s">&#39;UTC&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">localize</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">())</span>
<span class="c"># convert to user time zone</span>
<span class="k">return</span> <span class="n">utcnow</span><span class="o">.</span><span class="n">astimezone</span><span class="p">(</span><span class="n">timezone</span><span class="p">(</span><span class="n">user_time_zone</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="now"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.now">[docs]</a><span class="k">def</span> <span class="nf">now</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns `time.strftime(&#39;%Y-%m-%d %H:%M:%S&#39;)`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">now_datetime</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%Y-%m-</span><span class="si">%d</span><span class="s"> %H:%M:%S&#39;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="nowdate"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.nowdate">[docs]</a><span class="k">def</span> <span class="nf">nowdate</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns time.strftime(&#39;%Y-%m-%d&#39;)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">now_datetime</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%Y-%m-</span><span class="si">%d</span><span class="s">&#39;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="get_first_day"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.get_first_day">[docs]</a><span class="k">def</span> <span class="nf">get_first_day</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">d_years</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">d_months</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the first day of the month for the date specified by date object</span>
<span class="sd"> Also adds `d_years` and `d_months` if specified</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="c"># d_years, d_months are &quot;deltas&quot; to apply to dt</span>
<span class="n">y</span><span class="p">,</span> <span class="n">m</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">year</span> <span class="o">+</span> <span class="n">d_years</span><span class="p">,</span> <span class="n">dt</span><span class="o">.</span><span class="n">month</span> <span class="o">+</span> <span class="n">d_months</span>
<span class="n">a</span><span class="p">,</span> <span class="n">m</span> <span class="o">=</span> <span class="nb">divmod</span><span class="p">(</span><span class="n">m</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">)</span>
<span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">(</span><span class="n">y</span><span class="o">+</span><span class="n">a</span><span class="p">,</span> <span class="n">m</span><span class="o">+</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="get_last_day"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.get_last_day">[docs]</a><span class="k">def</span> <span class="nf">get_last_day</span><span class="p">(</span><span class="n">dt</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns last day of the month using:</span>
<span class="sd"> `get_first_day(dt, 0, 1) + datetime.timedelta(-1)`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">return</span> <span class="n">get_first_day</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="o">+</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
</div>
<span class="n">user_format</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> User format specified in :term:`Control Panel`</span>
<span class="sd"> </span>
<span class="sd"> Examples:</span>
<span class="sd"> </span>
<span class="sd"> * dd-mm-yyyy</span>
<span class="sd"> * mm-dd-yyyy</span>
<span class="sd"> * dd/mm/yyyy</span>
<span class="sd">&quot;&quot;&quot;</span>
<div class="viewcode-block" id="formatdate"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.formatdate">[docs]</a><span class="k">def</span> <span class="nf">formatdate</span><span class="p">(</span><span class="n">string_date</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Convers the given string date to :data:`user_format`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">global</span> <span class="n">user_format</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">user_format</span><span class="p">:</span>
<span class="n">user_format</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="s">&#39;date_format&#39;</span><span class="p">)</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">string_date</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;-&#39;</span><span class="p">);</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">user_format</span>
<span class="k">return</span> <span class="n">out</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;dd&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s">&#39;</span><span class="si">%.2i</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">cint</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="mi">2</span><span class="p">])))</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;mm&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s">&#39;</span><span class="si">%.2i</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">cint</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="mi">1</span><span class="p">])))</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;yyyy&#39;</span><span class="p">,</span> <span class="n">d</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</div>
<div class="viewcode-block" id="dict_to_str"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.dict_to_str">[docs]</a><span class="k">def</span> <span class="nf">dict_to_str</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s">&#39;&amp;&#39;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Converts a dictionary to URL</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">urllib</span>
<span class="n">t</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">args</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="n">t</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">k</span><span class="p">)</span><span class="o">+</span><span class="s">&#39;=&#39;</span><span class="o">+</span><span class="n">urllib</span><span class="o">.</span><span class="n">quote</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="timestamps_equal"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.timestamps_equal">[docs]</a><span class="k">def</span> <span class="nf">timestamps_equal</span><span class="p">(</span><span class="n">t1</span><span class="p">,</span> <span class="n">t2</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Returns true if same the two string timestamps are same&quot;&quot;&quot;</span>
<span class="n">scrub</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</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">split</span><span class="p">()</span>
<span class="n">t1</span><span class="p">,</span> <span class="n">t2</span> <span class="o">=</span> <span class="n">scrub</span><span class="p">(</span><span class="n">t1</span><span class="p">),</span> <span class="n">scrub</span><span class="p">(</span><span class="n">t2</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t1</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">t2</span><span class="p">):</span>
<span class="k">return</span>
<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="nb">len</span><span class="p">(</span><span class="n">t1</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">t1</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">!=</span><span class="n">t2</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="k">return</span>
<span class="k">return</span> <span class="mi">1</span>
</div>
<div class="viewcode-block" id="global_date_format"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.global_date_format">[docs]</a><span class="k">def</span> <span class="nf">global_date_format</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">date</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">):</span>
<span class="n">date</span> <span class="o">=</span> <span class="n">getdate</span><span class="p">(</span><span class="n">date</span><span class="p">)</span>
<span class="k">return</span> <span class="n">date</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%d</span><span class="s">&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="n">month_name_full</span><span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">date</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%m&#39;</span><span class="p">))]</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="n">date</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&#39;%Y&#39;</span><span class="p">)</span>
<span class="c"># Datatype</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="isNull"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.isNull">[docs]</a><span class="k">def</span> <span class="nf">isNull</span><span class="p">(</span><span class="n">v</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns true if v=&#39;&#39; or v is `None`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="p">(</span><span class="n">v</span><span class="o">==</span><span class="s">&#39;&#39;</span> <span class="ow">or</span> <span class="n">v</span><span class="o">==</span><span class="bp">None</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="has_common"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.has_common">[docs]</a><span class="k">def</span> <span class="nf">has_common</span><span class="p">(</span><span class="n">l1</span><span class="p">,</span> <span class="n">l2</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns true if there are common elements in lists l1 and l2</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">l1</span><span class="p">:</span>
<span class="k">if</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">l2</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">1</span>
<span class="k">return</span> <span class="mi">0</span>
</div>
<div class="viewcode-block" id="flt"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.flt">[docs]</a><span class="k">def</span> <span class="nf">flt</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Convert to float (ignore commas)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">s</span><span class="p">)</span><span class="o">==</span><span class="nb">str</span><span class="p">:</span> <span class="c"># if string</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</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="k">try</span><span class="p">:</span> <span class="n">tmp</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="n">tmp</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">return</span> <span class="n">tmp</span>
</div>
<div class="viewcode-block" id="cint"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.cint">[docs]</a><span class="k">def</span> <span class="nf">cint</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Convert to integer</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span> <span class="n">tmp</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">s</span><span class="p">))</span>
<span class="k">except</span><span class="p">:</span> <span class="n">tmp</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">return</span> <span class="n">tmp</span>
</div>
<div class="viewcode-block" id="cstr"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.cstr">[docs]</a><span class="k">def</span> <span class="nf">cstr</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; </span>
<span class="sd"> Convert to string</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">s</span><span class="o">==</span><span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="s">&#39;&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="s">&#39;encode&#39;</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">&#39;utf-8&#39;</span><span class="p">,</span> <span class="s">&#39;ignore&#39;</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="str_esc_quote"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.str_esc_quote">[docs]</a><span class="k">def</span> <span class="nf">str_esc_quote</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Escape quotes</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">s</span><span class="o">==</span><span class="bp">None</span><span class="p">:</span><span class="k">return</span> <span class="s">&#39;&#39;</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&quot;&#39;&quot;</span><span class="p">,</span><span class="s">&quot;</span><span class="se">\&#39;</span><span class="s">&quot;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="replace_newlines"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.replace_newlines">[docs]</a><span class="k">def</span> <span class="nf">replace_newlines</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Replace newlines by &#39;&lt;br&gt;&#39;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">s</span><span class="o">==</span><span class="bp">None</span><span class="p">:</span><span class="k">return</span> <span class="s">&#39;&#39;</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span><span class="s">&quot;&lt;br&gt;&quot;</span><span class="p">)</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="parse_val"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.parse_val">[docs]</a><span class="k">def</span> <span class="nf">parse_val</span><span class="p">(</span><span class="n">v</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Converts to simple datatypes from SQL query results</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">try</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">decimal</span> <span class="c"># for decimal Python 2.5 (?)</span>
<span class="k">except</span><span class="p">:</span> <span class="k">pass</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">==</span><span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">==</span><span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="s">&#39;:&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;:&#39;</span><span class="p">)[:</span><span class="mi">2</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">==</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">==</span><span class="nb">long</span><span class="p">:</span> <span class="n">v</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">==</span><span class="n">decimal</span><span class="o">.</span><span class="n">Decimal</span><span class="p">:</span> <span class="n">v</span><span class="o">=</span><span class="nb">float</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="k">pass</span>
<span class="k">return</span> <span class="n">v</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="fmt_money"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.fmt_money">[docs]</a><span class="k">def</span> <span class="nf">fmt_money</span><span class="p">(</span><span class="n">amount</span><span class="p">,</span> <span class="n">fmt</span> <span class="o">=</span> <span class="s">&#39;</span><span class="si">%.2f</span><span class="s">&#39;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Convert to string with commas for thousands, millions etc</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">curr</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="s">&#39;currency_format&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;Millions&#39;</span>
<span class="n">val</span> <span class="o">=</span> <span class="mi">2</span>
<span class="k">if</span> <span class="n">curr</span> <span class="o">==</span> <span class="s">&#39;Millions&#39;</span><span class="p">:</span> <span class="n">val</span> <span class="o">=</span> <span class="mi">3</span>
<span class="k">if</span> <span class="n">cstr</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> <span class="n">temp</span> <span class="o">=</span> <span class="s">&#39;00&#39;</span>
<span class="k">else</span><span class="p">:</span> <span class="n">temp</span> <span class="o">=</span> <span class="n">cstr</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">l</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">minus</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
<span class="k">if</span> <span class="n">flt</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span> <span class="n">minus</span> <span class="o">=</span> <span class="s">&#39;-&#39;</span>
<span class="n">amount</span> <span class="o">=</span> <span class="s">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cstr</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;,&#39;</span><span class="p">))</span>
<span class="n">amount</span> <span class="o">=</span> <span class="n">cstr</span><span class="p">(</span><span class="nb">abs</span><span class="p">(</span><span class="n">flt</span><span class="p">(</span><span class="n">amount</span><span class="p">)))</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="c"># main logic </span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cstr</span><span class="p">(</span><span class="n">amount</span><span class="p">))</span> <span class="o">&gt;</span> <span class="mi">3</span><span class="p">:</span>
<span class="n">nn</span> <span class="o">=</span> <span class="n">amount</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span><span class="o">-</span><span class="mi">3</span><span class="p">:]</span>
<span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nn</span><span class="p">)</span>
<span class="n">amount</span> <span class="o">=</span> <span class="n">amount</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="nb">len</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span>
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">cstr</span><span class="p">(</span><span class="n">amount</span><span class="p">))</span> <span class="o">&gt;</span> <span class="n">val</span><span class="p">:</span>
<span class="n">nn</span> <span class="o">=</span> <span class="n">amount</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span><span class="o">-</span><span class="n">val</span><span class="p">:]</span>
<span class="n">l</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="n">nn</span><span class="p">)</span>
<span class="n">amount</span> <span class="o">=</span> <span class="n">amount</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="nb">len</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span><span class="o">-</span><span class="n">val</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span> <span class="n">l</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="n">amount</span><span class="p">)</span>
<span class="n">amount</span> <span class="o">=</span> <span class="s">&#39;,&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">l</span><span class="p">)</span><span class="o">+</span><span class="s">&#39;.&#39;</span><span class="o">+</span><span class="n">temp</span>
<span class="n">amount</span> <span class="o">=</span> <span class="n">minus</span> <span class="o">+</span> <span class="n">amount</span>
<span class="k">return</span> <span class="n">amount</span>
<span class="c">#</span>
<span class="c"># convet currency to words</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="money_in_words"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.money_in_words">[docs]</a><span class="k">def</span> <span class="nf">money_in_words</span><span class="p">(</span><span class="n">number</span><span class="p">,</span> <span class="n">main_currency</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">fraction_currency</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns string in words with currency and fraction currency. </span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">get_defaults</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">main_currency</span><span class="p">:</span>
<span class="n">main_currency</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;currency&#39;</span><span class="p">,</span> <span class="s">&#39;INR&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">fraction_currency</span><span class="p">:</span>
<span class="n">fraction_currency</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;fraction_currency&#39;</span><span class="p">,</span> <span class="s">&#39;paise&#39;</span><span class="p">)</span>
<span class="n">n</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">flt</span><span class="p">(</span><span class="n">number</span><span class="p">))</span>
<span class="n">main</span><span class="p">,</span> <span class="n">fraction</span> <span class="o">=</span> <span class="n">n</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">fraction</span><span class="p">)</span><span class="o">==</span><span class="mi">1</span><span class="p">:</span> <span class="n">fraction</span> <span class="o">+=</span> <span class="s">&#39;0&#39;</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">main_currency</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="n">in_words</span><span class="p">(</span><span class="n">main</span><span class="p">)</span><span class="o">.</span><span class="n">title</span><span class="p">()</span>
<span class="k">if</span> <span class="n">cint</span><span class="p">(</span><span class="n">fraction</span><span class="p">):</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">out</span> <span class="o">+</span> <span class="s">&#39; and &#39;</span> <span class="o">+</span> <span class="n">in_words</span><span class="p">(</span><span class="n">fraction</span><span class="p">)</span><span class="o">.</span><span class="n">title</span><span class="p">()</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="n">fraction_currency</span>
<span class="k">return</span> <span class="n">out</span> <span class="o">+</span> <span class="s">&#39; only.&#39;</span>
<span class="c">#</span>
<span class="c"># convert number to words</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="in_words"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.in_words">[docs]</a><span class="k">def</span> <span class="nf">in_words</span><span class="p">(</span><span class="n">integer</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns string in words for the given integer.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">in_million</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span><span class="bp">None</span><span class="p">,</span><span class="s">&#39;currency_format&#39;</span><span class="p">)</span><span class="o">==</span><span class="s">&#39;Millions&#39;</span> <span class="ow">and</span> <span class="mi">1</span> <span class="ow">or</span> <span class="mi">0</span>
<span class="n">n</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">integer</span><span class="p">)</span>
<span class="n">known</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s">&#39;zero&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s">&#39;one&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s">&#39;two&#39;</span><span class="p">,</span> <span class="mi">3</span><span class="p">:</span> <span class="s">&#39;three&#39;</span><span class="p">,</span> <span class="mi">4</span><span class="p">:</span> <span class="s">&#39;four&#39;</span><span class="p">,</span> <span class="mi">5</span><span class="p">:</span> <span class="s">&#39;five&#39;</span><span class="p">,</span> <span class="mi">6</span><span class="p">:</span> <span class="s">&#39;six&#39;</span><span class="p">,</span> <span class="mi">7</span><span class="p">:</span> <span class="s">&#39;seven&#39;</span><span class="p">,</span> <span class="mi">8</span><span class="p">:</span> <span class="s">&#39;eight&#39;</span><span class="p">,</span> <span class="mi">9</span><span class="p">:</span> <span class="s">&#39;nine&#39;</span><span class="p">,</span> <span class="mi">10</span><span class="p">:</span> <span class="s">&#39;ten&#39;</span><span class="p">,</span>
<span class="mi">11</span><span class="p">:</span> <span class="s">&#39;eleven&#39;</span><span class="p">,</span> <span class="mi">12</span><span class="p">:</span> <span class="s">&#39;twelve&#39;</span><span class="p">,</span> <span class="mi">13</span><span class="p">:</span> <span class="s">&#39;thirteen&#39;</span><span class="p">,</span> <span class="mi">14</span><span class="p">:</span> <span class="s">&#39;fourteen&#39;</span><span class="p">,</span> <span class="mi">15</span><span class="p">:</span> <span class="s">&#39;fifteen&#39;</span><span class="p">,</span> <span class="mi">16</span><span class="p">:</span> <span class="s">&#39;sixteen&#39;</span><span class="p">,</span> <span class="mi">17</span><span class="p">:</span> <span class="s">&#39;seventeen&#39;</span><span class="p">,</span> <span class="mi">18</span><span class="p">:</span> <span class="s">&#39;eighteen&#39;</span><span class="p">,</span>
<span class="mi">19</span><span class="p">:</span> <span class="s">&#39;nineteen&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">:</span> <span class="s">&#39;twenty&#39;</span><span class="p">,</span> <span class="mi">30</span><span class="p">:</span> <span class="s">&#39;thirty&#39;</span><span class="p">,</span> <span class="mi">40</span><span class="p">:</span> <span class="s">&#39;forty&#39;</span><span class="p">,</span> <span class="mi">50</span><span class="p">:</span> <span class="s">&#39;fifty&#39;</span><span class="p">,</span> <span class="mi">60</span><span class="p">:</span> <span class="s">&#39;sixty&#39;</span><span class="p">,</span> <span class="mi">70</span><span class="p">:</span> <span class="s">&#39;seventy&#39;</span><span class="p">,</span> <span class="mi">80</span><span class="p">:</span> <span class="s">&#39;eighty&#39;</span><span class="p">,</span> <span class="mi">90</span><span class="p">:</span> <span class="s">&#39;ninety&#39;</span><span class="p">}</span>
<span class="k">def</span> <span class="nf">psn</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">sys</span><span class="p">;</span>
<span class="k">if</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">known</span><span class="p">:</span> <span class="k">return</span> <span class="n">known</span><span class="p">[</span><span class="n">n</span><span class="p">]</span>
<span class="n">bestguess</span><span class="p">,</span> <span class="n">remainder</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">),</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">n</span><span class="o">&lt;=</span><span class="mi">20</span><span class="p">:</span>
<span class="k">print</span> <span class="o">&gt;&gt;</span><span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="n">n</span><span class="p">,</span> <span class="s">&quot;How did this happen?&quot;</span>
<span class="k">assert</span> <span class="mi">0</span>
<span class="k">elif</span> <span class="n">n</span> <span class="o">&lt;</span> <span class="mi">100</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">((</span><span class="n">n</span><span class="o">//</span><span class="mi">10</span><span class="p">)</span><span class="o">*</span><span class="mi">10</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;-&#39;</span> <span class="o">+</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">%</span><span class="mi">10</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span>
<span class="k">return</span> <span class="n">bestguess</span>
<span class="k">elif</span> <span class="n">n</span> <span class="o">&lt;</span> <span class="mi">1000</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">//</span><span class="mi">100</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="s">&#39;hundred&#39;</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">n</span><span class="o">%</span><span class="mi">100</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">in_million</span><span class="p">:</span>
<span class="k">if</span> <span class="n">n</span> <span class="o">&lt;</span> <span class="mi">1000000</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">//</span><span class="mi">1000</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="s">&#39;thousand&#39;</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">n</span><span class="o">%</span><span class="mi">1000</span>
<span class="k">elif</span> <span class="n">n</span> <span class="o">&lt;</span> <span class="mi">1000000000</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">//</span><span class="mi">1000000</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="s">&#39;million&#39;</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">n</span><span class="o">%</span><span class="mi">1000000</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">//</span><span class="mi">1000000000</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="s">&#39;billion&#39;</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">n</span><span class="o">%</span><span class="mi">1000000000</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">n</span> <span class="o">&lt;</span> <span class="mi">100000</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">//</span><span class="mi">1000</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="s">&#39;thousand&#39;</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">n</span><span class="o">%</span><span class="mi">1000</span>
<span class="k">elif</span> <span class="n">n</span> <span class="o">&lt;</span> <span class="mi">10000000</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">//</span><span class="mi">100000</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="s">&#39;lakh&#39;</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">n</span><span class="o">%</span><span class="mi">100000</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">bestguess</span><span class="o">=</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">n</span><span class="o">//</span><span class="mi">10000000</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="s">&#39;crore&#39;</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">n</span><span class="o">%</span><span class="mi">10000000</span>
<span class="k">if</span> <span class="n">remainder</span><span class="p">:</span>
<span class="k">if</span> <span class="n">remainder</span> <span class="o">&gt;=</span> <span class="mi">100</span><span class="p">:</span>
<span class="n">comma</span> <span class="o">=</span> <span class="s">&#39;,&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">comma</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
<span class="k">return</span> <span class="n">bestguess</span> <span class="o">+</span> <span class="n">comma</span> <span class="o">+</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="n">xpsn</span><span class="p">(</span><span class="n">remainder</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">xpsn</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">bestguess</span>
<span class="k">return</span> <span class="n">psn</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">known</span><span class="p">,</span> <span class="n">psn</span><span class="p">)</span>
<span class="c"># Get Defaults</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="get_defaults"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.get_defaults">[docs]</a><span class="k">def</span> <span class="nf">get_defaults</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get dictionary of default values from the :term:`Control Panel`, or a value if key is passed</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">key</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</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">&#39;select defvalue from `tabDefaultValue` where parent = &quot;Control Panel&quot; where defkey=</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
<span class="k">return</span> <span class="n">res</span> <span class="ow">and</span> <span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="ow">or</span> <span class="bp">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</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">&#39;select defkey, defvalue from `tabDefaultValue` where parent = &quot;Control Panel&quot;&#39;</span><span class="p">)</span>
<span class="n">d</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">rec</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
<span class="n">d</span><span class="p">[</span><span class="n">rec</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="n">rec</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
<span class="k">return</span> <span class="n">d</span>
</div>
<div class="viewcode-block" id="set_default"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.set_default">[docs]</a><span class="k">def</span> <span class="nf">set_default</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">val</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Set / add a default value to :term:`Control Panel`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">res</span> <span class="o">=</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">&#39;select defkey from `tabDefaultValue` where defkey=&quot;</span><span class="si">%s</span><span class="s">&quot; and parent = &quot;Control Panel&quot;&#39;</span> <span class="o">%</span> <span class="n">key</span><span class="p">)</span>
<span class="k">if</span> <span class="n">res</span><span class="p">:</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">&#39;update `tabDefaultValue` set defvalue=&quot;</span><span class="si">%s</span><span class="s">&quot; where parent = &quot;Control Panel&quot; and defkey=&quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">key</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">webnotes.model.doc</span> <span class="kn">import</span> <span class="n">Document</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">Document</span><span class="p">(</span><span class="s">&#39;DefaultValue&#39;</span><span class="p">)</span>
<span class="n">d</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="s">&#39;Control Panel&#39;</span>
<span class="n">d</span><span class="o">.</span><span class="n">parenttype</span> <span class="o">=</span> <span class="s">&#39;Control Panel&#39;</span>
<span class="n">d</span><span class="o">.</span><span class="n">parentfield</span> <span class="o">=</span> <span class="s">&#39;system_defaults&#39;</span>
<span class="n">d</span><span class="o">.</span><span class="n">defkey</span> <span class="o">=</span> <span class="n">key</span>
<span class="n">d</span><span class="o">.</span><span class="n">defvalue</span> <span class="o">=</span> <span class="n">val</span>
<span class="n">d</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="c">#</span>
<span class="c"># Clear recycle bin</span>
<span class="c">#</span></div>
<div class="viewcode-block" id="clear_recycle_bin"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.clear_recycle_bin">[docs]</a><span class="k">def</span> <span class="nf">clear_recycle_bin</span><span class="p">():</span>
<span class="n">sql</span> <span class="o">=</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="n">tl</span> <span class="o">=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&#39;show tables&#39;</span><span class="p">)</span>
<span class="n">total_deleted</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">tl</span><span class="p">:</span>
<span class="n">fl</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">sql</span><span class="p">(</span><span class="s">&#39;desc `</span><span class="si">%s</span><span class="s">`&#39;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])]</span>
<span class="k">if</span> <span class="s">&#39;name&#39;</span> <span class="ow">in</span> <span class="n">fl</span><span class="p">:</span>
<span class="n">total_deleted</span> <span class="o">+=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;select count(*) from `</span><span class="si">%s</span><span class="s">` where name like &#39;__overwritten:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;delete from `</span><span class="si">%s</span><span class="s">` where name like &#39;__overwritten:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="s">&#39;parent&#39;</span> <span class="ow">in</span> <span class="n">fl</span><span class="p">:</span>
<span class="n">total_deleted</span> <span class="o">+=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;select count(*) from `</span><span class="si">%s</span><span class="s">` where parent like &#39;__oldparent:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;delete from `</span><span class="si">%s</span><span class="s">` where parent like &#39;__oldparent:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">total_deleted</span> <span class="o">+=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;select count(*) from `</span><span class="si">%s</span><span class="s">` where parent like &#39;oldparent:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;delete from `</span><span class="si">%s</span><span class="s">` where parent like &#39;oldparent:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">total_deleted</span> <span class="o">+=</span> <span class="n">sql</span><span class="p">(</span><span class="s">&quot;select count(*) from `</span><span class="si">%s</span><span class="s">` where parent like &#39;old_parent:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">sql</span><span class="p">(</span><span class="s">&quot;delete from `</span><span class="si">%s</span><span class="s">` where parent like &#39;old_parent:</span><span class="si">%%</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">return</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s"> records deleted&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">total_deleted</span><span class="p">))</span>
<span class="c"># Send Error Report</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="send_error_report"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.send_error_report">[docs]</a><span class="k">def</span> <span class="nf">send_error_report</span><span class="p">():</span>
<span class="n">sql</span> <span class="o">=</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="n">m</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
<span class="n">acc_id</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span><span class="bp">None</span><span class="p">,</span><span class="s">&#39;account_id&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
<span class="k">if</span> <span class="n">acc_id</span><span class="p">:</span> <span class="n">m</span> <span class="o">=</span> <span class="s">&#39;Account Id : &#39;</span><span class="o">+</span><span class="n">acc_id</span>
<span class="n">form</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span>
<span class="n">err_msg</span> <span class="o">=</span> <span class="s">&#39;&#39;&#39;</span>
<span class="s"> </span><span class="si">%s</span><span class="s"> &lt;br&gt;</span>
<span class="s"> Comment: </span><span class="si">%s</span><span class="s"></span>
<span class="s"> Err Msg : </span><span class="si">%s</span><span class="s"></span>
<span class="s"> &#39;&#39;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;msg&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">,</span> <span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;err_msg&#39;</span><span class="p">))</span>
<span class="n">sendmail</span><span class="p">([</span><span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Control Panel&#39;</span><span class="p">,</span><span class="bp">None</span><span class="p">,</span><span class="s">&#39;support_email_id&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;support@iwebnotes.com&#39;</span><span class="p">],</span> <span class="n">sender</span><span class="o">=</span><span class="n">webnotes</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">&#39;user&#39;</span><span class="p">],</span> <span class="n">msg</span><span class="o">=</span><span class="n">err_msg</span><span class="p">,</span> <span class="n">subject</span><span class="o">=</span><span class="s">&#39;Error Report &#39;</span><span class="o">+</span><span class="n">m</span><span class="p">)</span>
<span class="c"># pretty print a dict</span>
<span class="c"># ==============================================================================</span>
</div>
<div class="viewcode-block" id="pprint_dict"><a class="viewcode-back" href="../../webnotes.utils.html#webnotes.utils.pprint_dict">[docs]</a><span class="k">def</span> <span class="nf">pprint_dict</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="n">indent</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
<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="mi">0</span><span class="p">,</span><span class="n">level</span><span class="p">):</span>
<span class="n">indent</span> <span class="o">+=</span> <span class="s">&#39;</span><span class="se">\t</span><span class="s">&#39;</span>
<span class="n">lines</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">kl</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
<span class="n">kl</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">kl</span><span class="p">:</span>
<span class="n">tmp</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">d</span><span class="p">[</span><span class="n">key</span><span class="p">]}</span>
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">indent</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">tmp</span><span class="p">)[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">indent</span> <span class="o">+</span> <span class="s">&#39;{</span><span class="se">\n</span><span class="s">&#39;</span> \
<span class="o">+</span> <span class="n">indent</span> <span class="o">+</span> <span class="s">&#39;,</span><span class="se">\n\t</span><span class="s">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lines</span><span class="p">)</span> \
<span class="o">+</span> <span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</span> <span class="o">+</span> <span class="n">indent</span> <span class="o">+</span> <span class="s">&#39;}&#39;</span></div>
</pre></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