anoopmb
/
frappe
1
0
Fork 0
Código Incidencias 0 Pull Requests 0 Lanzamientos 0 Wiki Actividad
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
314 Commits
1 Rama
314 MiB
 
 
 
 
 
 
Árbol: f97604bd61
Ramas Etiquetas
${ item.name }
Crear rama ${ searchTerm }
desde 'f97604bd61'
${ noResults }
frappe/docs/_build/html/webnotes.html

911 líneas
71 KiB
Original Blame Histórico 

  1. 

  2. 

  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  4.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  5. 

  6. <html xmlns="http://www.w3.org/1999/xhtml">

  7.   <head>

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  9.     

  10.     <title>webnotes Package &mdash; WNFramework v1.8 documentation</title>

  11.     <link rel="stylesheet" href="_static/default.css" type="text/css" />

  12.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  13.     <script type="text/javascript">

  14.       var DOCUMENTATION_OPTIONS = {

  15.         URL_ROOT:    '',

  16.         VERSION:     '1.8',

  17.         COLLAPSE_INDEX: false,

  18.         FILE_SUFFIX: '.html',

  19.         HAS_SOURCE:  true

  20.       };

  21.     </script>

  22.     <script type="text/javascript" src="_static/jquery.js"></script>

  23.     <script type="text/javascript" src="_static/underscore.js"></script>

  24.     <script type="text/javascript" src="_static/doctools.js"></script>

  25.     <link rel="top" title="WNFramework v1.8 documentation" href="index.html" />

  26.     <link rel="next" title="install_lib Package" href="webnotes.install_lib.html" />

  27.     <link rel="prev" title="page Package" href="core.page.html" /> 

  28.   </head>

  29.   <body>

  30.     <div class="related">

  31.       <h3>Navigation</h3>

  32.       <ul>

  33.         <li class="right" style="margin-right: 10px">

  34.           <a href="genindex.html" title="General Index"

  35.              accesskey="I">index</a></li>

  36.         <li class="right" >

  37.           <a href="py-modindex.html" title="Python Module Index"

  38.              >modules</a> |</li>

  39.         <li class="right" >

  40.           <a href="webnotes.install_lib.html" title="install_lib Package"

  41.              accesskey="N">next</a> |</li>

  42.         <li class="right" >

  43.           <a href="core.page.html" title="page Package"

  44.              accesskey="P">previous</a> |</li>

  45.         <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 

  46.       </ul>

  47.     </div>  

  48. 

  49.     <div class="document">

  50.       <div class="documentwrapper">

  51.         <div class="bodywrapper">

  52.           <div class="body">

  53.             

  54.   <div class="section" id="webnotes-package">

  55. <h1>webnotes Package<a class="headerlink" href="#webnotes-package" title="Permalink to this headline">¶</a></h1>

  56. <div class="section" id="id1">

  57. <h2><a class="reference internal" href="#module-webnotes" title="webnotes"><tt class="xref py py-mod docutils literal"><span class="pre">webnotes</span></tt></a> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>

  58. <span class="target" id="module-webnotes"></span><dl class="exception">

  59. <dt id="webnotes.ValidationError">

  60. <em class="property">exception </em><tt class="descclassname">webnotes.</tt><tt class="descname">ValidationError</tt><a class="reference internal" href="_modules/webnotes.html#ValidationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.ValidationError" title="Permalink to this definition">¶</a></dt>

  61. <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>

  62. </dd></dl>

  63. 

  64. <dl class="data">

  65. <dt id="webnotes.add_cookies">

  66. <tt class="descclassname">webnotes.</tt><tt class="descname">add_cookies</tt><a class="headerlink" href="#webnotes.add_cookies" title="Permalink to this definition">¶</a></dt>

  67. <dd><p>Dictionary of additional cookies appended by custom code</p>

  68. </dd></dl>

  69. 

  70. <dl class="data">

  71. <dt id="webnotes.conn">

  72. <tt class="descclassname">webnotes.</tt><tt class="descname">conn</tt><a class="headerlink" href="#webnotes.conn" title="Permalink to this definition">¶</a></dt>

  73. <dd><p>The database connection <a class="reference internal" href="#webnotes.db.Database" title="webnotes.db.Database"><tt class="xref py py-class docutils literal"><span class="pre">webnotes.db.Database</span></tt></a> setup by <tt class="xref py py-mod docutils literal"><span class="pre">auth</span></tt></p>

  74. </dd></dl>

  75. 

  76. <dl class="function">

  77. <dt id="webnotes.create_folder">

  78. <tt class="descclassname">webnotes.</tt><tt class="descname">create_folder</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="_modules/webnotes.html#create_folder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.create_folder" title="Permalink to this definition">¶</a></dt>

  79. <dd><p>Wrapper function for os.makedirs (does not throw exception if directory exists)</p>

  80. </dd></dl>

  81. 

  82. <dl class="data">

  83. <dt id="webnotes.debug_log">

  84. <tt class="descclassname">webnotes.</tt><tt class="descname">debug_log</tt><a class="headerlink" href="#webnotes.debug_log" title="Permalink to this definition">¶</a></dt>

  85. <dd><p>List of exceptions to be shown in the <em class="xref std std-term">Error Console</em></p>

  86. </dd></dl>

  87. 

  88. <dl class="function">

  89. <dt id="webnotes.errprint">

  90. <tt class="descclassname">webnotes.</tt><tt class="descname">errprint</tt><big>(</big><em>msg</em><big>)</big><a class="reference internal" href="_modules/webnotes.html#errprint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.errprint" title="Permalink to this definition">¶</a></dt>

  91. <dd><p>Append to the <tt class="xref py py-data docutils literal"><span class="pre">debug</span> <span class="pre">log</span></tt></p>

  92. </dd></dl>

  93. 

  94. <dl class="data">

  95. <dt id="webnotes.form">

  96. <tt class="descclassname">webnotes.</tt><tt class="descname">form</tt><a class="headerlink" href="#webnotes.form" title="Permalink to this definition">¶</a></dt>

  97. <dd><p>The cgi.FieldStorage() object (Dictionary representing the formdata from the URL)</p>

  98. </dd></dl>

  99. 

  100. <dl class="function">

  101. <dt id="webnotes.getTraceback">

  102. <tt class="descclassname">webnotes.</tt><tt class="descname">getTraceback</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#getTraceback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.getTraceback" title="Permalink to this definition">¶</a></dt>

  103. <dd></dd></dl>

  104. 

  105. <dl class="function">

  106. <dt id="webnotes.get_env_vars">

  107. <tt class="descclassname">webnotes.</tt><tt class="descname">get_env_vars</tt><big>(</big><em>env_var</em><big>)</big><a class="reference internal" href="_modules/webnotes.html#get_env_vars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.get_env_vars" title="Permalink to this definition">¶</a></dt>

  108. <dd></dd></dl>

  109. 

  110. <dl class="function">

  111. <dt id="webnotes.get_files_path">

  112. <tt class="descclassname">webnotes.</tt><tt class="descname">get_files_path</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#get_files_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.get_files_path" title="Permalink to this definition">¶</a></dt>

  113. <dd></dd></dl>

  114. 

  115. <dl class="function">

  116. <dt id="webnotes.get_index_path">

  117. <tt class="descclassname">webnotes.</tt><tt class="descname">get_index_path</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#get_index_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.get_index_path" title="Permalink to this definition">¶</a></dt>

  118. <dd></dd></dl>

  119. 

  120. <dl class="function">

  121. <dt id="webnotes.is_apache_user">

  122. <tt class="descclassname">webnotes.</tt><tt class="descname">is_apache_user</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#is_apache_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.is_apache_user" title="Permalink to this definition">¶</a></dt>

  123. <dd></dd></dl>

  124. 

  125. <dl class="data">

  126. <dt id="webnotes.is_testing">

  127. <tt class="descclassname">webnotes.</tt><tt class="descname">is_testing</tt><a class="headerlink" href="#webnotes.is_testing" title="Permalink to this definition">¶</a></dt>

  128. <dd><p>Flag to identify if system is in <em class="xref std std-term">Testing Mode</em></p>

  129. </dd></dl>

  130. 

  131. <dl class="data">

  132. <dt id="webnotes.message_log">

  133. <tt class="descclassname">webnotes.</tt><tt class="descname">message_log</tt><a class="headerlink" href="#webnotes.message_log" title="Permalink to this definition">¶</a></dt>

  134. <dd><p>List of messages to be shown to the user in a popup box at the end of the request</p>

  135. </dd></dl>

  136. 

  137. <dl class="function">

  138. <dt id="webnotes.msgprint">

  139. <tt class="descclassname">webnotes.</tt><tt class="descname">msgprint</tt><big>(</big><em>msg</em>, <em>small=0</em>, <em>raise_exception=0</em><big>)</big><a class="reference internal" href="_modules/webnotes.html#msgprint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.msgprint" title="Permalink to this definition">¶</a></dt>

  140. <dd><p>Append to the <a class="reference internal" href="#webnotes.message_log" title="webnotes.message_log"><tt class="xref py py-data docutils literal"><span class="pre">message_log</span></tt></a></p>

  141. </dd></dl>

  142. 

  143. <dl class="data">

  144. <dt id="webnotes.response">

  145. <tt class="descclassname">webnotes.</tt><tt class="descname">response</tt><a class="headerlink" href="#webnotes.response" title="Permalink to this definition">¶</a></dt>

  146. <dd><p>The JSON response object. Default is:</p>

  147. <div class="highlight-python"><div class="highlight"><pre><span class="p">{</span><span class="s">&#39;message&#39;</span><span class="p">:</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="s">&#39;exc&#39;</span><span class="p">:</span><span class="s">&#39;&#39;</span><span class="p">}</span>

  148. </pre></div>

  149. </div>

  150. </dd></dl>

  151. 

  152. <dl class="data">

  153. <dt id="webnotes.session">

  154. <tt class="descclassname">webnotes.</tt><tt class="descname">session</tt><a class="headerlink" href="#webnotes.session" title="Permalink to this definition">¶</a></dt>

  155. <dd><p>Global session dictionary.</p>

  156. <ul class="simple">

  157. <li>session[&#8216;user&#8217;] - Current user</li>

  158. <li>session[&#8216;data&#8217;] - Returns a dictionary of the session cache</li>

  159. </ul>

  160. </dd></dl>

  161. 

  162. <dl class="function">

  163. <dt id="webnotes.set_as_account_master">

  164. <tt class="descclassname">webnotes.</tt><tt class="descname">set_as_account_master</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#set_as_account_master"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.set_as_account_master" title="Permalink to this definition">¶</a></dt>

  165. <dd></dd></dl>

  166. 

  167. <dl class="function">

  168. <dt id="webnotes.set_as_admin">

  169. <tt class="descclassname">webnotes.</tt><tt class="descname">set_as_admin</tt><big>(</big><em>db_name=None</em>, <em>ac_name=None</em><big>)</big><a class="reference internal" href="_modules/webnotes.html#set_as_admin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.set_as_admin" title="Permalink to this definition">¶</a></dt>

  170. <dd></dd></dl>

  171. 

  172. <dl class="function">

  173. <dt id="webnotes.set_as_admin_session">

  174. <tt class="descclassname">webnotes.</tt><tt class="descname">set_as_admin_session</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#set_as_admin_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.set_as_admin_session" title="Permalink to this definition">¶</a></dt>

  175. <dd></dd></dl>

  176. 

  177. <dl class="function">

  178. <dt id="webnotes.set_as_administrator">

  179. <tt class="descclassname">webnotes.</tt><tt class="descname">set_as_administrator</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#set_as_administrator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.set_as_administrator" title="Permalink to this definition">¶</a></dt>

  180. <dd></dd></dl>

  181. 

  182. <dl class="function">

  183. <dt id="webnotes.setup_logging">

  184. <tt class="descclassname">webnotes.</tt><tt class="descname">setup_logging</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes.html#setup_logging"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.setup_logging" title="Permalink to this definition">¶</a></dt>

  185. <dd></dd></dl>

  186. 

  187. <dl class="data">

  188. <dt id="webnotes.version">

  189. <tt class="descclassname">webnotes.</tt><tt class="descname">version</tt><a class="headerlink" href="#webnotes.version" title="Permalink to this definition">¶</a></dt>

  190. <dd><p>&#8220;v170&#8221;</p>

  191. </dd></dl>

  192. 

  193. </div>

  194. <div class="section" id="module-webnotes.auth">

  195. <span id="auth-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">auth</span></tt> Module<a class="headerlink" href="#module-webnotes.auth" title="Permalink to this headline">¶</a></h2>

  196. <dl class="class">

  197. <dt id="webnotes.auth.CookieManager">

  198. <em class="property">class </em><tt class="descclassname">webnotes.auth.</tt><tt class="descname">CookieManager</tt><a class="reference internal" href="_modules/webnotes/auth.html#CookieManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.CookieManager" title="Permalink to this definition">¶</a></dt>

  199. <dd><dl class="method">

  200. <dt id="webnotes.auth.CookieManager.get_incoming_cookies">

  201. <tt class="descname">get_incoming_cookies</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#CookieManager.get_incoming_cookies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.CookieManager.get_incoming_cookies" title="Permalink to this definition">¶</a></dt>

  202. <dd></dd></dl>

  203. 

  204. <dl class="method">

  205. <dt id="webnotes.auth.CookieManager.set_cookies">

  206. <tt class="descname">set_cookies</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#CookieManager.set_cookies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.CookieManager.set_cookies" title="Permalink to this definition">¶</a></dt>

  207. <dd></dd></dl>

  208. 

  209. <dl class="method">

  210. <dt id="webnotes.auth.CookieManager.set_remember_me">

  211. <tt class="descname">set_remember_me</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#CookieManager.set_remember_me"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.CookieManager.set_remember_me" title="Permalink to this definition">¶</a></dt>

  212. <dd></dd></dl>

  213. 

  214. </dd></dl>

  215. 

  216. <dl class="class">

  217. <dt id="webnotes.auth.HTTPRequest">

  218. <em class="property">class </em><tt class="descclassname">webnotes.auth.</tt><tt class="descname">HTTPRequest</tt><a class="reference internal" href="_modules/webnotes/auth.html#HTTPRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.HTTPRequest" title="Permalink to this definition">¶</a></dt>

  219. <dd><dl class="method">

  220. <dt id="webnotes.auth.HTTPRequest.get_ac_name">

  221. <tt class="descname">get_ac_name</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#HTTPRequest.get_ac_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.HTTPRequest.get_ac_name" title="Permalink to this definition">¶</a></dt>

  222. <dd></dd></dl>

  223. 

  224. <dl class="method">

  225. <dt id="webnotes.auth.HTTPRequest.set_db">

  226. <tt class="descname">set_db</tt><big>(</big><em>ac_name=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#HTTPRequest.set_db"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.HTTPRequest.set_db" title="Permalink to this definition">¶</a></dt>

  227. <dd></dd></dl>

  228. 

  229. <dl class="method">

  230. <dt id="webnotes.auth.HTTPRequest.setup_profile">

  231. <tt class="descname">setup_profile</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#HTTPRequest.setup_profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.HTTPRequest.setup_profile" title="Permalink to this definition">¶</a></dt>

  232. <dd></dd></dl>

  233. 

  234. </dd></dl>

  235. 

  236. <dl class="class">

  237. <dt id="webnotes.auth.LoginManager">

  238. <em class="property">class </em><tt class="descclassname">webnotes.auth.</tt><tt class="descname">LoginManager</tt><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager" title="Permalink to this definition">¶</a></dt>

  239. <dd><dl class="method">

  240. <dt id="webnotes.auth.LoginManager.authenticate">

  241. <tt class="descname">authenticate</tt><big>(</big><em>user=None</em>, <em>pwd=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.authenticate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.authenticate" title="Permalink to this definition">¶</a></dt>

  242. <dd></dd></dl>

  243. 

  244. <dl class="method">

  245. <dt id="webnotes.auth.LoginManager.call_on_logout_event">

  246. <tt class="descname">call_on_logout_event</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.call_on_logout_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.call_on_logout_event" title="Permalink to this definition">¶</a></dt>

  247. <dd></dd></dl>

  248. 

  249. <dl class="method">

  250. <dt id="webnotes.auth.LoginManager.load_control_panel">

  251. <tt class="descname">load_control_panel</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.load_control_panel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.load_control_panel" title="Permalink to this definition">¶</a></dt>

  252. <dd></dd></dl>

  253. 

  254. <dl class="method">

  255. <dt id="webnotes.auth.LoginManager.login_as_guest">

  256. <tt class="descname">login_as_guest</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.login_as_guest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.login_as_guest" title="Permalink to this definition">¶</a></dt>

  257. <dd></dd></dl>

  258. 

  259. <dl class="method">

  260. <dt id="webnotes.auth.LoginManager.logout">

  261. <tt class="descname">logout</tt><big>(</big><em>arg=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.logout" title="Permalink to this definition">¶</a></dt>

  262. <dd></dd></dl>

  263. 

  264. <dl class="method">

  265. <dt id="webnotes.auth.LoginManager.post_login">

  266. <tt class="descname">post_login</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.post_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.post_login" title="Permalink to this definition">¶</a></dt>

  267. <dd></dd></dl>

  268. 

  269. <dl class="method">

  270. <dt id="webnotes.auth.LoginManager.run_trigger">

  271. <tt class="descname">run_trigger</tt><big>(</big><em>method='on_login'</em><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.run_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.run_trigger" title="Permalink to this definition">¶</a></dt>

  272. <dd></dd></dl>

  273. 

  274. <dl class="method">

  275. <dt id="webnotes.auth.LoginManager.validate_ip_address">

  276. <tt class="descname">validate_ip_address</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#LoginManager.validate_ip_address"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.LoginManager.validate_ip_address" title="Permalink to this definition">¶</a></dt>

  277. <dd></dd></dl>

  278. 

  279. </dd></dl>

  280. 

  281. <dl class="class">

  282. <dt id="webnotes.auth.Session">

  283. <em class="property">class </em><tt class="descclassname">webnotes.auth.</tt><tt class="descname">Session</tt><big>(</big><em>user=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session" title="Permalink to this definition">¶</a></dt>

  284. <dd><dl class="method">

  285. <dt id="webnotes.auth.Session.add_status_column">

  286. <tt class="descname">add_status_column</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.add_status_column"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.add_status_column" title="Permalink to this definition">¶</a></dt>

  287. <dd></dd></dl>

  288. 

  289. <dl class="method">

  290. <dt id="webnotes.auth.Session.check_expired">

  291. <tt class="descname">check_expired</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.check_expired"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.check_expired" title="Permalink to this definition">¶</a></dt>

  292. <dd></dd></dl>

  293. 

  294. <dl class="method">

  295. <dt id="webnotes.auth.Session.get_ipinfo">

  296. <tt class="descname">get_ipinfo</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.get_ipinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.get_ipinfo" title="Permalink to this definition">¶</a></dt>

  297. <dd></dd></dl>

  298. 

  299. <dl class="method">

  300. <dt id="webnotes.auth.Session.insert_session_record">

  301. <tt class="descname">insert_session_record</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.insert_session_record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.insert_session_record" title="Permalink to this definition">¶</a></dt>

  302. <dd></dd></dl>

  303. 

  304. <dl class="method">

  305. <dt id="webnotes.auth.Session.load">

  306. <tt class="descname">load</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.load" title="Permalink to this definition">¶</a></dt>

  307. <dd></dd></dl>

  308. 

  309. <dl class="method">

  310. <dt id="webnotes.auth.Session.resume">

  311. <tt class="descname">resume</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.resume"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.resume" title="Permalink to this definition">¶</a></dt>

  312. <dd></dd></dl>

  313. 

  314. <dl class="method">

  315. <dt id="webnotes.auth.Session.start">

  316. <tt class="descname">start</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.start" title="Permalink to this definition">¶</a></dt>

  317. <dd></dd></dl>

  318. 

  319. <dl class="method">

  320. <dt id="webnotes.auth.Session.update">

  321. <tt class="descname">update</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/auth.html#Session.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.auth.Session.update" title="Permalink to this definition">¶</a></dt>

  322. <dd></dd></dl>

  323. 

  324. </dd></dl>

  325. 

  326. </div>

  327. <div class="section" id="module-webnotes.db">

  328. <span id="db-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">db</span></tt> Module<a class="headerlink" href="#module-webnotes.db" title="Permalink to this headline">¶</a></h2>

  329. <dl class="class">

  330. <dt id="webnotes.db.Database">

  331. <em class="property">class </em><tt class="descclassname">webnotes.db.</tt><tt class="descname">Database</tt><big>(</big><em>host=''</em>, <em>user=''</em>, <em>password=''</em>, <em>ac_name=''</em>, <em>use_default=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database" title="Permalink to this definition">¶</a></dt>

  332. <dd><p>Open a database connection with the given parmeters, if use_default is True, use the

  333. login details from <cite>defs.py</cite>. This is called by the request handler and is accessible using

  334. the <cite>conn</cite> global variable. the <cite>sql</cite> method is also global to run queries</p>

  335. <dl class="method">

  336. <dt id="webnotes.db.Database.add_multi_tenant_condition">

  337. <tt class="descname">add_multi_tenant_condition</tt><big>(</big><em>query</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.add_multi_tenant_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.add_multi_tenant_condition" title="Permalink to this definition">¶</a></dt>

  338. <dd></dd></dl>

  339. 

  340. <dl class="method">

  341. <dt id="webnotes.db.Database.begin">

  342. <tt class="descname">begin</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.begin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.begin" title="Permalink to this definition">¶</a></dt>

  343. <dd></dd></dl>

  344. 

  345. <dl class="method">

  346. <dt id="webnotes.db.Database.check_transaction_status">

  347. <tt class="descname">check_transaction_status</tt><big>(</big><em>query</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.check_transaction_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.check_transaction_status" title="Permalink to this definition">¶</a></dt>

  348. <dd><p>Update <em>in_transaction</em> and check if &#8220;START TRANSACTION&#8221; is not called twice</p>

  349. </dd></dl>

  350. 

  351. <dl class="method">

  352. <dt id="webnotes.db.Database.close">

  353. <tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.close" title="Permalink to this definition">¶</a></dt>

  354. <dd><p>Close my connection</p>

  355. </dd></dl>

  356. 

  357. <dl class="method">

  358. <dt id="webnotes.db.Database.commit">

  359. <tt class="descname">commit</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.commit" title="Permalink to this definition">¶</a></dt>

  360. <dd></dd></dl>

  361. 

  362. <dl class="method">

  363. <dt id="webnotes.db.Database.connect">

  364. <tt class="descname">connect</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.connect" title="Permalink to this definition">¶</a></dt>

  365. <dd><p>Connect to a database</p>

  366. </dd></dl>

  367. 

  368. <dl class="method">

  369. <dt id="webnotes.db.Database.convert_to_lists">

  370. <tt class="descname">convert_to_lists</tt><big>(</big><em>res</em>, <em>formatted=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.convert_to_lists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.convert_to_lists" title="Permalink to this definition">¶</a></dt>

  371. <dd><p>Convert the given result set to a list of lists (with cleaned up dates and decimals)</p>

  372. </dd></dl>

  373. 

  374. <dl class="method">

  375. <dt id="webnotes.db.Database.convert_to_simple_type">

  376. <tt class="descname">convert_to_simple_type</tt><big>(</big><em>v</em>, <em>formatted=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.convert_to_simple_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.convert_to_simple_type" title="Permalink to this definition">¶</a></dt>

  377. <dd></dd></dl>

  378. 

  379. <dl class="method">

  380. <dt id="webnotes.db.Database.exists">

  381. <tt class="descname">exists</tt><big>(</big><em>dt</em>, <em>dn</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.exists" title="Permalink to this definition">¶</a></dt>

  382. <dd><p>Returns true if the record exists</p>

  383. </dd></dl>

  384. 

  385. <dl class="method">

  386. <dt id="webnotes.db.Database.fetch_as_dict">

  387. <tt class="descname">fetch_as_dict</tt><big>(</big><em>formatted=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.fetch_as_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.fetch_as_dict" title="Permalink to this definition">¶</a></dt>

  388. <dd><p>Internal - get results as dictionary</p>

  389. </dd></dl>

  390. 

  391. <dl class="method">

  392. <dt id="webnotes.db.Database.field_exists">

  393. <tt class="descname">field_exists</tt><big>(</big><em>dt</em>, <em>fn</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.field_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.field_exists" title="Permalink to this definition">¶</a></dt>

  394. <dd><p>Returns True if <cite>fn</cite> exists in <cite>DocType</cite> <cite>dt</cite></p>

  395. </dd></dl>

  396. 

  397. <dl class="method">

  398. <dt id="webnotes.db.Database.get_db_login">

  399. <tt class="descname">get_db_login</tt><big>(</big><em>ac_name</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.get_db_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.get_db_login" title="Permalink to this definition">¶</a></dt>

  400. <dd></dd></dl>

  401. 

  402. <dl class="method">

  403. <dt id="webnotes.db.Database.get_description">

  404. <tt class="descname">get_description</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.get_description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.get_description" title="Permalink to this definition">¶</a></dt>

  405. <dd><p>Get metadata of the last query</p>

  406. </dd></dl>

  407. 

  408. <dl class="method">

  409. <dt id="webnotes.db.Database.get_global">

  410. <tt class="descname">get_global</tt><big>(</big><em>key</em>, <em>user='__global'</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.get_global"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.get_global" title="Permalink to this definition">¶</a></dt>

  411. <dd></dd></dl>

  412. 

  413. <dl class="method">

  414. <dt id="webnotes.db.Database.get_testing_tables">

  415. <tt class="descname">get_testing_tables</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.get_testing_tables"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.get_testing_tables" title="Permalink to this definition">¶</a></dt>

  416. <dd><p>Get list of all tables for which <cite>tab</cite> is to be replaced by <cite>test</cite> before a query is executed</p>

  417. </dd></dl>

  418. 

  419. <dl class="method">

  420. <dt id="webnotes.db.Database.get_value">

  421. <tt class="descname">get_value</tt><big>(</big><em>doctype</em>, <em>docname</em>, <em>fieldname</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.get_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.get_value" title="Permalink to this definition">¶</a></dt>

  422. <dd><p>Get a single / multiple value from a record.</p>

  423. <p>For Single DocType, let docname be = None</p>

  424. </dd></dl>

  425. 

  426. <dl class="method">

  427. <dt id="webnotes.db.Database.replace_tab_by_test">

  428. <tt class="descname">replace_tab_by_test</tt><big>(</big><em>query</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.replace_tab_by_test"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.replace_tab_by_test" title="Permalink to this definition">¶</a></dt>

  429. <dd><p>Relace all <tt class="docutils literal"><span class="pre">tab</span></tt> + doctype to <tt class="docutils literal"><span class="pre">test</span></tt> + doctype</p>

  430. </dd></dl>

  431. 

  432. <dl class="method">

  433. <dt id="webnotes.db.Database.rollback">

  434. <tt class="descname">rollback</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.rollback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.rollback" title="Permalink to this definition">¶</a></dt>

  435. <dd></dd></dl>

  436. 

  437. <dl class="method">

  438. <dt id="webnotes.db.Database.set">

  439. <tt class="descname">set</tt><big>(</big><em>doc</em>, <em>field</em>, <em>val</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.set" title="Permalink to this definition">¶</a></dt>

  440. <dd></dd></dl>

  441. 

  442. <dl class="method">

  443. <dt id="webnotes.db.Database.set_global">

  444. <tt class="descname">set_global</tt><big>(</big><em>key</em>, <em>val</em>, <em>user='__global'</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.set_global"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.set_global" title="Permalink to this definition">¶</a></dt>

  445. <dd></dd></dl>

  446. 

  447. <dl class="method">

  448. <dt id="webnotes.db.Database.set_value">

  449. <tt class="descname">set_value</tt><big>(</big><em>dt</em>, <em>dn</em>, <em>field</em>, <em>val</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.set_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.set_value" title="Permalink to this definition">¶</a></dt>

  450. <dd></dd></dl>

  451. 

  452. <dl class="method">

  453. <dt id="webnotes.db.Database.sql">

  454. <tt class="descname">sql</tt><big>(</big><em>query</em>, <em>values=()</em>, <em>as_dict=0</em>, <em>as_list=0</em>, <em>formatted=0</em>, <em>ignore_no_table=1</em>, <em>debug=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.sql"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.sql" title="Permalink to this definition">¶</a></dt>

  455. <dd><ul class="simple">

  456. <li>Execute a <cite>query</cite>, with given <cite>values</cite></li>

  457. <li>returns as a dictionary if as_dict = 1</li>

  458. <li>returns as a list of lists (with cleaned up dates and decimals) if as_list = 1</li>

  459. </ul>

  460. </dd></dl>

  461. 

  462. <dl class="method">

  463. <dt id="webnotes.db.Database.use">

  464. <tt class="descname">use</tt><big>(</big><em>db_name</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.use" title="Permalink to this definition">¶</a></dt>

  465. <dd><p><cite>USE</cite> db_name</p>

  466. </dd></dl>

  467. 

  468. <dl class="method">

  469. <dt id="webnotes.db.Database.validate_query">

  470. <tt class="descname">validate_query</tt><big>(</big><em>q</em><big>)</big><a class="reference internal" href="_modules/webnotes/db.html#Database.validate_query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.db.Database.validate_query" title="Permalink to this definition">¶</a></dt>

  471. <dd></dd></dl>

  472. 

  473. </dd></dl>

  474. 

  475. </div>

  476. <div class="section" id="module-webnotes.defs">

  477. <span id="defs-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">defs</span></tt> Module<a class="headerlink" href="#module-webnotes.defs" title="Permalink to this headline">¶</a></h2>

  478. </div>

  479. <div class="section" id="module-webnotes.defs_template">

  480. <span id="defs-template-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">defs_template</span></tt> Module<a class="headerlink" href="#module-webnotes.defs_template" title="Permalink to this headline">¶</a></h2>

  481. </div>

  482. <div class="section" id="module-webnotes.handler">

  483. <span id="handler-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">handler</span></tt> Module<a class="headerlink" href="#module-webnotes.handler" title="Permalink to this headline">¶</a></h2>

  484. <dl class="function">

  485. <dt id="webnotes.handler.backupdb">

  486. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">backupdb</tt><big>(</big><em>form_dict</em>, <em>session</em><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#backupdb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.backupdb" title="Permalink to this definition">¶</a></dt>

  487. <dd></dd></dl>

  488. 

  489. <dl class="function">

  490. <dt id="webnotes.handler.cleanup_docs">

  491. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">cleanup_docs</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#cleanup_docs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.cleanup_docs" title="Permalink to this definition">¶</a></dt>

  492. <dd></dd></dl>

  493. 

  494. <dl class="function">

  495. <dt id="webnotes.handler.compressBuf">

  496. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">compressBuf</tt><big>(</big><em>buf</em><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#compressBuf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.compressBuf" title="Permalink to this definition">¶</a></dt>

  497. <dd></dd></dl>

  498. 

  499. <dl class="function">

  500. <dt id="webnotes.handler.dt_map">

  501. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">dt_map</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#dt_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.dt_map" title="Permalink to this definition">¶</a></dt>

  502. <dd></dd></dl>

  503. 

  504. <dl class="function">

  505. <dt id="webnotes.handler.get_file">

  506. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">get_file</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#get_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.get_file" title="Permalink to this definition">¶</a></dt>

  507. <dd></dd></dl>

  508. 

  509. <dl class="function">

  510. <dt id="webnotes.handler.get_graph">

  511. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">get_graph</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#get_graph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.get_graph" title="Permalink to this definition">¶</a></dt>

  512. <dd></dd></dl>

  513. 

  514. <dl class="function">

  515. <dt id="webnotes.handler.get_template">

  516. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">get_template</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#get_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.get_template" title="Permalink to this definition">¶</a></dt>

  517. <dd></dd></dl>

  518. 

  519. <dl class="function">

  520. <dt id="webnotes.handler.import_csv">

  521. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">import_csv</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#import_csv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.import_csv" title="Permalink to this definition">¶</a></dt>

  522. <dd></dd></dl>

  523. 

  524. <dl class="function">

  525. <dt id="webnotes.handler.load_month_events">

  526. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">load_month_events</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#load_month_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.load_month_events" title="Permalink to this definition">¶</a></dt>

  527. <dd></dd></dl>

  528. 

  529. <dl class="function">

  530. <dt id="webnotes.handler.logout">

  531. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">logout</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.logout" title="Permalink to this definition">¶</a></dt>

  532. <dd></dd></dl>

  533. 

  534. <dl class="function">

  535. <dt id="webnotes.handler.reset_password">

  536. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">reset_password</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#reset_password"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.reset_password" title="Permalink to this definition">¶</a></dt>

  537. <dd></dd></dl>

  538. 

  539. <dl class="function">

  540. <dt id="webnotes.handler.resume_session">

  541. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">resume_session</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#resume_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.resume_session" title="Permalink to this definition">¶</a></dt>

  542. <dd></dd></dl>

  543. 

  544. <dl class="function">

  545. <dt id="webnotes.handler.runserverobj">

  546. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">runserverobj</tt><big>(</big><em>arg=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#runserverobj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.runserverobj" title="Permalink to this definition">¶</a></dt>

  547. <dd></dd></dl>

  548. 

  549. <dl class="function">

  550. <dt id="webnotes.handler.startup">

  551. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">startup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#startup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.startup" title="Permalink to this definition">¶</a></dt>

  552. <dd></dd></dl>

  553. 

  554. <dl class="function">

  555. <dt id="webnotes.handler.upload_many">

  556. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">upload_many</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#upload_many"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.upload_many" title="Permalink to this definition">¶</a></dt>

  557. <dd></dd></dl>

  558. 

  559. <dl class="function">

  560. <dt id="webnotes.handler.uploadfile">

  561. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">uploadfile</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#uploadfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.uploadfile" title="Permalink to this definition">¶</a></dt>

  562. <dd></dd></dl>

  563. 

  564. <dl class="function">

  565. <dt id="webnotes.handler.validate_cmd">

  566. <tt class="descclassname">webnotes.handler.</tt><tt class="descname">validate_cmd</tt><big>(</big><em>cmd</em><big>)</big><a class="reference internal" href="_modules/webnotes/handler.html#validate_cmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.handler.validate_cmd" title="Permalink to this definition">¶</a></dt>

  567. <dd></dd></dl>

  568. 

  569. </div>

  570. <div class="section" id="module-webnotes.profile">

  571. <span id="profile-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">profile</span></tt> Module<a class="headerlink" href="#module-webnotes.profile" title="Permalink to this headline">¶</a></h2>

  572. <dl class="class">

  573. <dt id="webnotes.profile.Profile">

  574. <em class="property">class </em><tt class="descclassname">webnotes.profile.</tt><tt class="descname">Profile</tt><big>(</big><em>name=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile" title="Permalink to this definition">¶</a></dt>

  575. <dd><p>A profile object is created at the beginning of every request with details of the use.

  576. The global profile object is <cite>webnotes.user</cite></p>

  577. <dl class="method">

  578. <dt id="webnotes.profile.Profile.get_allow_list">

  579. <tt class="descname">get_allow_list</tt><big>(</big><em>key</em><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_allow_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_allow_list" title="Permalink to this definition">¶</a></dt>

  580. <dd><p>Internal - get list of DocType where <cite>key</cite> is allowed. Key is either &#8216;read&#8217;, &#8216;write&#8217; or &#8216;create&#8217;</p>

  581. </dd></dl>

  582. 

  583. <dl class="method">

  584. <dt id="webnotes.profile.Profile.get_create_list">

  585. <tt class="descname">get_create_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_create_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_create_list" title="Permalink to this definition">¶</a></dt>

  586. <dd><p>Get list of DocTypes the user can create. Will filter DocTypes tagged with &#8216;not_in_create&#8217; and table</p>

  587. </dd></dl>

  588. 

  589. <dl class="method">

  590. <dt id="webnotes.profile.Profile.get_defaults">

  591. <tt class="descname">get_defaults</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_defaults" title="Permalink to this definition">¶</a></dt>

  592. <dd><p>Get the user&#8217;s default values based on user and role profile</p>

  593. </dd></dl>

  594. 

  595. <dl class="method">

  596. <dt id="webnotes.profile.Profile.get_hide_tips">

  597. <tt class="descname">get_hide_tips</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_hide_tips"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_hide_tips" title="Permalink to this definition">¶</a></dt>

  598. <dd></dd></dl>

  599. 

  600. <dl class="method">

  601. <dt id="webnotes.profile.Profile.get_home_page">

  602. <tt class="descname">get_home_page</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_home_page"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_home_page" title="Permalink to this definition">¶</a></dt>

  603. <dd><p>Get the name of the user&#8217;s home page from the <cite>Control Panel</cite></p>

  604. </dd></dl>

  605. 

  606. <dl class="method">

  607. <dt id="webnotes.profile.Profile.get_random_password">

  608. <tt class="descname">get_random_password</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_random_password"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_random_password" title="Permalink to this definition">¶</a></dt>

  609. <dd><p>Generate a random password</p>

  610. </dd></dl>

  611. 

  612. <dl class="method">

  613. <dt id="webnotes.profile.Profile.get_read_list">

  614. <tt class="descname">get_read_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_read_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_read_list" title="Permalink to this definition">¶</a></dt>

  615. <dd><p>Get list of DocTypes the user can read</p>

  616. </dd></dl>

  617. 

  618. <dl class="method">

  619. <dt id="webnotes.profile.Profile.get_report_list">

  620. <tt class="descname">get_report_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_report_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_report_list" title="Permalink to this definition">¶</a></dt>

  621. <dd></dd></dl>

  622. 

  623. <dl class="method">

  624. <dt id="webnotes.profile.Profile.get_roles">

  625. <tt class="descname">get_roles</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_roles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_roles" title="Permalink to this definition">¶</a></dt>

  626. <dd><p>get list of roles</p>

  627. </dd></dl>

  628. 

  629. <dl class="method">

  630. <dt id="webnotes.profile.Profile.get_write_list">

  631. <tt class="descname">get_write_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.get_write_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.get_write_list" title="Permalink to this definition">¶</a></dt>

  632. <dd><p>Get list of DocTypes the user can write</p>

  633. </dd></dl>

  634. 

  635. <dl class="method">

  636. <dt id="webnotes.profile.Profile.load_from_session">

  637. <tt class="descname">load_from_session</tt><big>(</big><em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.load_from_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.load_from_session" title="Permalink to this definition">¶</a></dt>

  638. <dd><p>Setup the user profile from the dictionary saved in the session (generated by <cite>load_profile</cite>)</p>

  639. </dd></dl>

  640. 

  641. <dl class="method">

  642. <dt id="webnotes.profile.Profile.load_profile">

  643. <tt class="descname">load_profile</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.load_profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.load_profile" title="Permalink to this definition">¶</a></dt>

  644. <dd><p>Return a dictionary of user properites to be stored in the session</p>

  645. </dd></dl>

  646. 

  647. <dl class="method">

  648. <dt id="webnotes.profile.Profile.reset_password">

  649. <tt class="descname">reset_password</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.reset_password"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.reset_password" title="Permalink to this definition">¶</a></dt>

  650. <dd><p>Reset the user&#8217;s password and send an email</p>

  651. </dd></dl>

  652. 

  653. <dl class="method">

  654. <dt id="webnotes.profile.Profile.send_email">

  655. <tt class="descname">send_email</tt><big>(</big><em>subj</em>, <em>mess</em>, <em>email</em><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.send_email"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.send_email" title="Permalink to this definition">¶</a></dt>

  656. <dd></dd></dl>

  657. 

  658. <dl class="method">

  659. <dt id="webnotes.profile.Profile.update_recent">

  660. <tt class="descname">update_recent</tt><big>(</big><em>dt</em>, <em>dn</em><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#Profile.update_recent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.Profile.update_recent" title="Permalink to this definition">¶</a></dt>

  661. <dd><p>Update the user&#8217;s <cite>Recent</cite> list with the given <cite>dt</cite> and <cite>dn</cite></p>

  662. </dd></dl>

  663. 

  664. </dd></dl>

  665. 

  666. <dl class="function">

  667. <dt id="webnotes.profile.get_user_img">

  668. <tt class="descclassname">webnotes.profile.</tt><tt class="descname">get_user_img</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/profile.html#get_user_img"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.profile.get_user_img" title="Permalink to this definition">¶</a></dt>

  669. <dd></dd></dl>

  670. 

  671. </div>

  672. <div class="section" id="module-webnotes.session_cache">

  673. <span id="session-cache-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">session_cache</span></tt> Module<a class="headerlink" href="#module-webnotes.session_cache" title="Permalink to this headline">¶</a></h2>

  674. <dl class="function">

  675. <dt id="webnotes.session_cache.build">

  676. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">build</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.build" title="Permalink to this definition">¶</a></dt>

  677. <dd></dd></dl>

  678. 

  679. <dl class="function">

  680. <dt id="webnotes.session_cache.clear">

  681. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">clear</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.clear" title="Permalink to this definition">¶</a></dt>

  682. <dd></dd></dl>

  683. 

  684. <dl class="function">

  685. <dt id="webnotes.session_cache.clear_cache">

  686. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">clear_cache</tt><big>(</big><em>user=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#clear_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.clear_cache" title="Permalink to this definition">¶</a></dt>

  687. <dd></dd></dl>

  688. 

  689. <dl class="function">

  690. <dt id="webnotes.session_cache.dump">

  691. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">dump</tt><big>(</big><em>sd</em>, <em>country</em><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.dump" title="Permalink to this definition">¶</a></dt>

  692. <dd></dd></dl>

  693. 

  694. <dl class="function">

  695. <dt id="webnotes.session_cache.get">

  696. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.get" title="Permalink to this definition">¶</a></dt>

  697. <dd></dd></dl>

  698. 

  699. <dl class="function">

  700. <dt id="webnotes.session_cache.get_letter_heads">

  701. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">get_letter_heads</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#get_letter_heads"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.get_letter_heads" title="Permalink to this definition">¶</a></dt>

  702. <dd></dd></dl>

  703. 

  704. <dl class="function">

  705. <dt id="webnotes.session_cache.load">

  706. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">load</tt><big>(</big><em>country</em><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.load" title="Permalink to this definition">¶</a></dt>

  707. <dd></dd></dl>

  708. 

  709. <dl class="function">

  710. <dt id="webnotes.session_cache.load_startup">

  711. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">load_startup</tt><big>(</big><em>cp</em><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#load_startup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.load_startup" title="Permalink to this definition">¶</a></dt>

  712. <dd></dd></dl>

  713. 

  714. <dl class="function">

  715. <dt id="webnotes.session_cache.make_cache_table">

  716. <tt class="descclassname">webnotes.session_cache.</tt><tt class="descname">make_cache_table</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/session_cache.html#make_cache_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.session_cache.make_cache_table" title="Permalink to this definition">¶</a></dt>

  717. <dd></dd></dl>

  718. 

  719. </div>

  720. <div class="section" id="module-webnotes.tests">

  721. <span id="tests-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">tests</span></tt> Module<a class="headerlink" href="#module-webnotes.tests" title="Permalink to this headline">¶</a></h2>

  722. <p>Run tests from modules. Sets up database connection, modules path and session before running test</p>

  723. <p>Usage: from shell, run</p>

  724. <p>python tests.py [test modules]</p>

  725. <dl class="docutils">

  726. <dt>Options:</dt>

  727. <dd>test modules: list of modules separated by space</dd>

  728. </dl>

  729. <p>if no modules are specified, it will run all &#8220;tests.py&#8221; files from all modules</p>

  730. <dl class="function">

  731. <dt id="webnotes.tests.get_tests">

  732. <tt class="descclassname">webnotes.tests.</tt><tt class="descname">get_tests</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/tests.html#get_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.tests.get_tests" title="Permalink to this definition">¶</a></dt>

  733. <dd><p>Returns list of test modules identified by &#8220;tests.py&#8221;</p>

  734. </dd></dl>

  735. 

  736. <dl class="function">

  737. <dt id="webnotes.tests.setup">

  738. <tt class="descclassname">webnotes.tests.</tt><tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/tests.html#setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.tests.setup" title="Permalink to this definition">¶</a></dt>

  739. <dd><p>Sets up connection and session</p>

  740. </dd></dl>

  741. 

  742. </div>

  743. <div class="section" id="subpackages">

  744. <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>

  745. <div class="toctree-wrapper compound">

  746. <ul>

  747. <li class="toctree-l1"><a class="reference internal" href="webnotes.install_lib.html">install_lib Package</a><ul>

  748. <li class="toctree-l2"><a class="reference internal" href="webnotes.install_lib.html#module-webnotes.install_lib.db_init"><tt class="docutils literal"><span class="pre">db_init</span></tt> Module</a></li>

  749. <li class="toctree-l2"><a class="reference internal" href="webnotes.install_lib.html#module-webnotes.install_lib.install"><tt class="docutils literal"><span class="pre">install</span></tt> Module</a></li>

  750. </ul>

  751. </li>

  752. <li class="toctree-l1"><a class="reference internal" href="webnotes.model.html">model Package</a><ul>

  753. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#id1"><tt class="docutils literal"><span class="pre">model</span></tt> Package</a></li>

  754. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.code"><tt class="docutils literal"><span class="pre">code</span></tt> Module</a></li>

  755. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.db_schema"><tt class="docutils literal"><span class="pre">db_schema</span></tt> Module</a></li>

  756. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doc"><tt class="docutils literal"><span class="pre">doc</span></tt> Module</a></li>

  757. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doclist"><tt class="docutils literal"><span class="pre">doclist</span></tt> Module</a></li>

  758. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doctype"><tt class="docutils literal"><span class="pre">doctype</span></tt> Module</a><ul>

  759. <li class="toctree-l3"><a class="reference internal" href="webnotes.model.html#id2">DocType module</a></li>

  760. </ul>

  761. </li>

  762. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.import_docs"><tt class="docutils literal"><span class="pre">import_docs</span></tt> Module</a></li>

  763. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.meta"><tt class="docutils literal"><span class="pre">meta</span></tt> Module</a></li>

  764. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.modules"><tt class="docutils literal"><span class="pre">modules</span></tt> Module</a></li>

  765. <li class="toctree-l2"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.triggers"><tt class="docutils literal"><span class="pre">triggers</span></tt> Module</a></li>

  766. </ul>

  767. </li>

  768. <li class="toctree-l1"><a class="reference internal" href="webnotes.modules.html">modules Package</a><ul>

  769. <li class="toctree-l2"><a class="reference internal" href="webnotes.modules.html#id1"><tt class="docutils literal"><span class="pre">modules</span></tt> Package</a></li>

  770. <li class="toctree-l2"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.compress"><tt class="docutils literal"><span class="pre">compress</span></tt> Module</a></li>

  771. <li class="toctree-l2"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.export_module"><tt class="docutils literal"><span class="pre">export_module</span></tt> Module</a></li>

  772. <li class="toctree-l2"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.import_module"><tt class="docutils literal"><span class="pre">import_module</span></tt> Module</a></li>

  773. <li class="toctree-l2"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.module_manager"><tt class="docutils literal"><span class="pre">module_manager</span></tt> Module</a></li>

  774. <li class="toctree-l2"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.patch"><tt class="docutils literal"><span class="pre">patch</span></tt> Module</a></li>

  775. </ul>

  776. </li>

  777. <li class="toctree-l1"><a class="reference internal" href="webnotes.multi_tenant.html">multi_tenant Package</a><ul>

  778. <li class="toctree-l2"><a class="reference internal" href="webnotes.multi_tenant.html#id1"><tt class="docutils literal"><span class="pre">multi_tenant</span></tt> Package</a></li>

  779. <li class="toctree-l2"><a class="reference internal" href="webnotes.multi_tenant.html#query-parser-module"><tt class="docutils literal"><span class="pre">query_parser</span></tt> Module</a></li>

  780. <li class="toctree-l2"><a class="reference internal" href="webnotes.multi_tenant.html#module-webnotes.multi_tenant.setup"><tt class="docutils literal"><span class="pre">setup</span></tt> Module</a></li>

  781. </ul>

  782. </li>

  783. <li class="toctree-l1"><a class="reference internal" href="webnotes.utils.html">utils Package</a><ul>

  784. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#id1"><tt class="docutils literal"><span class="pre">utils</span></tt> Package</a></li>

  785. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#archive-module"><tt class="docutils literal"><span class="pre">archive</span></tt> Module</a></li>

  786. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#backups-module"><tt class="docutils literal"><span class="pre">backups</span></tt> Module</a></li>

  787. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.cache"><tt class="docutils literal"><span class="pre">cache</span></tt> Module</a></li>

  788. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.encrypt"><tt class="docutils literal"><span class="pre">encrypt</span></tt> Module</a></li>

  789. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.file_manager"><tt class="docutils literal"><span class="pre">file_manager</span></tt> Module</a></li>

  790. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.jsmin"><tt class="docutils literal"><span class="pre">jsmin</span></tt> Module</a></li>

  791. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.nestedset"><tt class="docutils literal"><span class="pre">nestedset</span></tt> Module</a></li>

  792. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.scheduler"><tt class="docutils literal"><span class="pre">scheduler</span></tt> Module</a><ul>

  793. <li class="toctree-l3"><a class="reference internal" href="webnotes.utils.html#to-install">To install:</a></li>

  794. <li class="toctree-l3"><a class="reference internal" href="webnotes.utils.html#in-cron">In cron:</a></li>

  795. </ul>

  796. </li>

  797. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.sitemap"><tt class="docutils literal"><span class="pre">sitemap</span></tt> Module</a></li>

  798. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.transfer"><tt class="docutils literal"><span class="pre">transfer</span></tt> Module</a></li>

  799. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.webservice"><tt class="docutils literal"><span class="pre">webservice</span></tt> Module</a></li>

  800. <li class="toctree-l2"><a class="reference internal" href="webnotes.utils.html#subpackages">Subpackages</a><ul>

  801. <li class="toctree-l3"><a class="reference internal" href="webnotes.utils.email_lib.html">email_lib Package</a><ul>

  802. <li class="toctree-l4"><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>

  803. <li class="toctree-l4"><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>

  804. <li class="toctree-l4"><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>

  805. <li class="toctree-l4"><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>

  806. <li class="toctree-l4"><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>

  807. </ul>

  808. </li>

  809. </ul>

  810. </li>

  811. </ul>

  812. </li>

  813. <li class="toctree-l1"><a class="reference internal" href="webnotes.widgets.html">widgets Package</a><ul>

  814. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.auto_master"><tt class="docutils literal"><span class="pre">auto_master</span></tt> Module</a></li>

  815. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.event"><tt class="docutils literal"><span class="pre">event</span></tt> Module</a></li>

  816. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.follow"><tt class="docutils literal"><span class="pre">follow</span></tt> Module</a></li>

  817. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.form"><tt class="docutils literal"><span class="pre">form</span></tt> Module</a></li>

  818. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.menus"><tt class="docutils literal"><span class="pre">menus</span></tt> Module</a></li>

  819. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.page"><tt class="docutils literal"><span class="pre">page</span></tt> Module</a></li>

  820. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.page_body"><tt class="docutils literal"><span class="pre">page_body</span></tt> Module</a></li>

  821. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.query_builder"><tt class="docutils literal"><span class="pre">query_builder</span></tt> Module</a></li>

  822. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.search"><tt class="docutils literal"><span class="pre">search</span></tt> Module</a></li>

  823. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.tags"><tt class="docutils literal"><span class="pre">tags</span></tt> Module</a></li>

  824. <li class="toctree-l2"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.todo"><tt class="docutils literal"><span class="pre">todo</span></tt> Module</a></li>

  825. </ul>

  826. </li>

  827. </ul>

  828. </div>

  829. </div>

  830. </div>

  831. 

  832. 

  833.           </div>

  834.         </div>

  835.       </div>

  836.       <div class="sphinxsidebar">

  837.         <div class="sphinxsidebarwrapper">

  838.             <p class="logo"><a href="index.html">

  839.               <img class="logo" src="_static/wnflogo200.gif" alt="Logo"/>

  840.             </a></p>

  841.   <h3><a href="index.html">Table Of Contents</a></h3>

  842.   <ul>

  843. <li><a class="reference internal" href="#">webnotes Package</a><ul>

  844. <li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">webnotes</span></tt> Package</a></li>

  845. <li><a class="reference internal" href="#module-webnotes.auth"><tt class="docutils literal"><span class="pre">auth</span></tt> Module</a></li>

  846. <li><a class="reference internal" href="#module-webnotes.db"><tt class="docutils literal"><span class="pre">db</span></tt> Module</a></li>

  847. <li><a class="reference internal" href="#module-webnotes.defs"><tt class="docutils literal"><span class="pre">defs</span></tt> Module</a></li>

  848. <li><a class="reference internal" href="#module-webnotes.defs_template"><tt class="docutils literal"><span class="pre">defs_template</span></tt> Module</a></li>

  849. <li><a class="reference internal" href="#module-webnotes.handler"><tt class="docutils literal"><span class="pre">handler</span></tt> Module</a></li>

  850. <li><a class="reference internal" href="#module-webnotes.profile"><tt class="docutils literal"><span class="pre">profile</span></tt> Module</a></li>

  851. <li><a class="reference internal" href="#module-webnotes.session_cache"><tt class="docutils literal"><span class="pre">session_cache</span></tt> Module</a></li>

  852. <li><a class="reference internal" href="#module-webnotes.tests"><tt class="docutils literal"><span class="pre">tests</span></tt> Module</a></li>

  853. <li><a class="reference internal" href="#subpackages">Subpackages</a><ul>

  854. </ul>

  855. </li>

  856. </ul>

  857. </li>

  858. </ul>

  859. 

  860.   <h4>Previous topic</h4>

  861.   <p class="topless"><a href="core.page.html"

  862.                         title="previous chapter">page Package</a></p>

  863.   <h4>Next topic</h4>

  864.   <p class="topless"><a href="webnotes.install_lib.html"

  865.                         title="next chapter">install_lib Package</a></p>

  866.   <h3>This Page</h3>

  867.   <ul class="this-page-menu">

  868.     <li><a href="_sources/webnotes.txt"

  869.            rel="nofollow">Show Source</a></li>

  870.   </ul>

  871. <div id="searchbox" style="display: none">

  872.   <h3>Quick search</h3>

  873.     <form class="search" action="search.html" method="get">

  874.       <input type="text" name="q" size="18" />

  875.       <input type="submit" value="Go" />

  876.       <input type="hidden" name="check_keywords" value="yes" />

  877.       <input type="hidden" name="area" value="default" />

  878.     </form>

  879.     <p class="searchtip" style="font-size: 90%">

  880.     Enter search terms or a module, class or function name.

  881.     </p>

  882. </div>

  883. <script type="text/javascript">$('#searchbox').show(0);</script>

  884.         </div>

  885.       </div>

  886.       <div class="clearer"></div>

  887.     </div>

  888.     <div class="related">

  889.       <h3>Navigation</h3>

  890.       <ul>

  891.         <li class="right" style="margin-right: 10px">

  892.           <a href="genindex.html" title="General Index"

  893.              >index</a></li>

  894.         <li class="right" >

  895.           <a href="py-modindex.html" title="Python Module Index"

  896.              >modules</a> |</li>

  897.         <li class="right" >

  898.           <a href="webnotes.install_lib.html" title="install_lib Package"

  899.              >next</a> |</li>

  900.         <li class="right" >

  901.           <a href="core.page.html" title="page Package"

  902.              >previous</a> |</li>

  903.         <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 

  904.       </ul>

  905.     </div>

  906.     <div class="footer">

  907.         &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.

  908.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.

  909.     </div>

  910.   </body>

  911. </html>