Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
 
 
 
 
 
 

916 рядки
73 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>utils Package &mdash; WNFramework v1.8 documentation</title>
  7. <link rel="stylesheet" href="_static/default.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '',
  12. VERSION: '1.8',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/underscore.js"></script>
  20. <script type="text/javascript" src="_static/doctools.js"></script>
  21. <link rel="top" title="WNFramework v1.8 documentation" href="index.html" />
  22. <link rel="up" title="webnotes Package" href="webnotes.html" />
  23. <link rel="next" title="email_lib Package" href="webnotes.utils.email_lib.html" />
  24. <link rel="prev" title="multi_tenant Package" href="webnotes.multi_tenant.html" />
  25. </head>
  26. <body>
  27. <div class="related">
  28. <h3>Navigation</h3>
  29. <ul>
  30. <li class="right" style="margin-right: 10px">
  31. <a href="genindex.html" title="General Index"
  32. accesskey="I">index</a></li>
  33. <li class="right" >
  34. <a href="py-modindex.html" title="Python Module Index"
  35. >modules</a> |</li>
  36. <li class="right" >
  37. <a href="webnotes.utils.email_lib.html" title="email_lib Package"
  38. accesskey="N">next</a> |</li>
  39. <li class="right" >
  40. <a href="webnotes.multi_tenant.html" title="multi_tenant Package"
  41. accesskey="P">previous</a> |</li>
  42. <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li>
  43. <li><a href="webnotes.html" accesskey="U">webnotes Package</a> &raquo;</li>
  44. </ul>
  45. </div>
  46. <div class="document">
  47. <div class="documentwrapper">
  48. <div class="bodywrapper">
  49. <div class="body">
  50. <div class="section" id="utils-package">
  51. <h1>utils Package<a class="headerlink" href="#utils-package" title="Permalink to this headline">¶</a></h1>
  52. <div class="section" id="id1">
  53. <h2><tt class="xref py py-mod docutils literal"><span class="pre">utils</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
  54. <span class="target" id="module-webnotes.utils"></span><dl class="function">
  55. <dt id="webnotes.utils.add_days">
  56. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">add_days</tt><big>(</big><em>date</em>, <em>days</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#add_days"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.add_days" title="Permalink to this definition">¶</a></dt>
  57. <dd><p>Adds <cite>days</cite> to the given <cite>string_date</cite></p>
  58. </dd></dl>
  59. <dl class="function">
  60. <dt id="webnotes.utils.add_months">
  61. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">add_months</tt><big>(</big><em>string_date</em>, <em>months</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#add_months"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.add_months" title="Permalink to this definition">¶</a></dt>
  62. <dd></dd></dl>
  63. <dl class="function">
  64. <dt id="webnotes.utils.add_years">
  65. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">add_years</tt><big>(</big><em>string_date</em>, <em>years</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#add_years"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.add_years" title="Permalink to this definition">¶</a></dt>
  66. <dd></dd></dl>
  67. <dl class="function">
  68. <dt id="webnotes.utils.cint">
  69. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">cint</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#cint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cint" title="Permalink to this definition">¶</a></dt>
  70. <dd><p>Convert to integer</p>
  71. </dd></dl>
  72. <dl class="function">
  73. <dt id="webnotes.utils.clear_recycle_bin">
  74. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">clear_recycle_bin</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#clear_recycle_bin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.clear_recycle_bin" title="Permalink to this definition">¶</a></dt>
  75. <dd></dd></dl>
  76. <dl class="function">
  77. <dt id="webnotes.utils.cstr">
  78. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">cstr</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#cstr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cstr" title="Permalink to this definition">¶</a></dt>
  79. <dd><p>Convert to string</p>
  80. </dd></dl>
  81. <dl class="function">
  82. <dt id="webnotes.utils.date_diff">
  83. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">date_diff</tt><big>(</big><em>string_ed_date</em>, <em>string_st_date=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#date_diff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.date_diff" title="Permalink to this definition">¶</a></dt>
  84. <dd></dd></dl>
  85. <dl class="function">
  86. <dt id="webnotes.utils.db_exists">
  87. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">db_exists</tt><big>(</big><em>dt</em>, <em>dn</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#db_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.db_exists" title="Permalink to this definition">¶</a></dt>
  88. <dd></dd></dl>
  89. <dl class="function">
  90. <dt id="webnotes.utils.dict_to_str">
  91. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">dict_to_str</tt><big>(</big><em>args</em>, <em>sep='&amp;'</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#dict_to_str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.dict_to_str" title="Permalink to this definition">¶</a></dt>
  92. <dd><p>Converts a dictionary to URL</p>
  93. </dd></dl>
  94. <dl class="function">
  95. <dt id="webnotes.utils.flt">
  96. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">flt</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#flt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.flt" title="Permalink to this definition">¶</a></dt>
  97. <dd><p>Convert to float (ignore commas)</p>
  98. </dd></dl>
  99. <dl class="function">
  100. <dt id="webnotes.utils.fmt_money">
  101. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">fmt_money</tt><big>(</big><em>amount</em>, <em>fmt='%.2f'</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#fmt_money"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.fmt_money" title="Permalink to this definition">¶</a></dt>
  102. <dd><p>Convert to string with commas for thousands, millions etc</p>
  103. </dd></dl>
  104. <dl class="function">
  105. <dt id="webnotes.utils.formatdate">
  106. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">formatdate</tt><big>(</big><em>string_date</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#formatdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.formatdate" title="Permalink to this definition">¶</a></dt>
  107. <dd><p>Convers the given string date to <a class="reference internal" href="#webnotes.utils.user_format" title="webnotes.utils.user_format"><tt class="xref py py-data docutils literal"><span class="pre">user_format</span></tt></a></p>
  108. </dd></dl>
  109. <dl class="function">
  110. <dt id="webnotes.utils.generate_hash">
  111. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">generate_hash</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#generate_hash"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.generate_hash" title="Permalink to this definition">¶</a></dt>
  112. <dd><p>Generates reandom hash for session id</p>
  113. </dd></dl>
  114. <dl class="function">
  115. <dt id="webnotes.utils.getCSVelement">
  116. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">getCSVelement</tt><big>(</big><em>v</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#getCSVelement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.getCSVelement" title="Permalink to this definition">¶</a></dt>
  117. <dd><p>Returns the CSV value of <cite>v</cite>, For example:</p>
  118. <ul class="simple">
  119. <li>apple becomes &#8220;apple&#8221;</li>
  120. <li>hi&#8221;there becomes &#8220;hi&#8221;&#8220;there&#8221;</li>
  121. </ul>
  122. </dd></dl>
  123. <dl class="function">
  124. <dt id="webnotes.utils.getTraceback">
  125. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">getTraceback</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#getTraceback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.getTraceback" title="Permalink to this definition">¶</a></dt>
  126. <dd><p>Returns the traceback of the Exception</p>
  127. </dd></dl>
  128. <dl class="function">
  129. <dt id="webnotes.utils.get_defaults">
  130. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">get_defaults</tt><big>(</big><em>key=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#get_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.get_defaults" title="Permalink to this definition">¶</a></dt>
  131. <dd><p>Get dictionary of default values from the <em class="xref std std-term">Control Panel</em>, or a value if key is passed</p>
  132. </dd></dl>
  133. <dl class="function">
  134. <dt id="webnotes.utils.get_first_day">
  135. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">get_first_day</tt><big>(</big><em>dt</em>, <em>d_years=0</em>, <em>d_months=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#get_first_day"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.get_first_day" title="Permalink to this definition">¶</a></dt>
  136. <dd><p>Returns the first day of the month for the date specified by date object
  137. Also adds <cite>d_years</cite> and <cite>d_months</cite> if specified</p>
  138. </dd></dl>
  139. <dl class="function">
  140. <dt id="webnotes.utils.get_last_day">
  141. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">get_last_day</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#get_last_day"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.get_last_day" title="Permalink to this definition">¶</a></dt>
  142. <dd><p>Returns last day of the month using:
  143. <cite>get_first_day(dt, 0, 1) + datetime.timedelta(-1)</cite></p>
  144. </dd></dl>
  145. <dl class="function">
  146. <dt id="webnotes.utils.getdate">
  147. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">getdate</tt><big>(</big><em>string_date</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#getdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.getdate" title="Permalink to this definition">¶</a></dt>
  148. <dd><p>Coverts string date (yyyy-mm-dd) to datetime.date object</p>
  149. </dd></dl>
  150. <dl class="function">
  151. <dt id="webnotes.utils.global_date_format">
  152. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">global_date_format</tt><big>(</big><em>date</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#global_date_format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.global_date_format" title="Permalink to this definition">¶</a></dt>
  153. <dd></dd></dl>
  154. <dl class="function">
  155. <dt id="webnotes.utils.has_common">
  156. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">has_common</tt><big>(</big><em>l1</em>, <em>l2</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#has_common"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.has_common" title="Permalink to this definition">¶</a></dt>
  157. <dd><p>Returns true if there are common elements in lists l1 and l2</p>
  158. </dd></dl>
  159. <dl class="function">
  160. <dt id="webnotes.utils.in_words">
  161. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">in_words</tt><big>(</big><em>integer</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#in_words"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.in_words" title="Permalink to this definition">¶</a></dt>
  162. <dd><p>Returns string in words for the given integer.</p>
  163. </dd></dl>
  164. <dl class="function">
  165. <dt id="webnotes.utils.isNull">
  166. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">isNull</tt><big>(</big><em>v</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#isNull"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.isNull" title="Permalink to this definition">¶</a></dt>
  167. <dd><p>Returns true if v=&#8217;&#8217; or v is <cite>None</cite></p>
  168. </dd></dl>
  169. <dl class="function">
  170. <dt id="webnotes.utils.load_json">
  171. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">load_json</tt><big>(</big><em>arg</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#load_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.load_json" title="Permalink to this definition">¶</a></dt>
  172. <dd></dd></dl>
  173. <dl class="function">
  174. <dt id="webnotes.utils.log">
  175. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">log</tt><big>(</big><em>event</em>, <em>details</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.log" title="Permalink to this definition">¶</a></dt>
  176. <dd></dd></dl>
  177. <dl class="function">
  178. <dt id="webnotes.utils.money_in_words">
  179. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">money_in_words</tt><big>(</big><em>number</em>, <em>main_currency=None</em>, <em>fraction_currency=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#money_in_words"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.money_in_words" title="Permalink to this definition">¶</a></dt>
  180. <dd><p>Returns string in words with currency and fraction currency.</p>
  181. </dd></dl>
  182. <dl class="function">
  183. <dt id="webnotes.utils.now">
  184. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">now</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#now"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.now" title="Permalink to this definition">¶</a></dt>
  185. <dd><p>Returns <cite>time.strftime(&#8216;%Y-%m-%d %H:%M:%S&#8217;)</cite></p>
  186. </dd></dl>
  187. <dl class="function">
  188. <dt id="webnotes.utils.now_datetime">
  189. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">now_datetime</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#now_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.now_datetime" title="Permalink to this definition">¶</a></dt>
  190. <dd></dd></dl>
  191. <dl class="function">
  192. <dt id="webnotes.utils.nowdate">
  193. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">nowdate</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#nowdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.nowdate" title="Permalink to this definition">¶</a></dt>
  194. <dd><p>Returns time.strftime(&#8216;%Y-%m-%d&#8217;)</p>
  195. </dd></dl>
  196. <dl class="function">
  197. <dt id="webnotes.utils.parse_val">
  198. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">parse_val</tt><big>(</big><em>v</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#parse_val"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.parse_val" title="Permalink to this definition">¶</a></dt>
  199. <dd><p>Converts to simple datatypes from SQL query results</p>
  200. </dd></dl>
  201. <dl class="function">
  202. <dt id="webnotes.utils.pprint_dict">
  203. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">pprint_dict</tt><big>(</big><em>d</em>, <em>level=1</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#pprint_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.pprint_dict" title="Permalink to this definition">¶</a></dt>
  204. <dd></dd></dl>
  205. <dl class="function">
  206. <dt id="webnotes.utils.replace_newlines">
  207. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">replace_newlines</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#replace_newlines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.replace_newlines" title="Permalink to this definition">¶</a></dt>
  208. <dd><p>Replace newlines by &#8216;&lt;br&gt;&#8217;</p>
  209. </dd></dl>
  210. <dl class="function">
  211. <dt id="webnotes.utils.send_error_report">
  212. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">send_error_report</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#send_error_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.send_error_report" title="Permalink to this definition">¶</a></dt>
  213. <dd></dd></dl>
  214. <dl class="function">
  215. <dt id="webnotes.utils.sendmail">
  216. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">sendmail</tt><big>(</big><em>recipients</em>, <em>sender=''</em>, <em>msg=''</em>, <em>subject='[No Subject]'</em>, <em>parts=</em><span class="optional">[</span><span class="optional">]</span>, <em>cc=</em><span class="optional">[</span><span class="optional">]</span>, <em>attach=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#sendmail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.sendmail" title="Permalink to this definition">¶</a></dt>
  217. <dd><p>Send an email. For more details see <a class="reference internal" href="webnotes.utils.email_lib.html#webnotes.utils.email_lib.sendmail" title="webnotes.utils.email_lib.sendmail"><tt class="xref py py-func docutils literal"><span class="pre">email_lib.sendmail()</span></tt></a></p>
  218. </dd></dl>
  219. <dl class="function">
  220. <dt id="webnotes.utils.set_default">
  221. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">set_default</tt><big>(</big><em>key</em>, <em>val</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#set_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.set_default" title="Permalink to this definition">¶</a></dt>
  222. <dd><p>Set / add a default value to <em class="xref std std-term">Control Panel</em></p>
  223. </dd></dl>
  224. <dl class="function">
  225. <dt id="webnotes.utils.str_esc_quote">
  226. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">str_esc_quote</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#str_esc_quote"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.str_esc_quote" title="Permalink to this definition">¶</a></dt>
  227. <dd><p>Escape quotes</p>
  228. </dd></dl>
  229. <dl class="function">
  230. <dt id="webnotes.utils.timestamps_equal">
  231. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">timestamps_equal</tt><big>(</big><em>t1</em>, <em>t2</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#timestamps_equal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.timestamps_equal" title="Permalink to this definition">¶</a></dt>
  232. <dd><p>Returns true if same the two string timestamps are same</p>
  233. </dd></dl>
  234. <dl class="data">
  235. <dt id="webnotes.utils.user_format">
  236. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">user_format</tt><a class="headerlink" href="#webnotes.utils.user_format" title="Permalink to this definition">¶</a></dt>
  237. <dd><p>User format specified in <em class="xref std std-term">Control Panel</em></p>
  238. <p>Examples:</p>
  239. <ul class="simple">
  240. <li>dd-mm-yyyy</li>
  241. <li>mm-dd-yyyy</li>
  242. <li>dd/mm/yyyy</li>
  243. </ul>
  244. </dd></dl>
  245. <dl class="function">
  246. <dt id="webnotes.utils.validate_email_add">
  247. <tt class="descclassname">webnotes.utils.</tt><tt class="descname">validate_email_add</tt><big>(</big><em>email_str</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils.html#validate_email_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.validate_email_add" title="Permalink to this definition">¶</a></dt>
  248. <dd><p>Validates the email string</p>
  249. </dd></dl>
  250. </div>
  251. <div class="section" id="archive-module">
  252. <h2><tt class="xref py py-mod docutils literal"><span class="pre">archive</span></tt> Module<a class="headerlink" href="#archive-module" title="Permalink to this headline">¶</a></h2>
  253. </div>
  254. <div class="section" id="backups-module">
  255. <h2><tt class="xref py py-mod docutils literal"><span class="pre">backups</span></tt> Module<a class="headerlink" href="#backups-module" title="Permalink to this headline">¶</a></h2>
  256. </div>
  257. <div class="section" id="module-webnotes.utils.cache">
  258. <span id="cache-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">cache</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.cache" title="Permalink to this headline">¶</a></h2>
  259. <p>Simple Caching:</p>
  260. <p>Stores key-value pairs in database and enables simple caching</p>
  261. <p>get_item(key).get() returns the cached value if not expired (else returns null)
  262. get_item(key).set(interval = 60000) sets a value to cache, expiring after x seconds
  263. get_item(key).clear() clears an old value
  264. setup() sets up cache</p>
  265. <dl class="class">
  266. <dt id="webnotes.utils.cache.CacheItem">
  267. <em class="property">class </em><tt class="descclassname">webnotes.utils.cache.</tt><tt class="descname">CacheItem</tt><big>(</big><em>key</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/cache.html#CacheItem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cache.CacheItem" title="Permalink to this definition">¶</a></dt>
  268. <dd><dl class="method">
  269. <dt id="webnotes.utils.cache.CacheItem.clear">
  270. <tt class="descname">clear</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/cache.html#CacheItem.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cache.CacheItem.clear" title="Permalink to this definition">¶</a></dt>
  271. <dd><p>clear the item</p>
  272. </dd></dl>
  273. <dl class="method">
  274. <dt id="webnotes.utils.cache.CacheItem.get">
  275. <tt class="descname">get</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/cache.html#CacheItem.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cache.CacheItem.get" title="Permalink to this definition">¶</a></dt>
  276. <dd><p>get value</p>
  277. </dd></dl>
  278. <dl class="method">
  279. <dt id="webnotes.utils.cache.CacheItem.set">
  280. <tt class="descname">set</tt><big>(</big><em>value</em>, <em>interval=6000</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/cache.html#CacheItem.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cache.CacheItem.set" title="Permalink to this definition">¶</a></dt>
  281. <dd><p>set a new value, with interval</p>
  282. </dd></dl>
  283. </dd></dl>
  284. <dl class="function">
  285. <dt id="webnotes.utils.cache.get_item">
  286. <tt class="descclassname">webnotes.utils.cache.</tt><tt class="descname">get_item</tt><big>(</big><em>key</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/cache.html#get_item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cache.get_item" title="Permalink to this definition">¶</a></dt>
  287. <dd><p>returns get CacheItem object</p>
  288. </dd></dl>
  289. <dl class="function">
  290. <dt id="webnotes.utils.cache.setup">
  291. <tt class="descclassname">webnotes.utils.cache.</tt><tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/cache.html#setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.cache.setup" title="Permalink to this definition">¶</a></dt>
  292. <dd></dd></dl>
  293. </div>
  294. <div class="section" id="module-webnotes.utils.encrypt">
  295. <span id="encrypt-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">encrypt</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.encrypt" title="Permalink to this headline">¶</a></h2>
  296. <p>XTEA Block Encryption Algorithm
  297. Author: Paul Chakravarti (paul_dot_chakravarti_at_gmail_dot_com)
  298. License: Public Domain</p>
  299. <dl class="function">
  300. <dt id="webnotes.utils.encrypt.crypt">
  301. <tt class="descclassname">webnotes.utils.encrypt.</tt><tt class="descname">crypt</tt><big>(</big><em>key</em>, <em>data</em>, <em>iv='\x00\x00\x00\x00\x00\x00\x00\x00'</em>, <em>n=32</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/encrypt.html#crypt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.encrypt.crypt" title="Permalink to this definition">¶</a></dt>
  302. <dd></dd></dl>
  303. <dl class="function">
  304. <dt id="webnotes.utils.encrypt.decrypt">
  305. <tt class="descclassname">webnotes.utils.encrypt.</tt><tt class="descname">decrypt</tt><big>(</big><em>data</em>, <em>encryption_key=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/encrypt.html#decrypt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.encrypt.decrypt" title="Permalink to this definition">¶</a></dt>
  306. <dd></dd></dl>
  307. <dl class="function">
  308. <dt id="webnotes.utils.encrypt.encrypt">
  309. <tt class="descclassname">webnotes.utils.encrypt.</tt><tt class="descname">encrypt</tt><big>(</big><em>data</em>, <em>encryption_key=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/encrypt.html#encrypt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.encrypt.encrypt" title="Permalink to this definition">¶</a></dt>
  310. <dd></dd></dl>
  311. <dl class="function">
  312. <dt id="webnotes.utils.encrypt.get_key">
  313. <tt class="descclassname">webnotes.utils.encrypt.</tt><tt class="descname">get_key</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/encrypt.html#get_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.encrypt.get_key" title="Permalink to this definition">¶</a></dt>
  314. <dd></dd></dl>
  315. <dl class="function">
  316. <dt id="webnotes.utils.encrypt.xtea_decrypt">
  317. <tt class="descclassname">webnotes.utils.encrypt.</tt><tt class="descname">xtea_decrypt</tt><big>(</big><em>key</em>, <em>block</em>, <em>n=32</em>, <em>endian='!'</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/encrypt.html#xtea_decrypt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.encrypt.xtea_decrypt" title="Permalink to this definition">¶</a></dt>
  318. <dd></dd></dl>
  319. <dl class="function">
  320. <dt id="webnotes.utils.encrypt.xtea_encrypt">
  321. <tt class="descclassname">webnotes.utils.encrypt.</tt><tt class="descname">xtea_encrypt</tt><big>(</big><em>key</em>, <em>block</em>, <em>n=32</em>, <em>endian='!'</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/encrypt.html#xtea_encrypt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.encrypt.xtea_encrypt" title="Permalink to this definition">¶</a></dt>
  322. <dd></dd></dl>
  323. </div>
  324. <div class="section" id="module-webnotes.utils.file_manager">
  325. <span id="file-manager-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">file_manager</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.file_manager" title="Permalink to this headline">¶</a></h2>
  326. <dl class="function">
  327. <dt id="webnotes.utils.file_manager.convert_to_files">
  328. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">convert_to_files</tt><big>(</big><em>verbose=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#convert_to_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.convert_to_files" title="Permalink to this definition">¶</a></dt>
  329. <dd></dd></dl>
  330. <dl class="function">
  331. <dt id="webnotes.utils.file_manager.delete_file">
  332. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">delete_file</tt><big>(</big><em>fname</em>, <em>verbose=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#delete_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.delete_file" title="Permalink to this definition">¶</a></dt>
  333. <dd></dd></dl>
  334. <dl class="function">
  335. <dt id="webnotes.utils.file_manager.get_file">
  336. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">get_file</tt><big>(</big><em>fname</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#get_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.get_file" title="Permalink to this definition">¶</a></dt>
  337. <dd></dd></dl>
  338. <dl class="function">
  339. <dt id="webnotes.utils.file_manager.get_file_system_name">
  340. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">get_file_system_name</tt><big>(</big><em>fname</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#get_file_system_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.get_file_system_name" title="Permalink to this definition">¶</a></dt>
  341. <dd></dd></dl>
  342. <dl class="function">
  343. <dt id="webnotes.utils.file_manager.make_thumbnail">
  344. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">make_thumbnail</tt><big>(</big><em>blob</em>, <em>size</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#make_thumbnail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.make_thumbnail" title="Permalink to this definition">¶</a></dt>
  345. <dd></dd></dl>
  346. <dl class="function">
  347. <dt id="webnotes.utils.file_manager.save_file">
  348. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">save_file</tt><big>(</big><em>fname</em>, <em>content</em>, <em>module=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#save_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.save_file" title="Permalink to this definition">¶</a></dt>
  349. <dd></dd></dl>
  350. <dl class="function">
  351. <dt id="webnotes.utils.file_manager.save_uploaded">
  352. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">save_uploaded</tt><big>(</big><em>js_okay='window.parent.msgprint(&quot;File Upload Successful&quot;)'</em>, <em>js_fail=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#save_uploaded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.save_uploaded" title="Permalink to this definition">¶</a></dt>
  353. <dd></dd></dl>
  354. <dl class="function">
  355. <dt id="webnotes.utils.file_manager.upload">
  356. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">upload</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#upload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.upload" title="Permalink to this definition">¶</a></dt>
  357. <dd></dd></dl>
  358. <dl class="function">
  359. <dt id="webnotes.utils.file_manager.write_file">
  360. <tt class="descclassname">webnotes.utils.file_manager.</tt><tt class="descname">write_file</tt><big>(</big><em>fid</em>, <em>content</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/file_manager.html#write_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.file_manager.write_file" title="Permalink to this definition">¶</a></dt>
  361. <dd></dd></dl>
  362. </div>
  363. <div class="section" id="module-webnotes.utils.jsmin">
  364. <span id="jsmin-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">jsmin</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.jsmin" title="Permalink to this headline">¶</a></h2>
  365. <dl class="class">
  366. <dt id="webnotes.utils.jsmin.JavascriptMinify">
  367. <em class="property">class </em><tt class="descclassname">webnotes.utils.jsmin.</tt><tt class="descname">JavascriptMinify</tt><a class="reference internal" href="_modules/webnotes/utils/jsmin.html#JavascriptMinify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.jsmin.JavascriptMinify" title="Permalink to this definition">¶</a></dt>
  368. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
  369. <dl class="method">
  370. <dt id="webnotes.utils.jsmin.JavascriptMinify.minify">
  371. <tt class="descname">minify</tt><big>(</big><em>instream</em>, <em>outstream</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/jsmin.html#JavascriptMinify.minify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.jsmin.JavascriptMinify.minify" title="Permalink to this definition">¶</a></dt>
  372. <dd></dd></dl>
  373. </dd></dl>
  374. <dl class="exception">
  375. <dt id="webnotes.utils.jsmin.UnterminatedComment">
  376. <em class="property">exception </em><tt class="descclassname">webnotes.utils.jsmin.</tt><tt class="descname">UnterminatedComment</tt><a class="reference internal" href="_modules/webnotes/utils/jsmin.html#UnterminatedComment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.jsmin.UnterminatedComment" title="Permalink to this definition">¶</a></dt>
  377. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
  378. </dd></dl>
  379. <dl class="exception">
  380. <dt id="webnotes.utils.jsmin.UnterminatedRegularExpression">
  381. <em class="property">exception </em><tt class="descclassname">webnotes.utils.jsmin.</tt><tt class="descname">UnterminatedRegularExpression</tt><a class="reference internal" href="_modules/webnotes/utils/jsmin.html#UnterminatedRegularExpression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.jsmin.UnterminatedRegularExpression" title="Permalink to this definition">¶</a></dt>
  382. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
  383. </dd></dl>
  384. <dl class="exception">
  385. <dt id="webnotes.utils.jsmin.UnterminatedStringLiteral">
  386. <em class="property">exception </em><tt class="descclassname">webnotes.utils.jsmin.</tt><tt class="descname">UnterminatedStringLiteral</tt><a class="reference internal" href="_modules/webnotes/utils/jsmin.html#UnterminatedStringLiteral"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.jsmin.UnterminatedStringLiteral" title="Permalink to this definition">¶</a></dt>
  387. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
  388. </dd></dl>
  389. <dl class="function">
  390. <dt id="webnotes.utils.jsmin.isAlphanum">
  391. <tt class="descclassname">webnotes.utils.jsmin.</tt><tt class="descname">isAlphanum</tt><big>(</big><em>c</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/jsmin.html#isAlphanum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.jsmin.isAlphanum" title="Permalink to this definition">¶</a></dt>
  392. <dd><p>return true if the character is a letter, digit, underscore,
  393. dollar sign, or non-ASCII character.</p>
  394. </dd></dl>
  395. <dl class="function">
  396. <dt id="webnotes.utils.jsmin.jsmin">
  397. <tt class="descclassname">webnotes.utils.jsmin.</tt><tt class="descname">jsmin</tt><big>(</big><em>js</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/jsmin.html#jsmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.jsmin.jsmin" title="Permalink to this definition">¶</a></dt>
  398. <dd></dd></dl>
  399. </div>
  400. <div class="section" id="module-webnotes.utils.nestedset">
  401. <span id="nestedset-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">nestedset</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.nestedset" title="Permalink to this headline">¶</a></h2>
  402. <dl class="function">
  403. <dt id="webnotes.utils.nestedset.rebuild_node">
  404. <tt class="descclassname">webnotes.utils.nestedset.</tt><tt class="descname">rebuild_node</tt><big>(</big><em>doctype</em>, <em>parent</em>, <em>left</em>, <em>parent_field</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/nestedset.html#rebuild_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.nestedset.rebuild_node" title="Permalink to this definition">¶</a></dt>
  405. <dd></dd></dl>
  406. <dl class="function">
  407. <dt id="webnotes.utils.nestedset.rebuild_tree">
  408. <tt class="descclassname">webnotes.utils.nestedset.</tt><tt class="descname">rebuild_tree</tt><big>(</big><em>doctype</em>, <em>parent_field</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/nestedset.html#rebuild_tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.nestedset.rebuild_tree" title="Permalink to this definition">¶</a></dt>
  409. <dd></dd></dl>
  410. <dl class="function">
  411. <dt id="webnotes.utils.nestedset.update_add_node">
  412. <tt class="descclassname">webnotes.utils.nestedset.</tt><tt class="descname">update_add_node</tt><big>(</big><em>doctype</em>, <em>name</em>, <em>parent</em>, <em>parent_field</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/nestedset.html#update_add_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.nestedset.update_add_node" title="Permalink to this definition">¶</a></dt>
  413. <dd></dd></dl>
  414. <dl class="function">
  415. <dt id="webnotes.utils.nestedset.update_nsm">
  416. <tt class="descclassname">webnotes.utils.nestedset.</tt><tt class="descname">update_nsm</tt><big>(</big><em>doc_obj</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/nestedset.html#update_nsm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.nestedset.update_nsm" title="Permalink to this definition">¶</a></dt>
  417. <dd></dd></dl>
  418. <dl class="function">
  419. <dt id="webnotes.utils.nestedset.update_remove_node">
  420. <tt class="descclassname">webnotes.utils.nestedset.</tt><tt class="descname">update_remove_node</tt><big>(</big><em>doctype</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/nestedset.html#update_remove_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.nestedset.update_remove_node" title="Permalink to this definition">¶</a></dt>
  421. <dd></dd></dl>
  422. </div>
  423. <div class="section" id="module-webnotes.utils.scheduler">
  424. <span id="scheduler-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">scheduler</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.scheduler" title="Permalink to this headline">¶</a></h2>
  425. <p>Simple Scheduler</p>
  426. <p>This scheduler is used to fire events across multiple databases. A database
  427. master_scheduler is maintained with one event and one log table</p>
  428. <p>Events are added by different databases in the master scheduler using the
  429. <cite>set_event</cite> method and they are executed by the cron.</p>
  430. <p>__main__ will call run</p>
  431. <div class="section" id="to-install">
  432. <h3>To install:<a class="headerlink" href="#to-install" title="Permalink to this headline">¶</a></h3>
  433. <p>python install_lib.py [root] [password] master_scheduler</p>
  434. </div>
  435. <div class="section" id="in-cron">
  436. <h3>In cron:<a class="headerlink" href="#in-cron" title="Permalink to this headline">¶</a></h3>
  437. <p>python [path]webnotes/utils/scheduler.py</p>
  438. <dl class="class">
  439. <dt id="webnotes.utils.scheduler.Scheduler">
  440. <em class="property">class </em><tt class="descclassname">webnotes.utils.scheduler.</tt><tt class="descname">Scheduler</tt><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler" title="Permalink to this definition">¶</a></dt>
  441. <dd><dl class="method">
  442. <dt id="webnotes.utils.scheduler.Scheduler.clear">
  443. <tt class="descname">clear</tt><big>(</big><em>db_name</em>, <em>event</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.clear" title="Permalink to this definition">¶</a></dt>
  444. <dd><p>Clears the event</p>
  445. </dd></dl>
  446. <dl class="method">
  447. <dt id="webnotes.utils.scheduler.Scheduler.connect">
  448. <tt class="descname">connect</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.connect" title="Permalink to this definition">¶</a></dt>
  449. <dd></dd></dl>
  450. <dl class="method">
  451. <dt id="webnotes.utils.scheduler.Scheduler.execute">
  452. <tt class="descname">execute</tt><big>(</big><em>db_name</em>, <em>event</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.execute" title="Permalink to this definition">¶</a></dt>
  453. <dd><p>Executes event in the specifed db</p>
  454. </dd></dl>
  455. <dl class="method">
  456. <dt id="webnotes.utils.scheduler.Scheduler.get_events">
  457. <tt class="descname">get_events</tt><big>(</big><em>db_name=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.get_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.get_events" title="Permalink to this definition">¶</a></dt>
  458. <dd><p>Returns list of upcoming events</p>
  459. </dd></dl>
  460. <dl class="method">
  461. <dt id="webnotes.utils.scheduler.Scheduler.get_log">
  462. <tt class="descname">get_log</tt><big>(</big><em>db_name=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.get_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.get_log" title="Permalink to this definition">¶</a></dt>
  463. <dd><p>Returns log of events</p>
  464. </dd></dl>
  465. <dl class="method">
  466. <dt id="webnotes.utils.scheduler.Scheduler.log">
  467. <tt class="descname">log</tt><big>(</big><em>db_name</em>, <em>event</em>, <em>traceback</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.log" title="Permalink to this definition">¶</a></dt>
  468. <dd><p>Log an event error</p>
  469. </dd></dl>
  470. <dl class="method">
  471. <dt id="webnotes.utils.scheduler.Scheduler.run">
  472. <tt class="descname">run</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.run" title="Permalink to this definition">¶</a></dt>
  473. <dd><p>Run scheduled (due) events and reset time for recurring events</p>
  474. </dd></dl>
  475. <dl class="method">
  476. <dt id="webnotes.utils.scheduler.Scheduler.set">
  477. <tt class="descname">set</tt><big>(</big><em>event</em>, <em>interval</em>, <em>recurring</em>, <em>db_name=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#Scheduler.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.Scheduler.set" title="Permalink to this definition">¶</a></dt>
  478. <dd><p>Add an event to the Event table in the master scheduler</p>
  479. </dd></dl>
  480. </dd></dl>
  481. <dl class="function">
  482. <dt id="webnotes.utils.scheduler.cancel_event">
  483. <tt class="descclassname">webnotes.utils.scheduler.</tt><tt class="descname">cancel_event</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#cancel_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.cancel_event" title="Permalink to this definition">¶</a></dt>
  484. <dd><p>Cancels an event</p>
  485. </dd></dl>
  486. <dl class="function">
  487. <dt id="webnotes.utils.scheduler.set_event">
  488. <tt class="descclassname">webnotes.utils.scheduler.</tt><tt class="descname">set_event</tt><big>(</big><em>event</em>, <em>interval=86400</em>, <em>recurring=1</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/scheduler.html#set_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.scheduler.set_event" title="Permalink to this definition">¶</a></dt>
  489. <dd><p>Adds an event to the master scheduler</p>
  490. </dd></dl>
  491. </div>
  492. </div>
  493. <div class="section" id="module-webnotes.utils.sitemap">
  494. <span id="sitemap-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">sitemap</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.sitemap" title="Permalink to this headline">¶</a></h2>
  495. <dl class="function">
  496. <dt id="webnotes.utils.sitemap.generate_xml">
  497. <tt class="descclassname">webnotes.utils.sitemap.</tt><tt class="descname">generate_xml</tt><big>(</big><em>conn</em>, <em>site_prefix</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/sitemap.html#generate_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.sitemap.generate_xml" title="Permalink to this definition">¶</a></dt>
  498. <dd></dd></dl>
  499. </div>
  500. <div class="section" id="module-webnotes.utils.transfer">
  501. <span id="transfer-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">transfer</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.transfer" title="Permalink to this headline">¶</a></h2>
  502. <dl class="class">
  503. <dt id="webnotes.utils.transfer.UpdateDocType">
  504. <em class="property">class </em><tt class="descclassname">webnotes.utils.transfer.</tt><tt class="descname">UpdateDocType</tt><big>(</big><em>in_doclist</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType" title="Permalink to this definition">¶</a></dt>
  505. <dd><p>Bases: <a class="reference internal" href="#webnotes.utils.transfer.UpdateDocumentMerge" title="webnotes.utils.transfer.UpdateDocumentMerge"><tt class="xref py py-class docutils literal"><span class="pre">webnotes.utils.transfer.UpdateDocumentMerge</span></tt></a></p>
  506. <dl class="method">
  507. <dt id="webnotes.utils.transfer.UpdateDocType.add_section_breaks_and_renum">
  508. <tt class="descname">add_section_breaks_and_renum</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.add_section_breaks_and_renum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.add_section_breaks_and_renum" title="Permalink to this definition">¶</a></dt>
  509. <dd></dd></dl>
  510. <dl class="method">
  511. <dt id="webnotes.utils.transfer.UpdateDocType.child_exists">
  512. <tt class="descname">child_exists</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.child_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.child_exists" title="Permalink to this definition">¶</a></dt>
  513. <dd></dd></dl>
  514. <dl class="method">
  515. <dt id="webnotes.utils.transfer.UpdateDocType.clear_section_breaks">
  516. <tt class="descname">clear_section_breaks</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.clear_section_breaks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.clear_section_breaks" title="Permalink to this definition">¶</a></dt>
  517. <dd></dd></dl>
  518. <dl class="method">
  519. <dt id="webnotes.utils.transfer.UpdateDocType.fix_extra_fields">
  520. <tt class="descname">fix_extra_fields</tt><big>(</big><em>extra</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.fix_extra_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.fix_extra_fields" title="Permalink to this definition">¶</a></dt>
  521. <dd></dd></dl>
  522. <dl class="method">
  523. <dt id="webnotes.utils.transfer.UpdateDocType.get_extra_fields">
  524. <tt class="descname">get_extra_fields</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.get_extra_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.get_extra_fields" title="Permalink to this definition">¶</a></dt>
  525. <dd></dd></dl>
  526. <dl class="method">
  527. <dt id="webnotes.utils.transfer.UpdateDocType.get_id">
  528. <tt class="descname">get_id</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.get_id" title="Permalink to this definition">¶</a></dt>
  529. <dd></dd></dl>
  530. <dl class="method">
  531. <dt id="webnotes.utils.transfer.UpdateDocType.get_orignal_values">
  532. <tt class="descname">get_orignal_values</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.get_orignal_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.get_orignal_values" title="Permalink to this definition">¶</a></dt>
  533. <dd></dd></dl>
  534. <dl class="method">
  535. <dt id="webnotes.utils.transfer.UpdateDocType.on_save">
  536. <tt class="descname">on_save</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.on_save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.on_save" title="Permalink to this definition">¶</a></dt>
  537. <dd></dd></dl>
  538. <dl class="method">
  539. <dt id="webnotes.utils.transfer.UpdateDocType.renum">
  540. <tt class="descname">renum</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.renum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.renum" title="Permalink to this definition">¶</a></dt>
  541. <dd></dd></dl>
  542. <dl class="method">
  543. <dt id="webnotes.utils.transfer.UpdateDocType.to_udpate">
  544. <tt class="descname">to_udpate</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocType.to_udpate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocType.to_udpate" title="Permalink to this definition">¶</a></dt>
  545. <dd></dd></dl>
  546. </dd></dl>
  547. <dl class="class">
  548. <dt id="webnotes.utils.transfer.UpdateDocTypeMapper">
  549. <em class="property">class </em><tt class="descclassname">webnotes.utils.transfer.</tt><tt class="descname">UpdateDocTypeMapper</tt><big>(</big><em>in_doclist</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocTypeMapper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocTypeMapper" title="Permalink to this definition">¶</a></dt>
  550. <dd><p>Bases: <a class="reference internal" href="#webnotes.utils.transfer.UpdateDocumentMerge" title="webnotes.utils.transfer.UpdateDocumentMerge"><tt class="xref py py-class docutils literal"><span class="pre">webnotes.utils.transfer.UpdateDocumentMerge</span></tt></a></p>
  551. <dl class="method">
  552. <dt id="webnotes.utils.transfer.UpdateDocTypeMapper.get_id">
  553. <tt class="descname">get_id</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocTypeMapper.get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocTypeMapper.get_id" title="Permalink to this definition">¶</a></dt>
  554. <dd></dd></dl>
  555. <dl class="method">
  556. <dt id="webnotes.utils.transfer.UpdateDocTypeMapper.get_orignal_values">
  557. <tt class="descname">get_orignal_values</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocTypeMapper.get_orignal_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocTypeMapper.get_orignal_values" title="Permalink to this definition">¶</a></dt>
  558. <dd></dd></dl>
  559. </dd></dl>
  560. <dl class="class">
  561. <dt id="webnotes.utils.transfer.UpdateDocument">
  562. <em class="property">class </em><tt class="descclassname">webnotes.utils.transfer.</tt><tt class="descname">UpdateDocument</tt><big>(</big><em>in_doclist=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument" title="Permalink to this definition">¶</a></dt>
  563. <dd><dl class="method">
  564. <dt id="webnotes.utils.transfer.UpdateDocument.delete_existing">
  565. <tt class="descname">delete_existing</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.delete_existing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.delete_existing" title="Permalink to this definition">¶</a></dt>
  566. <dd></dd></dl>
  567. <dl class="method">
  568. <dt id="webnotes.utils.transfer.UpdateDocument.is_modified">
  569. <tt class="descname">is_modified</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.is_modified"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.is_modified" title="Permalink to this definition">¶</a></dt>
  570. <dd></dd></dl>
  571. <dl class="method">
  572. <dt id="webnotes.utils.transfer.UpdateDocument.run_on_update">
  573. <tt class="descname">run_on_update</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.run_on_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.run_on_update" title="Permalink to this definition">¶</a></dt>
  574. <dd></dd></dl>
  575. <dl class="method">
  576. <dt id="webnotes.utils.transfer.UpdateDocument.save">
  577. <tt class="descname">save</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.save" title="Permalink to this definition">¶</a></dt>
  578. <dd></dd></dl>
  579. <dl class="method">
  580. <dt id="webnotes.utils.transfer.UpdateDocument.save_children">
  581. <tt class="descname">save_children</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.save_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.save_children" title="Permalink to this definition">¶</a></dt>
  582. <dd></dd></dl>
  583. <dl class="method">
  584. <dt id="webnotes.utils.transfer.UpdateDocument.save_one_doc">
  585. <tt class="descname">save_one_doc</tt><big>(</big><em>df</em>, <em>as_new=1</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.save_one_doc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.save_one_doc" title="Permalink to this definition">¶</a></dt>
  586. <dd></dd></dl>
  587. <dl class="method">
  588. <dt id="webnotes.utils.transfer.UpdateDocument.sync">
  589. <tt class="descname">sync</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.sync"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.sync" title="Permalink to this definition">¶</a></dt>
  590. <dd></dd></dl>
  591. <dl class="method">
  592. <dt id="webnotes.utils.transfer.UpdateDocument.update_modified">
  593. <tt class="descname">update_modified</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocument.update_modified"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocument.update_modified" title="Permalink to this definition">¶</a></dt>
  594. <dd></dd></dl>
  595. </dd></dl>
  596. <dl class="class">
  597. <dt id="webnotes.utils.transfer.UpdateDocumentMerge">
  598. <em class="property">class </em><tt class="descclassname">webnotes.utils.transfer.</tt><tt class="descname">UpdateDocumentMerge</tt><big>(</big><em>in_doclist</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge" title="Permalink to this definition">¶</a></dt>
  599. <dd><p>Bases: <a class="reference internal" href="#webnotes.utils.transfer.UpdateDocument" title="webnotes.utils.transfer.UpdateDocument"><tt class="xref py py-class docutils literal"><span class="pre">webnotes.utils.transfer.UpdateDocument</span></tt></a></p>
  600. <dl class="method">
  601. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.child_exists">
  602. <tt class="descname">child_exists</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.child_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.child_exists" title="Permalink to this definition">¶</a></dt>
  603. <dd></dd></dl>
  604. <dl class="method">
  605. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.delete_existing">
  606. <tt class="descname">delete_existing</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.delete_existing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.delete_existing" title="Permalink to this definition">¶</a></dt>
  607. <dd></dd></dl>
  608. <dl class="method">
  609. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.get_id">
  610. <tt class="descname">get_id</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.get_id" title="Permalink to this definition">¶</a></dt>
  611. <dd></dd></dl>
  612. <dl class="method">
  613. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.keep_values">
  614. <tt class="descname">keep_values</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.keep_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.keep_values" title="Permalink to this definition">¶</a></dt>
  615. <dd></dd></dl>
  616. <dl class="method">
  617. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.on_save">
  618. <tt class="descname">on_save</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.on_save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.on_save" title="Permalink to this definition">¶</a></dt>
  619. <dd></dd></dl>
  620. <dl class="method">
  621. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.save">
  622. <tt class="descname">save</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.save" title="Permalink to this definition">¶</a></dt>
  623. <dd></dd></dl>
  624. <dl class="method">
  625. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.save_children">
  626. <tt class="descname">save_children</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.save_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.save_children" title="Permalink to this definition">¶</a></dt>
  627. <dd></dd></dl>
  628. <dl class="method">
  629. <dt id="webnotes.utils.transfer.UpdateDocumentMerge.to_update">
  630. <tt class="descname">to_update</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateDocumentMerge.to_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateDocumentMerge.to_update" title="Permalink to this definition">¶</a></dt>
  631. <dd></dd></dl>
  632. </dd></dl>
  633. <dl class="class">
  634. <dt id="webnotes.utils.transfer.UpdateModuleDef">
  635. <em class="property">class </em><tt class="descclassname">webnotes.utils.transfer.</tt><tt class="descname">UpdateModuleDef</tt><big>(</big><em>in_doclist</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateModuleDef"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateModuleDef" title="Permalink to this definition">¶</a></dt>
  636. <dd><p>Bases: <a class="reference internal" href="#webnotes.utils.transfer.UpdateDocumentMerge" title="webnotes.utils.transfer.UpdateDocumentMerge"><tt class="xref py py-class docutils literal"><span class="pre">webnotes.utils.transfer.UpdateDocumentMerge</span></tt></a></p>
  637. <dl class="method">
  638. <dt id="webnotes.utils.transfer.UpdateModuleDef.get_id">
  639. <tt class="descname">get_id</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateModuleDef.get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateModuleDef.get_id" title="Permalink to this definition">¶</a></dt>
  640. <dd></dd></dl>
  641. <dl class="method">
  642. <dt id="webnotes.utils.transfer.UpdateModuleDef.get_orignal_values">
  643. <tt class="descname">get_orignal_values</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateModuleDef.get_orignal_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateModuleDef.get_orignal_values" title="Permalink to this definition">¶</a></dt>
  644. <dd></dd></dl>
  645. <dl class="method">
  646. <dt id="webnotes.utils.transfer.UpdateModuleDef.to_update">
  647. <tt class="descname">to_update</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#UpdateModuleDef.to_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.UpdateModuleDef.to_update" title="Permalink to this definition">¶</a></dt>
  648. <dd></dd></dl>
  649. </dd></dl>
  650. <dl class="function">
  651. <dt id="webnotes.utils.transfer.set_doc">
  652. <tt class="descclassname">webnotes.utils.transfer.</tt><tt class="descname">set_doc</tt><big>(</big><em>doclist</em>, <em>ovr=0</em>, <em>ignore=1</em>, <em>onupdate=1</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/transfer.html#set_doc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.transfer.set_doc" title="Permalink to this definition">¶</a></dt>
  653. <dd></dd></dl>
  654. </div>
  655. <div class="section" id="module-webnotes.utils.webservice">
  656. <span id="webservice-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">webservice</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.webservice" title="Permalink to this headline">¶</a></h2>
  657. <dl class="class">
  658. <dt id="webnotes.utils.webservice.FrameworkServer">
  659. <em class="property">class </em><tt class="descclassname">webnotes.utils.webservice.</tt><tt class="descname">FrameworkServer</tt><big>(</big><em>remote_host</em>, <em>path</em>, <em>user=''</em>, <em>password=''</em>, <em>account=''</em>, <em>cookies=None</em>, <em>opts=None</em>, <em>https=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/webservice.html#FrameworkServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.webservice.FrameworkServer" title="Permalink to this definition">¶</a></dt>
  660. <dd><p>Connect to a remote server via HTTP (webservice).</p>
  661. <ul class="simple">
  662. <li><cite>remote_host</cite> is the the address of the remote server</li>
  663. <li><cite>path</cite> is the path of the Framework (excluding index.cgi)</li>
  664. </ul>
  665. <dl class="method">
  666. <dt id="webnotes.utils.webservice.FrameworkServer.http_get_response">
  667. <tt class="descname">http_get_response</tt><big>(</big><em>method</em>, <em>args</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/webservice.html#FrameworkServer.http_get_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.webservice.FrameworkServer.http_get_response" title="Permalink to this definition">¶</a></dt>
  668. <dd><p>Run a method on the remote server, with the given arguments</p>
  669. </dd></dl>
  670. <dl class="method">
  671. <dt id="webnotes.utils.webservice.FrameworkServer.run_method">
  672. <tt class="descname">run_method</tt><big>(</big><em>method</em>, <em>args</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/webservice.html#FrameworkServer.run_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.webservice.FrameworkServer.run_method" title="Permalink to this definition">¶</a></dt>
  673. <dd></dd></dl>
  674. <dl class="method">
  675. <dt id="webnotes.utils.webservice.FrameworkServer.runserverobj">
  676. <tt class="descname">runserverobj</tt><big>(</big><em>doctype</em>, <em>docname</em>, <em>method</em>, <em>arg=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/webservice.html#FrameworkServer.runserverobj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.webservice.FrameworkServer.runserverobj" title="Permalink to this definition">¶</a></dt>
  677. <dd><p>Returns the response of a remote method called on a system object specified by <cite>doctype</cite> and <cite>docname</cite></p>
  678. </dd></dl>
  679. </dd></dl>
  680. </div>
  681. <div class="section" id="subpackages">
  682. <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
  683. <div class="toctree-wrapper compound">
  684. <ul>
  685. <li class="toctree-l1"><a class="reference internal" href="webnotes.utils.email_lib.html">email_lib Package</a><ul>
  686. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.email_lib.html#id1"><tt class="docutils literal"><span class="pre">email_lib</span></tt> Package</a></li>
  687. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.form_email"><tt class="docutils literal"><span class="pre">form_email</span></tt> Module</a></li>
  688. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.html2text"><tt class="docutils literal"><span class="pre">html2text</span></tt> Module</a></li>
  689. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.receive"><tt class="docutils literal"><span class="pre">receive</span></tt> Module</a></li>
  690. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.send"><tt class="docutils literal"><span class="pre">send</span></tt> Module</a></li>
  691. </ul>
  692. </li>
  693. </ul>
  694. </div>
  695. </div>
  696. </div>
  697. </div>
  698. </div>
  699. </div>
  700. <div class="sphinxsidebar">
  701. <div class="sphinxsidebarwrapper">
  702. <p class="logo"><a href="index.html">
  703. <img class="logo" src="_static/wnflogo200.gif" alt="Logo"/>
  704. </a></p>
  705. <h3><a href="index.html">Table Of Contents</a></h3>
  706. <ul>
  707. <li><a class="reference internal" href="#">utils Package</a><ul>
  708. <li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">utils</span></tt> Package</a></li>
  709. <li><a class="reference internal" href="#archive-module"><tt class="docutils literal"><span class="pre">archive</span></tt> Module</a></li>
  710. <li><a class="reference internal" href="#backups-module"><tt class="docutils literal"><span class="pre">backups</span></tt> Module</a></li>
  711. <li><a class="reference internal" href="#module-webnotes.utils.cache"><tt class="docutils literal"><span class="pre">cache</span></tt> Module</a></li>
  712. <li><a class="reference internal" href="#module-webnotes.utils.encrypt"><tt class="docutils literal"><span class="pre">encrypt</span></tt> Module</a></li>
  713. <li><a class="reference internal" href="#module-webnotes.utils.file_manager"><tt class="docutils literal"><span class="pre">file_manager</span></tt> Module</a></li>
  714. <li><a class="reference internal" href="#module-webnotes.utils.jsmin"><tt class="docutils literal"><span class="pre">jsmin</span></tt> Module</a></li>
  715. <li><a class="reference internal" href="#module-webnotes.utils.nestedset"><tt class="docutils literal"><span class="pre">nestedset</span></tt> Module</a></li>
  716. <li><a class="reference internal" href="#module-webnotes.utils.scheduler"><tt class="docutils literal"><span class="pre">scheduler</span></tt> Module</a><ul>
  717. <li><a class="reference internal" href="#to-install">To install:</a></li>
  718. <li><a class="reference internal" href="#in-cron">In cron:</a></li>
  719. </ul>
  720. </li>
  721. <li><a class="reference internal" href="#module-webnotes.utils.sitemap"><tt class="docutils literal"><span class="pre">sitemap</span></tt> Module</a></li>
  722. <li><a class="reference internal" href="#module-webnotes.utils.transfer"><tt class="docutils literal"><span class="pre">transfer</span></tt> Module</a></li>
  723. <li><a class="reference internal" href="#module-webnotes.utils.webservice"><tt class="docutils literal"><span class="pre">webservice</span></tt> Module</a></li>
  724. <li><a class="reference internal" href="#subpackages">Subpackages</a><ul>
  725. </ul>
  726. </li>
  727. </ul>
  728. </li>
  729. </ul>
  730. <h4>Previous topic</h4>
  731. <p class="topless"><a href="webnotes.multi_tenant.html"
  732. title="previous chapter">multi_tenant Package</a></p>
  733. <h4>Next topic</h4>
  734. <p class="topless"><a href="webnotes.utils.email_lib.html"
  735. title="next chapter">email_lib Package</a></p>
  736. <h3>This Page</h3>
  737. <ul class="this-page-menu">
  738. <li><a href="_sources/webnotes.utils.txt"
  739. rel="nofollow">Show Source</a></li>
  740. </ul>
  741. <div id="searchbox" style="display: none">
  742. <h3>Quick search</h3>
  743. <form class="search" action="search.html" method="get">
  744. <input type="text" name="q" size="18" />
  745. <input type="submit" value="Go" />
  746. <input type="hidden" name="check_keywords" value="yes" />
  747. <input type="hidden" name="area" value="default" />
  748. </form>
  749. <p class="searchtip" style="font-size: 90%">
  750. Enter search terms or a module, class or function name.
  751. </p>
  752. </div>
  753. <script type="text/javascript">$('#searchbox').show(0);</script>
  754. </div>
  755. </div>
  756. <div class="clearer"></div>
  757. </div>
  758. <div class="related">
  759. <h3>Navigation</h3>
  760. <ul>
  761. <li class="right" style="margin-right: 10px">
  762. <a href="genindex.html" title="General Index"
  763. >index</a></li>
  764. <li class="right" >
  765. <a href="py-modindex.html" title="Python Module Index"
  766. >modules</a> |</li>
  767. <li class="right" >
  768. <a href="webnotes.utils.email_lib.html" title="email_lib Package"
  769. >next</a> |</li>
  770. <li class="right" >
  771. <a href="webnotes.multi_tenant.html" title="multi_tenant Package"
  772. >previous</a> |</li>
  773. <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li>
  774. <li><a href="webnotes.html" >webnotes Package</a> &raquo;</li>
  775. </ul>
  776. </div>
  777. <div class="footer">
  778. &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
  779. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
  780. </div>
  781. </body>
  782. </html>