@@ -8,4 +8,3 @@ locale | |||
*.egg-info | |||
dist/ | |||
build/ | |||
docs/ |
@@ -0,0 +1,16 @@ | |||
source_link = "https://github.com/frappe/frappe" | |||
docs_base_url = "https://frappe.github.io/frappe" | |||
headline = "Full stack web framework to build complex apps" | |||
sub_heading = "Build extensions to ERPNext or make your own database driven app" | |||
hide_install = True | |||
long_description = """The Frappe Framework is a server side and client side | |||
framework and is built with the philosophy make it "battries included". | |||
It has libraries and API for authentication, MVC, permissions, REST API, | |||
templating, admin interface, forms, reports and much more. | |||
Frappe Framework was designed to build [ERPNext](https://erpnext.com), open source | |||
ERP for managing small and medium sized businesses. | |||
""" | |||
def get_context(context): | |||
context.title = "Frappe Framework" |
@@ -0,0 +1,10 @@ | |||
<!-- title: Table of Contents --> | |||
<h1>Table of Contents</h1> | |||
<br> | |||
{% include "templates/includes/full_index.html" %} | |||
<!-- autodoc --> | |||
<!-- jinja --> | |||
<!-- no-breadcrumbs --> |
@@ -0,0 +1,9 @@ | |||
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors | |||
# See license.txt | |||
from __future__ import unicode_literals | |||
import frappe | |||
from frappe.website.utils import get_full_index | |||
def get_context(context): | |||
context.full_index = get_full_index(extn = True) |
@@ -0,0 +1,34 @@ | |||
<!-- title: frappe.config.desktop --><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/config/desktop.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.config.desktop.get_data" href="#frappe.config.desktop.get_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.config.desktop.<b>get_data</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,34 @@ | |||
<!-- title: frappe.config.docs --><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/config/docs.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.config.docs.get_context" href="#frappe.config.docs.get_context" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.config.docs.<b>get_context</b> | |||
<i class="text-muted">(context)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.config --><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/config.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,34 @@ | |||
<!-- title: frappe.config.integrations --><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/config/integrations.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.config.integrations.get_data" href="#frappe.config.integrations.get_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.config.integrations.<b>get_data</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,34 @@ | |||
<!-- title: frappe.config.setup --><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/config/setup.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.config.setup.get_data" href="#frappe.config.setup.get_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.config.setup.<b>get_data</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,34 @@ | |||
<!-- title: frappe.config.website --><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/config/website.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.config.website.get_data" href="#frappe.config.website.get_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.config.website.<b>get_data</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,19 @@ | |||
<!-- title: config --> | |||
<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/tree/v6.6.1/config" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3>Package Contents</h3> | |||
{index} | |||
<!-- autodoc --> |
@@ -0,0 +1,6 @@ | |||
frappe.config.desktop | |||
frappe.config.docs | |||
frappe.config | |||
frappe.config.integrations | |||
frappe.config.setup | |||
frappe.config.website |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.core --><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/core.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,82 @@ | |||
<!-- title: frappe.core.notifications --><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/core/notifications.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.core.notifications.get_notification_config" href="#frappe.core.notifications.get_notification_config" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.core.notifications.<b>get_notification_config</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.core.notifications.get_things_todo" href="#frappe.core.notifications.get_things_todo" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.core.notifications.<b>get_things_todo</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns a count of incomplete todos</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.core.notifications.get_todays_events" href="#frappe.core.notifications.get_todays_events" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.core.notifications.<b>get_todays_events</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns a count of todays events in calendar</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.core.notifications.get_unread_messages" href="#frappe.core.notifications.get_unread_messages" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.core.notifications.<b>get_unread_messages</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>returns unread (docstatus-0 messages for a user)</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,19 @@ | |||
<!-- title: core --> | |||
<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/tree/v6.6.1/core" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3>Package Contents</h3> | |||
{index} | |||
<!-- autodoc --> |
@@ -0,0 +1,2 @@ | |||
frappe.core | |||
frappe.core.notifications |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.custom --><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/custom.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,19 @@ | |||
<!-- title: custom --> | |||
<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/tree/v6.6.1/custom" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3>Package Contents</h3> | |||
{index} | |||
<!-- autodoc --> |
@@ -0,0 +1 @@ | |||
frappe.custom |
@@ -0,0 +1,108 @@ | |||
<!-- title: frappe.desk.form.assign_to --><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/desk/form/assign_to.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.assign_to.add</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.assign_to.add" href="#frappe.desk.form.assign_to.add" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.assign_to.<b>add</b> | |||
<i class="text-muted">(args=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>add in someone's to do list | |||
args = { | |||
"assign_to": , | |||
"doctype": , | |||
"name": , | |||
"description": | |||
}</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.assign_to.clear" href="#frappe.desk.form.assign_to.clear" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.assign_to.<b>clear</b> | |||
<i class="text-muted">(doctype, name)</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.desk.form.assign_to.get" href="#frappe.desk.form.assign_to.get" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.assign_to.<b>get</b> | |||
<i class="text-muted">(args=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get assigned to</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.assign_to.notify_assignment" href="#frappe.desk.form.assign_to.notify_assignment" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.assign_to.<b>notify_assignment</b> | |||
<i class="text-muted">(assigned_by, owner, doc_type, doc_name, action=CLOSE, description=None, notify=0)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Notify assignee that there is a change in assignment</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.assign_to.remove</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.assign_to.remove" href="#frappe.desk.form.assign_to.remove" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.assign_to.<b>remove</b> | |||
<i class="text-muted">(doctype, name, assign_to)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>remove from todo</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.desk.form --><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/desk/form.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,107 @@ | |||
<!-- title: frappe.desk.form.linked_with --><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/desk/form/linked_with.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.linked_with._get_linked_doctypes" href="#frappe.desk.form.linked_with._get_linked_doctypes" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.linked_with.<b>_get_linked_doctypes</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.desk.form.linked_with.get_dynamic_linked_fields" href="#frappe.desk.form.linked_with.get_dynamic_linked_fields" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.linked_with.<b>get_dynamic_linked_fields</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><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.linked_with.get_linked_docs</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.linked_with.get_linked_docs" href="#frappe.desk.form.linked_with.get_linked_docs" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.linked_with.<b>get_linked_docs</b> | |||
<i class="text-muted">(doctype, name, linkinfo=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.linked_with.get_linked_doctypes</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.linked_with.get_linked_doctypes" href="#frappe.desk.form.linked_with.get_linked_doctypes" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.linked_with.<b>get_linked_doctypes</b> | |||
<i class="text-muted">(doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>add list of doctypes this doctype is 'linked' with.</p> | |||
<p>Example, for Customer:</p> | |||
<pre><code>{"Address": {"fieldname": "customer"}..} | |||
</code></pre> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.linked_with.get_linked_fields" href="#frappe.desk.form.linked_with.get_linked_fields" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.linked_with.<b>get_linked_fields</b> | |||
<i class="text-muted">(doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,188 @@ | |||
<!-- title: frappe.desk.form.load --><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/desk/form/load.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.load.get_assignments" href="#frappe.desk.form.load.get_assignments" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>get_assignments</b> | |||
<i class="text-muted">(dt, dn)</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.desk.form.load.get_attachments" href="#frappe.desk.form.load.get_attachments" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>get_attachments</b> | |||
<i class="text-muted">(dt, dn)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.load.get_badge_info</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.load.get_badge_info" href="#frappe.desk.form.load.get_badge_info" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>get_badge_info</b> | |||
<i class="text-muted">(doctypes, filters)</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.desk.form.load.get_comments" href="#frappe.desk.form.load.get_comments" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>get_comments</b> | |||
<i class="text-muted">(dt, dn, limit=100)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.load.get_docinfo</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.load.get_docinfo" href="#frappe.desk.form.load.get_docinfo" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>get_docinfo</b> | |||
<i class="text-muted">(doc=None, doctype=None, name=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.desk.form.load.get_meta_bundle" href="#frappe.desk.form.load.get_meta_bundle" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>get_meta_bundle</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.desk.form.load.get_user_permissions" href="#frappe.desk.form.load.get_user_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>get_user_permissions</b> | |||
<i class="text-muted">(meta)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.load.getdoc</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.load.getdoc" href="#frappe.desk.form.load.getdoc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>getdoc</b> | |||
<i class="text-muted">(doctype, name, user=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Loads a doclist for a given document. This method is called directly from the client. | |||
Requries "doctype", "name" as form variables. | |||
Will also call the "onload" method on the document.</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.load.getdoctype</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.load.getdoctype" href="#frappe.desk.form.load.getdoctype" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>getdoctype</b> | |||
<i class="text-muted">(doctype, with_parent=False, cached_timestamp=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>load doctype</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.load.run_onload" href="#frappe.desk.form.load.run_onload" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.load.<b>run_onload</b> | |||
<i class="text-muted">(doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,245 @@ | |||
<!-- title: frappe.desk.form.meta --><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/desk/form/meta.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>FormMeta</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.model.meta.Meta</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, 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="_add_code" href="#_add_code" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>_add_code</b> | |||
<i class="text-muted">(self, path, fieldname)</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="add_code" href="#add_code" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_code</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="add_code_via_hook" href="#add_code_via_hook" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_code_via_hook</b> | |||
<i class="text-muted">(self, hook, fieldname)</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="add_custom_script" href="#add_custom_script" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_custom_script</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>embed all require files</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="add_html_templates" href="#add_html_templates" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_html_templates</b> | |||
<i class="text-muted">(self, path)</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="add_linked_document_type" href="#add_linked_document_type" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_linked_document_type</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="add_search_fields" href="#add_search_fields" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_search_fields</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>add search fields found in the doctypes indicated by link fields' options</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="as_dict" href="#as_dict" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>as_dict</b> | |||
<i class="text-muted">(self, no_nulls=False)</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="load_assets" href="#load_assets" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>load_assets</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="load_print_formats" href="#load_print_formats" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>load_print_formats</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="load_templates" href="#load_templates" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>load_templates</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="load_workflows" href="#load_workflows" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>load_workflows</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="set_translations" href="#set_translations" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_translations</b> | |||
<i class="text-muted">(self, lang)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.meta.get_meta" href="#frappe.desk.form.meta.get_meta" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.meta.<b>get_meta</b> | |||
<i class="text-muted">(doctype, cached=True)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,52 @@ | |||
<!-- title: frappe.desk.form.run_method --><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/desk/form/run_method.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.run_method.make_csv_output" href="#frappe.desk.form.run_method.make_csv_output" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.run_method.<b>make_csv_output</b> | |||
<i class="text-muted">(res, dt)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>send method response as downloadable CSV file</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.run_method.runserverobj</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.run_method.runserverobj" href="#frappe.desk.form.run_method.runserverobj" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.run_method.<b>runserverobj</b> | |||
<i class="text-muted">(method, docs=None, dt=None, dn=None, arg=None, args=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>run controller method - old style</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,86 @@ | |||
<!-- title: frappe.desk.form.save --><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/desk/form/save.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.save.cancel</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.save.cancel" href="#frappe.desk.form.save.cancel" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.save.<b>cancel</b> | |||
<i class="text-muted">(doctype=None, name=None, workflow_state_fieldname=None, workflow_state=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>cancel a doclist</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.save.savedocs</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.save.savedocs" href="#frappe.desk.form.save.savedocs" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.save.<b>savedocs</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>save / submit / update doclist</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.save.send_updated_docs" href="#frappe.desk.form.save.send_updated_docs" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.save.<b>send_updated_docs</b> | |||
<i class="text-muted">(doc)</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.desk.form.save.set_local_name" href="#frappe.desk.form.save.set_local_name" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.save.<b>set_local_name</b> | |||
<i class="text-muted">(doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,47 @@ | |||
<!-- title: frappe.desk.form.test_form --><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/desk/form/test_form.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>TestForm</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from unittest.case.TestCase</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="test_linked_with" href="#test_linked_with" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>test_linked_with</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<!-- autodoc --> |
@@ -0,0 +1,108 @@ | |||
<!-- title: frappe.desk.form.utils --><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/desk/form/utils.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.utils.add_comment</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.utils.add_comment" href="#frappe.desk.form.utils.add_comment" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.utils.<b>add_comment</b> | |||
<i class="text-muted">(doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>allow any logged user to post a comment</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.utils.get_fields</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.utils.get_fields" href="#frappe.desk.form.utils.get_fields" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.utils.<b>get_fields</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get fields</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.utils.get_next</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.utils.get_next" href="#frappe.desk.form.utils.get_next" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.utils.<b>get_next</b> | |||
<i class="text-muted">(doctype, value, prev, filters=None, order_by=modified desc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.utils.remove_attach</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.utils.remove_attach" href="#frappe.desk.form.utils.remove_attach" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.utils.<b>remove_attach</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>remove attachment</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.form.utils.validate_link</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.form.utils.validate_link" href="#frappe.desk.form.utils.validate_link" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.form.utils.<b>validate_link</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>validate link when updated by user</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,19 @@ | |||
<!-- title: form --> | |||
<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/tree/v6.6.1/form" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3>Package Contents</h3> | |||
{index} | |||
<!-- autodoc --> |
@@ -0,0 +1,9 @@ | |||
frappe.desk.form.assign_to | |||
frappe.desk.form | |||
frappe.desk.form.linked_with | |||
frappe.desk.form.load | |||
frappe.desk.form.meta | |||
frappe.desk.form.run_method | |||
frappe.desk.form.save | |||
frappe.desk.form.test_form | |||
frappe.desk.form.utils |
@@ -0,0 +1,52 @@ | |||
<!-- title: frappe.desk.calendar --><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/desk/calendar.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.calendar.get_event_conditions" href="#frappe.desk.calendar.get_event_conditions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.calendar.<b>get_event_conditions</b> | |||
<i class="text-muted">(doctype, filters=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns SQL conditions with user permissions and filters for event queries</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.calendar.update_event</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.calendar.update_event" href="#frappe.desk.calendar.update_event" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.calendar.<b>update_event</b> | |||
<i class="text-muted">(args, field_map)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Updates Event (called via calendar) based on passed <code>field_map</code></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,70 @@ | |||
<!-- title: frappe.desk.desk_page --><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/desk/desk_page.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.desk_page.get</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.desk_page.get" href="#frappe.desk.desk_page.get" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.desk_page.<b>get</b> | |||
<i class="text-muted">(name)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Return the :term:<code>doclist</code> of the <code>Page</code> specified by <code>name</code></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.desk_page.getpage</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.desk_page.getpage" href="#frappe.desk.desk_page.getpage" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.desk_page.<b>getpage</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Load the page from <code>frappe.form</code> and send it via <code>frappe.response</code></p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.desk_page.has_permission" href="#frappe.desk.desk_page.has_permission" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.desk_page.<b>has_permission</b> | |||
<i class="text-muted">(page)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.desk --><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/desk.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,261 @@ | |||
<!-- title: frappe.desk.moduleview --><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/desk/moduleview.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.add_custom_doctypes" href="#frappe.desk.moduleview.add_custom_doctypes" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>add_custom_doctypes</b> | |||
<i class="text-muted">(data, doctype_info)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Adds Custom DocTypes to modules setup via <code>config/desktop.py</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.add_section" href="#frappe.desk.moduleview.add_section" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>add_section</b> | |||
<i class="text-muted">(data, label, icon, items)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Adds a section to the module data.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.add_setup_section" href="#frappe.desk.moduleview.add_setup_section" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>add_setup_section</b> | |||
<i class="text-muted">(config, app, module, label, icon)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Add common sections to <code>/desk#Module/Setup</code></p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.apply_permissions" href="#frappe.desk.moduleview.apply_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>apply_permissions</b> | |||
<i class="text-muted">(data)</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.desk.moduleview.build_config_from_file" href="#frappe.desk.moduleview.build_config_from_file" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>build_config_from_file</b> | |||
<i class="text-muted">(module)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Build module info from <code>app/config/desktop.py</code> files.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.build_standard_config" href="#frappe.desk.moduleview.build_standard_config" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>build_standard_config</b> | |||
<i class="text-muted">(module, doctype_info)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Build standard module data from DocTypes.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.combine_common_sections" href="#frappe.desk.moduleview.combine_common_sections" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>combine_common_sections</b> | |||
<i class="text-muted">(data)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Combine sections declared in separate apps.</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.moduleview.get</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.get" href="#frappe.desk.moduleview.get" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>get</b> | |||
<i class="text-muted">(module)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns data (sections, list of reports, counts) to render module view in desk: | |||
<code>/desk/#Module/[name]</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.get_config" href="#frappe.desk.moduleview.get_config" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>get_config</b> | |||
<i class="text-muted">(app, module)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Load module info from <code>[app].config.[module]</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.get_data" href="#frappe.desk.moduleview.get_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>get_data</b> | |||
<i class="text-muted">(module)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Get module data for the module view <code>desk/#Module/[name]</code></p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.get_doctype_info" href="#frappe.desk.moduleview.get_doctype_info" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>get_doctype_info</b> | |||
<i class="text-muted">(module)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns list of non child DocTypes for given module.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.get_last_modified" href="#frappe.desk.moduleview.get_last_modified" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>get_last_modified</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.desk.moduleview.get_report_list" href="#frappe.desk.moduleview.get_report_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>get_report_list</b> | |||
<i class="text-muted">(module, is_standard=No)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns list on new style reports for modules.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.get_setup_section" href="#frappe.desk.moduleview.get_setup_section" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>get_setup_section</b> | |||
<i class="text-muted">(app, module, label, icon)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Get the setup section from each module (for global Setup page).</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.moduleview.set_last_modified" href="#frappe.desk.moduleview.set_last_modified" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.moduleview.<b>set_last_modified</b> | |||
<i class="text-muted">(data)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,164 @@ | |||
<!-- title: frappe.desk.notifications --><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/desk/notifications.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.notifications.clear_doctype_notifications" href="#frappe.desk.notifications.clear_doctype_notifications" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>clear_doctype_notifications</b> | |||
<i class="text-muted">(doc, method=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.desk.notifications.clear_notifications" href="#frappe.desk.notifications.clear_notifications" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>clear_notifications</b> | |||
<i class="text-muted">(user=*)</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.desk.notifications.delete_notification_count_for" href="#frappe.desk.notifications.delete_notification_count_for" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>delete_notification_count_for</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.desk.notifications.get_new_messages" href="#frappe.desk.notifications.get_new_messages" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>get_new_messages</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.desk.notifications.get_notification_config" href="#frappe.desk.notifications.get_notification_config" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>get_notification_config</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.desk.notifications.get_notification_info_for_boot" href="#frappe.desk.notifications.get_notification_info_for_boot" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>get_notification_info_for_boot</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.notifications.get_notifications</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.notifications.get_notifications" href="#frappe.desk.notifications.get_notifications" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>get_notifications</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.desk.notifications.get_notifications_for_doctypes" href="#frappe.desk.notifications.get_notifications_for_doctypes" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>get_notifications_for_doctypes</b> | |||
<i class="text-muted">(config, notification_count)</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.desk.notifications.get_notifications_for_modules" href="#frappe.desk.notifications.get_notifications_for_modules" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.notifications.<b>get_notifications_for_modules</b> | |||
<i class="text-muted">(config, notification_count)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,183 @@ | |||
<!-- title: frappe.desk.query_builder --><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/desk/query_builder.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_builder.add_limit_to_query" href="#frappe.desk.query_builder.add_limit_to_query" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>add_limit_to_query</b> | |||
<i class="text-muted">(query, args)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Add limit condition to query | |||
can be used by methods called in listing to add limit condition</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_builder.add_match_conditions" href="#frappe.desk.query_builder.add_match_conditions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>add_match_conditions</b> | |||
<i class="text-muted">(q, tl)</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.desk.query_builder.build_description_simple" href="#frappe.desk.query_builder.build_description_simple" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>build_description_simple</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.desk.query_builder.build_description_standard" href="#frappe.desk.query_builder.build_description_standard" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>build_description_standard</b> | |||
<i class="text-muted">(meta, tl)</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.desk.query_builder.get_parent_dt" href="#frappe.desk.query_builder.get_parent_dt" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>get_parent_dt</b> | |||
<i class="text-muted">(dt)</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.desk.query_builder.get_sql_meta" href="#frappe.desk.query_builder.get_sql_meta" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>get_sql_meta</b> | |||
<i class="text-muted">(tl)</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.desk.query_builder.get_sql_tables" href="#frappe.desk.query_builder.get_sql_tables" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>get_sql_tables</b> | |||
<i class="text-muted">(q)</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.desk.query_builder.guess_type" href="#frappe.desk.query_builder.guess_type" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>guess_type</b> | |||
<i class="text-muted">(m)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns fieldtype depending on the MySQLdb Description</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.query_builder.runquery</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_builder.runquery" href="#frappe.desk.query_builder.runquery" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>runquery</b> | |||
<i class="text-muted">(q=, ret=0, from_export=0)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.query_builder.runquery_csv</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_builder.runquery_csv" href="#frappe.desk.query_builder.runquery_csv" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_builder.<b>runquery_csv</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,193 @@ | |||
<!-- title: frappe.desk.query_report --><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/desk/query_report.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_report.add_total_row" href="#frappe.desk.query_report.add_total_row" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>add_total_row</b> | |||
<i class="text-muted">(result, columns)</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.desk.query_report.get_columns_dict" href="#frappe.desk.query_report.get_columns_dict" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>get_columns_dict</b> | |||
<i class="text-muted">(columns)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns a dict with column docfield values as dict | |||
The keys for the dict are both idx and fieldname, | |||
so either index or fieldname can be used to search for a column's docfield properties</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_report.get_filtered_data" href="#frappe.desk.query_report.get_filtered_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>get_filtered_data</b> | |||
<i class="text-muted">(ref_doctype, columns, data)</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.desk.query_report.get_linked_doctypes" href="#frappe.desk.query_report.get_linked_doctypes" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>get_linked_doctypes</b> | |||
<i class="text-muted">(columns, data)</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.desk.query_report.get_report_doc" href="#frappe.desk.query_report.get_report_doc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>get_report_doc</b> | |||
<i class="text-muted">(report_name)</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.desk.query_report.get_report_module_dotted_path" href="#frappe.desk.query_report.get_report_module_dotted_path" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>get_report_module_dotted_path</b> | |||
<i class="text-muted">(module, report_name)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.query_report.get_script</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_report.get_script" href="#frappe.desk.query_report.get_script" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>get_script</b> | |||
<i class="text-muted">(report_name)</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.desk.query_report.get_user_match_filters" href="#frappe.desk.query_report.get_user_match_filters" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>get_user_match_filters</b> | |||
<i class="text-muted">(doctypes, ref_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.desk.query_report.has_match" href="#frappe.desk.query_report.has_match" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>has_match</b> | |||
<i class="text-muted">(row, linked_doctypes, doctype_match_filters, ref_doctype, if_owner, columns_dict)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns True if after evaluating permissions for each linked doctype | |||
- There is an owner match for the ref_doctype | |||
- <code>and</code> There is a user permission match for all linked doctypes</p> | |||
<p>Returns True if the row is empty</p> | |||
<p>Note: | |||
Each doctype could have multiple conflicting user permission doctypes. | |||
Hence even if one of the sets allows a match, it is true. | |||
This behavior is equivalent to the trickling of user permissions of linked doctypes to the ref doctype.</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.query_report.run</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.query_report.run" href="#frappe.desk.query_report.run" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.query_report.<b>run</b> | |||
<i class="text-muted">(report_name, filters=())</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,36 @@ | |||
<!-- title: frappe.desk.report_dump --><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/desk/report_dump.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.report_dump.get_data</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.report_dump.get_data" href="#frappe.desk.report_dump.get_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.report_dump.<b>get_data</b> | |||
<i class="text-muted">(doctypes, last_modified)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,220 @@ | |||
<!-- title: frappe.desk.reportview --><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/desk/reportview.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.build_match_conditions" href="#frappe.desk.reportview.build_match_conditions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>build_match_conditions</b> | |||
<i class="text-muted">(doctype, as_condition=True)</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.desk.reportview.compress" href="#frappe.desk.reportview.compress" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>compress</b> | |||
<i class="text-muted">(data)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>separate keys and values</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.reportview.delete_items</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.delete_items" href="#frappe.desk.reportview.delete_items" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>delete_items</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>delete selected items</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.execute" href="#frappe.desk.reportview.execute" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>execute</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><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.reportview.export_query</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.export_query" href="#frappe.desk.reportview.export_query" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>export_query</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>export from report builder</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.reportview.get</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.get" href="#frappe.desk.reportview.get" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>get</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.desk.reportview.get_form_params" href="#frappe.desk.reportview.get_form_params" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>get_form_params</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Stringify GET request parameters.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.get_labels" href="#frappe.desk.reportview.get_labels" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>get_labels</b> | |||
<i class="text-muted">(fields, doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get column labels based on column names</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.get_match_cond" href="#frappe.desk.reportview.get_match_cond" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>get_match_cond</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><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.reportview.get_stats</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.get_stats" href="#frappe.desk.reportview.get_stats" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>get_stats</b> | |||
<i class="text-muted">(stats, doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get tag info</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.reportview.save_report</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.save_report" href="#frappe.desk.reportview.save_report" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>save_report</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>save report</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.reportview.scrub_user_tags" href="#frappe.desk.reportview.scrub_user_tags" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.reportview.<b>scrub_user_tags</b> | |||
<i class="text-muted">(tagcount)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>rebuild tag list for tags</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,102 @@ | |||
<!-- title: frappe.desk.search --><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/desk/search.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.search.build_for_autosuggest" href="#frappe.desk.search.build_for_autosuggest" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.search.<b>build_for_autosuggest</b> | |||
<i class="text-muted">(res)</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.desk.search.get_std_fields_list" href="#frappe.desk.search.get_std_fields_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.search.<b>get_std_fields_list</b> | |||
<i class="text-muted">(meta, 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="frappe.desk.search.scrub_custom_query" href="#frappe.desk.search.scrub_custom_query" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.search.<b>scrub_custom_query</b> | |||
<i class="text-muted">(query, key, txt)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.search.search_link</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.search.search_link" href="#frappe.desk.search.search_link" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.search.<b>search_link</b> | |||
<i class="text-muted">(doctype, txt, query=None, filters=None, page_len=20, searchfield=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.search.search_widget</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.search.search_widget" href="#frappe.desk.search.search_widget" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.search.<b>search_widget</b> | |||
<i class="text-muted">(doctype, txt, query=None, searchfield=None, start=0, page_len=50, filters=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,64 @@ | |||
<!-- title: frappe.desk.star --><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/desk/star.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.star._toggle_star" href="#frappe.desk.star._toggle_star" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.star.<b>_toggle_star</b> | |||
<i class="text-muted">(doctype, name, add=False, user=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Same as toggle_star but hides param <code>user</code> from API</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.star.toggle_star</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.star.toggle_star" href="#frappe.desk.star.toggle_star" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.star.<b>toggle_star</b> | |||
<i class="text-muted">(doctype, name, add=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Adds / removes the current user in the <code>__starred_by</code> property of the given document. | |||
If column does not exist, will add it in the database.</p> | |||
<p>The <code>_starred_by</code> property is always set from this function and is ignored if set via | |||
Document API</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>doctype</code></strong> - DocType of the document to star</li> | |||
<li><strong><code>name</code></strong> - Name of the document to star</li> | |||
<li><strong><code>add</code></strong> - <code>Yes</code> if star is to be added. If not <code>Yes</code> the star will be removed.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,213 @@ | |||
<!-- title: frappe.desk.tags --><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/desk/tags.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>DocTags</b></h3> | |||
<div class="docs-attr-desc"><p>Tags for a particular doctype</p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, dt)</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="add" href="#add" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add</b> | |||
<i class="text-muted">(self, dn, tag)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>add a new user tag</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_tag_fields" href="#get_tag_fields" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_tag_fields</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>returns tag_fields property</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_tags" href="#get_tags" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_tags</b> | |||
<i class="text-muted">(self, dn)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>returns tag for a particular item</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="remove" href="#remove" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>remove</b> | |||
<i class="text-muted">(self, dn, tag)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>remove a user tag</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="remove_all" href="#remove_all" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>remove_all</b> | |||
<i class="text-muted">(self, dn)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>remove all user tags (call before delete)</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="setup" href="#setup" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>setup</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>adds the <em>user</em>tags column if not exists</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, dn, tl)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>updates the <em>user</em>tag column in the table</p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.tags.add_tag</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.tags.add_tag" href="#frappe.desk.tags.add_tag" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.tags.<b>add_tag</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>adds a new tag to a record, and creates the Tag master</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.tags.check_user_tags" href="#frappe.desk.tags.check_user_tags" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.tags.<b>check_user_tags</b> | |||
<i class="text-muted">(dt)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>if the user does not have a tags column, then it creates one</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.tags.get_tags</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.tags.get_tags" href="#frappe.desk.tags.get_tags" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.tags.<b>get_tags</b> | |||
<i class="text-muted">(doctype, txt)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.desk.tags.remove_tag</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.desk.tags.remove_tag" href="#frappe.desk.tags.remove_tag" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.desk.tags.<b>remove_tag</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>removes tag from the record</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,19 @@ | |||
<!-- title: desk --> | |||
<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/tree/v6.6.1/desk" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3>Package Contents</h3> | |||
{index} | |||
<!-- autodoc --> |
@@ -0,0 +1,12 @@ | |||
frappe.desk.calendar | |||
frappe.desk.desk_page | |||
frappe.desk | |||
frappe.desk.moduleview | |||
frappe.desk.notifications | |||
frappe.desk.query_builder | |||
frappe.desk.query_report | |||
frappe.desk.report_dump | |||
frappe.desk.reportview | |||
frappe.desk.search | |||
frappe.desk.star | |||
frappe.desk.tags |
@@ -0,0 +1,197 @@ | |||
<!-- title: frappe.email.bulk --><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/email/bulk.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>BulkLimitCrossedError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.bulk.add" href="#frappe.email.bulk.add" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>add</b> | |||
<i class="text-muted">(email, sender, subject, formatted, text_content=None, reference_doctype=None, reference_name=None, attachments=None, reply_to=None, cc=(), message_id=None, send_after=None, bulk_priority=1)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>add to bulk mail queue</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.bulk.check_bulk_limit" href="#frappe.email.bulk.check_bulk_limit" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>check_bulk_limit</b> | |||
<i class="text-muted">(recipients)</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.email.bulk.clear_outbox" href="#frappe.email.bulk.clear_outbox" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>clear_outbox</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Remove mails older than 31 days in Outbox. Called daily via scheduler.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.bulk.flush" href="#frappe.email.bulk.flush" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>flush</b> | |||
<i class="text-muted">(from_test=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>flush email queue, every time: called from scheduler</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.bulk.get_unsubcribed_url" href="#frappe.email.bulk.get_unsubcribed_url" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>get_unsubcribed_url</b> | |||
<i class="text-muted">(reference_doctype, reference_name, email, unsubscribe_method, unsubscribe_params)</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.email.bulk.get_unsubscribe_link" href="#frappe.email.bulk.get_unsubscribe_link" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>get_unsubscribe_link</b> | |||
<i class="text-muted">(reference_doctype, reference_name, email, recipients, expose_recipients, show_as_cc, unsubscribe_method, unsubscribe_params, unsubscribe_message)</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.email.bulk.return_unsubscribed_page" href="#frappe.email.bulk.return_unsubscribed_page" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>return_unsubscribed_page</b> | |||
<i class="text-muted">(email, doctype, name)</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.email.bulk.send" href="#frappe.email.bulk.send" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>send</b> | |||
<i class="text-muted">(recipients=None, sender=None, subject=None, message=None, reference_doctype=None, reference_name=None, unsubscribe_method=None, unsubscribe_params=None, unsubscribe_message=None, attachments=None, reply_to=None, cc=(), show_as_cc=(), message_id=None, send_after=None, expose_recipients=False, bulk_priority=1)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Add email to sending queue (Bulk Email)</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.</li> | |||
<li><strong><code>subject</code></strong> - Email subject.</li> | |||
<li><strong><code>message</code></strong> - Email message.</li> | |||
<li><strong><code>reference_doctype</code></strong> - Reference DocType of caller document.</li> | |||
<li><strong><code>reference_name</code></strong> - Reference name of caller document.</li> | |||
<li><strong><code>bulk_priority</code></strong> - Priority for bulk email, default 1.</li> | |||
<li><strong><code>unsubscribe_method</code></strong> - URL method for unsubscribe. Default is <code>/api/method/frappe.email.bulk.unsubscribe</code>.</li> | |||
<li><strong><code>unsubscribe_params</code></strong> - additional params for unsubscribed links. default are name, doctype, email</li> | |||
<li><strong><code>attachments</code></strong> - Attachments to be sent.</li> | |||
<li><strong><code>reply_to</code></strong> - Reply to be captured here (default inbox)</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 this email after the given datetime. If value is in integer, then <code>send_after</code> will be the automatically set to no of days from current date.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.email.bulk.unsubscribe</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.bulk.unsubscribe" href="#frappe.email.bulk.unsubscribe" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.bulk.<b>unsubscribe</b> | |||
<i class="text-muted">(doctype, name, email)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,293 @@ | |||
<!-- title: frappe.email.email_body --><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/email/email_body.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>EMail</b></h3> | |||
<div class="docs-attr-desc"><p>Wrapper on the email module. Email object represents emails to be sent to the client. | |||
Also provides a clean way to add binary <code>FileData</code> attachments | |||
Also sets all messages as multipart/alternative for cleaner reading in text-only clients</p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, sender=, recipients=(), subject=, alternative=0, reply_to=None, cc=())</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="add_attachment" href="#add_attachment" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_attachment</b> | |||
<i class="text-muted">(self, fname, fcontent, content_type=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>add attachment</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="add_pdf_attachment" href="#add_pdf_attachment" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_pdf_attachment</b> | |||
<i class="text-muted">(self, name, html, options=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="as_string" href="#as_string" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>as_string</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>validate, build message and convert to string</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="attach_file" href="#attach_file" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>attach_file</b> | |||
<i class="text-muted">(self, n)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>attach a file from the <code>FileData</code> table</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_default_sender" href="#get_default_sender" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_default_sender</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="make" href="#make" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>make</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>build into msg_root</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_html" href="#set_html" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_html</b> | |||
<i class="text-muted">(self, message, text_content=None, footer=None, print_html=None, formatted=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Attach message in the html portion of multipart/alternative</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_html_as_text" href="#set_html_as_text" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_html_as_text</b> | |||
<i class="text-muted">(self, html)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>return html2text</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_message" href="#set_message" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_message</b> | |||
<i class="text-muted">(self, message, mime_type=text/html, as_attachment=0, filename=attachment.html)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Append the message with MIME content to the root node (as attachment)</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_message_id" href="#set_message_id" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_message_id</b> | |||
<i class="text-muted">(self, message_id)</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="set_part_html" href="#set_part_html" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_part_html</b> | |||
<i class="text-muted">(self, message)</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="set_text" href="#set_text" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_text</b> | |||
<i class="text-muted">(self, message)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Attach message in the text portion of multipart/alternative</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="validate" href="#validate" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>validate</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>validate the email ids</p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.email_body.get_email" href="#frappe.email.email_body.get_email" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.email_body.<b>get_email</b> | |||
<i class="text-muted">(recipients, sender=, msg=, subject=[No Subject], text_content=None, footer=None, print_html=None, formatted=None, attachments=None, content=None, reply_to=None, cc=())</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>send an html email as multipart with attachments and all</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.email_body.get_footer" href="#frappe.email.email_body.get_footer" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.email_body.<b>get_footer</b> | |||
<i class="text-muted">(email_account, footer=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>append a footer (signature)</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.email_body.get_formatted_html" href="#frappe.email.email_body.get_formatted_html" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.email_body.<b>get_formatted_html</b> | |||
<i class="text-muted">(subject, message, footer=None, print_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.email.email_body.get_signature" href="#frappe.email.email_body.get_signature" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.email_body.<b>get_signature</b> | |||
<i class="text-muted">(email_account)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,100 @@ | |||
<!-- title: frappe.email --><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/email.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.email.get_contact_list</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.get_contact_list" href="#frappe.email.get_contact_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.<b>get_contact_list</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns contacts (from autosuggest)</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.get_system_managers" href="#frappe.email.get_system_managers" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.<b>get_system_managers</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.email.sendmail" href="#frappe.email.sendmail" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.<b>sendmail</b> | |||
<i class="text-muted">(recipients, sender=, msg=, subject=[No Subject], attachments=None, content=None, reply_to=None, cc=(), message_id=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>send an html email as multipart with attachments and all</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.sendmail_md" href="#frappe.email.sendmail_md" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.<b>sendmail_md</b> | |||
<i class="text-muted">(recipients, sender=None, msg=None, subject=None, attachments=None, content=None, reply_to=None, cc=(), message_id=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>send markdown email</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.sendmail_to_system_managers" href="#frappe.email.sendmail_to_system_managers" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.<b>sendmail_to_system_managers</b> | |||
<i class="text-muted">(subject, content)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,575 @@ | |||
<!-- title: frappe.email.receive --><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/email/receive.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>Email</b></h3> | |||
<div class="docs-attr-desc"><p>Wrapper for an email.</p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, content)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Parses headers, content, attachments from given raw message.</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>content</code></strong> - Raw message.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_attachment" href="#get_attachment" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_attachment</b> | |||
<i class="text-muted">(self, part, charset)</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="get_charset" href="#get_charset" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_charset</b> | |||
<i class="text-muted">(self, part)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Detect chartset.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_payload" href="#get_payload" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_payload</b> | |||
<i class="text-muted">(self, part, charset)</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="get_thread_id" href="#get_thread_id" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_thread_id</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Extract thread ID from <code>[]</code></p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="parse" href="#parse" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>parse</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Walk and process multi-part email.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="process_part" href="#process_part" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>process_part</b> | |||
<i class="text-muted">(self, part)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Parse email <code>part</code> and set it to <code>text_content</code>, <code>html_content</code> or <code>attachments</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="save_attachments_in_doc" href="#save_attachments_in_doc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>save_attachments_in_doc</b> | |||
<i class="text-muted">(self, doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Save email attachments in given document.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_content_and_type" href="#set_content_and_type" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_content_and_type</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="set_subject" href="#set_subject" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_subject</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Parse and decode <code>Subject</code> header.</p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>EmailSizeExceededError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>EmailTimeoutError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>LoginLimitExceeded</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>POP3Server</b></h3> | |||
<div class="docs-attr-desc"><p>Wrapper for POP server to pull emails.</p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, args=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="check_mails" href="#check_mails" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>check_mails</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="connect" href="#connect" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>connect</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Connect to <strong>Email Account</strong>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_messages" href="#get_messages" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_messages</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns new email messages in a list.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="has_login_limit_exceeded" href="#has_login_limit_exceeded" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>has_login_limit_exceeded</b> | |||
<i class="text-muted">(self, e)</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="is_temporary_system_problem" href="#is_temporary_system_problem" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>is_temporary_system_problem</b> | |||
<i class="text-muted">(self, e)</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="make_error_msg" href="#make_error_msg" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>make_error_msg</b> | |||
<i class="text-muted">(self, msg_num, incoming_mail)</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="process_message" href="#process_message" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>process_message</b> | |||
<i class="text-muted">(self, mail)</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="retrieve_message" href="#retrieve_message" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>retrieve_message</b> | |||
<i class="text-muted">(self, pop_meta, msg_num)</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="setup" href="#setup" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>setup</b> | |||
<i class="text-muted">(self, args=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="validate_pop" href="#validate_pop" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>validate_pop</b> | |||
<i class="text-muted">(self, pop_meta)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>Timed_POP3</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.email.receive.TimerMixin, poplib.POP3</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</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="_getline" href="#_getline" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>_getline</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="quit" href="#quit" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>quit</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>Timed_POP3_SSL</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.email.receive.TimerMixin, poplib.POP3_SSL</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</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="_getline" href="#_getline" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>_getline</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="quit" href="#quit" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>quit</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>TimerMixin</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from __builtin__.object</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</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="_getline" href="#_getline" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>_getline</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="quit" href="#quit" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>quit</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>TotalSizeExceededError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<!-- autodoc --> |
@@ -0,0 +1,125 @@ | |||
<!-- title: frappe.email.smtp --><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/email/smtp.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>SMTPServer</b></h3> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, login=None, password=None, server=None, port=None, use_ssl=None, append_to=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="setup_email_account" href="#setup_email_account" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>setup_email_account</b> | |||
<i class="text-muted">(self, append_to=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.smtp._get_email_account" href="#frappe.email.smtp._get_email_account" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.smtp.<b>_get_email_account</b> | |||
<i class="text-muted">(filters)</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.email.smtp.get_default_outgoing_email_account" href="#frappe.email.smtp.get_default_outgoing_email_account" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.smtp.<b>get_default_outgoing_email_account</b> | |||
<i class="text-muted">(raise_exception_not_set=True)</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.email.smtp.get_outgoing_email_account" href="#frappe.email.smtp.get_outgoing_email_account" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.smtp.<b>get_outgoing_email_account</b> | |||
<i class="text-muted">(raise_exception_not_set=True, append_to=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns outgoing email account based on <code>append_to</code> or the default | |||
outgoing account. If default outgoing account is not found, it will | |||
try getting settings from <code>site_config.json</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.email.smtp.send" href="#frappe.email.smtp.send" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.email.smtp.<b>send</b> | |||
<i class="text-muted">(email, append_to=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>send the message or add it to Outbox Email</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,19 @@ | |||
<!-- title: email --> | |||
<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/tree/v6.6.1/email" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3>Package Contents</h3> | |||
{index} | |||
<!-- autodoc --> |
@@ -0,0 +1,5 @@ | |||
frappe.email.bulk | |||
frappe.email.email_body | |||
frappe.email | |||
frappe.email.receive | |||
frappe.email.smtp |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.__version__ --><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/__version__.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,53 @@ | |||
<!-- title: frappe.api --><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/api.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.api.handle" href="#frappe.api.handle" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.api.<b>handle</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Handler for <code>/api</code> methods</p> | |||
<h3>Examples:</h3> | |||
<p><code>/api/method/{methodname}</code> will call a whitelisted method</p> | |||
<p><code>/api/resource/{doctype}</code> will query a table | |||
examples: | |||
- <code>?fields=["name", "owner"]</code> | |||
- <code>?filters=[["Task", "name", "like", "%005"]]</code> | |||
- <code>?limit_start=0</code> | |||
- <code>?limit_page_length=20</code></p> | |||
<p><code>/api/resource/{doctype}/{name}</code> will point to a resource | |||
<code>GET</code> will return doclist | |||
<code>POST</code> will insert | |||
<code>PUT</code> will update | |||
<code>DELETE</code> will delete</p> | |||
<p><code>/api/resource/{doctype}/{name}?run_method={method}</code> will run a whitelisted controller method</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,123 @@ | |||
<!-- title: frappe.app --><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/app.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>RequestContext</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from __builtin__.object</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__enter__" href="#__enter__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__enter__</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="__exit__" href="#__exit__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__exit__</b> | |||
<i class="text-muted">(self, type, value, traceback)</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="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, environ)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.app.init_site" href="#frappe.app.init_site" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.app.<b>init_site</b> | |||
<i class="text-muted">(request)</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.app.make_form_dict" href="#frappe.app.make_form_dict" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.app.<b>make_form_dict</b> | |||
<i class="text-muted">(request)</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.app.serve" href="#frappe.app.serve" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.app.<b>serve</b> | |||
<i class="text-muted">(port=8000, profile=False, site=None, sites_path=.)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,394 @@ | |||
<!-- title: frappe.async --><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/async.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>FileAndRedisStream</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from __builtin__.file</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</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="write" href="#write" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>write</b> | |||
<i class="text-muted">(self, data)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.async.can_subscribe_doc</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.async.can_subscribe_doc" href="#frappe.async.can_subscribe_doc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>can_subscribe_doc</b> | |||
<i class="text-muted">(doctype, docname, sid)</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.async.emit_via_redis" href="#frappe.async.emit_via_redis" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>emit_via_redis</b> | |||
<i class="text-muted">(event, message, room)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Publish real-time updates via redis</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> - name of the room</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.async.get_doc_room" href="#frappe.async.get_doc_room" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_doc_room</b> | |||
<i class="text-muted">(doctype, docname)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.async.get_pending_tasks_for_doc</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.async.get_pending_tasks_for_doc" href="#frappe.async.get_pending_tasks_for_doc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_pending_tasks_for_doc</b> | |||
<i class="text-muted">(doctype, docname)</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.async.get_redis_server" href="#frappe.async.get_redis_server" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_redis_server</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.async.get_site_room" href="#frappe.async.get_site_room" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_site_room</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.async.get_std_streams" href="#frappe.async.get_std_streams" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_std_streams</b> | |||
<i class="text-muted">(task_id)</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.async.get_task_log_file_path" href="#frappe.async.get_task_log_file_path" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_task_log_file_path</b> | |||
<i class="text-muted">(task_id, stream_type)</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.async.get_task_progress_room" href="#frappe.async.get_task_progress_room" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_task_progress_room</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.async.get_task_status</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.async.get_task_status" href="#frappe.async.get_task_status" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_task_status</b> | |||
<i class="text-muted">(task_id)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.async.get_user_info</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.async.get_user_info" href="#frappe.async.get_user_info" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_user_info</b> | |||
<i class="text-muted">(sid)</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.async.get_user_room" href="#frappe.async.get_user_room" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>get_user_room</b> | |||
<i class="text-muted">(user)</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.async.handler" href="#frappe.async.handler" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>handler</b> | |||
<i class="text-muted">(f)</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.async.is_file_old" href="#frappe.async.is_file_old" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>is_file_old</b> | |||
<i class="text-muted">(file_path)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.async.ping</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.async.ping" href="#frappe.async.ping" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>ping</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.async.publish_realtime" href="#frappe.async.publish_realtime" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>publish_realtime</b> | |||
<i class="text-muted">(event=None, message=None, room=None, user=None, doctype=None, docname=None, now=False)</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. that will be handled by the client (default is <code>task_progress</code> if within task or <code>global</code>)</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.async.put_log" href="#frappe.async.put_log" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>put_log</b> | |||
<i class="text-muted">(line_no, line, task_id=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.async.remove_old_task_logs" href="#frappe.async.remove_old_task_logs" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>remove_old_task_logs</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.async.set_task_status" href="#frappe.async.set_task_status" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.async.<b>set_task_status</b> | |||
<i class="text-muted">(task_id, status, response=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,485 @@ | |||
<!-- title: frappe.auth --><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/auth.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>CookieManager</b></h3> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</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="delete_cookie" href="#delete_cookie" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>delete_cookie</b> | |||
<i class="text-muted">(self, to_delete)</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="flush_cookies" href="#flush_cookies" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>flush_cookies</b> | |||
<i class="text-muted">(self, response)</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="init_cookies" href="#init_cookies" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>init_cookies</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="set_cookie" href="#set_cookie" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_cookie</b> | |||
<i class="text-muted">(self, key, value, expires=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>HTTPRequest</b></h3> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</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="connect" href="#connect" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>connect</b> | |||
<i class="text-muted">(self, ac_name=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>connect to db, from ac<em>name or db</em>name</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_db_name" href="#get_db_name" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_db_name</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get database name from conf</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_lang" href="#set_lang" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_lang</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="validate_csrf_token" href="#validate_csrf_token" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>validate_csrf_token</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>LoginManager</b></h3> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</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="authenticate" href="#authenticate" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>authenticate</b> | |||
<i class="text-muted">(self, user=None, pwd=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="check_if_enabled" href="#check_if_enabled" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>check_if_enabled</b> | |||
<i class="text-muted">(self, user)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>raise exception if user not enabled</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="check_password" href="#check_password" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>check_password</b> | |||
<i class="text-muted">(self, user, pwd)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>check password</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="clear_active_sessions" href="#clear_active_sessions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>clear_active_sessions</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="clear_cookies" href="#clear_cookies" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>clear_cookies</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="fail" href="#fail" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>fail</b> | |||
<i class="text-muted">(self, message)</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="login" href="#login" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>login</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="login_as" href="#login_as" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>login_as</b> | |||
<i class="text-muted">(self, user)</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="login_as_guest" href="#login_as_guest" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>login_as_guest</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>login as guest</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="logout" href="#logout" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>logout</b> | |||
<i class="text-muted">(self, arg=, user=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="make_session" href="#make_session" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>make_session</b> | |||
<i class="text-muted">(self, resume=False)</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="post_login" href="#post_login" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>post_login</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="run_trigger" href="#run_trigger" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>run_trigger</b> | |||
<i class="text-muted">(self, event=on_login)</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="set_user_info" href="#set_user_info" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_user_info</b> | |||
<i class="text-muted">(self, resume=False)</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="validate_hour" href="#validate_hour" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>validate_hour</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>check if user is logging in during restricted hours</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="validate_ip_address" href="#validate_ip_address" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>validate_ip_address</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>check if IP Address is valid</p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.auth._update_password" href="#frappe.auth._update_password" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.auth.<b>_update_password</b> | |||
<i class="text-muted">(user, password)</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.auth.clear_cookies" href="#frappe.auth.clear_cookies" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.auth.<b>clear_cookies</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.auth.get_logged_user</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.auth.get_logged_user" href="#frappe.auth.get_logged_user" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.auth.<b>get_logged_user</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,178 @@ | |||
<!-- title: frappe.boot --><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/boot.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.boot.add_home_page" href="#frappe.boot.add_home_page" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>add_home_page</b> | |||
<i class="text-muted">(bootinfo, docs)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>load home page</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.boot.add_timezone_info" href="#frappe.boot.add_timezone_info" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>add_timezone_info</b> | |||
<i class="text-muted">(bootinfo)</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.boot.get_allowed_pages" href="#frappe.boot.get_allowed_pages" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>get_allowed_pages</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.boot.get_bootinfo" href="#frappe.boot.get_bootinfo" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>get_bootinfo</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>build and return boot info</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.boot.get_fullnames" href="#frappe.boot.get_fullnames" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>get_fullnames</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>map of user fullnames</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.boot.get_user" href="#frappe.boot.get_user" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>get_user</b> | |||
<i class="text-muted">(bootinfo)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get user info</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.boot.load_conf_settings" href="#frappe.boot.load_conf_settings" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>load_conf_settings</b> | |||
<i class="text-muted">(bootinfo)</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.boot.load_print" href="#frappe.boot.load_print" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>load_print</b> | |||
<i class="text-muted">(bootinfo, doclist)</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.boot.load_print_css" href="#frappe.boot.load_print_css" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>load_print_css</b> | |||
<i class="text-muted">(bootinfo, print_settings)</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.boot.load_translations" href="#frappe.boot.load_translations" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.boot.<b>load_translations</b> | |||
<i class="text-muted">(bootinfo)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,178 @@ | |||
<!-- title: frappe.build --><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/build.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.build.build" href="#frappe.build.build" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>build</b> | |||
<i class="text-muted">(no_compress=False, verbose=False)</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.build.bundle" href="#frappe.build.bundle" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>bundle</b> | |||
<i class="text-muted">(no_compress, make_copy=False, verbose=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>concat / minify js files</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.build.compile_less" href="#frappe.build.compile_less" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>compile_less</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.build.files_dirty" href="#frappe.build.files_dirty" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>files_dirty</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.build.get_build_maps" href="#frappe.build.get_build_maps" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>get_build_maps</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get all build.jsons with absolute paths</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.build.html_to_js_template" href="#frappe.build.html_to_js_template" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>html_to_js_template</b> | |||
<i class="text-muted">(path, content)</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.build.make_asset_dirs" href="#frappe.build.make_asset_dirs" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>make_asset_dirs</b> | |||
<i class="text-muted">(make_copy=False)</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.build.pack" href="#frappe.build.pack" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>pack</b> | |||
<i class="text-muted">(target, sources, no_compress, verbose)</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.build.setup" href="#frappe.build.setup" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>setup</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.build.watch" href="#frappe.build.watch" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.build.<b>watch</b> | |||
<i class="text-muted">(no_compress)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>watch and rebuild if necessary</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,261 @@ | |||
<!-- title: frappe.celery_app --><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/celery_app.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>AsyncTaskRouter</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from __builtin__.object</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="route_for_task" href="#route_for_task" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>route_for_task</b> | |||
<i class="text-muted">(self, task, args=None, kwargs=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>MonitorThread</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from __builtin__.object</i></h4> | |||
<div class="docs-attr-desc"><p>Thread manager for monitoring celery events</p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, celery_app, interval=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="catchall" href="#catchall" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>catchall</b> | |||
<i class="text-muted">(self, event)</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="run" href="#run" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>run</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>SiteRouter</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from __builtin__.object</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="route_for_task" href="#route_for_task" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>route_for_task</b> | |||
<i class="text-muted">(self, task, args=None, kwargs=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.celery_app.celery_task" href="#frappe.celery_app.celery_task" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>celery_task</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.celery_app.get_beat_schedule" href="#frappe.celery_app.get_beat_schedule" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>get_beat_schedule</b> | |||
<i class="text-muted">(conf)</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.celery_app.get_celery" href="#frappe.celery_app.get_celery" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>get_celery</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.celery_app.get_celery_app" href="#frappe.celery_app.get_celery_app" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>get_celery_app</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.celery_app.get_queue" href="#frappe.celery_app.get_queue" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>get_queue</b> | |||
<i class="text-muted">(site, prefix=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.celery_app.get_site_config" href="#frappe.celery_app.get_site_config" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>get_site_config</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.celery_app.make_async_task" href="#frappe.celery_app.make_async_task" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>make_async_task</b> | |||
<i class="text-muted">(args)</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.celery_app.run_test" href="#frappe.celery_app.run_test" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.celery_app.<b>run_test</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,288 @@ | |||
<!-- title: frappe.client --><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/client.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.bulk_update</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.bulk_update" href="#frappe.client.bulk_update" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>bulk_update</b> | |||
<i class="text-muted">(docs)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.cancel</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.cancel" href="#frappe.client.cancel" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>cancel</b> | |||
<i class="text-muted">(doctype, name)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.delete</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.delete" href="#frappe.client.delete" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>delete</b> | |||
<i class="text-muted">(doctype, name)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.get</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.get" href="#frappe.client.get" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>get</b> | |||
<i class="text-muted">(doctype, name=None, filters=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.get_js</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.get_js" href="#frappe.client.get_js" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>get_js</b> | |||
<i class="text-muted">(src)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.get_list</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.get_list" href="#frappe.client.get_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>get_list</b> | |||
<i class="text-muted">(doctype, fields=None, filters=None, order_by=None, limit_start=None, limit_page_length=20)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.get_value</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.get_value" href="#frappe.client.get_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>get_value</b> | |||
<i class="text-muted">(doctype, fieldname, filters=None, as_dict=True, debug=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.has_permission</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.has_permission" href="#frappe.client.has_permission" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>has_permission</b> | |||
<i class="text-muted">(doctype, docname, perm_type=read)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.insert</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.insert" href="#frappe.client.insert" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>insert</b> | |||
<i class="text-muted">(doc=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.make_width_property_setter</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.make_width_property_setter" href="#frappe.client.make_width_property_setter" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>make_width_property_setter</b> | |||
<i class="text-muted">(doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.rename_doc</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.rename_doc" href="#frappe.client.rename_doc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>rename_doc</b> | |||
<i class="text-muted">(doctype, old_name, new_name, merge=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.save</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.save" href="#frappe.client.save" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>save</b> | |||
<i class="text-muted">(doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.set_default</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.set_default" href="#frappe.client.set_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>set_default</b> | |||
<i class="text-muted">(key, value, parent=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>set a user default value</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.set_value</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.set_value" href="#frappe.client.set_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>set_value</b> | |||
<i class="text-muted">(doctype, name, fieldname, value)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.client.submit</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.client.submit" href="#frappe.client.submit" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.client.<b>submit</b> | |||
<i class="text-muted">(doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,146 @@ | |||
<!-- title: frappe.commands --><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/commands.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.commands._is_scheduler_enabled" href="#frappe.commands._is_scheduler_enabled" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>_is_scheduler_enabled</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.commands._new_site" href="#frappe.commands._new_site" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>_new_site</b> | |||
<i class="text-muted">(db_name, site, mariadb_root_username=None, mariadb_root_password=None, admin_password=None, verbose=False, install_apps=None, source_sql=None, force=False, reinstall=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Install a new Frappe site</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.commands.call_command" href="#frappe.commands.call_command" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>call_command</b> | |||
<i class="text-muted">(cmd, context)</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.commands.get_single_site" href="#frappe.commands.get_single_site" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>get_single_site</b> | |||
<i class="text-muted">(context)</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.commands.move" href="#frappe.commands.move" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>move</b> | |||
<i class="text-muted">(dest_dir, site)</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.commands.pass_context" href="#frappe.commands.pass_context" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>pass_context</b> | |||
<i class="text-muted">(f)</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.commands.prepare_for_update" href="#frappe.commands.prepare_for_update" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>prepare_for_update</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.commands.use" href="#frappe.commands.use" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.commands.<b>use</b> | |||
<i class="text-muted">(site, sites_path=.)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,952 @@ | |||
<!-- title: frappe.database --><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/database.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>Database</b></h3> | |||
<div class="docs-attr-desc"><p>Open a database connection with the given parmeters, if use_default is True, use the | |||
login details from <code>conf.py</code>. This is called by the request handler and is accessible using | |||
the <code>db</code> global variable. the <code>sql</code> method is also global to run queries</p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, host=None, user=None, password=None, ac_name=None, use_default=0)</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="_get_value_for_many_names" href="#_get_value_for_many_names" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>_get_value_for_many_names</b> | |||
<i class="text-muted">(self, doctype, names, field, debug=False)</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="_get_values_from_table" href="#_get_values_from_table" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>_get_values_from_table</b> | |||
<i class="text-muted">(self, fields, filters, doctype, as_dict, debug, order_by=None, update=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="a_row_exists" href="#a_row_exists" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>a_row_exists</b> | |||
<i class="text-muted">(self, doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns True if atleast one row exists.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="add_default" href="#add_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_default</b> | |||
<i class="text-muted">(self, key, val, parent=__default, parenttype=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Append a default value for a key, there can be multiple default values for a particular key.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="add_index" href="#add_index" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_index</b> | |||
<i class="text-muted">(self, doctype, fields, index_name=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Creates an index with given fields if not already created. | |||
Index name will be <code>fieldname1_fieldname2_index</code></p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="add_unique" href="#add_unique" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>add_unique</b> | |||
<i class="text-muted">(self, doctype, fields, constraint_name=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="begin" href="#begin" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>begin</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="build_conditions" href="#build_conditions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>build_conditions</b> | |||
<i class="text-muted">(self, filters)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Convert filters sent as dict, lists to SQL conditions. filter's key | |||
is passed by map function, build conditions like:</p> | |||
<ul> | |||
<li>ifnull(<code>fieldname</code>, default_value) = %(fieldname)s</li> | |||
<li><code>fieldname</code> [=, !=, >, >=, <, <=] %(fieldname)s</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="check_transaction_status" href="#check_transaction_status" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>check_transaction_status</b> | |||
<i class="text-muted">(self, query)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Raises exception if more than 20,000 <code>INSERT</code>, <code>UPDATE</code> queries are | |||
executed in one transaction. This is to ensure that writes are always flushed otherwise this | |||
could cause the system to hang.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="close" href="#close" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>close</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Close database connection.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="commit" href="#commit" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>commit</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Commit current transaction. Calls SQL <code>COMMIT</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="connect" href="#connect" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>connect</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Connects to a database as set in <code>site_config.json</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="convert_to_lists" href="#convert_to_lists" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>convert_to_lists</b> | |||
<i class="text-muted">(self, res, formatted=0, as_utf8=0)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Convert tuple output to lists (internal).</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="convert_to_simple_type" href="#convert_to_simple_type" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>convert_to_simple_type</b> | |||
<i class="text-muted">(self, v, formatted=0)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Format date, time, longint values.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="convert_to_utf8" href="#convert_to_utf8" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>convert_to_utf8</b> | |||
<i class="text-muted">(self, res, formatted=0)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Encode result as UTF-8.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="count" href="#count" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>count</b> | |||
<i class="text-muted">(self, dt, filters=None, debug=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns <code>COUNT(*)</code> for given DocType and filters.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="escape" href="#escape" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>escape</b> | |||
<i class="text-muted">(self, s)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Excape quotes and percent in given string.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="exists" href="#exists" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>exists</b> | |||
<i class="text-muted">(self, dt, dn=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns true if document exists.</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>dt</code></strong> - DocType name.</li> | |||
<li><strong><code>dn</code></strong> - Document name or filter dict.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="explain_query" href="#explain_query" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>explain_query</b> | |||
<i class="text-muted">(self, query, values=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Print <code>EXPLAIN</code> in error log.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="fetch_as_dict" href="#fetch_as_dict" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>fetch_as_dict</b> | |||
<i class="text-muted">(self, formatted=0, as_utf8=0)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Internal. Converts results to dict.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="field_exists" href="#field_exists" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>field_exists</b> | |||
<i class="text-muted">(self, dt, fn)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Return true of field exists.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get" href="#get" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get</b> | |||
<i class="text-muted">(self, doctype, filters=None, as_dict=True, cache=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns <code>get_value</code> with fieldname='*'</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_all" href="#get_all" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_all</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="get_creation_count" href="#get_creation_count" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_creation_count</b> | |||
<i class="text-muted">(self, doctype, minutes)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Get count of records created in the last x minutes</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_db_login" href="#get_db_login" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_db_login</b> | |||
<i class="text-muted">(self, ac_name)</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="get_default" href="#get_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_default</b> | |||
<i class="text-muted">(self, key, parent=__default)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns default value as a list if multiple or single</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_defaults" href="#get_defaults" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_defaults</b> | |||
<i class="text-muted">(self, key=None, parent=__default)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Get all defaults</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_defaults_as_list" href="#get_defaults_as_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_defaults_as_list</b> | |||
<i class="text-muted">(self, key, parent=__default)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns default values as a list.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_description" href="#get_description" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_description</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns result metadata.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_global" href="#get_global" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_global</b> | |||
<i class="text-muted">(self, key, user=__global)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns a global key value.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_list" href="#get_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_list</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="get_single_value" href="#get_single_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_single_value</b> | |||
<i class="text-muted">(self, doctype, fieldname, cache=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Get property of Single DocType. Cache locally by default</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_singles_dict" href="#get_singles_dict" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_singles_dict</b> | |||
<i class="text-muted">(self, doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Get Single DocType as dict.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_singles_value" href="#get_singles_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_singles_value</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Alias for get<em>single</em>value</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_table_columns" href="#get_table_columns" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_table_columns</b> | |||
<i class="text-muted">(self, doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns list of column names from given doctype.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_tables" href="#get_tables" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_tables</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="get_temp" href="#get_temp" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_temp</b> | |||
<i class="text-muted">(self, key)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Return the temperory value and delete it.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_value" href="#get_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_value</b> | |||
<i class="text-muted">(self, doctype, filters=None, fieldname=name, ignore=None, as_dict=False, debug=False, cache=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns a document property or list of properties.</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> | |||
<p>Example:</p> | |||
<pre><code># return first customer starting with a | |||
frappe.db.get_value("Customer", {"name": ("like a%")}) | |||
# return last login of **User** `test@example.com` | |||
frappe.db.get_value("User", "test@example.com", "last_login") | |||
last_login, last_ip = frappe.db.get_value("User", "test@example.com", | |||
["last_login", "last_ip"]) | |||
# returns default date_format | |||
frappe.db.get_value("System Settings", None, "date_format") | |||
</code></pre> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_values" href="#get_values" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_values</b> | |||
<i class="text-muted">(self, doctype, filters=None, fieldname=name, ignore=None, as_dict=False, debug=False, order_by=None, update=None, cache=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns multiple document properties.</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.</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> | |||
<p>Example:</p> | |||
<pre><code># return first customer starting with a | |||
customers = frappe.db.get_values("Customer", {"name": ("like a%")}) | |||
# return last login of **User** `test@example.com` | |||
user = frappe.db.get_values("User", "test@example.com", "*")[0] | |||
</code></pre> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_values_from_single" href="#get_values_from_single" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_values_from_single</b> | |||
<i class="text-muted">(self, fields, filters, doctype, as_dict=False, debug=False, update=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Get values from <code>tabSingles</code> (Single DocTypes) (internal).</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>fields</code></strong> - List of fields,</li> | |||
<li><strong><code>filters</code></strong> - Filters (dict).</li> | |||
<li><strong><code>doctype</code></strong> - DocType name.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="has_column" href="#has_column" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>has_column</b> | |||
<i class="text-muted">(self, doctype, column)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns True if column exists in database.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="needs_formatting" href="#needs_formatting" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>needs_formatting</b> | |||
<i class="text-muted">(self, result, formatted)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns true if the first row in the result has a Date, Datetime, Long Int.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="rollback" href="#rollback" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>rollback</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><code>ROLLBACK</code> current transaction.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set" href="#set" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set</b> | |||
<i class="text-muted">(self, doc, field, val)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Set value in document. <strong>Avoid</strong></p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_default" href="#set_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_default</b> | |||
<i class="text-muted">(self, key, val, parent=__default, parenttype=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Sets a global / user default value.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_global" href="#set_global" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_global</b> | |||
<i class="text-muted">(self, key, val, user=__global)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Save a global key value. Global values will be automatically set if they match fieldname.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_temp" href="#set_temp" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_temp</b> | |||
<i class="text-muted">(self, value)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Set a temperory value and return a key.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="set_value" href="#set_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_value</b> | |||
<i class="text-muted">(self, dt, dn, field, val, modified=None, modified_by=None, update_modified=True, debug=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Set a single value in the database, do not call the ORM triggers | |||
but update the modified timestamp (unless specified not to).</p> | |||
<p><strong>Warning:</strong> this function will not call Document events and should be avoided in normal cases.</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>dt</code></strong> - DocType name.</li> | |||
<li><strong><code>dn</code></strong> - Document name.</li> | |||
<li><strong><code>field</code></strong> - Property / field name.</li> | |||
<li><strong><code>value</code></strong> - Value to be updated.</li> | |||
<li><strong><code>modified</code></strong> - Use this as the <code>modified</code> timestamp.</li> | |||
<li><strong><code>modified_by</code></strong> - Set this user as <code>modified_by</code>.</li> | |||
<li><strong><code>update_modified</code></strong> - default True. Set as false, if you don't want to update the timestamp.</li> | |||
<li><strong><code>debug</code></strong> - Print the query in the developer / js console.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="sql" href="#sql" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>sql</b> | |||
<i class="text-muted">(self, query, values=(), as_dict=0, as_list=0, formatted=0, debug=0, ignore_ddl=0, as_utf8=0, auto_commit=0, update=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Execute a SQL query and fetch all rows.</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>query</code></strong> - SQL query.</li> | |||
<li><strong><code>values</code></strong> - List / dict of values to be escaped and substituted in the query.</li> | |||
<li><strong><code>as_dict</code></strong> - Return as a dictionary.</li> | |||
<li><strong><code>as_list</code></strong> - Always return as a list.</li> | |||
<li><strong><code>formatted</code></strong> - Format values like date etc.</li> | |||
<li><strong><code>debug</code></strong> - Print query and <code>EXPLAIN</code> in debug log.</li> | |||
<li><strong><code>ignore_ddl</code></strong> - Catch exception if table, column missing.</li> | |||
<li><strong><code>as_utf8</code></strong> - Encode values as UTF 8.</li> | |||
<li><strong><code>auto_commit</code></strong> - Commit after executing the query.</li> | |||
<li><strong><code>update</code></strong> - Update this dict to all rows (if returned <code>as_dict</code>).</li> | |||
</ul> | |||
<p>Examples:</p> | |||
<pre><code># return customer names as dicts | |||
frappe.db.sql("select name from tabCustomer", as_dict=True) | |||
# return names beginning with a | |||
frappe.db.sql("select name from tabCustomer where name like %s", "a%") | |||
# values as dict | |||
frappe.db.sql("select name from tabCustomer where name like %(name)s and owner=%(owner)s", | |||
{"name": "a%", "owner":"test@example.com"}) | |||
</code></pre> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="sql_ddl" href="#sql_ddl" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>sql_ddl</b> | |||
<i class="text-muted">(self, query, values=(), debug=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Commit and execute a query. DDL (Data Definition Language) queries that alter schema | |||
autocommit in MariaDB.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="sql_list" href="#sql_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>sql_list</b> | |||
<i class="text-muted">(self, query, values=(), debug=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Return data as list of single elements (first column).</p> | |||
<p>Example:</p> | |||
<pre><code># doctypes = ["DocType", "DocField", "User", ...] | |||
doctypes = frappe.db.sql_list("select name from DocType") | |||
</code></pre> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="table_exists" href="#table_exists" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>table_exists</b> | |||
<i class="text-muted">(self, tablename)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns True if table exists.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="touch" href="#touch" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>touch</b> | |||
<i class="text-muted">(self, doctype, docname)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Update the modified timestamp of this document.</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)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Update multiple values. Alias for <code>set_value</code>.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="use" href="#use" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>use</b> | |||
<i class="text-muted">(self, db_name)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><code>USE</code> db_name.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="validate_query" href="#validate_query" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>validate_query</b> | |||
<i class="text-muted">(self, q)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Throw exception for dangerous queries: <code>ALTER</code>, <code>DROP</code>, <code>TRUNCATE</code> if not <code>Administrator</code>.</p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<!-- autodoc --> |
@@ -0,0 +1,310 @@ | |||
<!-- title: frappe.defaults --><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/defaults.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.defaults._clear_cache" href="#frappe.defaults._clear_cache" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>_clear_cache</b> | |||
<i class="text-muted">(parent)</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.defaults.add_default" href="#frappe.defaults.add_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>add_default</b> | |||
<i class="text-muted">(key, value, parent, parenttype=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.defaults.add_global_default" href="#frappe.defaults.add_global_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>add_global_default</b> | |||
<i class="text-muted">(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="frappe.defaults.add_user_default" href="#frappe.defaults.add_user_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>add_user_default</b> | |||
<i class="text-muted">(key, value, user=None, parenttype=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.defaults.build_user_permissions" href="#frappe.defaults.build_user_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>build_user_permissions</b> | |||
<i class="text-muted">(user)</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.defaults.clear_cache" href="#frappe.defaults.clear_cache" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>clear_cache</b> | |||
<i class="text-muted">(user=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.defaults.clear_default" href="#frappe.defaults.clear_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>clear_default</b> | |||
<i class="text-muted">(key=None, value=None, parent=None, name=None, parenttype=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Clear a default value by any of the given parameters and delete caches.</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>key</code></strong> - Default key.</li> | |||
<li><strong><code>value</code></strong> - Default value.</li> | |||
<li><strong><code>parent</code></strong> - User name, or <code>__global</code>, <code>__default</code>.</li> | |||
<li><strong><code>name</code></strong> - Default ID.</li> | |||
<li><strong><code>parenttype</code></strong> - Clear defaults table for a particular type e.g. <strong>User</strong>.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.defaults.clear_user_default" href="#frappe.defaults.clear_user_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>clear_user_default</b> | |||
<i class="text-muted">(key, user=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.defaults.get_defaults" href="#frappe.defaults.get_defaults" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>get_defaults</b> | |||
<i class="text-muted">(user=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.defaults.get_defaults_for" href="#frappe.defaults.get_defaults_for" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>get_defaults_for</b> | |||
<i class="text-muted">(parent=__default)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get all defaults</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.defaults.get_global_default" href="#frappe.defaults.get_global_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>get_global_default</b> | |||
<i class="text-muted">(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="frappe.defaults.get_user_default" href="#frappe.defaults.get_user_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>get_user_default</b> | |||
<i class="text-muted">(key, user=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.defaults.get_user_default_as_list" href="#frappe.defaults.get_user_default_as_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>get_user_default_as_list</b> | |||
<i class="text-muted">(key, user=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.defaults.get_user_permissions" href="#frappe.defaults.get_user_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>get_user_permissions</b> | |||
<i class="text-muted">(user=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.defaults.set_default" href="#frappe.defaults.set_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>set_default</b> | |||
<i class="text-muted">(key, value, parent, parenttype=__default)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Override or add a default value. | |||
Adds default value in table <code>tabDefaultValue</code>.</p> | |||
<p><strong>Parameters:</strong></p> | |||
<ul> | |||
<li><strong><code>key</code></strong> - Default key.</li> | |||
<li><strong><code>value</code></strong> - Default value.</li> | |||
<li><strong><code>parent</code></strong> - Usually, <strong>User</strong> to whom the default belongs.</li> | |||
<li><strong><code>parenttype</code></strong> - [optional] default is <code>__default</code>.</li> | |||
</ul> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.defaults.set_global_default" href="#frappe.defaults.set_global_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>set_global_default</b> | |||
<i class="text-muted">(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="frappe.defaults.set_user_default" href="#frappe.defaults.set_user_default" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.defaults.<b>set_user_default</b> | |||
<i class="text-muted">(key, value, user=None, parenttype=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,468 @@ | |||
<!-- title: frappe.exceptions --><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/exceptions.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>AuthenticationError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>CSRFTokenError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>CancelledLinkError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.LinkValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>CannotChangeConstantError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>CharacterLengthExceededError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>DataError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>DocstatusTransitionError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>DoesNotExistError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>DuplicateEntryError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.NameError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>EmptyTableError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>InvalidEmailAddressError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>InvalidSignatureError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>InvalidStatusError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>LinkExistsError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>LinkValidationError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>MandatoryError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>MappingMismatchError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>NameError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>OutgoingEmailError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>PermissionError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>RateLimitExceededError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>Redirect</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>SessionStopped</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>TemplateNotFoundError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>TimestampMismatchError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>UniqueValidationError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>UnknownDomainError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>UnsupportedMediaType</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>UpdateAfterSubmitError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>ValidationError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<!-- autodoc --> |
@@ -0,0 +1,399 @@ | |||
<!-- title: frappe.frappeclient --><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/frappeclient.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>AuthError</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>FrappeClient</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from __builtin__.object</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__enter__" href="#__enter__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__enter__</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="__exit__" href="#__exit__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__exit__</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="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, url, username, password, verify=True)</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="bulk_update" href="#bulk_update" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>bulk_update</b> | |||
<i class="text-muted">(self, docs)</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="cancel" href="#cancel" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>cancel</b> | |||
<i class="text-muted">(self, doctype, name)</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="delete" href="#delete" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>delete</b> | |||
<i class="text-muted">(self, doctype, name)</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="get_api" href="#get_api" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_api</b> | |||
<i class="text-muted">(self, method, params={})</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="get_doc" href="#get_doc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_doc</b> | |||
<i class="text-muted">(self, doctype, name=, filters=None, fields=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="get_list" href="#get_list" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_list</b> | |||
<i class="text-muted">(self, doctype, fields="*", filters=None, limit_start=0, limit_page_length=0)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns list of records of a particular type</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="get_request" href="#get_request" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_request</b> | |||
<i class="text-muted">(self, params)</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="get_value" href="#get_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_value</b> | |||
<i class="text-muted">(self, doctype, fieldname=None, filters=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="insert" href="#insert" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>insert</b> | |||
<i class="text-muted">(self, doc)</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="login" href="#login" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>login</b> | |||
<i class="text-muted">(self, username, password)</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="logout" href="#logout" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>logout</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="migrate_doctype" href="#migrate_doctype" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>migrate_doctype</b> | |||
<i class="text-muted">(self, doctype, filters=None, update=None, verbose=1, exclude=None, preprocess=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Migrate records from another doctype</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="migrate_single" href="#migrate_single" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>migrate_single</b> | |||
<i class="text-muted">(self, 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="post_api" href="#post_api" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>post_api</b> | |||
<i class="text-muted">(self, method, params={})</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="post_process" href="#post_process" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>post_process</b> | |||
<i class="text-muted">(self, response)</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="post_request" href="#post_request" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>post_request</b> | |||
<i class="text-muted">(self, data)</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="preprocess" href="#preprocess" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>preprocess</b> | |||
<i class="text-muted">(self, params)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>convert dicts, lists to json</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="rename_doc" href="#rename_doc" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>rename_doc</b> | |||
<i class="text-muted">(self, doctype, old_name, new_name)</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="set_value" href="#set_value" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>set_value</b> | |||
<i class="text-muted">(self, doctype, docname, fieldname, 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="submit" href="#submit" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>submit</b> | |||
<i class="text-muted">(self, doclist)</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, doc)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<h3 style="font-weight: normal;">Class <b>FrappeException</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from exceptions.Exception</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
</div> | |||
<hr> | |||
<!-- autodoc --> |
@@ -0,0 +1,228 @@ | |||
<!-- title: frappe.handler --><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/handler.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.async_ping</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.async_ping" href="#frappe.handler.async_ping" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>async_ping</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.handler.execute_cmd" href="#frappe.handler.execute_cmd" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>execute_cmd</b> | |||
<i class="text-muted">(cmd, from_async=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>execute a request as python module</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.get_async_task_status</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.get_async_task_status" href="#frappe.handler.get_async_task_status" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>get_async_task_status</b> | |||
<i class="text-muted">(task_id)</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.handler.get_attr" href="#frappe.handler.get_attr" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>get_attr</b> | |||
<i class="text-muted">(cmd)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get method object from cmd</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.handle" href="#frappe.handler.handle" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>handle</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>handle request</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.logout</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.logout" href="#frappe.handler.logout" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>logout</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.ping</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.ping" href="#frappe.handler.ping" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>ping</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.run_custom_method</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.run_custom_method" href="#frappe.handler.run_custom_method" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>run_custom_method</b> | |||
<i class="text-muted">(doctype, name, custom_method)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>cmd=run<em>custom</em>method&doctype={doctype}&name={name}&custom<em>method={custom</em>method}</p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.runserverobj</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.runserverobj" href="#frappe.handler.runserverobj" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>runserverobj</b> | |||
<i class="text-muted">(method, docs=None, dt=None, dn=None, arg=None, args=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.uploadfile</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.uploadfile" href="#frappe.handler.uploadfile" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>uploadfile</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.version</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.version" href="#frappe.handler.version" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>version</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.handler.web_logout</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.handler.web_logout" href="#frappe.handler.web_logout" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.handler.<b>web_logout</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.hooks --><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/hooks.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,370 @@ | |||
<!-- title: frappe.installer --><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/installer.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.installer.add_module_defs" href="#frappe.installer.add_module_defs" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>add_module_defs</b> | |||
<i class="text-muted">(app)</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.installer.add_to_installed_apps" href="#frappe.installer.add_to_installed_apps" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>add_to_installed_apps</b> | |||
<i class="text-muted">(app_name, rebuild_website=True)</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.installer.check_if_ready_for_barracuda" href="#frappe.installer.check_if_ready_for_barracuda" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>check_if_ready_for_barracuda</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.installer.create_auth_table" href="#frappe.installer.create_auth_table" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>create_auth_table</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.installer.create_database_and_user" href="#frappe.installer.create_database_and_user" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>create_database_and_user</b> | |||
<i class="text-muted">(force, verbose)</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.installer.get_conf_params" href="#frappe.installer.get_conf_params" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>get_conf_params</b> | |||
<i class="text-muted">(db_name=None, db_password=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.installer.get_current_host" href="#frappe.installer.get_current_host" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>get_current_host</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.installer.get_site_config_path" href="#frappe.installer.get_site_config_path" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>get_site_config_path</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.installer.import_db_from_sql" href="#frappe.installer.import_db_from_sql" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>import_db_from_sql</b> | |||
<i class="text-muted">(source_sql, verbose)</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.installer.init_singles" href="#frappe.installer.init_singles" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>init_singles</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.installer.install_app" href="#frappe.installer.install_app" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>install_app</b> | |||
<i class="text-muted">(name, verbose=False, set_as_patched=True)</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.installer.install_db" href="#frappe.installer.install_db" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>install_db</b> | |||
<i class="text-muted">(root_login=root, root_password=None, db_name=None, source_sql=None, admin_password=None, verbose=True, force=0, site_config=None, reinstall=False)</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.installer.make_conf" href="#frappe.installer.make_conf" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>make_conf</b> | |||
<i class="text-muted">(db_name=None, db_password=None, site_config=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.installer.make_connection" href="#frappe.installer.make_connection" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>make_connection</b> | |||
<i class="text-muted">(root_login, root_password)</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.installer.make_site_config" href="#frappe.installer.make_site_config" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>make_site_config</b> | |||
<i class="text-muted">(db_name=None, db_password=None, site_config=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.installer.make_site_dirs" href="#frappe.installer.make_site_dirs" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>make_site_dirs</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.installer.post_install" href="#frappe.installer.post_install" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>post_install</b> | |||
<i class="text-muted">(rebuild_website=False)</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.installer.remove_app" href="#frappe.installer.remove_app" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>remove_app</b> | |||
<i class="text-muted">(app_name, dry_run=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Delete app and all linked to the app's module with the app.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.installer.remove_from_installed_apps" href="#frappe.installer.remove_from_installed_apps" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>remove_from_installed_apps</b> | |||
<i class="text-muted">(app_name)</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.installer.remove_missing_apps" href="#frappe.installer.remove_missing_apps" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>remove_missing_apps</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.installer.set_all_patches_as_completed" href="#frappe.installer.set_all_patches_as_completed" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>set_all_patches_as_completed</b> | |||
<i class="text-muted">(app)</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.installer.update_site_config" href="#frappe.installer.update_site_config" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.installer.<b>update_site_config</b> | |||
<i class="text-muted">(key, value)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Update a value in site_config</p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,61 @@ | |||
<!-- title: frappe.middlewares --><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/middlewares.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>StaticDataMiddleware</b></h3> | |||
<p style="padding-left: 30px;"><i>Inherits from werkzeug.wsgi.SharedDataMiddleware</i></h4> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__call__" href="#__call__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__call__</b> | |||
<i class="text-muted">(self, environ, start_response)</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="get_directory_loader" href="#get_directory_loader" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_directory_loader</b> | |||
<i class="text-muted">(self, directory)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<!-- autodoc --> |
@@ -0,0 +1,332 @@ | |||
<!-- title: frappe.permissions --><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/permissions.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.add_user_permission" href="#frappe.permissions.add_user_permission" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>add_user_permission</b> | |||
<i class="text-muted">(doctype, name, user, with_message=False)</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.permissions.apply_user_permissions" href="#frappe.permissions.apply_user_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>apply_user_permissions</b> | |||
<i class="text-muted">(doctype, ptype, user=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Check if apply<em>user</em>permissions is checked for a doctype, perm type, user combination</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.can_export" href="#frappe.permissions.can_export" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>can_export</b> | |||
<i class="text-muted">(doctype, raise_exception=False)</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.permissions.can_import" href="#frappe.permissions.can_import" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>can_import</b> | |||
<i class="text-muted">(doctype, raise_exception=False)</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.permissions.can_set_user_permissions" href="#frappe.permissions.can_set_user_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>can_set_user_permissions</b> | |||
<i class="text-muted">(doctype, docname=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.permissions.check_admin_or_system_manager" href="#frappe.permissions.check_admin_or_system_manager" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>check_admin_or_system_manager</b> | |||
<i class="text-muted">(user=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.permissions.clear_user_permissions_for_doctype" href="#frappe.permissions.clear_user_permissions_for_doctype" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>clear_user_permissions_for_doctype</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.permissions.get_doc_permissions" href="#frappe.permissions.get_doc_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>get_doc_permissions</b> | |||
<i class="text-muted">(doc, verbose=False, user=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns a dict of evaluated permissions for given <code>doc</code> like <code>{"read":1, "write":1}</code></p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.get_linked_doctypes" href="#frappe.permissions.get_linked_doctypes" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>get_linked_doctypes</b> | |||
<i class="text-muted">(dt)</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.permissions.get_role_permissions" href="#frappe.permissions.get_role_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>get_role_permissions</b> | |||
<i class="text-muted">(meta, user=None, verbose=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns dict of evaluated role permissions like <code>{"read": True, "write":False}</code></p> | |||
<p>If user permissions are applicable, it adds a dict of user permissions like</p> | |||
<pre><code>{ | |||
// user permissions will apply on these rights | |||
"apply_user_permissions": {"read": 1, "write": 1}, | |||
// doctypes that will be applicable for each right | |||
"user_permission_doctypes": { | |||
"read": [ | |||
// AND between "DocType 1" and "DocType 2" | |||
["DocType 1", "DocType 2"], | |||
// OR | |||
["DocType 3"] | |||
] | |||
} | |||
"if_owner": {"read": 1, "write": 1} | |||
} | |||
</code></pre> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.get_user_permission_doctypes" href="#frappe.permissions.get_user_permission_doctypes" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>get_user_permission_doctypes</b> | |||
<i class="text-muted">(user_permission_doctypes, user_permissions)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>returns a list of list like [["User", "Blog Post"], ["User"]]</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.has_controller_permissions" href="#frappe.permissions.has_controller_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>has_controller_permissions</b> | |||
<i class="text-muted">(doc, ptype, user=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns controller permissions if defined. None if not defined</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.has_permission" href="#frappe.permissions.has_permission" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>has_permission</b> | |||
<i class="text-muted">(doctype, ptype=read, doc=None, verbose=False, user=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Returns True if user has permission <code>ptype</code> for given <code>doctype</code>. | |||
If <code>doc</code> is passed, it also checks user, share and owner permissions.</p> | |||
<p>Note: if Table DocType is passed, it always returns True.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.remove_user_permission" href="#frappe.permissions.remove_user_permission" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>remove_user_permission</b> | |||
<i class="text-muted">(doctype, name, user, default_value_name=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.permissions.reset_perms" href="#frappe.permissions.reset_perms" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>reset_perms</b> | |||
<i class="text-muted">(doctype)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Reset permissions for given doctype.</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.set_user_permission_if_allowed" href="#frappe.permissions.set_user_permission_if_allowed" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>set_user_permission_if_allowed</b> | |||
<i class="text-muted">(doctype, name, user, with_message=False)</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.permissions.update_share_permissions" href="#frappe.permissions.update_share_permissions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>update_share_permissions</b> | |||
<i class="text-muted">(role_permissions, doc, user)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>Updates share permissions on <code>role_permissions</code> for given doc, if shared</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.permissions.user_has_permission" href="#frappe.permissions.user_has_permission" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.permissions.<b>user_has_permission</b> | |||
<i class="text-muted">(doc, verbose=True, user=None, user_permission_doctypes=None)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |
@@ -0,0 +1,18 @@ | |||
<!-- title: frappe.pythonrc --><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/pythonrc.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<!-- autodoc --> |
@@ -0,0 +1,409 @@ | |||
<!-- title: frappe.sessions --><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/sessions.py" | |||
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a> | |||
</div> | |||
<h3 style="font-weight: normal;">Class <b>Session</b></h3> | |||
<div class="docs-attr-desc"><p></p> | |||
</div> | |||
<div style="padding-left: 30px;"> | |||
<p class="docs-attr-name"> | |||
<a name="__init__" href="#__init__" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>__init__</b> | |||
<i class="text-muted">(self, user, resume=False, full_name=None, user_type=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="delete_session" href="#delete_session" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>delete_session</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="get_expiry_in_seconds" href="#get_expiry_in_seconds" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_expiry_in_seconds</b> | |||
<i class="text-muted">(self, expiry)</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="get_session_data" href="#get_session_data" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_session_data</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="get_session_data_from_cache" href="#get_session_data_from_cache" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_session_data_from_cache</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="get_session_data_from_db" href="#get_session_data_from_db" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_session_data_from_db</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="get_session_record" href="#get_session_record" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>get_session_record</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get session record, or return the standard Guest Record</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="insert_session_record" href="#insert_session_record" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>insert_session_record</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="resume" href="#resume" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>resume</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>non-login request: load a session</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="start" href="#start" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>start</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>start a new session</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="start_as_guest" href="#start_as_guest" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
<b>start_as_guest</b> | |||
<i class="text-muted">(self)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>all guests share the same 'Guest' session</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, force=False)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>extend session expiry</p> | |||
</div> | |||
<br> | |||
</div> | |||
<hr> | |||
<p><span class="label label-info">Public API</span> | |||
<br><code>/api/method/frappe.sessions.clear</code> | |||
</p> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.sessions.clear" href="#frappe.sessions.clear" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>clear</b> | |||
<i class="text-muted">(user=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.sessions.clear_all_sessions" href="#frappe.sessions.clear_all_sessions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>clear_all_sessions</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>This effectively logs out all users</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.sessions.clear_cache" href="#frappe.sessions.clear_cache" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>clear_cache</b> | |||
<i class="text-muted">(user=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.sessions.clear_expired_sessions" href="#frappe.sessions.clear_expired_sessions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>clear_expired_sessions</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>This function is meant to be called from scheduler</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.sessions.clear_global_cache" href="#frappe.sessions.clear_global_cache" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>clear_global_cache</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.sessions.clear_sessions" href="#frappe.sessions.clear_sessions" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>clear_sessions</b> | |||
<i class="text-muted">(user=None, keep_current=False)</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.sessions.delete_session" href="#frappe.sessions.delete_session" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>delete_session</b> | |||
<i class="text-muted">(sid=None, user=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.sessions.generate_csrf_token" href="#frappe.sessions.generate_csrf_token" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>generate_csrf_token</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.sessions.get" href="#frappe.sessions.get" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>get</b> | |||
<i class="text-muted">()</i> | |||
</p> | |||
<div class="docs-attr-desc"><p>get session boot info</p> | |||
</div> | |||
<br> | |||
<p class="docs-attr-name"> | |||
<a name="frappe.sessions.get_csrf_token" href="#frappe.sessions.get_csrf_token" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>get_csrf_token</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.sessions.get_expiry_period" href="#frappe.sessions.get_expiry_period" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>get_expiry_period</b> | |||
<i class="text-muted">(device=desktop)</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.sessions.get_geo_from_ip" href="#frappe.sessions.get_geo_from_ip" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>get_geo_from_ip</b> | |||
<i class="text-muted">(ip_addr)</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.sessions.get_geo_ip_country" href="#frappe.sessions.get_geo_ip_country" class="text-muted small"> | |||
<i class="icon-link small" style="color: #ccc;"></i></a> | |||
frappe.sessions.<b>get_geo_ip_country</b> | |||
<i class="text-muted">(ip_addr)</i> | |||
</p> | |||
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p> | |||
</div> | |||
<br> | |||
<!-- autodoc --> |