1665 lines
No EOL
49 KiB
HTML
1665 lines
No EOL
49 KiB
HTML
<!-- title: frappe.__init__ --><div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.6.1</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/v6.6.1/frappe/__init__.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<h2>Introduction</h2><br><p>globals attached to frappe module
|
|
+ some utility functions that should probably be moved</p>
|
|
<br><br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__._" href="#frappe.__init__._" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>_</b>
|
|
<i class="text-muted">(msg, lang=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns translated string in current lang, if exists.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>_dict</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from __builtin__.dict</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p>dict like object that exposes keys as attributes</p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="__getattr__" href="#__getattr__" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>__getattr__</b>
|
|
<i class="text-muted">(self, key)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="__getstate__" href="#__getstate__" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>__getstate__</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="__setattr__" href="#__setattr__" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>__setattr__</b>
|
|
<i class="text-muted">(self, key, value)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="__setstate__" href="#__setstate__" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>__setstate__</b>
|
|
<i class="text-muted">(self, d)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="copy" href="#copy" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>copy</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="update" href="#update" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>update</b>
|
|
<i class="text-muted">(self, d)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>update and return self -- the missing dict feature in python</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.add_version" href="#frappe.__init__.add_version" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>add_version</b>
|
|
<i class="text-muted">(doc)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Insert a new <strong>Version</strong> of the given document.
|
|
A <strong>Version</strong> is a JSON dump of the current document state.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.are_emails_muted" href="#frappe.__init__.are_emails_muted" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>are_emails_muted</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.as_json" href="#frappe.__init__.as_json" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>as_json</b>
|
|
<i class="text-muted">(obj, indent=1)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.attach_print" href="#frappe.__init__.attach_print" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>attach_print</b>
|
|
<i class="text-muted">(doctype, name, file_name=None, print_format=None, style=None, html=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.build_match_conditions" href="#frappe.__init__.build_match_conditions" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>build_match_conditions</b>
|
|
<i class="text-muted">(doctype, as_condition=True)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return match (User permissions) for given doctype as list or SQL.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.cache" href="#frappe.__init__.cache" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>cache</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns memcache connection.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.call" href="#frappe.__init__.call" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>call</b>
|
|
<i class="text-muted">(fn)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Call a function and match arguments.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.clear_cache" href="#frappe.__init__.clear_cache" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>clear_cache</b>
|
|
<i class="text-muted">(user=None, doctype=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Clear <strong>User</strong>, <strong>DocType</strong> or global cache.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>user</code></strong> - If user is given, only user cache is cleared.</li>
|
|
<li><strong><code>doctype</code></strong> - If doctype is given, only DocType cache is cleared.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.compare" href="#frappe.__init__.compare" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>compare</b>
|
|
<i class="text-muted">(val1, condition, val2)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Compare two values using <code>frappe.utils.compare</code></p>
|
|
|
|
<p><code>condition</code> could be:
|
|
- "^"
|
|
- "in"
|
|
- "not in"
|
|
- "="
|
|
- "!="
|
|
- ">"
|
|
- "<"
|
|
- ">="
|
|
- "<="
|
|
- "not None"
|
|
- "None"</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.connect" href="#frappe.__init__.connect" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>connect</b>
|
|
<i class="text-muted">(site=None, db_name=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Connect to site database instance.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>site</code></strong> - If site is given, calls <code>frappe.init</code>.</li>
|
|
<li><strong><code>db_name</code></strong> - Optional. Will use from <code>site_config.json</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.copy_doc" href="#frappe.__init__.copy_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>copy_doc</b>
|
|
<i class="text-muted">(doc, ignore_no_copy=True)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>No_copy fields also get copied.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.create_folder" href="#frappe.__init__.create_folder" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>create_folder</b>
|
|
<i class="text-muted">(path, with_init=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Create a folder in the given path and add an <code>__init__.py</code> file (optional).</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>path</code></strong> - Folder path.</li>
|
|
<li><strong><code>with_init</code></strong> - Create <code>__init__.py</code> in the new folder.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.delete_doc" href="#frappe.__init__.delete_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>delete_doc</b>
|
|
<i class="text-muted">(doctype=None, name=None, force=0, ignore_doctypes=None, for_reload=False, ignore_permissions=False, flags=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Delete a document. Calls <code>frappe.model.delete_doc.delete_doc</code>.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType of document to be delete.</li>
|
|
<li><strong><code>name</code></strong> - Name of document to be delete.</li>
|
|
<li><strong><code>force</code></strong> - Allow even if document is linked. Warning: This may lead to data integrity errors.</li>
|
|
<li><strong><code>ignore_doctypes</code></strong> - Ignore if child table is one of these.</li>
|
|
<li><strong><code>for_reload</code></strong> - Call <code>before_reload</code> trigger before deleting.</li>
|
|
<li><strong><code>ignore_permissions</code></strong> - Ignore user permissions.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.delete_doc_if_exists" href="#frappe.__init__.delete_doc_if_exists" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>delete_doc_if_exists</b>
|
|
<i class="text-muted">(doctype, name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Delete document if exists.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.destroy" href="#frappe.__init__.destroy" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>destroy</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Closes connection and releases werkzeug local.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.errprint" href="#frappe.__init__.errprint" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>errprint</b>
|
|
<i class="text-muted">(msg)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Log error. This is sent back as <code>exc</code> in response.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>msg</code></strong> - Message.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.format_value" href="#frappe.__init__.format_value" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>format_value</b>
|
|
<i class="text-muted">(value, df, doc=None, currency=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Format value with given field properties.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>value</code></strong> - Value to be formatted.</li>
|
|
<li><strong><code>df</code></strong> - DocField object with properties <code>fieldtype</code>, <code>options</code> etc.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.generate_hash" href="#frappe.__init__.generate_hash" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>generate_hash</b>
|
|
<i class="text-muted">(txt=None, length=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Generates random hash for given text + current timestamp + random string.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_all" href="#frappe.__init__.get_all" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_all</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>List database query via <code>frappe.model.db_query</code>. Will <strong>not</strong> check for conditions.
|
|
Parameters are same as <code>frappe.get_list</code></p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType on which query is to be made.</li>
|
|
<li><strong><code>fields</code></strong> - List of fields or <code>*</code>. Default is: <code>["name"]</code>.</li>
|
|
<li><strong><code>filters</code></strong> - List of filters (see example).</li>
|
|
<li><strong><code>order_by</code></strong> - Order By e.g. <code>modified desc</code>.</li>
|
|
<li><strong><code>limit_page_start</code></strong> - Start results at record #. Default 0.</li>
|
|
<li><strong><code>limit_poge_length</code></strong> - No of records in the page. Default 20.</li>
|
|
</ul>
|
|
|
|
<p>Example usage:</p>
|
|
|
|
<pre><code># simple dict filter
|
|
frappe.get_all("ToDo", fields=["name", "description"], filters = {"owner":"test@example.com"})
|
|
|
|
# filter as a list of lists
|
|
frappe.get_all("ToDo", fields=["*"], filters = [["modified", ">", "2014-01-01"]])
|
|
|
|
# filter as a list of dicts
|
|
frappe.get_all("ToDo", fields=["*"], filters = {"description": ("like", "test%")})
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_all_apps" href="#frappe.__init__.get_all_apps" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_all_apps</b>
|
|
<i class="text-muted">(with_frappe=False, with_internal_apps=True, sites_path=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get list of all apps via <code>sites/apps.txt</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_app_path" href="#frappe.__init__.get_app_path" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_app_path</b>
|
|
<i class="text-muted">(app_name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return path of given app.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>app</code></strong> - App name.</li>
|
|
<li><strong><code>*joins</code></strong> - Join additional path elements using <code>os.path.join</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_attr" href="#frappe.__init__.get_attr" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_attr</b>
|
|
<i class="text-muted">(method_string)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get python method object from its name.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_doc" href="#frappe.__init__.get_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_doc</b>
|
|
<i class="text-muted">(arg1, arg2=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return a <code>frappe.model.document.Document</code> object of the given type and name.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>arg1</code></strong> - DocType name as string <strong>or</strong> document JSON.</li>
|
|
<li><strong><code>arg2</code></strong> - [optional] Document name as string.</li>
|
|
</ul>
|
|
|
|
<p>Examples:</p>
|
|
|
|
<pre><code># insert a new document
|
|
todo = frappe.get_doc({"doctype":"ToDo", "description": "test"})
|
|
tood.insert()
|
|
|
|
# open an existing document
|
|
todo = frappe.get_doc("ToDo", "TD0001")
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_file_items" href="#frappe.__init__.get_file_items" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_file_items</b>
|
|
<i class="text-muted">(path, raise_not_found=False, ignore_empty_lines=True)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns items from text file as a list. Ignores empty lines.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_file_json" href="#frappe.__init__.get_file_json" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_file_json</b>
|
|
<i class="text-muted">(path)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Read a file and return parsed JSON object.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_hooks" href="#frappe.__init__.get_hooks" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_hooks</b>
|
|
<i class="text-muted">(hook=None, default=None, app_name=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get hooks via <code>app/hooks.py</code></p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>hook</code></strong> - Name of the hook. Will gather all hooks for this name and return as a list.</li>
|
|
<li><strong><code>default</code></strong> - Default if no hook found.</li>
|
|
<li><strong><code>app_name</code></strong> - Filter by app.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_installed_apps" href="#frappe.__init__.get_installed_apps" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_installed_apps</b>
|
|
<i class="text-muted">(sort=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get list of installed apps in current site.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_lang_dict" href="#frappe.__init__.get_lang_dict" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_lang_dict</b>
|
|
<i class="text-muted">(fortype, name=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns the translated language dict for the given type and name.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>fortype</code></strong> - must be one of <code>doctype</code>, <code>page</code>, <code>report</code>, <code>include</code>, <code>jsfile</code>, <code>boot</code></li>
|
|
<li><strong><code>name</code></strong> - name of the document for which assets are to be returned.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_last_doc" href="#frappe.__init__.get_last_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_last_doc</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get last created document of this type.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_list" href="#frappe.__init__.get_list" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_list</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>List database query via <code>frappe.model.db_query</code>. Will also check for permissions.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType on which query is to be made.</li>
|
|
<li><strong><code>fields</code></strong> - List of fields or <code>*</code>.</li>
|
|
<li><strong><code>filters</code></strong> - List of filters (see example).</li>
|
|
<li><strong><code>order_by</code></strong> - Order By e.g. <code>modified desc</code>.</li>
|
|
<li><strong><code>limit_page_start</code></strong> - Start results at record #. Default 0.</li>
|
|
<li><strong><code>limit_poge_length</code></strong> - No of records in the page. Default 20.</li>
|
|
</ul>
|
|
|
|
<p>Example usage:</p>
|
|
|
|
<pre><code># simple dict filter
|
|
frappe.get_list("ToDo", fields=["name", "description"], filters = {"owner":"test@example.com"})
|
|
|
|
# filter as a list of lists
|
|
frappe.get_list("ToDo", fields="*", filters = [["modified", ">", "2014-01-01"]])
|
|
|
|
# filter as a list of dicts
|
|
frappe.get_list("ToDo", fields="*", filters = {"description": ("like", "test%")})
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_logger" href="#frappe.__init__.get_logger" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_logger</b>
|
|
<i class="text-muted">(module=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_meta" href="#frappe.__init__.get_meta" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_meta</b>
|
|
<i class="text-muted">(doctype, cached=True)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get <code>frappe.model.meta.Meta</code> instance of given doctype name.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_meta_module" href="#frappe.__init__.get_meta_module" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_meta_module</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_module" href="#frappe.__init__.get_module" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_module</b>
|
|
<i class="text-muted">(modulename)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns a module object for given Python module name using <code>importlib.import_module</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_module_list" href="#frappe.__init__.get_module_list" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_module_list</b>
|
|
<i class="text-muted">(app_name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get list of modules for given all via <code>app/modules.txt</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_module_path" href="#frappe.__init__.get_module_path" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_module_path</b>
|
|
<i class="text-muted">(module)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get the path of the given module name.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>module</code></strong> - Module name.</li>
|
|
<li><strong><code>*joins</code></strong> - Join additional path elements using <code>os.path.join</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_precision" href="#frappe.__init__.get_precision" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_precision</b>
|
|
<i class="text-muted">(doctype, fieldname, currency=None, doc=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get precision for a given field</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_print" href="#frappe.__init__.get_print" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_print</b>
|
|
<i class="text-muted">(doctype, name, print_format=None, style=None, html=None, as_pdf=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get Print Format for given document.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType of document.</li>
|
|
<li><strong><code>name</code></strong> - Name of document.</li>
|
|
<li><strong><code>print_format</code></strong> - Print Format name. Default 'Standard',</li>
|
|
<li><strong><code>style</code></strong> - Print Format style.</li>
|
|
<li><strong><code>as_pdf</code></strong> - Return as PDF. Default False.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_pymodule_path" href="#frappe.__init__.get_pymodule_path" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_pymodule_path</b>
|
|
<i class="text-muted">(modulename)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return path of given Python module name.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>modulename</code></strong> - Python module name.</li>
|
|
<li><strong><code>*joins</code></strong> - Join additional path elements using <code>os.path.join</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_request_header" href="#frappe.__init__.get_request_header" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_request_header</b>
|
|
<i class="text-muted">(key, default=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return HTTP request header.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>key</code></strong> - HTTP header key.</li>
|
|
<li><strong><code>default</code></strong> - Default value.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_roles" href="#frappe.__init__.get_roles" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_roles</b>
|
|
<i class="text-muted">(username=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns roles of current user.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_single" href="#frappe.__init__.get_single" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_single</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return a <code>frappe.model.document.Document</code> object of the given Single doctype.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_site_config" href="#frappe.__init__.get_site_config" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_site_config</b>
|
|
<i class="text-muted">(sites_path=None, site_path=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns <code>site_config.json</code> combined with <code>sites/common_site_config.json</code>.
|
|
<code>site_config</code> is a set of site wide settings like database name, password, email etc.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_site_path" href="#frappe.__init__.get_site_path" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_site_path</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return path of current site.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>*joins</code></strong> - Join additional path elements using <code>os.path.join</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_test_records" href="#frappe.__init__.get_test_records" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_test_records</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns list of objects from <code>test_records.json</code> in the given doctype's folder.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_traceback" href="#frappe.__init__.get_traceback" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_traceback</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns error traceback.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_user" href="#frappe.__init__.get_user" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_user</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.get_value" href="#frappe.__init__.get_value" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>get_value</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns a document property or list of properties.</p>
|
|
|
|
<p>Alias for <code>frappe.db.get_value</code></p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType name.</li>
|
|
<li><strong><code>filters</code></strong> - Filters like <code>{"x":"y"}</code> or name of the document. <code>None</code> if Single DocType.</li>
|
|
<li><strong><code>fieldname</code></strong> - Column name.</li>
|
|
<li><strong><code>ignore</code></strong> - Don't raise exception if table, column is missing.</li>
|
|
<li><strong><code>as_dict</code></strong> - Return values as dict.</li>
|
|
<li><strong><code>debug</code></strong> - Print query in error log.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.has_permission" href="#frappe.__init__.has_permission" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>has_permission</b>
|
|
<i class="text-muted">(doctype, ptype=read, doc=None, user=None, verbose=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Raises <code>frappe.PermissionError</code> if not permitted.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType for which permission is to be check.</li>
|
|
<li><strong><code>ptype</code></strong> - Permission type (<code>read</code>, <code>write</code>, <code>create</code>, <code>submit</code>, <code>cancel</code>, <code>amend</code>). Default: <code>read</code>.</li>
|
|
<li><strong><code>doc</code></strong> - [optional] Checks User permissions for given doc.</li>
|
|
<li><strong><code>user</code></strong> - [optional] Check for given user. Default: current user.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.has_website_permission" href="#frappe.__init__.has_website_permission" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>has_website_permission</b>
|
|
<i class="text-muted">(doctype, ptype=read, doc=None, user=None, verbose=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Raises <code>frappe.PermissionError</code> if not permitted.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType for which permission is to be check.</li>
|
|
<li><strong><code>ptype</code></strong> - Permission type (<code>read</code>, <code>write</code>, <code>create</code>, <code>submit</code>, <code>cancel</code>, <code>amend</code>). Default: <code>read</code>.</li>
|
|
<li><strong><code>doc</code></strong> - Checks User permissions for given doc.</li>
|
|
<li><strong><code>user</code></strong> - [optional] Check for given user. Default: current user.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.import_doc" href="#frappe.__init__.import_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>import_doc</b>
|
|
<i class="text-muted">(path, ignore_links=False, ignore_insert=False, insert=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Import a file using Data Import Tool.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.init" href="#frappe.__init__.init" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>init</b>
|
|
<i class="text-muted">(site, sites_path=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Initialize frappe for the current site. Reset thread locals <code>frappe.local</code></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.is_table" href="#frappe.__init__.is_table" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>is_table</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns True if <code>istable</code> property (indicating child Table) is set for given DocType.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.local_cache" href="#frappe.__init__.local_cache" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>local_cache</b>
|
|
<i class="text-muted">(namespace, key, generator, regenerate_if_none=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>A key value store for caching within a request</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>namespace</code></strong> - frappe.local.cache[namespace]</li>
|
|
<li><strong><code>key</code></strong> - frappe.local.cache[namespace][key] used to retrieve value</li>
|
|
<li><strong><code>generator</code></strong> - method to generate a value if not found in store</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.log" href="#frappe.__init__.log" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>log</b>
|
|
<i class="text-muted">(msg)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Add to <code>debug_log</code>.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>msg</code></strong> - Message.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.make_property_setter" href="#frappe.__init__.make_property_setter" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>make_property_setter</b>
|
|
<i class="text-muted">(args, ignore_validate=False, validate_fields_for_doctype=True)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Create a new <strong>Property Setter</strong> (for overriding DocType and DocField properties).</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.msgprint" href="#frappe.__init__.msgprint" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>msgprint</b>
|
|
<i class="text-muted">(msg, small=0, raise_exception=0, as_table=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Print a message to the user (via HTTP response).
|
|
Messages are sent in the <code>__server_messages</code> property in the
|
|
response JSON and shown in a pop-up / modal.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>msg</code></strong> - Message.</li>
|
|
<li><strong><code>small</code></strong> - [optional] Show as a floating message in the footer.</li>
|
|
<li><strong><code>raise_exception</code></strong> - [optional] Raise given exception and show message.</li>
|
|
<li><strong><code>as_table</code></strong> - [optional] If <code>msg</code> is a list of lists, render as HTML table.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.new_doc" href="#frappe.__init__.new_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>new_doc</b>
|
|
<i class="text-muted">(doctype, parent_doc=None, parentfield=None, as_dict=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns a new document of the given DocType with defaults set.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>doctype</code></strong> - DocType of the new document.</li>
|
|
<li><strong><code>parent_doc</code></strong> - [optional] add to parent document.</li>
|
|
<li><strong><code>parentfield</code></strong> - [optional] add against this <code>parentfield</code>.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.only_for" href="#frappe.__init__.only_for" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>only_for</b>
|
|
<i class="text-muted">(roles)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Raise <code>frappe.PermissionError</code> if the user does not have any of the given <strong>Roles</strong>.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>roles</code></strong> - List of roles to check.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.publish_realtime" href="#frappe.__init__.publish_realtime" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>publish_realtime</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Publish real-time updates</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>event</code></strong> - Event name, like <code>task_progress</code> etc.</li>
|
|
<li><strong><code>message</code></strong> - JSON message object. For async must contain <code>task_id</code></li>
|
|
<li><strong><code>room</code></strong> - Room in which to publish update (default entire site)</li>
|
|
<li><strong><code>user</code></strong> - Transmit to user</li>
|
|
<li><strong><code>doctype</code></strong> - Transmit to doctype, docname</li>
|
|
<li><strong><code>docname</code></strong> - Transmit to doctype, docname</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.read_file" href="#frappe.__init__.read_file" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>read_file</b>
|
|
<i class="text-muted">(path, raise_not_found=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Open a file and return its content as Unicode.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.reload_doc" href="#frappe.__init__.reload_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>reload_doc</b>
|
|
<i class="text-muted">(module, dt=None, dn=None, force=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Reload Document from model (<code>[module]/[doctype]/[name]/[name].json</code>) files.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>module</code></strong> - Module name.</li>
|
|
<li><strong><code>dt</code></strong> - DocType name.</li>
|
|
<li><strong><code>dn</code></strong> - Document name.</li>
|
|
<li><strong><code>force</code></strong> - Reload even if <code>modified</code> timestamp matches.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.reload_doctype" href="#frappe.__init__.reload_doctype" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>reload_doctype</b>
|
|
<i class="text-muted">(doctype, force=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Reload DocType from model (<code>[module]/[doctype]/[name]/[name].json</code>) files.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.rename_doc" href="#frappe.__init__.rename_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>rename_doc</b>
|
|
<i class="text-muted">(doctype, old, new, debug=0, force=False, merge=False, ignore_permissions=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Rename a document. Calls <code>frappe.model.rename_doc.rename_doc</code></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.reset_metadata_version" href="#frappe.__init__.reset_metadata_version" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>reset_metadata_version</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Reset <code>metadata_version</code> (Client (Javascript) build ID) hash.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.respond_as_web_page" href="#frappe.__init__.respond_as_web_page" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>respond_as_web_page</b>
|
|
<i class="text-muted">(title, html, success=None, http_status_code=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Send response as a web page with a message rather than JSON. Used to show permission errors etc.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>title</code></strong> - Page title and heading.</li>
|
|
<li><strong><code>message</code></strong> - Message to be shown.</li>
|
|
<li><strong><code>success</code></strong> - Alert message.</li>
|
|
<li><strong><code>http_status_code</code></strong> - HTTP status code.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.scrub" href="#frappe.__init__.scrub" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>scrub</b>
|
|
<i class="text-muted">(txt)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns sluggified string. e.g. <code>Sales Order</code> becomes <code>sales_order</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.sendmail" href="#frappe.__init__.sendmail" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>sendmail</b>
|
|
<i class="text-muted">(recipients=(), sender=, subject=No Subject, message=No Message, as_markdown=False, bulk=False, reference_doctype=None, reference_name=None, unsubscribe_method=None, unsubscribe_params=None, unsubscribe_message=None, attachments=None, content=None, doctype=None, name=None, reply_to=None, cc=(), show_as_cc=(), message_id=None, as_bulk=False, send_after=None, expose_recipients=False, bulk_priority=1)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Send email using user's default <strong>Email Account</strong> or global default <strong>Email Account</strong>.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>recipients</code></strong> - List of recipients.</li>
|
|
<li><strong><code>sender</code></strong> - Email sender. Default is current user.</li>
|
|
<li><strong><code>subject</code></strong> - Email Subject.</li>
|
|
<li><strong><code>message</code></strong> - (or <code>content</code>) Email Content.</li>
|
|
<li><strong><code>as_markdown</code></strong> - Convert content markdown to HTML.</li>
|
|
<li><strong><code>bulk</code></strong> - Send via scheduled email sender <strong>Bulk Email</strong>. Don't send immediately.</li>
|
|
<li><strong><code>bulk_priority</code></strong> - Priority for bulk email, default 1.</li>
|
|
<li><strong><code>reference_doctype</code></strong> - (or <code>doctype</code>) Append as communication to this DocType.</li>
|
|
<li><strong><code>reference_name</code></strong> - (or <code>name</code>) Append as communication to this document name.</li>
|
|
<li><strong><code>unsubscribe_method</code></strong> - Unsubscribe url with options email, doctype, name. e.g. <code>/api/method/unsubscribe</code></li>
|
|
<li><strong><code>unsubscribe_params</code></strong> - Unsubscribe paramaters to be loaded on the unsubscribe_method [optional] (dict).</li>
|
|
<li><strong><code>attachments</code></strong> - List of attachments.</li>
|
|
<li><strong><code>reply_to</code></strong> - Reply-To email id.</li>
|
|
<li><strong><code>message_id</code></strong> - Used for threading. If a reply is received to this email, Message-Id is sent back as In-Reply-To in received email.</li>
|
|
<li><strong><code>send_after</code></strong> - Send after the given datetime.</li>
|
|
<li><strong><code>expose_recipients</code></strong> - Display all recipients in the footer message - "This email was sent to"</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.set_user" href="#frappe.__init__.set_user" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>set_user</b>
|
|
<i class="text-muted">(username)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Set current user.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>username</code></strong> - <strong>User</strong> name to set as current user.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.set_user_lang" href="#frappe.__init__.set_user_lang" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>set_user_lang</b>
|
|
<i class="text-muted">(user, user_language=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Guess and set user language for the session. <code>frappe.local.lang</code></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.set_value" href="#frappe.__init__.set_value" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>set_value</b>
|
|
<i class="text-muted">(doctype, docname, fieldname, value)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Set document value. Calls <code>frappe.client.set_value</code></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.setup_module_map" href="#frappe.__init__.setup_module_map" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>setup_module_map</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Rebuild map of all modules (internal).</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.throw" href="#frappe.__init__.throw" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>throw</b>
|
|
<i class="text-muted">(msg, exc=<class 'frappe.exceptions.ValidationError'>)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Throw execption and show message (<code>msgprint</code>).</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>msg</code></strong> - Message.</li>
|
|
<li><strong><code>exc</code></strong> - Exception class. Default <code>frappe.ValidationError</code></li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.unscrub" href="#frappe.__init__.unscrub" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>unscrub</b>
|
|
<i class="text-muted">(txt)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns titlified string. e.g. <code>sales_order</code> becomes <code>Sales Order</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.__init__.whitelist" href="#frappe.__init__.whitelist" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.__init__.<b>whitelist</b>
|
|
<i class="text-muted">(allow_guest=False, xss_safe=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Decorator for whitelisting a function and making it accessible via HTTP.
|
|
Standard request will be <code>/api/method/[path.to.method]</code></p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>allow_guest</code></strong> - Allow non logged-in user to access this method.</li>
|
|
</ul>
|
|
|
|
<p>Use as:</p>
|
|
|
|
<pre><code>@frappe.whitelist()
|
|
def myfunc(param1, param2):
|
|
pass
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |